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