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