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