dex_file.h revision e5f13e57ff8fa36342beb33830b3ec5942a61cca
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 std::string GetBaseLocation() const { 425 size_t pos = location_.rfind(kMultiDexSeparator); 426 if (pos == std::string::npos) { 427 return location_; 428 } else { 429 return location_.substr(0, pos); 430 } 431 } 432 433 // For DexFiles directly from .dex files, this is the checksum from the DexFile::Header. 434 // For DexFiles opened from a zip files, this will be the ZipEntry CRC32 of classes.dex. 435 uint32_t GetLocationChecksum() const { 436 return location_checksum_; 437 } 438 439 const Header& GetHeader() const { 440 DCHECK(header_ != NULL) << GetLocation(); 441 return *header_; 442 } 443 444 // Decode the dex magic version 445 uint32_t GetVersion() const; 446 447 // Returns true if the byte string points to the magic value. 448 static bool IsMagicValid(const uint8_t* magic); 449 450 // Returns true if the byte string after the magic is the correct value. 451 static bool IsVersionValid(const uint8_t* magic); 452 453 // Returns the number of string identifiers in the .dex file. 454 size_t NumStringIds() const { 455 DCHECK(header_ != NULL) << GetLocation(); 456 return header_->string_ids_size_; 457 } 458 459 // Returns the StringId at the specified index. 460 const StringId& GetStringId(uint32_t idx) const { 461 DCHECK_LT(idx, NumStringIds()) << GetLocation(); 462 return string_ids_[idx]; 463 } 464 465 uint32_t GetIndexForStringId(const StringId& string_id) const { 466 CHECK_GE(&string_id, string_ids_) << GetLocation(); 467 CHECK_LT(&string_id, string_ids_ + header_->string_ids_size_) << GetLocation(); 468 return &string_id - string_ids_; 469 } 470 471 int32_t GetStringLength(const StringId& string_id) const; 472 473 // Returns a pointer to the UTF-8 string data referred to by the given string_id as well as the 474 // length of the string when decoded as a UTF-16 string. Note the UTF-16 length is not the same 475 // as the string length of the string data. 476 const char* GetStringDataAndUtf16Length(const StringId& string_id, uint32_t* utf16_length) const; 477 478 const char* GetStringData(const StringId& string_id) const { 479 uint32_t ignored; 480 return GetStringDataAndUtf16Length(string_id, &ignored); 481 } 482 483 // Index version of GetStringDataAndUtf16Length. 484 const char* StringDataAndUtf16LengthByIdx(uint32_t idx, uint32_t* utf16_length) const { 485 if (idx == kDexNoIndex) { 486 *utf16_length = 0; 487 return NULL; 488 } 489 const StringId& string_id = GetStringId(idx); 490 return GetStringDataAndUtf16Length(string_id, utf16_length); 491 } 492 493 const char* StringDataByIdx(uint32_t idx) const { 494 uint32_t unicode_length; 495 return StringDataAndUtf16LengthByIdx(idx, &unicode_length); 496 } 497 498 // Looks up a string id for a given modified utf8 string. 499 const StringId* FindStringId(const char* string) const; 500 501 // Looks up a string id for a given utf16 string. 502 const StringId* FindStringId(const uint16_t* string, size_t length) const; 503 504 // Returns the number of type identifiers in the .dex file. 505 uint32_t NumTypeIds() const { 506 DCHECK(header_ != NULL) << GetLocation(); 507 return header_->type_ids_size_; 508 } 509 510 // Returns the TypeId at the specified index. 511 const TypeId& GetTypeId(uint32_t idx) const { 512 DCHECK_LT(idx, NumTypeIds()) << GetLocation(); 513 return type_ids_[idx]; 514 } 515 516 uint16_t GetIndexForTypeId(const TypeId& type_id) const { 517 CHECK_GE(&type_id, type_ids_) << GetLocation(); 518 CHECK_LT(&type_id, type_ids_ + header_->type_ids_size_) << GetLocation(); 519 size_t result = &type_id - type_ids_; 520 DCHECK_LT(result, 65536U) << GetLocation(); 521 return static_cast<uint16_t>(result); 522 } 523 524 // Get the descriptor string associated with a given type index. 525 const char* StringByTypeIdx(uint32_t idx, uint32_t* unicode_length) const { 526 const TypeId& type_id = GetTypeId(idx); 527 return StringDataAndUtf16LengthByIdx(type_id.descriptor_idx_, unicode_length); 528 } 529 530 const char* StringByTypeIdx(uint32_t idx) const { 531 const TypeId& type_id = GetTypeId(idx); 532 return StringDataByIdx(type_id.descriptor_idx_); 533 } 534 535 // Returns the type descriptor string of a type id. 536 const char* GetTypeDescriptor(const TypeId& type_id) const { 537 return StringDataByIdx(type_id.descriptor_idx_); 538 } 539 540 // Looks up a type for the given string index 541 const TypeId* FindTypeId(uint32_t string_idx) const; 542 543 // Returns the number of field identifiers in the .dex file. 544 size_t NumFieldIds() const { 545 DCHECK(header_ != NULL) << GetLocation(); 546 return header_->field_ids_size_; 547 } 548 549 // Returns the FieldId at the specified index. 550 const FieldId& GetFieldId(uint32_t idx) const { 551 DCHECK_LT(idx, NumFieldIds()) << GetLocation(); 552 return field_ids_[idx]; 553 } 554 555 uint32_t GetIndexForFieldId(const FieldId& field_id) const { 556 CHECK_GE(&field_id, field_ids_) << GetLocation(); 557 CHECK_LT(&field_id, field_ids_ + header_->field_ids_size_) << GetLocation(); 558 return &field_id - field_ids_; 559 } 560 561 // Looks up a field by its declaring class, name and type 562 const FieldId* FindFieldId(const DexFile::TypeId& declaring_klass, 563 const DexFile::StringId& name, 564 const DexFile::TypeId& type) const; 565 566 // Returns the declaring class descriptor string of a field id. 567 const char* GetFieldDeclaringClassDescriptor(const FieldId& field_id) const { 568 const DexFile::TypeId& type_id = GetTypeId(field_id.class_idx_); 569 return GetTypeDescriptor(type_id); 570 } 571 572 // Returns the class descriptor string of a field id. 573 const char* GetFieldTypeDescriptor(const FieldId& field_id) const { 574 const DexFile::TypeId& type_id = GetTypeId(field_id.type_idx_); 575 return GetTypeDescriptor(type_id); 576 } 577 578 // Returns the name of a field id. 579 const char* GetFieldName(const FieldId& field_id) const { 580 return StringDataByIdx(field_id.name_idx_); 581 } 582 583 // Returns the number of method identifiers in the .dex file. 584 size_t NumMethodIds() const { 585 DCHECK(header_ != NULL) << GetLocation(); 586 return header_->method_ids_size_; 587 } 588 589 // Returns the MethodId at the specified index. 590 const MethodId& GetMethodId(uint32_t idx) const { 591 DCHECK_LT(idx, NumMethodIds()) << GetLocation(); 592 return method_ids_[idx]; 593 } 594 595 uint32_t GetIndexForMethodId(const MethodId& method_id) const { 596 CHECK_GE(&method_id, method_ids_) << GetLocation(); 597 CHECK_LT(&method_id, method_ids_ + header_->method_ids_size_) << GetLocation(); 598 return &method_id - method_ids_; 599 } 600 601 // Looks up a method by its declaring class, name and proto_id 602 const MethodId* FindMethodId(const DexFile::TypeId& declaring_klass, 603 const DexFile::StringId& name, 604 const DexFile::ProtoId& signature) const; 605 606 // Returns the declaring class descriptor string of a method id. 607 const char* GetMethodDeclaringClassDescriptor(const MethodId& method_id) const { 608 const DexFile::TypeId& type_id = GetTypeId(method_id.class_idx_); 609 return GetTypeDescriptor(type_id); 610 } 611 612 // Returns the prototype of a method id. 613 const ProtoId& GetMethodPrototype(const MethodId& method_id) const { 614 return GetProtoId(method_id.proto_idx_); 615 } 616 617 // Returns a representation of the signature of a method id. 618 const Signature GetMethodSignature(const MethodId& method_id) const; 619 620 // Returns the name of a method id. 621 const char* GetMethodName(const MethodId& method_id) const { 622 return StringDataByIdx(method_id.name_idx_); 623 } 624 625 // Returns the shorty of a method id. 626 const char* GetMethodShorty(const MethodId& method_id) const { 627 return StringDataByIdx(GetProtoId(method_id.proto_idx_).shorty_idx_); 628 } 629 const char* GetMethodShorty(const MethodId& method_id, uint32_t* length) const { 630 // Using the UTF16 length is safe here as shorties are guaranteed to be ASCII characters. 631 return StringDataAndUtf16LengthByIdx(GetProtoId(method_id.proto_idx_).shorty_idx_, length); 632 } 633 // Returns the number of class definitions in the .dex file. 634 uint32_t NumClassDefs() const { 635 DCHECK(header_ != NULL) << GetLocation(); 636 return header_->class_defs_size_; 637 } 638 639 // Returns the ClassDef at the specified index. 640 const ClassDef& GetClassDef(uint16_t idx) const { 641 DCHECK_LT(idx, NumClassDefs()) << GetLocation(); 642 return class_defs_[idx]; 643 } 644 645 uint16_t GetIndexForClassDef(const ClassDef& class_def) const { 646 CHECK_GE(&class_def, class_defs_) << GetLocation(); 647 CHECK_LT(&class_def, class_defs_ + header_->class_defs_size_) << GetLocation(); 648 return &class_def - class_defs_; 649 } 650 651 // Returns the class descriptor string of a class definition. 652 const char* GetClassDescriptor(const ClassDef& class_def) const { 653 return StringByTypeIdx(class_def.class_idx_); 654 } 655 656 // Looks up a class definition by its class descriptor. Hash must be 657 // ComputeModifiedUtf8Hash(descriptor). 658 const ClassDef* FindClassDef(const char* descriptor, size_t hash) const; 659 660 // Looks up a class definition by its type index. 661 const ClassDef* FindClassDef(uint16_t type_idx) const; 662 663 const TypeList* GetInterfacesList(const ClassDef& class_def) const { 664 if (class_def.interfaces_off_ == 0) { 665 return NULL; 666 } else { 667 const uint8_t* addr = begin_ + class_def.interfaces_off_; 668 return reinterpret_cast<const TypeList*>(addr); 669 } 670 } 671 672 // Returns a pointer to the raw memory mapped class_data_item 673 const uint8_t* GetClassData(const ClassDef& class_def) const { 674 if (class_def.class_data_off_ == 0) { 675 return NULL; 676 } else { 677 return begin_ + class_def.class_data_off_; 678 } 679 } 680 681 // 682 const CodeItem* GetCodeItem(const uint32_t code_off) const { 683 if (code_off == 0) { 684 return NULL; // native or abstract method 685 } else { 686 const uint8_t* addr = begin_ + code_off; 687 return reinterpret_cast<const CodeItem*>(addr); 688 } 689 } 690 691 const char* GetReturnTypeDescriptor(const ProtoId& proto_id) const { 692 return StringByTypeIdx(proto_id.return_type_idx_); 693 } 694 695 // Returns the number of prototype identifiers in the .dex file. 696 size_t NumProtoIds() const { 697 DCHECK(header_ != NULL) << GetLocation(); 698 return header_->proto_ids_size_; 699 } 700 701 // Returns the ProtoId at the specified index. 702 const ProtoId& GetProtoId(uint32_t idx) const { 703 DCHECK_LT(idx, NumProtoIds()) << GetLocation(); 704 return proto_ids_[idx]; 705 } 706 707 uint16_t GetIndexForProtoId(const ProtoId& proto_id) const { 708 CHECK_GE(&proto_id, proto_ids_) << GetLocation(); 709 CHECK_LT(&proto_id, proto_ids_ + header_->proto_ids_size_) << GetLocation(); 710 return &proto_id - proto_ids_; 711 } 712 713 // Looks up a proto id for a given return type and signature type list 714 const ProtoId* FindProtoId(uint16_t return_type_idx, 715 const uint16_t* signature_type_idxs, uint32_t signature_length) const; 716 const ProtoId* FindProtoId(uint16_t return_type_idx, 717 const std::vector<uint16_t>& signature_type_idxs) const { 718 return FindProtoId(return_type_idx, &signature_type_idxs[0], signature_type_idxs.size()); 719 } 720 721 // Given a signature place the type ids into the given vector, returns true on success 722 bool CreateTypeList(const StringPiece& signature, uint16_t* return_type_idx, 723 std::vector<uint16_t>* param_type_idxs) const; 724 725 // Create a Signature from the given string signature or return Signature::NoSignature if not 726 // possible. 727 const Signature CreateSignature(const StringPiece& signature) const; 728 729 // Returns the short form method descriptor for the given prototype. 730 const char* GetShorty(uint32_t proto_idx) const { 731 const ProtoId& proto_id = GetProtoId(proto_idx); 732 return StringDataByIdx(proto_id.shorty_idx_); 733 } 734 735 const TypeList* GetProtoParameters(const ProtoId& proto_id) const { 736 if (proto_id.parameters_off_ == 0) { 737 return NULL; 738 } else { 739 const uint8_t* addr = begin_ + proto_id.parameters_off_; 740 return reinterpret_cast<const TypeList*>(addr); 741 } 742 } 743 744 const uint8_t* GetEncodedStaticFieldValuesArray(const ClassDef& class_def) const { 745 if (class_def.static_values_off_ == 0) { 746 return 0; 747 } else { 748 return begin_ + class_def.static_values_off_; 749 } 750 } 751 752 static const TryItem* GetTryItems(const CodeItem& code_item, uint32_t offset); 753 754 // Get the base of the encoded data for the given DexCode. 755 static const uint8_t* GetCatchHandlerData(const CodeItem& code_item, uint32_t offset) { 756 const uint8_t* handler_data = 757 reinterpret_cast<const uint8_t*>(GetTryItems(code_item, code_item.tries_size_)); 758 return handler_data + offset; 759 } 760 761 // Find which try region is associated with the given address (ie dex pc). Returns -1 if none. 762 static int32_t FindTryItem(const CodeItem &code_item, uint32_t address); 763 764 // Find the handler offset associated with the given address (ie dex pc). Returns -1 if none. 765 static int32_t FindCatchHandlerOffset(const CodeItem &code_item, uint32_t address); 766 767 // Get the pointer to the start of the debugging data 768 const uint8_t* GetDebugInfoStream(const CodeItem* code_item) const { 769 if (code_item->debug_info_off_ == 0) { 770 return NULL; 771 } else { 772 return begin_ + code_item->debug_info_off_; 773 } 774 } 775 776 // Callback for "new position table entry". 777 // Returning true causes the decoder to stop early. 778 typedef bool (*DexDebugNewPositionCb)(void* context, uint32_t address, uint32_t line_num); 779 780 // Callback for "new locals table entry". "signature" is an empty string 781 // if no signature is available for an entry. 782 typedef void (*DexDebugNewLocalCb)(void* context, uint16_t reg, 783 uint32_t start_address, 784 uint32_t end_address, 785 const char* name, 786 const char* descriptor, 787 const char* signature); 788 789 static bool LineNumForPcCb(void* context, uint32_t address, uint32_t line_num); 790 791 // Debug info opcodes and constants 792 enum { 793 DBG_END_SEQUENCE = 0x00, 794 DBG_ADVANCE_PC = 0x01, 795 DBG_ADVANCE_LINE = 0x02, 796 DBG_START_LOCAL = 0x03, 797 DBG_START_LOCAL_EXTENDED = 0x04, 798 DBG_END_LOCAL = 0x05, 799 DBG_RESTART_LOCAL = 0x06, 800 DBG_SET_PROLOGUE_END = 0x07, 801 DBG_SET_EPILOGUE_BEGIN = 0x08, 802 DBG_SET_FILE = 0x09, 803 DBG_FIRST_SPECIAL = 0x0a, 804 DBG_LINE_BASE = -4, 805 DBG_LINE_RANGE = 15, 806 }; 807 808 struct LocalInfo { 809 LocalInfo() 810 : name_(NULL), descriptor_(NULL), signature_(NULL), start_address_(0), is_live_(false) {} 811 812 const char* name_; // E.g., list 813 const char* descriptor_; // E.g., Ljava/util/LinkedList; 814 const char* signature_; // E.g., java.util.LinkedList<java.lang.Integer> 815 uint16_t start_address_; // PC location where the local is first defined. 816 bool is_live_; // Is the local defined and live. 817 818 private: 819 DISALLOW_COPY_AND_ASSIGN(LocalInfo); 820 }; 821 822 struct LineNumFromPcContext { 823 LineNumFromPcContext(uint32_t address, uint32_t line_num) 824 : address_(address), line_num_(line_num) {} 825 uint32_t address_; 826 uint32_t line_num_; 827 private: 828 DISALLOW_COPY_AND_ASSIGN(LineNumFromPcContext); 829 }; 830 831 void InvokeLocalCbIfLive(void* context, int reg, uint32_t end_address, 832 LocalInfo* local_in_reg, DexDebugNewLocalCb local_cb) const { 833 if (local_cb != NULL && local_in_reg[reg].is_live_) { 834 local_cb(context, reg, local_in_reg[reg].start_address_, end_address, 835 local_in_reg[reg].name_, local_in_reg[reg].descriptor_, 836 local_in_reg[reg].signature_ != NULL ? local_in_reg[reg].signature_ : ""); 837 } 838 } 839 840 // Determine the source file line number based on the program counter. 841 // "pc" is an offset, in 16-bit units, from the start of the method's code. 842 // 843 // Returns -1 if no match was found (possibly because the source files were 844 // compiled without "-g", so no line number information is present). 845 // Returns -2 for native methods (as expected in exception traces). 846 // 847 // This is used by runtime; therefore use art::Method not art::DexFile::Method. 848 int32_t GetLineNumFromPC(mirror::ArtMethod* method, uint32_t rel_pc) const 849 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 850 851 void DecodeDebugInfo(const CodeItem* code_item, bool is_static, uint32_t method_idx, 852 DexDebugNewPositionCb position_cb, DexDebugNewLocalCb local_cb, 853 void* context) const; 854 855 const char* GetSourceFile(const ClassDef& class_def) const { 856 if (class_def.source_file_idx_ == 0xffffffff) { 857 return NULL; 858 } else { 859 return StringDataByIdx(class_def.source_file_idx_); 860 } 861 } 862 863 int GetPermissions() const; 864 865 bool IsReadOnly() const; 866 867 bool EnableWrite() const; 868 869 bool DisableWrite() const; 870 871 const uint8_t* Begin() const { 872 return begin_; 873 } 874 875 size_t Size() const { 876 return size_; 877 } 878 879 static std::string GetMultiDexClassesDexName(size_t number, const char* dex_location); 880 881 // Returns the canonical form of the given dex location. 882 // 883 // There are different flavors of "dex locations" as follows: 884 // the file name of a dex file: 885 // The actual file path that the dex file has on disk. 886 // dex_location: 887 // This acts as a key for the class linker to know which dex file to load. 888 // It may correspond to either an old odex file or a particular dex file 889 // inside an oat file. In the first case it will also match the file name 890 // of the dex file. In the second case (oat) it will include the file name 891 // and possibly some multidex annotation to uniquely identify it. 892 // canonical_dex_location: 893 // the dex_location where it's file name part has been made canonical. 894 static std::string GetDexCanonicalLocation(const char* dex_location); 895 896 const OatFile* GetOatFile() const { 897 return oat_file_; 898 } 899 900 private: 901 // Opens a .dex file 902 static std::unique_ptr<const DexFile> OpenFile(int fd, const char* location, 903 bool verify, std::string* error_msg); 904 905 // Opens dex files from within a .jar, .zip, or .apk file 906 static bool OpenZip(int fd, const std::string& location, std::string* error_msg, 907 std::vector<std::unique_ptr<const DexFile>>* dex_files); 908 909 enum class ZipOpenErrorCode { // private 910 kNoError, 911 kEntryNotFound, 912 kExtractToMemoryError, 913 kDexFileError, 914 kMakeReadOnlyError, 915 kVerifyError 916 }; 917 918 // Opens .dex file from the entry_name in a zip archive. error_code is undefined when non-nullptr 919 // return. 920 static std::unique_ptr<const DexFile> Open(const ZipArchive& zip_archive, const char* entry_name, 921 const std::string& location, std::string* error_msg, 922 ZipOpenErrorCode* error_code); 923 924 // Opens a .dex file at the given address backed by a MemMap 925 static std::unique_ptr<const DexFile> OpenMemory(const std::string& location, 926 uint32_t location_checksum, 927 MemMap* mem_map, 928 std::string* error_msg); 929 930 // Opens a .dex file at the given address, optionally backed by a MemMap 931 static std::unique_ptr<const DexFile> OpenMemory(const uint8_t* dex_file, 932 size_t size, 933 const std::string& location, 934 uint32_t location_checksum, 935 MemMap* mem_map, 936 const OatFile* oat_file, 937 std::string* error_msg); 938 939 DexFile(const uint8_t* base, size_t size, 940 const std::string& location, 941 uint32_t location_checksum, 942 MemMap* mem_map, 943 const OatFile* oat_file); 944 945 // Top-level initializer that calls other Init methods. 946 bool Init(std::string* error_msg); 947 948 // Returns true if the header magic and version numbers are of the expected values. 949 bool CheckMagicAndVersion(std::string* error_msg) const; 950 951 void DecodeDebugInfo0(const CodeItem* code_item, bool is_static, uint32_t method_idx, 952 DexDebugNewPositionCb position_cb, DexDebugNewLocalCb local_cb, 953 void* context, const uint8_t* stream, LocalInfo* local_in_reg) const; 954 955 // Check whether a location denotes a multidex dex file. This is a very simple check: returns 956 // whether the string contains the separator character. 957 static bool IsMultiDexLocation(const char* location); 958 959 960 // The base address of the memory mapping. 961 const uint8_t* const begin_; 962 963 // The size of the underlying memory allocation in bytes. 964 const size_t size_; 965 966 // Typically the dex file name when available, alternatively some identifying string. 967 // 968 // The ClassLinker will use this to match DexFiles the boot class 969 // path to DexCache::GetLocation when loading from an image. 970 const std::string location_; 971 972 const uint32_t location_checksum_; 973 974 // Manages the underlying memory allocation. 975 std::unique_ptr<MemMap> mem_map_; 976 977 // Points to the header section. 978 const Header* const header_; 979 980 // Points to the base of the string identifier list. 981 const StringId* const string_ids_; 982 983 // Points to the base of the type identifier list. 984 const TypeId* const type_ids_; 985 986 // Points to the base of the field identifier list. 987 const FieldId* const field_ids_; 988 989 // Points to the base of the method identifier list. 990 const MethodId* const method_ids_; 991 992 // Points to the base of the prototype identifier list. 993 const ProtoId* const proto_ids_; 994 995 // Points to the base of the class definition list. 996 const ClassDef* const class_defs_; 997 998 // Number of misses finding a class def from a descriptor. 999 mutable Atomic<uint32_t> find_class_def_misses_; 1000 1001 struct UTF16EmptyFn { 1002 void MakeEmpty(std::pair<const char*, const ClassDef*>& pair) const { 1003 pair.first = nullptr; 1004 pair.second = nullptr; 1005 } 1006 bool IsEmpty(const std::pair<const char*, const ClassDef*>& pair) const { 1007 if (pair.first == nullptr) { 1008 DCHECK(pair.second == nullptr); 1009 return true; 1010 } 1011 return false; 1012 } 1013 }; 1014 struct UTF16HashCmp { 1015 // Hash function. 1016 size_t operator()(const char* key) const { 1017 return ComputeModifiedUtf8Hash(key); 1018 } 1019 // std::equal function. 1020 bool operator()(const char* a, const char* b) const { 1021 return CompareModifiedUtf8ToModifiedUtf8AsUtf16CodePointValues(a, b) == 0; 1022 } 1023 }; 1024 typedef HashMap<const char*, const ClassDef*, UTF16EmptyFn, UTF16HashCmp, UTF16HashCmp> Index; 1025 mutable Atomic<Index*> class_def_index_; 1026 1027 // The oat file this dex file was loaded from. May be null in case the dex file is not coming 1028 // from an oat file, e.g., directly from an apk. 1029 const OatFile* oat_file_; 1030}; 1031 1032struct DexFileReference { 1033 DexFileReference(const DexFile* file, uint32_t idx) : dex_file(file), index(idx) { } 1034 const DexFile* dex_file; 1035 uint32_t index; 1036}; 1037 1038std::ostream& operator<<(std::ostream& os, const DexFile& dex_file); 1039 1040// Iterate over a dex file's ProtoId's paramters 1041class DexFileParameterIterator { 1042 public: 1043 DexFileParameterIterator(const DexFile& dex_file, const DexFile::ProtoId& proto_id) 1044 : dex_file_(dex_file), size_(0), pos_(0) { 1045 type_list_ = dex_file_.GetProtoParameters(proto_id); 1046 if (type_list_ != NULL) { 1047 size_ = type_list_->Size(); 1048 } 1049 } 1050 bool HasNext() const { return pos_ < size_; } 1051 void Next() { ++pos_; } 1052 uint16_t GetTypeIdx() { 1053 return type_list_->GetTypeItem(pos_).type_idx_; 1054 } 1055 const char* GetDescriptor() { 1056 return dex_file_.StringByTypeIdx(GetTypeIdx()); 1057 } 1058 private: 1059 const DexFile& dex_file_; 1060 const DexFile::TypeList* type_list_; 1061 uint32_t size_; 1062 uint32_t pos_; 1063 DISALLOW_IMPLICIT_CONSTRUCTORS(DexFileParameterIterator); 1064}; 1065 1066// Abstract the signature of a method. 1067class Signature : public ValueObject { 1068 public: 1069 std::string ToString() const; 1070 1071 static Signature NoSignature() { 1072 return Signature(); 1073 } 1074 1075 bool operator==(const Signature& rhs) const; 1076 bool operator!=(const Signature& rhs) const { 1077 return !(*this == rhs); 1078 } 1079 1080 bool operator==(const StringPiece& rhs) const; 1081 1082 private: 1083 Signature(const DexFile* dex, const DexFile::ProtoId& proto) : dex_file_(dex), proto_id_(&proto) { 1084 } 1085 1086 Signature() : dex_file_(nullptr), proto_id_(nullptr) { 1087 } 1088 1089 friend class DexFile; 1090 1091 const DexFile* const dex_file_; 1092 const DexFile::ProtoId* const proto_id_; 1093}; 1094std::ostream& operator<<(std::ostream& os, const Signature& sig); 1095 1096// Iterate and decode class_data_item 1097class ClassDataItemIterator { 1098 public: 1099 ClassDataItemIterator(const DexFile& dex_file, const uint8_t* raw_class_data_item) 1100 : dex_file_(dex_file), pos_(0), ptr_pos_(raw_class_data_item), last_idx_(0) { 1101 ReadClassDataHeader(); 1102 if (EndOfInstanceFieldsPos() > 0) { 1103 ReadClassDataField(); 1104 } else if (EndOfVirtualMethodsPos() > 0) { 1105 ReadClassDataMethod(); 1106 } 1107 } 1108 uint32_t NumStaticFields() const { 1109 return header_.static_fields_size_; 1110 } 1111 uint32_t NumInstanceFields() const { 1112 return header_.instance_fields_size_; 1113 } 1114 uint32_t NumDirectMethods() const { 1115 return header_.direct_methods_size_; 1116 } 1117 uint32_t NumVirtualMethods() const { 1118 return header_.virtual_methods_size_; 1119 } 1120 bool HasNextStaticField() const { 1121 return pos_ < EndOfStaticFieldsPos(); 1122 } 1123 bool HasNextInstanceField() const { 1124 return pos_ >= EndOfStaticFieldsPos() && pos_ < EndOfInstanceFieldsPos(); 1125 } 1126 bool HasNextDirectMethod() const { 1127 return pos_ >= EndOfInstanceFieldsPos() && pos_ < EndOfDirectMethodsPos(); 1128 } 1129 bool HasNextVirtualMethod() const { 1130 return pos_ >= EndOfDirectMethodsPos() && pos_ < EndOfVirtualMethodsPos(); 1131 } 1132 bool HasNext() const { 1133 return pos_ < EndOfVirtualMethodsPos(); 1134 } 1135 inline void Next() { 1136 pos_++; 1137 if (pos_ < EndOfStaticFieldsPos()) { 1138 last_idx_ = GetMemberIndex(); 1139 ReadClassDataField(); 1140 } else if (pos_ == EndOfStaticFieldsPos() && NumInstanceFields() > 0) { 1141 last_idx_ = 0; // transition to next array, reset last index 1142 ReadClassDataField(); 1143 } else if (pos_ < EndOfInstanceFieldsPos()) { 1144 last_idx_ = GetMemberIndex(); 1145 ReadClassDataField(); 1146 } else if (pos_ == EndOfInstanceFieldsPos() && NumDirectMethods() > 0) { 1147 last_idx_ = 0; // transition to next array, reset last index 1148 ReadClassDataMethod(); 1149 } else if (pos_ < EndOfDirectMethodsPos()) { 1150 last_idx_ = GetMemberIndex(); 1151 ReadClassDataMethod(); 1152 } else if (pos_ == EndOfDirectMethodsPos() && NumVirtualMethods() > 0) { 1153 last_idx_ = 0; // transition to next array, reset last index 1154 ReadClassDataMethod(); 1155 } else if (pos_ < EndOfVirtualMethodsPos()) { 1156 last_idx_ = GetMemberIndex(); 1157 ReadClassDataMethod(); 1158 } else { 1159 DCHECK(!HasNext()); 1160 } 1161 } 1162 uint32_t GetMemberIndex() const { 1163 if (pos_ < EndOfInstanceFieldsPos()) { 1164 return last_idx_ + field_.field_idx_delta_; 1165 } else { 1166 DCHECK_LT(pos_, EndOfVirtualMethodsPos()); 1167 return last_idx_ + method_.method_idx_delta_; 1168 } 1169 } 1170 uint32_t GetRawMemberAccessFlags() const { 1171 if (pos_ < EndOfInstanceFieldsPos()) { 1172 return field_.access_flags_; 1173 } else { 1174 DCHECK_LT(pos_, EndOfVirtualMethodsPos()); 1175 return method_.access_flags_; 1176 } 1177 } 1178 uint32_t GetFieldAccessFlags() const { 1179 return GetRawMemberAccessFlags() & kAccValidFieldFlags; 1180 } 1181 uint32_t GetMethodAccessFlags() const { 1182 return GetRawMemberAccessFlags() & kAccValidMethodFlags; 1183 } 1184 bool MemberIsNative() const { 1185 return GetRawMemberAccessFlags() & kAccNative; 1186 } 1187 bool MemberIsFinal() const { 1188 return GetRawMemberAccessFlags() & kAccFinal; 1189 } 1190 InvokeType GetMethodInvokeType(const DexFile::ClassDef& class_def) const { 1191 if (HasNextDirectMethod()) { 1192 if ((GetRawMemberAccessFlags() & kAccStatic) != 0) { 1193 return kStatic; 1194 } else { 1195 return kDirect; 1196 } 1197 } else { 1198 DCHECK_EQ(GetRawMemberAccessFlags() & kAccStatic, 0U); 1199 if ((class_def.access_flags_ & kAccInterface) != 0) { 1200 return kInterface; 1201 } else if ((GetRawMemberAccessFlags() & kAccConstructor) != 0) { 1202 return kSuper; 1203 } else { 1204 return kVirtual; 1205 } 1206 } 1207 } 1208 const DexFile::CodeItem* GetMethodCodeItem() const { 1209 return dex_file_.GetCodeItem(method_.code_off_); 1210 } 1211 uint32_t GetMethodCodeItemOffset() const { 1212 return method_.code_off_; 1213 } 1214 const uint8_t* EndDataPointer() const { 1215 CHECK(!HasNext()); 1216 return ptr_pos_; 1217 } 1218 1219 private: 1220 // A dex file's class_data_item is leb128 encoded, this structure holds a decoded form of the 1221 // header for a class_data_item 1222 struct ClassDataHeader { 1223 uint32_t static_fields_size_; // the number of static fields 1224 uint32_t instance_fields_size_; // the number of instance fields 1225 uint32_t direct_methods_size_; // the number of direct methods 1226 uint32_t virtual_methods_size_; // the number of virtual methods 1227 } header_; 1228 1229 // Read and decode header from a class_data_item stream into header 1230 void ReadClassDataHeader(); 1231 1232 uint32_t EndOfStaticFieldsPos() const { 1233 return header_.static_fields_size_; 1234 } 1235 uint32_t EndOfInstanceFieldsPos() const { 1236 return EndOfStaticFieldsPos() + header_.instance_fields_size_; 1237 } 1238 uint32_t EndOfDirectMethodsPos() const { 1239 return EndOfInstanceFieldsPos() + header_.direct_methods_size_; 1240 } 1241 uint32_t EndOfVirtualMethodsPos() const { 1242 return EndOfDirectMethodsPos() + header_.virtual_methods_size_; 1243 } 1244 1245 // A decoded version of the field of a class_data_item 1246 struct ClassDataField { 1247 uint32_t field_idx_delta_; // delta of index into the field_ids array for FieldId 1248 uint32_t access_flags_; // access flags for the field 1249 ClassDataField() : field_idx_delta_(0), access_flags_(0) {} 1250 1251 private: 1252 DISALLOW_COPY_AND_ASSIGN(ClassDataField); 1253 }; 1254 ClassDataField field_; 1255 1256 // Read and decode a field from a class_data_item stream into field 1257 void ReadClassDataField(); 1258 1259 // A decoded version of the method of a class_data_item 1260 struct ClassDataMethod { 1261 uint32_t method_idx_delta_; // delta of index into the method_ids array for MethodId 1262 uint32_t access_flags_; 1263 uint32_t code_off_; 1264 ClassDataMethod() : method_idx_delta_(0), access_flags_(0), code_off_(0) {} 1265 1266 private: 1267 DISALLOW_COPY_AND_ASSIGN(ClassDataMethod); 1268 }; 1269 ClassDataMethod method_; 1270 1271 // Read and decode a method from a class_data_item stream into method 1272 void ReadClassDataMethod(); 1273 1274 const DexFile& dex_file_; 1275 size_t pos_; // integral number of items passed 1276 const uint8_t* ptr_pos_; // pointer into stream of class_data_item 1277 uint32_t last_idx_; // last read field or method index to apply delta to 1278 DISALLOW_IMPLICIT_CONSTRUCTORS(ClassDataItemIterator); 1279}; 1280 1281class EncodedStaticFieldValueIterator { 1282 public: 1283 EncodedStaticFieldValueIterator(const DexFile& dex_file, Handle<mirror::DexCache>* dex_cache, 1284 Handle<mirror::ClassLoader>* class_loader, 1285 ClassLinker* linker, const DexFile::ClassDef& class_def) 1286 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1287 1288 template<bool kTransactionActive> 1289 void ReadValueToField(Handle<mirror::ArtField> field) const SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); 1290 1291 bool HasNext() const { return pos_ < array_size_; } 1292 1293 void Next(); 1294 1295 enum ValueType { 1296 kByte = 0x00, 1297 kShort = 0x02, 1298 kChar = 0x03, 1299 kInt = 0x04, 1300 kLong = 0x06, 1301 kFloat = 0x10, 1302 kDouble = 0x11, 1303 kString = 0x17, 1304 kType = 0x18, 1305 kField = 0x19, 1306 kMethod = 0x1a, 1307 kEnum = 0x1b, 1308 kArray = 0x1c, 1309 kAnnotation = 0x1d, 1310 kNull = 0x1e, 1311 kBoolean = 0x1f 1312 }; 1313 1314 private: 1315 static constexpr uint8_t kEncodedValueTypeMask = 0x1f; // 0b11111 1316 static constexpr uint8_t kEncodedValueArgShift = 5; 1317 1318 const DexFile& dex_file_; 1319 Handle<mirror::DexCache>* const dex_cache_; // Dex cache to resolve literal objects. 1320 Handle<mirror::ClassLoader>* const class_loader_; // ClassLoader to resolve types. 1321 ClassLinker* linker_; // Linker to resolve literal objects. 1322 size_t array_size_; // Size of array. 1323 size_t pos_; // Current position. 1324 const uint8_t* ptr_; // Pointer into encoded data array. 1325 ValueType type_; // Type of current encoded value. 1326 jvalue jval_; // Value of current encoded value. 1327 DISALLOW_IMPLICIT_CONSTRUCTORS(EncodedStaticFieldValueIterator); 1328}; 1329std::ostream& operator<<(std::ostream& os, const EncodedStaticFieldValueIterator::ValueType& code); 1330 1331class CatchHandlerIterator { 1332 public: 1333 CatchHandlerIterator(const DexFile::CodeItem& code_item, uint32_t address); 1334 1335 CatchHandlerIterator(const DexFile::CodeItem& code_item, 1336 const DexFile::TryItem& try_item); 1337 1338 explicit CatchHandlerIterator(const uint8_t* handler_data) { 1339 Init(handler_data); 1340 } 1341 1342 uint16_t GetHandlerTypeIndex() const { 1343 return handler_.type_idx_; 1344 } 1345 uint32_t GetHandlerAddress() const { 1346 return handler_.address_; 1347 } 1348 void Next(); 1349 bool HasNext() const { 1350 return remaining_count_ != -1 || catch_all_; 1351 } 1352 // End of this set of catch blocks, convenience method to locate next set of catch blocks 1353 const uint8_t* EndDataPointer() const { 1354 CHECK(!HasNext()); 1355 return current_data_; 1356 } 1357 1358 private: 1359 void Init(const DexFile::CodeItem& code_item, int32_t offset); 1360 void Init(const uint8_t* handler_data); 1361 1362 struct CatchHandlerItem { 1363 uint16_t type_idx_; // type index of the caught exception type 1364 uint32_t address_; // handler address 1365 } handler_; 1366 const uint8_t* current_data_; // the current handler in dex file. 1367 int32_t remaining_count_; // number of handlers not read. 1368 bool catch_all_; // is there a handler that will catch all exceptions in case 1369 // that all typed handler does not match. 1370}; 1371 1372} // namespace art 1373 1374#endif // ART_RUNTIME_DEX_FILE_H_ 1375