dex_file.h revision 564ff985184737977aa26c485d0c1a413e530705
1/* 2 * Copyright (C) 2011 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#ifndef ART_RUNTIME_DEX_FILE_H_ 18#define ART_RUNTIME_DEX_FILE_H_ 19 20#include <memory> 21#include <string> 22#include <unordered_map> 23#include <vector> 24 25#include "base/hash_map.h" 26#include "base/logging.h" 27#include "base/mutex.h" // For Locks::mutator_lock_. 28#include "globals.h" 29#include "invoke_type.h" 30#include "jni.h" 31#include "modifiers.h" 32#include "utf.h" 33 34namespace art { 35 36// TODO: remove dependencies on mirror classes, primarily by moving 37// EncodedStaticFieldValueIterator to its own file. 38namespace mirror { 39 class ArtField; 40 class ArtMethod; 41 class ClassLoader; 42 class DexCache; 43} // namespace mirror 44class ClassLinker; 45class MemMap; 46class Signature; 47template<class T> class Handle; 48class StringPiece; 49class ZipArchive; 50 51// TODO: move all of the macro functionality into the DexCache class. 52class DexFile { 53 public: 54 static const byte kDexMagic[]; 55 static const byte kDexMagicVersion[]; 56 static const size_t kSha1DigestSize = 20; 57 static const uint32_t kDexEndianConstant = 0x12345678; 58 59 // name of the DexFile entry within a zip archive 60 static const char* kClassesDex; 61 62 // The value of an invalid index. 63 static const uint32_t kDexNoIndex = 0xFFFFFFFF; 64 65 // The value of an invalid index. 66 static const uint16_t kDexNoIndex16 = 0xFFFF; 67 68 // The separator charactor in MultiDex locations. 69 static constexpr char kMultiDexSeparator = ':'; 70 71 // A string version of the previous. This is a define so that we can merge string literals in the 72 // preprocessor. 73 #define kMultiDexSeparatorString ":" 74 75 // Raw header_item. 76 struct Header { 77 uint8_t magic_[8]; 78 uint32_t checksum_; // See also location_checksum_ 79 uint8_t signature_[kSha1DigestSize]; 80 uint32_t file_size_; // size of entire file 81 uint32_t header_size_; // offset to start of next section 82 uint32_t endian_tag_; 83 uint32_t link_size_; // unused 84 uint32_t link_off_; // unused 85 uint32_t map_off_; // unused 86 uint32_t string_ids_size_; // number of StringIds 87 uint32_t string_ids_off_; // file offset of StringIds array 88 uint32_t type_ids_size_; // number of TypeIds, we don't support more than 65535 89 uint32_t type_ids_off_; // file offset of TypeIds array 90 uint32_t proto_ids_size_; // number of ProtoIds, we don't support more than 65535 91 uint32_t proto_ids_off_; // file offset of ProtoIds array 92 uint32_t field_ids_size_; // number of FieldIds 93 uint32_t field_ids_off_; // file offset of FieldIds array 94 uint32_t method_ids_size_; // number of MethodIds 95 uint32_t method_ids_off_; // file offset of MethodIds array 96 uint32_t class_defs_size_; // number of ClassDefs 97 uint32_t class_defs_off_; // file offset of ClassDef array 98 uint32_t data_size_; // unused 99 uint32_t data_off_; // unused 100 101 private: 102 DISALLOW_COPY_AND_ASSIGN(Header); 103 }; 104 105 // Map item type codes. 106 enum { 107 kDexTypeHeaderItem = 0x0000, 108 kDexTypeStringIdItem = 0x0001, 109 kDexTypeTypeIdItem = 0x0002, 110 kDexTypeProtoIdItem = 0x0003, 111 kDexTypeFieldIdItem = 0x0004, 112 kDexTypeMethodIdItem = 0x0005, 113 kDexTypeClassDefItem = 0x0006, 114 kDexTypeMapList = 0x1000, 115 kDexTypeTypeList = 0x1001, 116 kDexTypeAnnotationSetRefList = 0x1002, 117 kDexTypeAnnotationSetItem = 0x1003, 118 kDexTypeClassDataItem = 0x2000, 119 kDexTypeCodeItem = 0x2001, 120 kDexTypeStringDataItem = 0x2002, 121 kDexTypeDebugInfoItem = 0x2003, 122 kDexTypeAnnotationItem = 0x2004, 123 kDexTypeEncodedArrayItem = 0x2005, 124 kDexTypeAnnotationsDirectoryItem = 0x2006, 125 }; 126 127 struct MapItem { 128 uint16_t type_; 129 uint16_t unused_; 130 uint32_t size_; 131 uint32_t offset_; 132 133 private: 134 DISALLOW_COPY_AND_ASSIGN(MapItem); 135 }; 136 137 struct MapList { 138 uint32_t size_; 139 MapItem list_[1]; 140 141 private: 142 DISALLOW_COPY_AND_ASSIGN(MapList); 143 }; 144 145 // Raw string_id_item. 146 struct StringId { 147 uint32_t string_data_off_; // offset in bytes from the base address 148 149 private: 150 DISALLOW_COPY_AND_ASSIGN(StringId); 151 }; 152 153 // Raw type_id_item. 154 struct TypeId { 155 uint32_t descriptor_idx_; // index into string_ids 156 157 private: 158 DISALLOW_COPY_AND_ASSIGN(TypeId); 159 }; 160 161 // Raw field_id_item. 162 struct FieldId { 163 uint16_t class_idx_; // index into type_ids_ array for defining class 164 uint16_t type_idx_; // index into type_ids_ array for field type 165 uint32_t name_idx_; // index into string_ids_ array for field name 166 167 private: 168 DISALLOW_COPY_AND_ASSIGN(FieldId); 169 }; 170 171 // Raw method_id_item. 172 struct MethodId { 173 uint16_t class_idx_; // index into type_ids_ array for defining class 174 uint16_t proto_idx_; // index into proto_ids_ array for method prototype 175 uint32_t name_idx_; // index into string_ids_ array for method name 176 177 private: 178 DISALLOW_COPY_AND_ASSIGN(MethodId); 179 }; 180 181 // Raw proto_id_item. 182 struct ProtoId { 183 uint32_t shorty_idx_; // index into string_ids array for shorty descriptor 184 uint16_t return_type_idx_; // index into type_ids array for return type 185 uint16_t pad_; // padding = 0 186 uint32_t parameters_off_; // file offset to type_list for parameter types 187 188 private: 189 DISALLOW_COPY_AND_ASSIGN(ProtoId); 190 }; 191 192 // Raw class_def_item. 193 struct ClassDef { 194 uint16_t class_idx_; // index into type_ids_ array for this class 195 uint16_t pad1_; // padding = 0 196 uint32_t access_flags_; 197 uint16_t superclass_idx_; // index into type_ids_ array for superclass 198 uint16_t pad2_; // padding = 0 199 uint32_t interfaces_off_; // file offset to TypeList 200 uint32_t source_file_idx_; // index into string_ids_ for source file name 201 uint32_t annotations_off_; // file offset to annotations_directory_item 202 uint32_t class_data_off_; // file offset to class_data_item 203 uint32_t static_values_off_; // file offset to EncodedArray 204 205 // Returns the valid access flags, that is, Java modifier bits relevant to the ClassDef type 206 // (class or interface). These are all in the lower 16b and do not contain runtime flags. 207 uint32_t GetJavaAccessFlags() const { 208 // Make sure that none of our runtime-only flags are set. 209 COMPILE_ASSERT((kAccValidClassFlags & kAccJavaFlagsMask) == kAccValidClassFlags, 210 valid_class_flags_not_subset_of_java_flags); 211 COMPILE_ASSERT((kAccValidInterfaceFlags & kAccJavaFlagsMask) == kAccValidInterfaceFlags, 212 valid_interface_flags_not_subset_of_java_flags); 213 214 if ((access_flags_ & kAccInterface) != 0) { 215 // Interface. 216 return access_flags_ & kAccValidInterfaceFlags; 217 } else { 218 // Class. 219 return access_flags_ & kAccValidClassFlags; 220 } 221 } 222 223 private: 224 DISALLOW_COPY_AND_ASSIGN(ClassDef); 225 }; 226 227 // Raw type_item. 228 struct TypeItem { 229 uint16_t type_idx_; // index into type_ids section 230 231 private: 232 DISALLOW_COPY_AND_ASSIGN(TypeItem); 233 }; 234 235 // Raw type_list. 236 class TypeList { 237 public: 238 uint32_t Size() const { 239 return size_; 240 } 241 242 const TypeItem& GetTypeItem(uint32_t idx) const { 243 DCHECK_LT(idx, this->size_); 244 return this->list_[idx]; 245 } 246 247 // Size in bytes of the part of the list that is common. 248 static constexpr size_t GetHeaderSize() { 249 return 4U; 250 } 251 252 // Size in bytes of the whole type list including all the stored elements. 253 static constexpr size_t GetListSize(size_t count) { 254 return GetHeaderSize() + sizeof(TypeItem) * count; 255 } 256 257 private: 258 uint32_t size_; // size of the list, in entries 259 TypeItem list_[1]; // elements of the list 260 DISALLOW_COPY_AND_ASSIGN(TypeList); 261 }; 262 263 // Raw code_item. 264 struct CodeItem { 265 uint16_t registers_size_; 266 uint16_t ins_size_; 267 uint16_t outs_size_; 268 uint16_t tries_size_; 269 uint32_t debug_info_off_; // file offset to debug info stream 270 uint32_t insns_size_in_code_units_; // size of the insns array, in 2 byte code units 271 uint16_t insns_[1]; 272 273 private: 274 DISALLOW_COPY_AND_ASSIGN(CodeItem); 275 }; 276 277 // Raw try_item. 278 struct TryItem { 279 uint32_t start_addr_; 280 uint16_t insn_count_; 281 uint16_t handler_off_; 282 283 private: 284 DISALLOW_COPY_AND_ASSIGN(TryItem); 285 }; 286 287 // Annotation constants. 288 enum { 289 kDexVisibilityBuild = 0x00, /* annotation visibility */ 290 kDexVisibilityRuntime = 0x01, 291 kDexVisibilitySystem = 0x02, 292 293 kDexAnnotationByte = 0x00, 294 kDexAnnotationShort = 0x02, 295 kDexAnnotationChar = 0x03, 296 kDexAnnotationInt = 0x04, 297 kDexAnnotationLong = 0x06, 298 kDexAnnotationFloat = 0x10, 299 kDexAnnotationDouble = 0x11, 300 kDexAnnotationString = 0x17, 301 kDexAnnotationType = 0x18, 302 kDexAnnotationField = 0x19, 303 kDexAnnotationMethod = 0x1a, 304 kDexAnnotationEnum = 0x1b, 305 kDexAnnotationArray = 0x1c, 306 kDexAnnotationAnnotation = 0x1d, 307 kDexAnnotationNull = 0x1e, 308 kDexAnnotationBoolean = 0x1f, 309 310 kDexAnnotationValueTypeMask = 0x1f, /* low 5 bits */ 311 kDexAnnotationValueArgShift = 5, 312 }; 313 314 struct AnnotationsDirectoryItem { 315 uint32_t class_annotations_off_; 316 uint32_t fields_size_; 317 uint32_t methods_size_; 318 uint32_t parameters_size_; 319 320 private: 321 DISALLOW_COPY_AND_ASSIGN(AnnotationsDirectoryItem); 322 }; 323 324 struct FieldAnnotationsItem { 325 uint32_t field_idx_; 326 uint32_t annotations_off_; 327 328 private: 329 DISALLOW_COPY_AND_ASSIGN(FieldAnnotationsItem); 330 }; 331 332 struct MethodAnnotationsItem { 333 uint32_t method_idx_; 334 uint32_t annotations_off_; 335 336 private: 337 DISALLOW_COPY_AND_ASSIGN(MethodAnnotationsItem); 338 }; 339 340 struct ParameterAnnotationsItem { 341 uint32_t method_idx_; 342 uint32_t annotations_off_; 343 344 private: 345 DISALLOW_COPY_AND_ASSIGN(ParameterAnnotationsItem); 346 }; 347 348 struct AnnotationSetRefItem { 349 uint32_t annotations_off_; 350 351 private: 352 DISALLOW_COPY_AND_ASSIGN(AnnotationSetRefItem); 353 }; 354 355 struct AnnotationSetRefList { 356 uint32_t size_; 357 AnnotationSetRefItem list_[1]; 358 359 private: 360 DISALLOW_COPY_AND_ASSIGN(AnnotationSetRefList); 361 }; 362 363 struct AnnotationSetItem { 364 uint32_t size_; 365 uint32_t entries_[1]; 366 367 private: 368 DISALLOW_COPY_AND_ASSIGN(AnnotationSetItem); 369 }; 370 371 struct AnnotationItem { 372 uint8_t visibility_; 373 uint8_t annotation_[1]; 374 375 private: 376 DISALLOW_COPY_AND_ASSIGN(AnnotationItem); 377 }; 378 379 // Returns the checksum of a file for comparison with GetLocationChecksum(). 380 // For .dex files, this is the header checksum. 381 // For zip files, this is the classes.dex zip entry CRC32 checksum. 382 // Return true if the checksum could be found, false otherwise. 383 static bool GetChecksum(const char* filename, uint32_t* checksum, std::string* error_msg); 384 385 // Opens .dex files found in the container, guessing the container format based on file extension. 386 static bool Open(const char* filename, const char* location, std::string* error_msg, 387 std::vector<const DexFile*>* dex_files); 388 389 // Opens .dex file, backed by existing memory 390 static const DexFile* Open(const uint8_t* base, size_t size, 391 const std::string& location, 392 uint32_t location_checksum, 393 std::string* error_msg) { 394 return OpenMemory(base, size, location, location_checksum, NULL, error_msg); 395 } 396 397 // Open all classesXXX.dex files from a zip archive. 398 static bool OpenFromZip(const ZipArchive& zip_archive, const std::string& location, 399 std::string* error_msg, std::vector<const DexFile*>* dex_files); 400 401 // Closes a .dex file. 402 virtual ~DexFile(); 403 404 const std::string& GetLocation() const { 405 return location_; 406 } 407 408 // For normal dex files, location and base location coincide. If a dex file is part of a multidex 409 // archive, the base location is the name of the originating jar/apk, stripped of any internal 410 // classes*.dex path. 411 static std::string GetBaseLocation(const char* location) { 412 const char* pos = strrchr(location, kMultiDexSeparator); 413 if (pos == nullptr) { 414 return location; 415 } else { 416 return std::string(location, pos - location); 417 } 418 } 419 420 std::string GetBaseLocation() const { 421 size_t pos = location_.rfind(kMultiDexSeparator); 422 if (pos == std::string::npos) { 423 return location_; 424 } else { 425 return location_.substr(0, pos); 426 } 427 } 428 429 // For DexFiles directly from .dex files, this is the checksum from the DexFile::Header. 430 // For DexFiles opened from a zip files, this will be the ZipEntry CRC32 of classes.dex. 431 uint32_t GetLocationChecksum() const { 432 return location_checksum_; 433 } 434 435 const Header& GetHeader() const { 436 DCHECK(header_ != NULL) << GetLocation(); 437 return *header_; 438 } 439 440 // Decode the dex magic version 441 uint32_t GetVersion() const; 442 443 // Returns true if the byte string points to the magic value. 444 static bool IsMagicValid(const byte* magic); 445 446 // Returns true if the byte string after the magic is the correct value. 447 static bool IsVersionValid(const byte* magic); 448 449 // Returns the number of string identifiers in the .dex file. 450 size_t NumStringIds() const { 451 DCHECK(header_ != NULL) << GetLocation(); 452 return header_->string_ids_size_; 453 } 454 455 // Returns the StringId at the specified index. 456 const StringId& GetStringId(uint32_t idx) const { 457 DCHECK_LT(idx, NumStringIds()) << GetLocation(); 458 return string_ids_[idx]; 459 } 460 461 uint32_t GetIndexForStringId(const StringId& string_id) const { 462 CHECK_GE(&string_id, string_ids_) << GetLocation(); 463 CHECK_LT(&string_id, string_ids_ + header_->string_ids_size_) << GetLocation(); 464 return &string_id - string_ids_; 465 } 466 467 int32_t GetStringLength(const StringId& string_id) const; 468 469 // Returns a pointer to the UTF-8 string data referred to by the given string_id as well as the 470 // length of the string when decoded as a UTF-16 string. Note the UTF-16 length is not the same 471 // as the string length of the string data. 472 const char* GetStringDataAndUtf16Length(const StringId& string_id, uint32_t* utf16_length) const; 473 474 const char* GetStringData(const StringId& string_id) const { 475 uint32_t ignored; 476 return GetStringDataAndUtf16Length(string_id, &ignored); 477 } 478 479 // Index version of GetStringDataAndUtf16Length. 480 const char* StringDataAndUtf16LengthByIdx(uint32_t idx, uint32_t* utf16_length) const { 481 if (idx == kDexNoIndex) { 482 *utf16_length = 0; 483 return NULL; 484 } 485 const StringId& string_id = GetStringId(idx); 486 return GetStringDataAndUtf16Length(string_id, utf16_length); 487 } 488 489 const char* StringDataByIdx(uint32_t idx) const { 490 uint32_t unicode_length; 491 return StringDataAndUtf16LengthByIdx(idx, &unicode_length); 492 } 493 494 // Looks up a string id for a given modified utf8 string. 495 const StringId* FindStringId(const char* string) const; 496 497 // Looks up a string id for a given utf16 string. 498 const StringId* FindStringId(const uint16_t* string) const; 499 500 // Returns the number of type identifiers in the .dex file. 501 uint32_t NumTypeIds() const { 502 DCHECK(header_ != NULL) << GetLocation(); 503 return header_->type_ids_size_; 504 } 505 506 // Returns the TypeId at the specified index. 507 const TypeId& GetTypeId(uint32_t idx) const { 508 DCHECK_LT(idx, NumTypeIds()) << GetLocation(); 509 return type_ids_[idx]; 510 } 511 512 uint16_t GetIndexForTypeId(const TypeId& type_id) const { 513 CHECK_GE(&type_id, type_ids_) << GetLocation(); 514 CHECK_LT(&type_id, type_ids_ + header_->type_ids_size_) << GetLocation(); 515 size_t result = &type_id - type_ids_; 516 DCHECK_LT(result, 65536U) << GetLocation(); 517 return static_cast<uint16_t>(result); 518 } 519 520 // Get the descriptor string associated with a given type index. 521 const char* StringByTypeIdx(uint32_t idx, uint32_t* unicode_length) const { 522 const TypeId& type_id = GetTypeId(idx); 523 return StringDataAndUtf16LengthByIdx(type_id.descriptor_idx_, unicode_length); 524 } 525 526 const char* StringByTypeIdx(uint32_t idx) const { 527 const TypeId& type_id = GetTypeId(idx); 528 return StringDataByIdx(type_id.descriptor_idx_); 529 } 530 531 // Returns the type descriptor string of a type id. 532 const char* GetTypeDescriptor(const TypeId& type_id) const { 533 return StringDataByIdx(type_id.descriptor_idx_); 534 } 535 536 // Looks up a type for the given string index 537 const TypeId* FindTypeId(uint32_t string_idx) const; 538 539 // Returns the number of field identifiers in the .dex file. 540 size_t NumFieldIds() const { 541 DCHECK(header_ != NULL) << GetLocation(); 542 return header_->field_ids_size_; 543 } 544 545 // Returns the FieldId at the specified index. 546 const FieldId& GetFieldId(uint32_t idx) const { 547 DCHECK_LT(idx, NumFieldIds()) << GetLocation(); 548 return field_ids_[idx]; 549 } 550 551 uint32_t GetIndexForFieldId(const FieldId& field_id) const { 552 CHECK_GE(&field_id, field_ids_) << GetLocation(); 553 CHECK_LT(&field_id, field_ids_ + header_->field_ids_size_) << GetLocation(); 554 return &field_id - field_ids_; 555 } 556 557 // Looks up a field by its declaring class, name and type 558 const FieldId* FindFieldId(const DexFile::TypeId& declaring_klass, 559 const DexFile::StringId& name, 560 const DexFile::TypeId& type) const; 561 562 // Returns the declaring class descriptor string of a field id. 563 const char* GetFieldDeclaringClassDescriptor(const FieldId& field_id) const { 564 const DexFile::TypeId& type_id = GetTypeId(field_id.class_idx_); 565 return GetTypeDescriptor(type_id); 566 } 567 568 // Returns the class descriptor string of a field id. 569 const char* GetFieldTypeDescriptor(const FieldId& field_id) const { 570 const DexFile::TypeId& type_id = GetTypeId(field_id.type_idx_); 571 return GetTypeDescriptor(type_id); 572 } 573 574 // Returns the name of a field id. 575 const char* GetFieldName(const FieldId& field_id) const { 576 return StringDataByIdx(field_id.name_idx_); 577 } 578 579 // Returns the number of method identifiers in the .dex file. 580 size_t NumMethodIds() const { 581 DCHECK(header_ != NULL) << GetLocation(); 582 return header_->method_ids_size_; 583 } 584 585 // Returns the MethodId at the specified index. 586 const MethodId& GetMethodId(uint32_t idx) const { 587 DCHECK_LT(idx, NumMethodIds()) << GetLocation(); 588 return method_ids_[idx]; 589 } 590 591 uint32_t GetIndexForMethodId(const MethodId& method_id) const { 592 CHECK_GE(&method_id, method_ids_) << GetLocation(); 593 CHECK_LT(&method_id, method_ids_ + header_->method_ids_size_) << GetLocation(); 594 return &method_id - method_ids_; 595 } 596 597 // Looks up a method by its declaring class, name and proto_id 598 const MethodId* FindMethodId(const DexFile::TypeId& declaring_klass, 599 const DexFile::StringId& name, 600 const DexFile::ProtoId& signature) const; 601 602 // Returns the declaring class descriptor string of a method id. 603 const char* GetMethodDeclaringClassDescriptor(const MethodId& method_id) const { 604 const DexFile::TypeId& type_id = GetTypeId(method_id.class_idx_); 605 return GetTypeDescriptor(type_id); 606 } 607 608 // Returns the prototype of a method id. 609 const ProtoId& GetMethodPrototype(const MethodId& method_id) const { 610 return GetProtoId(method_id.proto_idx_); 611 } 612 613 // Returns a representation of the signature of a method id. 614 const Signature GetMethodSignature(const MethodId& method_id) const; 615 616 // Returns the name of a method id. 617 const char* GetMethodName(const MethodId& method_id) const { 618 return StringDataByIdx(method_id.name_idx_); 619 } 620 621 // Returns the shorty of a method id. 622 const char* GetMethodShorty(const MethodId& method_id) const { 623 return StringDataByIdx(GetProtoId(method_id.proto_idx_).shorty_idx_); 624 } 625 const char* GetMethodShorty(const MethodId& method_id, uint32_t* length) const { 626 // Using the UTF16 length is safe here as shorties are guaranteed to be ASCII characters. 627 return StringDataAndUtf16LengthByIdx(GetProtoId(method_id.proto_idx_).shorty_idx_, length); 628 } 629 // Returns the number of class definitions in the .dex file. 630 uint32_t NumClassDefs() const { 631 DCHECK(header_ != NULL) << GetLocation(); 632 return header_->class_defs_size_; 633 } 634 635 // Returns the ClassDef at the specified index. 636 const ClassDef& GetClassDef(uint16_t idx) const { 637 DCHECK_LT(idx, NumClassDefs()) << GetLocation(); 638 return class_defs_[idx]; 639 } 640 641 uint16_t GetIndexForClassDef(const ClassDef& class_def) const { 642 CHECK_GE(&class_def, class_defs_) << GetLocation(); 643 CHECK_LT(&class_def, class_defs_ + header_->class_defs_size_) << GetLocation(); 644 return &class_def - class_defs_; 645 } 646 647 // Returns the class descriptor string of a class definition. 648 const char* GetClassDescriptor(const ClassDef& class_def) const { 649 return StringByTypeIdx(class_def.class_idx_); 650 } 651 652 // Looks up a class definition by its class descriptor. Hash must be 653 // ComputeModifiedUtf8Hash(descriptor). 654 const ClassDef* FindClassDef(const char* descriptor, size_t hash) const; 655 656 // Looks up a class definition by its type index. 657 const ClassDef* FindClassDef(uint16_t type_idx) const; 658 659 const TypeList* GetInterfacesList(const ClassDef& class_def) const { 660 if (class_def.interfaces_off_ == 0) { 661 return NULL; 662 } else { 663 const byte* addr = begin_ + class_def.interfaces_off_; 664 return reinterpret_cast<const TypeList*>(addr); 665 } 666 } 667 668 // Returns a pointer to the raw memory mapped class_data_item 669 const byte* GetClassData(const ClassDef& class_def) const { 670 if (class_def.class_data_off_ == 0) { 671 return NULL; 672 } else { 673 return begin_ + class_def.class_data_off_; 674 } 675 } 676 677 // 678 const CodeItem* GetCodeItem(const uint32_t code_off) const { 679 if (code_off == 0) { 680 return NULL; // native or abstract method 681 } else { 682 const byte* addr = begin_ + code_off; 683 return reinterpret_cast<const CodeItem*>(addr); 684 } 685 } 686 687 const char* GetReturnTypeDescriptor(const ProtoId& proto_id) const { 688 return StringByTypeIdx(proto_id.return_type_idx_); 689 } 690 691 // Returns the number of prototype identifiers in the .dex file. 692 size_t NumProtoIds() const { 693 DCHECK(header_ != NULL) << GetLocation(); 694 return header_->proto_ids_size_; 695 } 696 697 // Returns the ProtoId at the specified index. 698 const ProtoId& GetProtoId(uint32_t idx) const { 699 DCHECK_LT(idx, NumProtoIds()) << GetLocation(); 700 return proto_ids_[idx]; 701 } 702 703 uint16_t GetIndexForProtoId(const ProtoId& proto_id) const { 704 CHECK_GE(&proto_id, proto_ids_) << GetLocation(); 705 CHECK_LT(&proto_id, proto_ids_ + header_->proto_ids_size_) << GetLocation(); 706 return &proto_id - proto_ids_; 707 } 708 709 // Looks up a proto id for a given return type and signature type list 710 const ProtoId* FindProtoId(uint16_t return_type_idx, 711 const uint16_t* signature_type_idxs, uint32_t signature_length) const; 712 const ProtoId* FindProtoId(uint16_t return_type_idx, 713 const std::vector<uint16_t>& signature_type_idxs) const { 714 return FindProtoId(return_type_idx, &signature_type_idxs[0], signature_type_idxs.size()); 715 } 716 717 // Given a signature place the type ids into the given vector, returns true on success 718 bool CreateTypeList(const StringPiece& signature, uint16_t* return_type_idx, 719 std::vector<uint16_t>* param_type_idxs) const; 720 721 // Create a Signature from the given string signature or return Signature::NoSignature if not 722 // possible. 723 const Signature CreateSignature(const StringPiece& signature) const; 724 725 // Returns the short form method descriptor for the given prototype. 726 const char* GetShorty(uint32_t proto_idx) const { 727 const ProtoId& proto_id = GetProtoId(proto_idx); 728 return StringDataByIdx(proto_id.shorty_idx_); 729 } 730 731 const TypeList* GetProtoParameters(const ProtoId& proto_id) const { 732 if (proto_id.parameters_off_ == 0) { 733 return NULL; 734 } else { 735 const byte* addr = begin_ + proto_id.parameters_off_; 736 return reinterpret_cast<const TypeList*>(addr); 737 } 738 } 739 740 const byte* GetEncodedStaticFieldValuesArray(const ClassDef& class_def) const { 741 if (class_def.static_values_off_ == 0) { 742 return 0; 743 } else { 744 return begin_ + class_def.static_values_off_; 745 } 746 } 747 748 static const TryItem* GetTryItems(const CodeItem& code_item, uint32_t offset); 749 750 // Get the base of the encoded data for the given DexCode. 751 static const byte* GetCatchHandlerData(const CodeItem& code_item, uint32_t offset) { 752 const byte* handler_data = 753 reinterpret_cast<const byte*>(GetTryItems(code_item, code_item.tries_size_)); 754 return handler_data + offset; 755 } 756 757 // Find which try region is associated with the given address (ie dex pc). Returns -1 if none. 758 static int32_t FindTryItem(const CodeItem &code_item, uint32_t address); 759 760 // Find the handler offset associated with the given address (ie dex pc). Returns -1 if none. 761 static int32_t FindCatchHandlerOffset(const CodeItem &code_item, uint32_t address); 762 763 // Get the pointer to the start of the debugging data 764 const byte* GetDebugInfoStream(const CodeItem* code_item) const { 765 if (code_item->debug_info_off_ == 0) { 766 return NULL; 767 } else { 768 return begin_ + code_item->debug_info_off_; 769 } 770 } 771 772 // Callback for "new position table entry". 773 // Returning true causes the decoder to stop early. 774 typedef bool (*DexDebugNewPositionCb)(void* context, uint32_t address, uint32_t line_num); 775 776 // Callback for "new locals table entry". "signature" is an empty string 777 // if no signature is available for an entry. 778 typedef void (*DexDebugNewLocalCb)(void* context, uint16_t reg, 779 uint32_t start_address, 780 uint32_t end_address, 781 const char* name, 782 const char* descriptor, 783 const char* signature); 784 785 static bool LineNumForPcCb(void* context, uint32_t address, uint32_t line_num); 786 787 // Debug info opcodes and constants 788 enum { 789 DBG_END_SEQUENCE = 0x00, 790 DBG_ADVANCE_PC = 0x01, 791 DBG_ADVANCE_LINE = 0x02, 792 DBG_START_LOCAL = 0x03, 793 DBG_START_LOCAL_EXTENDED = 0x04, 794 DBG_END_LOCAL = 0x05, 795 DBG_RESTART_LOCAL = 0x06, 796 DBG_SET_PROLOGUE_END = 0x07, 797 DBG_SET_EPILOGUE_BEGIN = 0x08, 798 DBG_SET_FILE = 0x09, 799 DBG_FIRST_SPECIAL = 0x0a, 800 DBG_LINE_BASE = -4, 801 DBG_LINE_RANGE = 15, 802 }; 803 804 struct LocalInfo { 805 LocalInfo() 806 : name_(NULL), descriptor_(NULL), signature_(NULL), start_address_(0), is_live_(false) {} 807 808 const char* name_; // E.g., list 809 const char* descriptor_; // E.g., Ljava/util/LinkedList; 810 const char* signature_; // E.g., java.util.LinkedList<java.lang.Integer> 811 uint16_t start_address_; // PC location where the local is first defined. 812 bool is_live_; // Is the local defined and live. 813 814 private: 815 DISALLOW_COPY_AND_ASSIGN(LocalInfo); 816 }; 817 818 struct LineNumFromPcContext { 819 LineNumFromPcContext(uint32_t address, uint32_t line_num) 820 : address_(address), line_num_(line_num) {} 821 uint32_t address_; 822 uint32_t line_num_; 823 private: 824 DISALLOW_COPY_AND_ASSIGN(LineNumFromPcContext); 825 }; 826 827 void InvokeLocalCbIfLive(void* context, int reg, uint32_t end_address, 828 LocalInfo* local_in_reg, DexDebugNewLocalCb local_cb) const { 829 if (local_cb != NULL && local_in_reg[reg].is_live_) { 830 local_cb(context, reg, local_in_reg[reg].start_address_, end_address, 831 local_in_reg[reg].name_, local_in_reg[reg].descriptor_, 832 local_in_reg[reg].signature_ != NULL ? local_in_reg[reg].signature_ : ""); 833 } 834 } 835 836 // Determine the source file line number based on the program counter. 837 // "pc" is an offset, in 16-bit units, from the start of the method's code. 838 // 839 // Returns -1 if no match was found (possibly because the source files were 840 // compiled without "-g", so no line number information is present). 841 // Returns -2 for native methods (as expected in exception traces). 842 // 843 // This is used by runtime; therefore use art::Method not art::DexFile::Method. 844 int32_t GetLineNumFromPC(mirror::ArtMethod* method, uint32_t rel_pc) const 845 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 846 847 void DecodeDebugInfo(const CodeItem* code_item, bool is_static, uint32_t method_idx, 848 DexDebugNewPositionCb position_cb, DexDebugNewLocalCb local_cb, 849 void* context) const; 850 851 const char* GetSourceFile(const ClassDef& class_def) const { 852 if (class_def.source_file_idx_ == 0xffffffff) { 853 return NULL; 854 } else { 855 return StringDataByIdx(class_def.source_file_idx_); 856 } 857 } 858 859 int GetPermissions() const; 860 861 bool IsReadOnly() const; 862 863 bool EnableWrite() const; 864 865 bool DisableWrite() const; 866 867 const byte* Begin() const { 868 return begin_; 869 } 870 871 size_t Size() const { 872 return size_; 873 } 874 875 static std::string GetMultiDexClassesDexName(size_t number, const char* dex_location); 876 877 // Returns the canonical form of the given dex location. 878 // 879 // There are different flavors of "dex locations" as follows: 880 // the file name of a dex file: 881 // The actual file path that the dex file has on disk. 882 // dex_location: 883 // This acts as a key for the class linker to know which dex file to load. 884 // It may correspond to either an old odex file or a particular dex file 885 // inside an oat file. In the first case it will also match the file name 886 // of the dex file. In the second case (oat) it will include the file name 887 // and possibly some multidex annotation to uniquely identify it. 888 // canonical_dex_location: 889 // the dex_location where it's file name part has been made canonical. 890 static std::string GetDexCanonicalLocation(const char* dex_location); 891 892 private: 893 // Opens a .dex file 894 static const DexFile* OpenFile(int fd, const char* location, bool verify, std::string* error_msg); 895 896 // Opens dex files from within a .jar, .zip, or .apk file 897 static bool OpenZip(int fd, const std::string& location, std::string* error_msg, 898 std::vector<const DexFile*>* dex_files); 899 900 enum class ZipOpenErrorCode { // private 901 kNoError, 902 kEntryNotFound, 903 kExtractToMemoryError, 904 kDexFileError, 905 kMakeReadOnlyError, 906 kVerifyError 907 }; 908 909 // Opens .dex file from the entry_name in a zip archive. error_code is undefined when non-nullptr 910 // return. 911 static const DexFile* Open(const ZipArchive& zip_archive, const char* entry_name, 912 const std::string& location, std::string* error_msg, 913 ZipOpenErrorCode* error_code); 914 915 // Opens a .dex file at the given address backed by a MemMap 916 static const DexFile* OpenMemory(const std::string& location, 917 uint32_t location_checksum, 918 MemMap* mem_map, 919 std::string* error_msg); 920 921 // Opens a .dex file at the given address, optionally backed by a MemMap 922 static const DexFile* OpenMemory(const byte* dex_file, 923 size_t size, 924 const std::string& location, 925 uint32_t location_checksum, 926 MemMap* mem_map, 927 std::string* error_msg); 928 929 DexFile(const byte* base, size_t size, 930 const std::string& location, 931 uint32_t location_checksum, 932 MemMap* mem_map); 933 934 // Top-level initializer that calls other Init methods. 935 bool Init(std::string* error_msg); 936 937 // Returns true if the header magic and version numbers are of the expected values. 938 bool CheckMagicAndVersion(std::string* error_msg) const; 939 940 void DecodeDebugInfo0(const CodeItem* code_item, bool is_static, uint32_t method_idx, 941 DexDebugNewPositionCb position_cb, DexDebugNewLocalCb local_cb, 942 void* context, const byte* stream, LocalInfo* local_in_reg) const; 943 944 // Check whether a location denotes a multidex dex file. This is a very simple check: returns 945 // whether the string contains the separator character. 946 static bool IsMultiDexLocation(const char* location); 947 948 949 // The base address of the memory mapping. 950 const byte* const begin_; 951 952 // The size of the underlying memory allocation in bytes. 953 const size_t size_; 954 955 // Typically the dex file name when available, alternatively some identifying string. 956 // 957 // The ClassLinker will use this to match DexFiles the boot class 958 // path to DexCache::GetLocation when loading from an image. 959 const std::string location_; 960 961 const uint32_t location_checksum_; 962 963 // Manages the underlying memory allocation. 964 std::unique_ptr<MemMap> mem_map_; 965 966 // Points to the header section. 967 const Header* const header_; 968 969 // Points to the base of the string identifier list. 970 const StringId* const string_ids_; 971 972 // Points to the base of the type identifier list. 973 const TypeId* const type_ids_; 974 975 // Points to the base of the field identifier list. 976 const FieldId* const field_ids_; 977 978 // Points to the base of the method identifier list. 979 const MethodId* const method_ids_; 980 981 // Points to the base of the prototype identifier list. 982 const ProtoId* const proto_ids_; 983 984 // Points to the base of the class definition list. 985 const ClassDef* const class_defs_; 986 987 // Number of misses finding a class def from a descriptor. 988 mutable Atomic<uint32_t> find_class_def_misses_; 989 990 struct UTF16EmptyFn { 991 void MakeEmpty(std::pair<const char*, const ClassDef*>& pair) const { 992 pair.first = nullptr; 993 pair.second = nullptr; 994 } 995 bool IsEmpty(const std::pair<const char*, const ClassDef*>& pair) const { 996 if (pair.first == nullptr) { 997 DCHECK(pair.second == nullptr); 998 return true; 999 } 1000 return false; 1001 } 1002 }; 1003 struct UTF16HashCmp { 1004 // Hash function. 1005 size_t operator()(const char* key) const { 1006 return ComputeModifiedUtf8Hash(key); 1007 } 1008 // std::equal function. 1009 bool operator()(const char* a, const char* b) const { 1010 return CompareModifiedUtf8ToModifiedUtf8AsUtf16CodePointValues(a, b) == 0; 1011 } 1012 }; 1013 typedef HashMap<const char*, const ClassDef*, UTF16EmptyFn, UTF16HashCmp, UTF16HashCmp> Index; 1014 mutable Atomic<Index*> class_def_index_; 1015 mutable Mutex build_class_def_index_mutex_ DEFAULT_MUTEX_ACQUIRED_AFTER; 1016}; 1017std::ostream& operator<<(std::ostream& os, const DexFile& dex_file); 1018 1019// Iterate over a dex file's ProtoId's paramters 1020class DexFileParameterIterator { 1021 public: 1022 DexFileParameterIterator(const DexFile& dex_file, const DexFile::ProtoId& proto_id) 1023 : dex_file_(dex_file), size_(0), pos_(0) { 1024 type_list_ = dex_file_.GetProtoParameters(proto_id); 1025 if (type_list_ != NULL) { 1026 size_ = type_list_->Size(); 1027 } 1028 } 1029 bool HasNext() const { return pos_ < size_; } 1030 void Next() { ++pos_; } 1031 uint16_t GetTypeIdx() { 1032 return type_list_->GetTypeItem(pos_).type_idx_; 1033 } 1034 const char* GetDescriptor() { 1035 return dex_file_.StringByTypeIdx(GetTypeIdx()); 1036 } 1037 private: 1038 const DexFile& dex_file_; 1039 const DexFile::TypeList* type_list_; 1040 uint32_t size_; 1041 uint32_t pos_; 1042 DISALLOW_IMPLICIT_CONSTRUCTORS(DexFileParameterIterator); 1043}; 1044 1045// Abstract the signature of a method. 1046class Signature { 1047 public: 1048 std::string ToString() const; 1049 1050 static Signature NoSignature() { 1051 return Signature(); 1052 } 1053 1054 bool operator==(const Signature& rhs) const; 1055 bool operator!=(const Signature& rhs) const { 1056 return !(*this == rhs); 1057 } 1058 1059 bool operator==(const StringPiece& rhs) const; 1060 1061 private: 1062 Signature(const DexFile* dex, const DexFile::ProtoId& proto) : dex_file_(dex), proto_id_(&proto) { 1063 } 1064 1065 Signature() : dex_file_(nullptr), proto_id_(nullptr) { 1066 } 1067 1068 friend class DexFile; 1069 1070 const DexFile* const dex_file_; 1071 const DexFile::ProtoId* const proto_id_; 1072}; 1073std::ostream& operator<<(std::ostream& os, const Signature& sig); 1074 1075// Iterate and decode class_data_item 1076class ClassDataItemIterator { 1077 public: 1078 ClassDataItemIterator(const DexFile& dex_file, const byte* raw_class_data_item) 1079 : dex_file_(dex_file), pos_(0), ptr_pos_(raw_class_data_item), last_idx_(0) { 1080 ReadClassDataHeader(); 1081 if (EndOfInstanceFieldsPos() > 0) { 1082 ReadClassDataField(); 1083 } else if (EndOfVirtualMethodsPos() > 0) { 1084 ReadClassDataMethod(); 1085 } 1086 } 1087 uint32_t NumStaticFields() const { 1088 return header_.static_fields_size_; 1089 } 1090 uint32_t NumInstanceFields() const { 1091 return header_.instance_fields_size_; 1092 } 1093 uint32_t NumDirectMethods() const { 1094 return header_.direct_methods_size_; 1095 } 1096 uint32_t NumVirtualMethods() const { 1097 return header_.virtual_methods_size_; 1098 } 1099 bool HasNextStaticField() const { 1100 return pos_ < EndOfStaticFieldsPos(); 1101 } 1102 bool HasNextInstanceField() const { 1103 return pos_ >= EndOfStaticFieldsPos() && pos_ < EndOfInstanceFieldsPos(); 1104 } 1105 bool HasNextDirectMethod() const { 1106 return pos_ >= EndOfInstanceFieldsPos() && pos_ < EndOfDirectMethodsPos(); 1107 } 1108 bool HasNextVirtualMethod() const { 1109 return pos_ >= EndOfDirectMethodsPos() && pos_ < EndOfVirtualMethodsPos(); 1110 } 1111 bool HasNext() const { 1112 return pos_ < EndOfVirtualMethodsPos(); 1113 } 1114 inline void Next() { 1115 pos_++; 1116 if (pos_ < EndOfStaticFieldsPos()) { 1117 last_idx_ = GetMemberIndex(); 1118 ReadClassDataField(); 1119 } else if (pos_ == EndOfStaticFieldsPos() && NumInstanceFields() > 0) { 1120 last_idx_ = 0; // transition to next array, reset last index 1121 ReadClassDataField(); 1122 } else if (pos_ < EndOfInstanceFieldsPos()) { 1123 last_idx_ = GetMemberIndex(); 1124 ReadClassDataField(); 1125 } else if (pos_ == EndOfInstanceFieldsPos() && NumDirectMethods() > 0) { 1126 last_idx_ = 0; // transition to next array, reset last index 1127 ReadClassDataMethod(); 1128 } else if (pos_ < EndOfDirectMethodsPos()) { 1129 last_idx_ = GetMemberIndex(); 1130 ReadClassDataMethod(); 1131 } else if (pos_ == EndOfDirectMethodsPos() && NumVirtualMethods() > 0) { 1132 last_idx_ = 0; // transition to next array, reset last index 1133 ReadClassDataMethod(); 1134 } else if (pos_ < EndOfVirtualMethodsPos()) { 1135 last_idx_ = GetMemberIndex(); 1136 ReadClassDataMethod(); 1137 } else { 1138 DCHECK(!HasNext()); 1139 } 1140 } 1141 uint32_t GetMemberIndex() const { 1142 if (pos_ < EndOfInstanceFieldsPos()) { 1143 return last_idx_ + field_.field_idx_delta_; 1144 } else { 1145 DCHECK_LT(pos_, EndOfVirtualMethodsPos()); 1146 return last_idx_ + method_.method_idx_delta_; 1147 } 1148 } 1149 uint32_t GetRawMemberAccessFlags() const { 1150 if (pos_ < EndOfInstanceFieldsPos()) { 1151 return field_.access_flags_; 1152 } else { 1153 DCHECK_LT(pos_, EndOfVirtualMethodsPos()); 1154 return method_.access_flags_; 1155 } 1156 } 1157 uint32_t GetFieldAccessFlags() const { 1158 return GetRawMemberAccessFlags() & kAccValidFieldFlags; 1159 } 1160 uint32_t GetMethodAccessFlags() const { 1161 return GetRawMemberAccessFlags() & kAccValidMethodFlags; 1162 } 1163 bool MemberIsNative() const { 1164 return GetRawMemberAccessFlags() & kAccNative; 1165 } 1166 bool MemberIsFinal() const { 1167 return GetRawMemberAccessFlags() & kAccFinal; 1168 } 1169 InvokeType GetMethodInvokeType(const DexFile::ClassDef& class_def) const { 1170 if (HasNextDirectMethod()) { 1171 if ((GetRawMemberAccessFlags() & kAccStatic) != 0) { 1172 return kStatic; 1173 } else { 1174 return kDirect; 1175 } 1176 } else { 1177 DCHECK_EQ(GetRawMemberAccessFlags() & kAccStatic, 0U); 1178 if ((class_def.access_flags_ & kAccInterface) != 0) { 1179 return kInterface; 1180 } else if ((GetRawMemberAccessFlags() & kAccConstructor) != 0) { 1181 return kSuper; 1182 } else { 1183 return kVirtual; 1184 } 1185 } 1186 } 1187 const DexFile::CodeItem* GetMethodCodeItem() const { 1188 return dex_file_.GetCodeItem(method_.code_off_); 1189 } 1190 uint32_t GetMethodCodeItemOffset() const { 1191 return method_.code_off_; 1192 } 1193 const byte* EndDataPointer() const { 1194 CHECK(!HasNext()); 1195 return ptr_pos_; 1196 } 1197 1198 private: 1199 // A dex file's class_data_item is leb128 encoded, this structure holds a decoded form of the 1200 // header for a class_data_item 1201 struct ClassDataHeader { 1202 uint32_t static_fields_size_; // the number of static fields 1203 uint32_t instance_fields_size_; // the number of instance fields 1204 uint32_t direct_methods_size_; // the number of direct methods 1205 uint32_t virtual_methods_size_; // the number of virtual methods 1206 } header_; 1207 1208 // Read and decode header from a class_data_item stream into header 1209 void ReadClassDataHeader(); 1210 1211 uint32_t EndOfStaticFieldsPos() const { 1212 return header_.static_fields_size_; 1213 } 1214 uint32_t EndOfInstanceFieldsPos() const { 1215 return EndOfStaticFieldsPos() + header_.instance_fields_size_; 1216 } 1217 uint32_t EndOfDirectMethodsPos() const { 1218 return EndOfInstanceFieldsPos() + header_.direct_methods_size_; 1219 } 1220 uint32_t EndOfVirtualMethodsPos() const { 1221 return EndOfDirectMethodsPos() + header_.virtual_methods_size_; 1222 } 1223 1224 // A decoded version of the field of a class_data_item 1225 struct ClassDataField { 1226 uint32_t field_idx_delta_; // delta of index into the field_ids array for FieldId 1227 uint32_t access_flags_; // access flags for the field 1228 ClassDataField() : field_idx_delta_(0), access_flags_(0) {} 1229 1230 private: 1231 DISALLOW_COPY_AND_ASSIGN(ClassDataField); 1232 }; 1233 ClassDataField field_; 1234 1235 // Read and decode a field from a class_data_item stream into field 1236 void ReadClassDataField(); 1237 1238 // A decoded version of the method of a class_data_item 1239 struct ClassDataMethod { 1240 uint32_t method_idx_delta_; // delta of index into the method_ids array for MethodId 1241 uint32_t access_flags_; 1242 uint32_t code_off_; 1243 ClassDataMethod() : method_idx_delta_(0), access_flags_(0), code_off_(0) {} 1244 1245 private: 1246 DISALLOW_COPY_AND_ASSIGN(ClassDataMethod); 1247 }; 1248 ClassDataMethod method_; 1249 1250 // Read and decode a method from a class_data_item stream into method 1251 void ReadClassDataMethod(); 1252 1253 const DexFile& dex_file_; 1254 size_t pos_; // integral number of items passed 1255 const byte* ptr_pos_; // pointer into stream of class_data_item 1256 uint32_t last_idx_; // last read field or method index to apply delta to 1257 DISALLOW_IMPLICIT_CONSTRUCTORS(ClassDataItemIterator); 1258}; 1259 1260class EncodedStaticFieldValueIterator { 1261 public: 1262 EncodedStaticFieldValueIterator(const DexFile& dex_file, Handle<mirror::DexCache>* dex_cache, 1263 Handle<mirror::ClassLoader>* class_loader, 1264 ClassLinker* linker, const DexFile::ClassDef& class_def) 1265 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1266 1267 template<bool kTransactionActive> 1268 void ReadValueToField(mirror::ArtField* field) const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1269 1270 bool HasNext() { return pos_ < array_size_; } 1271 1272 void Next(); 1273 1274 enum ValueType { 1275 kByte = 0x00, 1276 kShort = 0x02, 1277 kChar = 0x03, 1278 kInt = 0x04, 1279 kLong = 0x06, 1280 kFloat = 0x10, 1281 kDouble = 0x11, 1282 kString = 0x17, 1283 kType = 0x18, 1284 kField = 0x19, 1285 kMethod = 0x1a, 1286 kEnum = 0x1b, 1287 kArray = 0x1c, 1288 kAnnotation = 0x1d, 1289 kNull = 0x1e, 1290 kBoolean = 0x1f 1291 }; 1292 1293 private: 1294 static const byte kEncodedValueTypeMask = 0x1f; // 0b11111 1295 static const byte kEncodedValueArgShift = 5; 1296 1297 const DexFile& dex_file_; 1298 Handle<mirror::DexCache>* const dex_cache_; // Dex cache to resolve literal objects. 1299 Handle<mirror::ClassLoader>* const class_loader_; // ClassLoader to resolve types. 1300 ClassLinker* linker_; // Linker to resolve literal objects. 1301 size_t array_size_; // Size of array. 1302 size_t pos_; // Current position. 1303 const byte* ptr_; // Pointer into encoded data array. 1304 ValueType type_; // Type of current encoded value. 1305 jvalue jval_; // Value of current encoded value. 1306 DISALLOW_IMPLICIT_CONSTRUCTORS(EncodedStaticFieldValueIterator); 1307}; 1308std::ostream& operator<<(std::ostream& os, const EncodedStaticFieldValueIterator::ValueType& code); 1309 1310class CatchHandlerIterator { 1311 public: 1312 CatchHandlerIterator(const DexFile::CodeItem& code_item, uint32_t address); 1313 1314 CatchHandlerIterator(const DexFile::CodeItem& code_item, 1315 const DexFile::TryItem& try_item); 1316 1317 explicit CatchHandlerIterator(const byte* handler_data) { 1318 Init(handler_data); 1319 } 1320 1321 uint16_t GetHandlerTypeIndex() const { 1322 return handler_.type_idx_; 1323 } 1324 uint32_t GetHandlerAddress() const { 1325 return handler_.address_; 1326 } 1327 void Next(); 1328 bool HasNext() const { 1329 return remaining_count_ != -1 || catch_all_; 1330 } 1331 // End of this set of catch blocks, convenience method to locate next set of catch blocks 1332 const byte* EndDataPointer() const { 1333 CHECK(!HasNext()); 1334 return current_data_; 1335 } 1336 1337 private: 1338 void Init(const DexFile::CodeItem& code_item, int32_t offset); 1339 void Init(const byte* handler_data); 1340 1341 struct CatchHandlerItem { 1342 uint16_t type_idx_; // type index of the caught exception type 1343 uint32_t address_; // handler address 1344 } handler_; 1345 const byte *current_data_; // the current handler in dex file. 1346 int32_t remaining_count_; // number of handlers not read. 1347 bool catch_all_; // is there a handler that will catch all exceptions in case 1348 // that all typed handler does not match. 1349}; 1350 1351} // namespace art 1352 1353#endif // ART_RUNTIME_DEX_FILE_H_ 1354