dex_file.h revision 90e34043ff7bf8926e8fe6a6d5011a9daa68d320
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 ArtMethod; 41 class ClassLoader; 42 class DexCache; 43} // namespace mirror 44class ArtField; 45class ClassLinker; 46class MemMap; 47class OatDexFile; 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 OatDexFile* oat_dex_file, 396 std::string* error_msg) { 397 return OpenMemory(base, size, location, location_checksum, nullptr, oat_dex_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_ != nullptr) << 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_ != nullptr) << 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 nullptr; 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_ != nullptr) << 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_ != nullptr) << 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_ != nullptr) << 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_ != nullptr) << 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 nullptr; 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 nullptr; 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 nullptr; // 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_ != nullptr) << 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 nullptr; 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 nullptr; 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_(nullptr), descriptor_(nullptr), signature_(nullptr), start_address_(0), 822 is_live_(false) {} 823 824 const char* name_; // E.g., list 825 const char* descriptor_; // E.g., Ljava/util/LinkedList; 826 const char* signature_; // E.g., java.util.LinkedList<java.lang.Integer> 827 uint16_t start_address_; // PC location where the local is first defined. 828 bool is_live_; // Is the local defined and live. 829 830 private: 831 DISALLOW_COPY_AND_ASSIGN(LocalInfo); 832 }; 833 834 struct LineNumFromPcContext { 835 LineNumFromPcContext(uint32_t address, uint32_t line_num) 836 : address_(address), line_num_(line_num) {} 837 uint32_t address_; 838 uint32_t line_num_; 839 private: 840 DISALLOW_COPY_AND_ASSIGN(LineNumFromPcContext); 841 }; 842 843 void InvokeLocalCbIfLive(void* context, int reg, uint32_t end_address, 844 LocalInfo* local_in_reg, DexDebugNewLocalCb local_cb) const { 845 if (local_cb != nullptr && local_in_reg[reg].is_live_) { 846 local_cb(context, reg, local_in_reg[reg].start_address_, end_address, 847 local_in_reg[reg].name_, local_in_reg[reg].descriptor_, 848 local_in_reg[reg].signature_ != nullptr ? local_in_reg[reg].signature_ : ""); 849 } 850 } 851 852 // Determine the source file line number based on the program counter. 853 // "pc" is an offset, in 16-bit units, from the start of the method's code. 854 // 855 // Returns -1 if no match was found (possibly because the source files were 856 // compiled without "-g", so no line number information is present). 857 // Returns -2 for native methods (as expected in exception traces). 858 // 859 // This is used by runtime; therefore use art::Method not art::DexFile::Method. 860 int32_t GetLineNumFromPC(mirror::ArtMethod* method, uint32_t rel_pc) const 861 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 862 863 void DecodeDebugInfo(const CodeItem* code_item, bool is_static, uint32_t method_idx, 864 DexDebugNewPositionCb position_cb, DexDebugNewLocalCb local_cb, 865 void* context) const; 866 867 const char* GetSourceFile(const ClassDef& class_def) const { 868 if (class_def.source_file_idx_ == 0xffffffff) { 869 return nullptr; 870 } else { 871 return StringDataByIdx(class_def.source_file_idx_); 872 } 873 } 874 875 int GetPermissions() const; 876 877 bool IsReadOnly() const; 878 879 bool EnableWrite() const; 880 881 bool DisableWrite() const; 882 883 const uint8_t* Begin() const { 884 return begin_; 885 } 886 887 size_t Size() const { 888 return size_; 889 } 890 891 // Return the name of the index-th classes.dex in a multidex zip file. This is classes.dex for 892 // index == 0, and classes{index + 1}.dex else. 893 static std::string GetMultiDexClassesDexName(size_t index); 894 895 // Return the (possibly synthetic) dex location for a multidex entry. This is dex_location for 896 // index == 0, and dex_location + multi-dex-separator + GetMultiDexClassesDexName(index) else. 897 static std::string GetMultiDexLocation(size_t index, const char* dex_location); 898 899 // Returns the canonical form of the given dex location. 900 // 901 // There are different flavors of "dex locations" as follows: 902 // the file name of a dex file: 903 // The actual file path that the dex file has on disk. 904 // dex_location: 905 // This acts as a key for the class linker to know which dex file to load. 906 // It may correspond to either an old odex file or a particular dex file 907 // inside an oat file. In the first case it will also match the file name 908 // of the dex file. In the second case (oat) it will include the file name 909 // and possibly some multidex annotation to uniquely identify it. 910 // canonical_dex_location: 911 // the dex_location where it's file name part has been made canonical. 912 static std::string GetDexCanonicalLocation(const char* dex_location); 913 914 const OatDexFile* GetOatDexFile() const { 915 return oat_dex_file_; 916 } 917 918 private: 919 // Opens a .dex file 920 static std::unique_ptr<const DexFile> OpenFile(int fd, const char* location, 921 bool verify, std::string* error_msg); 922 923 // Opens dex files from within a .jar, .zip, or .apk file 924 static bool OpenZip(int fd, const std::string& location, std::string* error_msg, 925 std::vector<std::unique_ptr<const DexFile>>* dex_files); 926 927 enum class ZipOpenErrorCode { // private 928 kNoError, 929 kEntryNotFound, 930 kExtractToMemoryError, 931 kDexFileError, 932 kMakeReadOnlyError, 933 kVerifyError 934 }; 935 936 // Opens .dex file from the entry_name in a zip archive. error_code is undefined when non-null 937 // return. 938 static std::unique_ptr<const DexFile> Open(const ZipArchive& zip_archive, const char* entry_name, 939 const std::string& location, std::string* error_msg, 940 ZipOpenErrorCode* error_code); 941 942 // Opens a .dex file at the given address backed by a MemMap 943 static std::unique_ptr<const DexFile> OpenMemory(const std::string& location, 944 uint32_t location_checksum, 945 MemMap* mem_map, 946 std::string* error_msg); 947 948 // Opens a .dex file at the given address, optionally backed by a MemMap 949 static std::unique_ptr<const DexFile> OpenMemory(const uint8_t* dex_file, 950 size_t size, 951 const std::string& location, 952 uint32_t location_checksum, 953 MemMap* mem_map, 954 const OatDexFile* oat_dex_file, 955 std::string* error_msg); 956 957 DexFile(const uint8_t* base, size_t size, 958 const std::string& location, 959 uint32_t location_checksum, 960 MemMap* mem_map, 961 const OatDexFile* oat_dex_file); 962 963 // Top-level initializer that calls other Init methods. 964 bool Init(std::string* error_msg); 965 966 // Returns true if the header magic and version numbers are of the expected values. 967 bool CheckMagicAndVersion(std::string* error_msg) const; 968 969 void DecodeDebugInfo0(const CodeItem* code_item, bool is_static, uint32_t method_idx, 970 DexDebugNewPositionCb position_cb, DexDebugNewLocalCb local_cb, 971 void* context, const uint8_t* stream, LocalInfo* local_in_reg) const; 972 973 // Check whether a location denotes a multidex dex file. This is a very simple check: returns 974 // whether the string contains the separator character. 975 static bool IsMultiDexLocation(const char* location); 976 977 978 // The base address of the memory mapping. 979 const uint8_t* const begin_; 980 981 // The size of the underlying memory allocation in bytes. 982 const size_t size_; 983 984 // Typically the dex file name when available, alternatively some identifying string. 985 // 986 // The ClassLinker will use this to match DexFiles the boot class 987 // path to DexCache::GetLocation when loading from an image. 988 const std::string location_; 989 990 const uint32_t location_checksum_; 991 992 // Manages the underlying memory allocation. 993 std::unique_ptr<MemMap> mem_map_; 994 995 // Points to the header section. 996 const Header* const header_; 997 998 // Points to the base of the string identifier list. 999 const StringId* const string_ids_; 1000 1001 // Points to the base of the type identifier list. 1002 const TypeId* const type_ids_; 1003 1004 // Points to the base of the field identifier list. 1005 const FieldId* const field_ids_; 1006 1007 // Points to the base of the method identifier list. 1008 const MethodId* const method_ids_; 1009 1010 // Points to the base of the prototype identifier list. 1011 const ProtoId* const proto_ids_; 1012 1013 // Points to the base of the class definition list. 1014 const ClassDef* const class_defs_; 1015 1016 // Number of misses finding a class def from a descriptor. 1017 mutable Atomic<uint32_t> find_class_def_misses_; 1018 1019 struct UTF16EmptyFn { 1020 void MakeEmpty(std::pair<const char*, const ClassDef*>& pair) const { 1021 pair.first = nullptr; 1022 pair.second = nullptr; 1023 } 1024 bool IsEmpty(const std::pair<const char*, const ClassDef*>& pair) const { 1025 if (pair.first == nullptr) { 1026 DCHECK(pair.second == nullptr); 1027 return true; 1028 } 1029 return false; 1030 } 1031 }; 1032 struct UTF16HashCmp { 1033 // Hash function. 1034 size_t operator()(const char* key) const { 1035 return ComputeModifiedUtf8Hash(key); 1036 } 1037 // std::equal function. 1038 bool operator()(const char* a, const char* b) const { 1039 return CompareModifiedUtf8ToModifiedUtf8AsUtf16CodePointValues(a, b) == 0; 1040 } 1041 }; 1042 typedef HashMap<const char*, const ClassDef*, UTF16EmptyFn, UTF16HashCmp, UTF16HashCmp> Index; 1043 mutable Atomic<Index*> class_def_index_; 1044 1045 // If this dex file was loaded from an oat file, oat_dex_file_ contains a 1046 // pointer to the OatDexFile it was loaded from. Otherwise oat_dex_file_ is 1047 // null. 1048 const OatDexFile* oat_dex_file_; 1049}; 1050 1051struct DexFileReference { 1052 DexFileReference(const DexFile* file, uint32_t idx) : dex_file(file), index(idx) { } 1053 const DexFile* dex_file; 1054 uint32_t index; 1055}; 1056 1057std::ostream& operator<<(std::ostream& os, const DexFile& dex_file); 1058 1059// Iterate over a dex file's ProtoId's paramters 1060class DexFileParameterIterator { 1061 public: 1062 DexFileParameterIterator(const DexFile& dex_file, const DexFile::ProtoId& proto_id) 1063 : dex_file_(dex_file), size_(0), pos_(0) { 1064 type_list_ = dex_file_.GetProtoParameters(proto_id); 1065 if (type_list_ != nullptr) { 1066 size_ = type_list_->Size(); 1067 } 1068 } 1069 bool HasNext() const { return pos_ < size_; } 1070 void Next() { ++pos_; } 1071 uint16_t GetTypeIdx() { 1072 return type_list_->GetTypeItem(pos_).type_idx_; 1073 } 1074 const char* GetDescriptor() { 1075 return dex_file_.StringByTypeIdx(GetTypeIdx()); 1076 } 1077 private: 1078 const DexFile& dex_file_; 1079 const DexFile::TypeList* type_list_; 1080 uint32_t size_; 1081 uint32_t pos_; 1082 DISALLOW_IMPLICIT_CONSTRUCTORS(DexFileParameterIterator); 1083}; 1084 1085// Abstract the signature of a method. 1086class Signature : public ValueObject { 1087 public: 1088 std::string ToString() const; 1089 1090 static Signature NoSignature() { 1091 return Signature(); 1092 } 1093 1094 bool operator==(const Signature& rhs) const; 1095 bool operator!=(const Signature& rhs) const { 1096 return !(*this == rhs); 1097 } 1098 1099 bool operator==(const StringPiece& rhs) const; 1100 1101 private: 1102 Signature(const DexFile* dex, const DexFile::ProtoId& proto) : dex_file_(dex), proto_id_(&proto) { 1103 } 1104 1105 Signature() : dex_file_(nullptr), proto_id_(nullptr) { 1106 } 1107 1108 friend class DexFile; 1109 1110 const DexFile* const dex_file_; 1111 const DexFile::ProtoId* const proto_id_; 1112}; 1113std::ostream& operator<<(std::ostream& os, const Signature& sig); 1114 1115// Iterate and decode class_data_item 1116class ClassDataItemIterator { 1117 public: 1118 ClassDataItemIterator(const DexFile& dex_file, const uint8_t* raw_class_data_item) 1119 : dex_file_(dex_file), pos_(0), ptr_pos_(raw_class_data_item), last_idx_(0) { 1120 ReadClassDataHeader(); 1121 if (EndOfInstanceFieldsPos() > 0) { 1122 ReadClassDataField(); 1123 } else if (EndOfVirtualMethodsPos() > 0) { 1124 ReadClassDataMethod(); 1125 } 1126 } 1127 uint32_t NumStaticFields() const { 1128 return header_.static_fields_size_; 1129 } 1130 uint32_t NumInstanceFields() const { 1131 return header_.instance_fields_size_; 1132 } 1133 uint32_t NumDirectMethods() const { 1134 return header_.direct_methods_size_; 1135 } 1136 uint32_t NumVirtualMethods() const { 1137 return header_.virtual_methods_size_; 1138 } 1139 bool HasNextStaticField() const { 1140 return pos_ < EndOfStaticFieldsPos(); 1141 } 1142 bool HasNextInstanceField() const { 1143 return pos_ >= EndOfStaticFieldsPos() && pos_ < EndOfInstanceFieldsPos(); 1144 } 1145 bool HasNextDirectMethod() const { 1146 return pos_ >= EndOfInstanceFieldsPos() && pos_ < EndOfDirectMethodsPos(); 1147 } 1148 bool HasNextVirtualMethod() const { 1149 return pos_ >= EndOfDirectMethodsPos() && pos_ < EndOfVirtualMethodsPos(); 1150 } 1151 bool HasNext() const { 1152 return pos_ < EndOfVirtualMethodsPos(); 1153 } 1154 inline void Next() { 1155 pos_++; 1156 if (pos_ < EndOfStaticFieldsPos()) { 1157 last_idx_ = GetMemberIndex(); 1158 ReadClassDataField(); 1159 } else if (pos_ == EndOfStaticFieldsPos() && NumInstanceFields() > 0) { 1160 last_idx_ = 0; // transition to next array, reset last index 1161 ReadClassDataField(); 1162 } else if (pos_ < EndOfInstanceFieldsPos()) { 1163 last_idx_ = GetMemberIndex(); 1164 ReadClassDataField(); 1165 } else if (pos_ == EndOfInstanceFieldsPos() && NumDirectMethods() > 0) { 1166 last_idx_ = 0; // transition to next array, reset last index 1167 ReadClassDataMethod(); 1168 } else if (pos_ < EndOfDirectMethodsPos()) { 1169 last_idx_ = GetMemberIndex(); 1170 ReadClassDataMethod(); 1171 } else if (pos_ == EndOfDirectMethodsPos() && NumVirtualMethods() > 0) { 1172 last_idx_ = 0; // transition to next array, reset last index 1173 ReadClassDataMethod(); 1174 } else if (pos_ < EndOfVirtualMethodsPos()) { 1175 last_idx_ = GetMemberIndex(); 1176 ReadClassDataMethod(); 1177 } else { 1178 DCHECK(!HasNext()); 1179 } 1180 } 1181 uint32_t GetMemberIndex() const { 1182 if (pos_ < EndOfInstanceFieldsPos()) { 1183 return last_idx_ + field_.field_idx_delta_; 1184 } else { 1185 DCHECK_LT(pos_, EndOfVirtualMethodsPos()); 1186 return last_idx_ + method_.method_idx_delta_; 1187 } 1188 } 1189 uint32_t GetRawMemberAccessFlags() const { 1190 if (pos_ < EndOfInstanceFieldsPos()) { 1191 return field_.access_flags_; 1192 } else { 1193 DCHECK_LT(pos_, EndOfVirtualMethodsPos()); 1194 return method_.access_flags_; 1195 } 1196 } 1197 uint32_t GetFieldAccessFlags() const { 1198 return GetRawMemberAccessFlags() & kAccValidFieldFlags; 1199 } 1200 uint32_t GetMethodAccessFlags() const { 1201 return GetRawMemberAccessFlags() & kAccValidMethodFlags; 1202 } 1203 bool MemberIsNative() const { 1204 return GetRawMemberAccessFlags() & kAccNative; 1205 } 1206 bool MemberIsFinal() const { 1207 return GetRawMemberAccessFlags() & kAccFinal; 1208 } 1209 InvokeType GetMethodInvokeType(const DexFile::ClassDef& class_def) const { 1210 if (HasNextDirectMethod()) { 1211 if ((GetRawMemberAccessFlags() & kAccStatic) != 0) { 1212 return kStatic; 1213 } else { 1214 return kDirect; 1215 } 1216 } else { 1217 DCHECK_EQ(GetRawMemberAccessFlags() & kAccStatic, 0U); 1218 if ((class_def.access_flags_ & kAccInterface) != 0) { 1219 return kInterface; 1220 } else if ((GetRawMemberAccessFlags() & kAccConstructor) != 0) { 1221 return kSuper; 1222 } else { 1223 return kVirtual; 1224 } 1225 } 1226 } 1227 const DexFile::CodeItem* GetMethodCodeItem() const { 1228 return dex_file_.GetCodeItem(method_.code_off_); 1229 } 1230 uint32_t GetMethodCodeItemOffset() const { 1231 return method_.code_off_; 1232 } 1233 const uint8_t* EndDataPointer() const { 1234 CHECK(!HasNext()); 1235 return ptr_pos_; 1236 } 1237 1238 private: 1239 // A dex file's class_data_item is leb128 encoded, this structure holds a decoded form of the 1240 // header for a class_data_item 1241 struct ClassDataHeader { 1242 uint32_t static_fields_size_; // the number of static fields 1243 uint32_t instance_fields_size_; // the number of instance fields 1244 uint32_t direct_methods_size_; // the number of direct methods 1245 uint32_t virtual_methods_size_; // the number of virtual methods 1246 } header_; 1247 1248 // Read and decode header from a class_data_item stream into header 1249 void ReadClassDataHeader(); 1250 1251 uint32_t EndOfStaticFieldsPos() const { 1252 return header_.static_fields_size_; 1253 } 1254 uint32_t EndOfInstanceFieldsPos() const { 1255 return EndOfStaticFieldsPos() + header_.instance_fields_size_; 1256 } 1257 uint32_t EndOfDirectMethodsPos() const { 1258 return EndOfInstanceFieldsPos() + header_.direct_methods_size_; 1259 } 1260 uint32_t EndOfVirtualMethodsPos() const { 1261 return EndOfDirectMethodsPos() + header_.virtual_methods_size_; 1262 } 1263 1264 // A decoded version of the field of a class_data_item 1265 struct ClassDataField { 1266 uint32_t field_idx_delta_; // delta of index into the field_ids array for FieldId 1267 uint32_t access_flags_; // access flags for the field 1268 ClassDataField() : field_idx_delta_(0), access_flags_(0) {} 1269 1270 private: 1271 DISALLOW_COPY_AND_ASSIGN(ClassDataField); 1272 }; 1273 ClassDataField field_; 1274 1275 // Read and decode a field from a class_data_item stream into field 1276 void ReadClassDataField(); 1277 1278 // A decoded version of the method of a class_data_item 1279 struct ClassDataMethod { 1280 uint32_t method_idx_delta_; // delta of index into the method_ids array for MethodId 1281 uint32_t access_flags_; 1282 uint32_t code_off_; 1283 ClassDataMethod() : method_idx_delta_(0), access_flags_(0), code_off_(0) {} 1284 1285 private: 1286 DISALLOW_COPY_AND_ASSIGN(ClassDataMethod); 1287 }; 1288 ClassDataMethod method_; 1289 1290 // Read and decode a method from a class_data_item stream into method 1291 void ReadClassDataMethod(); 1292 1293 const DexFile& dex_file_; 1294 size_t pos_; // integral number of items passed 1295 const uint8_t* ptr_pos_; // pointer into stream of class_data_item 1296 uint32_t last_idx_; // last read field or method index to apply delta to 1297 DISALLOW_IMPLICIT_CONSTRUCTORS(ClassDataItemIterator); 1298}; 1299 1300class EncodedStaticFieldValueIterator { 1301 public: 1302 EncodedStaticFieldValueIterator(const DexFile& dex_file, Handle<mirror::DexCache>* dex_cache, 1303 Handle<mirror::ClassLoader>* class_loader, 1304 ClassLinker* linker, const DexFile::ClassDef& class_def) 1305 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1306 1307 template<bool kTransactionActive> 1308 void ReadValueToField(ArtField* field) const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1309 1310 bool HasNext() const { return pos_ < array_size_; } 1311 1312 void Next(); 1313 1314 enum ValueType { 1315 kByte = 0x00, 1316 kShort = 0x02, 1317 kChar = 0x03, 1318 kInt = 0x04, 1319 kLong = 0x06, 1320 kFloat = 0x10, 1321 kDouble = 0x11, 1322 kString = 0x17, 1323 kType = 0x18, 1324 kField = 0x19, 1325 kMethod = 0x1a, 1326 kEnum = 0x1b, 1327 kArray = 0x1c, 1328 kAnnotation = 0x1d, 1329 kNull = 0x1e, 1330 kBoolean = 0x1f 1331 }; 1332 1333 private: 1334 static constexpr uint8_t kEncodedValueTypeMask = 0x1f; // 0b11111 1335 static constexpr uint8_t kEncodedValueArgShift = 5; 1336 1337 const DexFile& dex_file_; 1338 Handle<mirror::DexCache>* const dex_cache_; // Dex cache to resolve literal objects. 1339 Handle<mirror::ClassLoader>* const class_loader_; // ClassLoader to resolve types. 1340 ClassLinker* linker_; // Linker to resolve literal objects. 1341 size_t array_size_; // Size of array. 1342 size_t pos_; // Current position. 1343 const uint8_t* ptr_; // Pointer into encoded data array. 1344 ValueType type_; // Type of current encoded value. 1345 jvalue jval_; // Value of current encoded value. 1346 DISALLOW_IMPLICIT_CONSTRUCTORS(EncodedStaticFieldValueIterator); 1347}; 1348std::ostream& operator<<(std::ostream& os, const EncodedStaticFieldValueIterator::ValueType& code); 1349 1350class CatchHandlerIterator { 1351 public: 1352 CatchHandlerIterator(const DexFile::CodeItem& code_item, uint32_t address); 1353 1354 CatchHandlerIterator(const DexFile::CodeItem& code_item, 1355 const DexFile::TryItem& try_item); 1356 1357 explicit CatchHandlerIterator(const uint8_t* handler_data) { 1358 Init(handler_data); 1359 } 1360 1361 uint16_t GetHandlerTypeIndex() const { 1362 return handler_.type_idx_; 1363 } 1364 uint32_t GetHandlerAddress() const { 1365 return handler_.address_; 1366 } 1367 void Next(); 1368 bool HasNext() const { 1369 return remaining_count_ != -1 || catch_all_; 1370 } 1371 // End of this set of catch blocks, convenience method to locate next set of catch blocks 1372 const uint8_t* EndDataPointer() const { 1373 CHECK(!HasNext()); 1374 return current_data_; 1375 } 1376 1377 private: 1378 void Init(const DexFile::CodeItem& code_item, int32_t offset); 1379 void Init(const uint8_t* handler_data); 1380 1381 struct CatchHandlerItem { 1382 uint16_t type_idx_; // type index of the caught exception type 1383 uint32_t address_; // handler address 1384 } handler_; 1385 const uint8_t* current_data_; // the current handler in dex file. 1386 int32_t remaining_count_; // number of handlers not read. 1387 bool catch_all_; // is there a handler that will catch all exceptions in case 1388 // that all typed handler does not match. 1389}; 1390 1391} // namespace art 1392 1393#endif // ART_RUNTIME_DEX_FILE_H_ 1394