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