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