1 /*
2 * Copyright (C) 2008 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 * Access .dex (Dalvik Executable Format) files. The code here assumes that
18 * the DEX file has been rewritten (byte-swapped, word-aligned) and that
19 * the contents can be directly accessed as a collection of C arrays. Please
20 * see docs/dalvik/dex-format.html for a detailed description.
21 *
22 * The structure and field names were chosen to match those in the DEX spec.
23 *
24 * It's generally assumed that the DEX file will be stored in shared memory,
25 * obviating the need to copy code and constant pool entries into newly
26 * allocated storage. Maintaining local pointers to items in the shared area
27 * is valid and encouraged.
28 *
29 * All memory-mapped structures are 32-bit aligned unless otherwise noted.
30 */
31 #ifndef _LIBDEX_DEXFILE
32 #define _LIBDEX_DEXFILE
33
34 #include "vm/Common.h" // basic type defs, e.g. u1/u2/u4/u8, and LOG
35 #include "libdex/SysUtil.h"
36
37 /*
38 * gcc-style inline management -- ensures we have a copy of all functions
39 * in the library, so code that links against us will work whether or not
40 * it was built with optimizations enabled.
41 */
42 #ifndef _DEX_GEN_INLINES /* only defined by DexInlines.c */
43 # define DEX_INLINE extern __inline__
44 #else
45 # define DEX_INLINE
46 #endif
47
48 /* DEX file magic number */
49 #define DEX_MAGIC "dex\n"
50 /* version, encoded in 4 bytes of ASCII */
51 #define DEX_MAGIC_VERS "035\0"
52
53 /* same, but for optimized DEX header */
54 #define DEX_OPT_MAGIC "dey\n"
55 #define DEX_OPT_MAGIC_VERS "035\0"
56
57 #define DEX_DEP_MAGIC "deps"
58
59 /*
60 * 160-bit SHA-1 digest.
61 */
62 enum { kSHA1DigestLen = 20,
63 kSHA1DigestOutputLen = kSHA1DigestLen*2 +1 };
64
65 /* general constants */
66 enum {
67 kDexEndianConstant = 0x12345678, /* the endianness indicator */
68 kDexNoIndex = 0xffffffff, /* not a valid index value */
69 };
70
71 /*
72 * access flags and masks; the "standard" ones are all <= 0x4000
73 *
74 * Note: There are related declarations in vm/oo/Object.h in the ClassFlags
75 * enum.
76 */
77 enum {
78 ACC_PUBLIC = 0x00000001, // class, field, method, ic
79 ACC_PRIVATE = 0x00000002, // field, method, ic
80 ACC_PROTECTED = 0x00000004, // field, method, ic
81 ACC_STATIC = 0x00000008, // field, method, ic
82 ACC_FINAL = 0x00000010, // class, field, method, ic
83 ACC_SYNCHRONIZED = 0x00000020, // method (only allowed on natives)
84 ACC_SUPER = 0x00000020, // class (not used in Dalvik)
85 ACC_VOLATILE = 0x00000040, // field
86 ACC_BRIDGE = 0x00000040, // method (1.5)
87 ACC_TRANSIENT = 0x00000080, // field
88 ACC_VARARGS = 0x00000080, // method (1.5)
89 ACC_NATIVE = 0x00000100, // method
90 ACC_INTERFACE = 0x00000200, // class, ic
91 ACC_ABSTRACT = 0x00000400, // class, method, ic
92 ACC_STRICT = 0x00000800, // method
93 ACC_SYNTHETIC = 0x00001000, // field, method, ic
94 ACC_ANNOTATION = 0x00002000, // class, ic (1.5)
95 ACC_ENUM = 0x00004000, // class, field, ic (1.5)
96 ACC_CONSTRUCTOR = 0x00010000, // method (Dalvik only)
97 ACC_DECLARED_SYNCHRONIZED =
98 0x00020000, // method (Dalvik only)
99 ACC_CLASS_MASK =
100 (ACC_PUBLIC | ACC_FINAL | ACC_INTERFACE | ACC_ABSTRACT
101 | ACC_SYNTHETIC | ACC_ANNOTATION | ACC_ENUM),
102 ACC_INNER_CLASS_MASK =
103 (ACC_CLASS_MASK | ACC_PRIVATE | ACC_PROTECTED | ACC_STATIC),
104 ACC_FIELD_MASK =
105 (ACC_PUBLIC | ACC_PRIVATE | ACC_PROTECTED | ACC_STATIC | ACC_FINAL
106 | ACC_VOLATILE | ACC_TRANSIENT | ACC_SYNTHETIC | ACC_ENUM),
107 ACC_METHOD_MASK =
108 (ACC_PUBLIC | ACC_PRIVATE | ACC_PROTECTED | ACC_STATIC | ACC_FINAL
109 | ACC_SYNCHRONIZED | ACC_BRIDGE | ACC_VARARGS | ACC_NATIVE
110 | ACC_ABSTRACT | ACC_STRICT | ACC_SYNTHETIC | ACC_CONSTRUCTOR
111 | ACC_DECLARED_SYNCHRONIZED),
112 };
113
114 /* annotation constants */
115 enum {
116 kDexVisibilityBuild = 0x00, /* annotation visibility */
117 kDexVisibilityRuntime = 0x01,
118 kDexVisibilitySystem = 0x02,
119
120 kDexAnnotationByte = 0x00,
121 kDexAnnotationShort = 0x02,
122 kDexAnnotationChar = 0x03,
123 kDexAnnotationInt = 0x04,
124 kDexAnnotationLong = 0x06,
125 kDexAnnotationFloat = 0x10,
126 kDexAnnotationDouble = 0x11,
127 kDexAnnotationString = 0x17,
128 kDexAnnotationType = 0x18,
129 kDexAnnotationField = 0x19,
130 kDexAnnotationMethod = 0x1a,
131 kDexAnnotationEnum = 0x1b,
132 kDexAnnotationArray = 0x1c,
133 kDexAnnotationAnnotation = 0x1d,
134 kDexAnnotationNull = 0x1e,
135 kDexAnnotationBoolean = 0x1f,
136
137 kDexAnnotationValueTypeMask = 0x1f, /* low 5 bits */
138 kDexAnnotationValueArgShift = 5,
139 };
140
141 /* map item type codes */
142 enum {
143 kDexTypeHeaderItem = 0x0000,
144 kDexTypeStringIdItem = 0x0001,
145 kDexTypeTypeIdItem = 0x0002,
146 kDexTypeProtoIdItem = 0x0003,
147 kDexTypeFieldIdItem = 0x0004,
148 kDexTypeMethodIdItem = 0x0005,
149 kDexTypeClassDefItem = 0x0006,
150 kDexTypeMapList = 0x1000,
151 kDexTypeTypeList = 0x1001,
152 kDexTypeAnnotationSetRefList = 0x1002,
153 kDexTypeAnnotationSetItem = 0x1003,
154 kDexTypeClassDataItem = 0x2000,
155 kDexTypeCodeItem = 0x2001,
156 kDexTypeStringDataItem = 0x2002,
157 kDexTypeDebugInfoItem = 0x2003,
158 kDexTypeAnnotationItem = 0x2004,
159 kDexTypeEncodedArrayItem = 0x2005,
160 kDexTypeAnnotationsDirectoryItem = 0x2006,
161 };
162
163 /* auxillary data section chunk codes */
164 enum {
165 kDexChunkClassLookup = 0x434c4b50, /* CLKP */
166
167 kDexChunkReducingIndexMap = 0x5249584d, /* RIXM */
168 kDexChunkExpandingIndexMap = 0x4549584d, /* EIXM */
169
170 kDexChunkEnd = 0x41454e44, /* AEND */
171 };
172
173 /* debug info opcodes and constants */
174 enum {
175 DBG_END_SEQUENCE = 0x00,
176 DBG_ADVANCE_PC = 0x01,
177 DBG_ADVANCE_LINE = 0x02,
178 DBG_START_LOCAL = 0x03,
179 DBG_START_LOCAL_EXTENDED = 0x04,
180 DBG_END_LOCAL = 0x05,
181 DBG_RESTART_LOCAL = 0x06,
182 DBG_SET_PROLOGUE_END = 0x07,
183 DBG_SET_EPILOGUE_BEGIN = 0x08,
184 DBG_SET_FILE = 0x09,
185 DBG_FIRST_SPECIAL = 0x0a,
186 DBG_LINE_BASE = -4,
187 DBG_LINE_RANGE = 15,
188 };
189
190 /*
191 * Direct-mapped "header_item" struct.
192 */
193 typedef struct DexHeader {
194 u1 magic[8]; /* includes version number */
195 u4 checksum; /* adler32 checksum */
196 u1 signature[kSHA1DigestLen]; /* SHA-1 hash */
197 u4 fileSize; /* length of entire file */
198 u4 headerSize; /* offset to start of next section */
199 u4 endianTag;
200 u4 linkSize;
201 u4 linkOff;
202 u4 mapOff;
203 u4 stringIdsSize;
204 u4 stringIdsOff;
205 u4 typeIdsSize;
206 u4 typeIdsOff;
207 u4 protoIdsSize;
208 u4 protoIdsOff;
209 u4 fieldIdsSize;
210 u4 fieldIdsOff;
211 u4 methodIdsSize;
212 u4 methodIdsOff;
213 u4 classDefsSize;
214 u4 classDefsOff;
215 u4 dataSize;
216 u4 dataOff;
217 } DexHeader;
218
219 /*
220 * Direct-mapped "map_item".
221 */
222 typedef struct DexMapItem {
223 u2 type; /* type code (see kDexType* above) */
224 u2 unused;
225 u4 size; /* count of items of the indicated type */
226 u4 offset; /* file offset to the start of data */
227 } DexMapItem;
228
229 /*
230 * Direct-mapped "map_list".
231 */
232 typedef struct DexMapList {
233 u4 size; /* #of entries in list */
234 DexMapItem list[1]; /* entries */
235 } DexMapList;
236
237 /*
238 * Direct-mapped "string_id_item".
239 */
240 typedef struct DexStringId {
241 u4 stringDataOff; /* file offset to string_data_item */
242 } DexStringId;
243
244 /*
245 * Direct-mapped "type_id_item".
246 */
247 typedef struct DexTypeId {
248 u4 descriptorIdx; /* index into stringIds list for type descriptor */
249 } DexTypeId;
250
251 /*
252 * Direct-mapped "field_id_item".
253 */
254 typedef struct DexFieldId {
255 u2 classIdx; /* index into typeIds list for defining class */
256 u2 typeIdx; /* index into typeIds for field type */
257 u4 nameIdx; /* index into stringIds for field name */
258 } DexFieldId;
259
260 /*
261 * Direct-mapped "method_id_item".
262 */
263 typedef struct DexMethodId {
264 u2 classIdx; /* index into typeIds list for defining class */
265 u2 protoIdx; /* index into protoIds for method prototype */
266 u4 nameIdx; /* index into stringIds for method name */
267 } DexMethodId;
268
269 /*
270 * Direct-mapped "proto_id_item".
271 */
272 typedef struct DexProtoId {
273 u4 shortyIdx; /* index into stringIds for shorty descriptor */
274 u4 returnTypeIdx; /* index into typeIds list for return type */
275 u4 parametersOff; /* file offset to type_list for parameter types */
276 } DexProtoId;
277
278 /*
279 * Direct-mapped "class_def_item".
280 */
281 typedef struct DexClassDef {
282 u4 classIdx; /* index into typeIds for this class */
283 u4 accessFlags;
284 u4 superclassIdx; /* index into typeIds for superclass */
285 u4 interfacesOff; /* file offset to DexTypeList */
286 u4 sourceFileIdx; /* index into stringIds for source file name */
287 u4 annotationsOff; /* file offset to annotations_directory_item */
288 u4 classDataOff; /* file offset to class_data_item */
289 u4 staticValuesOff; /* file offset to DexEncodedArray */
290 } DexClassDef;
291
292 /*
293 * Direct-mapped "type_item".
294 */
295 typedef struct DexTypeItem {
296 u2 typeIdx; /* index into typeIds */
297 } DexTypeItem;
298
299 /*
300 * Direct-mapped "type_list".
301 */
302 typedef struct DexTypeList {
303 u4 size; /* #of entries in list */
304 DexTypeItem list[1]; /* entries */
305 } DexTypeList;
306
307 /*
308 * Direct-mapped "code_item".
309 *
310 * The "catches" table is used when throwing an exception,
311 * "debugInfo" is used when displaying an exception stack trace or
312 * debugging. An offset of zero indicates that there are no entries.
313 */
314 typedef struct DexCode {
315 u2 registersSize;
316 u2 insSize;
317 u2 outsSize;
318 u2 triesSize;
319 u4 debugInfoOff; /* file offset to debug info stream */
320 u4 insnsSize; /* size of the insns array, in u2 units */
321 u2 insns[1];
322 /* followed by optional u2 padding */
323 /* followed by try_item[triesSize] */
324 /* followed by uleb128 handlersSize */
325 /* followed by catch_handler_item[handlersSize] */
326 } DexCode;
327
328 /*
329 * Direct-mapped "try_item".
330 */
331 typedef struct DexTry {
332 u4 startAddr; /* start address, in 16-bit code units */
333 u2 insnCount; /* instruction count, in 16-bit code units */
334 u2 handlerOff; /* offset in encoded handler data to handlers */
335 } DexTry;
336
337 /*
338 * Link table. Currently undefined.
339 */
340 typedef struct DexLink {
341 u1 bleargh;
342 } DexLink;
343
344
345 /*
346 * Direct-mapped "annotations_directory_item".
347 */
348 typedef struct DexAnnotationsDirectoryItem {
349 u4 classAnnotationsOff; /* offset to DexAnnotationSetItem */
350 u4 fieldsSize; /* count of DexFieldAnnotationsItem */
351 u4 methodsSize; /* count of DexMethodAnnotationsItem */
352 u4 parametersSize; /* count of DexParameterAnnotationsItem */
353 /* followed by DexFieldAnnotationsItem[fieldsSize] */
354 /* followed by DexMethodAnnotationsItem[methodsSize] */
355 /* followed by DexParameterAnnotationsItem[parametersSize] */
356 } DexAnnotationsDirectoryItem;
357
358 /*
359 * Direct-mapped "field_annotations_item".
360 */
361 typedef struct DexFieldAnnotationsItem {
362 u4 fieldIdx;
363 u4 annotationsOff; /* offset to DexAnnotationSetItem */
364 } DexFieldAnnotationsItem;
365
366 /*
367 * Direct-mapped "method_annotations_item".
368 */
369 typedef struct DexMethodAnnotationsItem {
370 u4 methodIdx;
371 u4 annotationsOff; /* offset to DexAnnotationSetItem */
372 } DexMethodAnnotationsItem;
373
374 /*
375 * Direct-mapped "parameter_annotations_item".
376 */
377 typedef struct DexParameterAnnotationsItem {
378 u4 methodIdx;
379 u4 annotationsOff; /* offset to DexAnotationSetRefList */
380 } DexParameterAnnotationsItem;
381
382 /*
383 * Direct-mapped "annotation_set_ref_item".
384 */
385 typedef struct DexAnnotationSetRefItem {
386 u4 annotationsOff; /* offset to DexAnnotationSetItem */
387 } DexAnnotationSetRefItem;
388
389 /*
390 * Direct-mapped "annotation_set_ref_list".
391 */
392 typedef struct DexAnnotationSetRefList {
393 u4 size;
394 DexAnnotationSetRefItem list[1];
395 } DexAnnotationSetRefList;
396
397 /*
398 * Direct-mapped "anotation_set_item".
399 */
400 typedef struct DexAnnotationSetItem {
401 u4 size;
402 u4 entries[1]; /* offset to DexAnnotationItem */
403 } DexAnnotationSetItem;
404
405 /*
406 * Direct-mapped "annotation_item".
407 *
408 * NOTE: this structure is byte-aligned.
409 */
410 typedef struct DexAnnotationItem {
411 u1 visibility;
412 u1 annotation[1]; /* data in encoded_annotation format */
413 } DexAnnotationItem;
414
415 /*
416 * Direct-mapped "encoded_array".
417 *
418 * NOTE: this structure is byte-aligned.
419 */
420 typedef struct DexEncodedArray {
421 u1 array[1]; /* data in encoded_array format */
422 } DexEncodedArray;
423
424 /*
425 * Lookup table for classes. It provides a mapping from class name to
426 * class definition. Used by dexFindClass().
427 *
428 * We calculate this at DEX optimization time and embed it in the file so we
429 * don't need the same hash table in every VM. This is slightly slower than
430 * a hash table with direct pointers to the items, but because it's shared
431 * there's less of a penalty for using a fairly sparse table.
432 */
433 typedef struct DexClassLookup {
434 int size; // total size, including "size"
435 int numEntries; // size of table[]; always power of 2
436 struct {
437 u4 classDescriptorHash; // class descriptor hash code
438 int classDescriptorOffset; // in bytes, from start of DEX
439 int classDefOffset; // in bytes, from start of DEX
440 } table[1];
441 } DexClassLookup;
442
443 /*
444 * Map constant pool indices from one form to another. Some or all of these
445 * may be NULL.
446 *
447 * The map values are 16-bit unsigned values. If the values we map to
448 * require a larger range, we omit the mapping for that category (which
449 * requires that the lookup code recognize that the data will not be
450 * there for all DEX files in all categories.)
451 */
452 typedef struct DexIndexMap {
453 const u2* classMap; /* map, either expanding or reducing */
454 u4 classFullCount; /* same as typeIdsSize */
455 u4 classReducedCount; /* post-reduction count */
456 const u2* methodMap;
457 u4 methodFullCount;
458 u4 methodReducedCount;
459 const u2* fieldMap;
460 u4 fieldFullCount;
461 u4 fieldReducedCount;
462 const u2* stringMap;
463 u4 stringFullCount;
464 u4 stringReducedCount;
465 } DexIndexMap;
466
467 /*
468 * Header added by DEX optimization pass. Values are always written in
469 * local byte and structure padding. The first field (magic + version)
470 * is guaranteed to be present and directly readable for all expected
471 * compiler configurations; the rest is version-dependent.
472 *
473 * Try to keep this simple and fixed-size.
474 */
475 typedef struct DexOptHeader {
476 u1 magic[8]; /* includes version number */
477
478 u4 dexOffset; /* file offset of DEX header */
479 u4 dexLength;
480 u4 depsOffset; /* offset of optimized DEX dependency table */
481 u4 depsLength;
482 u4 auxOffset; /* file offset of pre-calc auxillary data */
483 u4 auxLength;
484
485 u4 flags; /* some info flags */
486
487 u4 padding; /* induce 64-bit alignment */
488 } DexOptHeader;
489
490 #define DEX_FLAG_VERIFIED (1) /* tried to verify all classes */
491 #define DEX_OPT_FLAG_BIG (1<<1) /* swapped to big-endian */
492 #define DEX_OPT_FLAG_FIELDS (1<<2) /* field access optimized */
493 #define DEX_OPT_FLAG_INVOCATIONS (1<<3) /* method calls optimized */
494
495 #define DEX_INTERFACE_CACHE_SIZE 128 /* must be power of 2 */
496
497 /*
498 * Structure representing a DEX file.
499 *
500 * Code should regard DexFile as opaque, using the API calls provided here
501 * to access specific structures.
502 */
503 typedef struct DexFile {
504 /* directly-mapped "opt" header */
505 const DexOptHeader* pOptHeader;
506
507 /* pointers to directly-mapped structs and arrays in base DEX */
508 const DexHeader* pHeader;
509 const DexStringId* pStringIds;
510 const DexTypeId* pTypeIds;
511 const DexFieldId* pFieldIds;
512 const DexMethodId* pMethodIds;
513 const DexProtoId* pProtoIds;
514 const DexClassDef* pClassDefs;
515 const DexLink* pLinkData;
516
517 /* mapped in "auxillary" section */
518 const DexClassLookup* pClassLookup;
519
520 /* mapped in "auxillary" section */
521 DexIndexMap indexMap;
522
523 /* points to start of DEX file data */
524 const u1* baseAddr;
525
526 /* track memory overhead for auxillary structures */
527 int overhead;
528
529 /* additional app-specific data structures associated with the DEX */
530 //void* auxData;
531 } DexFile;
532
533 /*
534 * Utility function -- rounds up to the nearest power of 2.
535 */
536 u4 dexRoundUpPower2(u4 val);
537
538 /*
539 * Parse an optimized or unoptimized .dex file sitting in memory.
540 *
541 * On success, return a newly-allocated DexFile.
542 */
543 DexFile* dexFileParse(const u1* data, size_t length, int flags);
544
545 /* bit values for "flags" argument to dexFileParse */
546 enum {
547 kDexParseDefault = 0,
548 kDexParseVerifyChecksum = 1,
549 kDexParseContinueOnError = (1 << 1),
550 };
551
552 /*
553 * Correct the byte ordering in a memory-mapped DEX file. This is only
554 * required for code that opens "raw" DEX files, such as the DEX optimizer.
555 *
556 * Return 0 on success.
557 */
558 int dexFixByteOrdering(u1* addr, int len);
559
560 /*
561 * Compute DEX checksum.
562 */
563 u4 dexComputeChecksum(const DexHeader* pHeader);
564
565 /*
566 * Free a DexFile structure, along with any associated structures.
567 */
568 void dexFileFree(DexFile* pDexFile);
569
570 /*
571 * Create class lookup table.
572 */
573 DexClassLookup* dexCreateClassLookup(DexFile* pDexFile);
574
575 /*
576 * Find a class definition by descriptor.
577 */
578 const DexClassDef* dexFindClass(const DexFile* pFile, const char* descriptor);
579
580 /*
581 * Set up the basic raw data pointers of a DexFile. This function isn't
582 * meant for general use.
583 */
584 void dexFileSetupBasicPointers(DexFile* pDexFile, const u1* data);
585
586 /* return the DexMapList of the file, if any */
dexGetMap(const DexFile * pDexFile)587 DEX_INLINE const DexMapList* dexGetMap(const DexFile* pDexFile) {
588 u4 mapOff = pDexFile->pHeader->mapOff;
589
590 if (mapOff == 0) {
591 return NULL;
592 } else {
593 return (const DexMapList*) (pDexFile->baseAddr + mapOff);
594 }
595 }
596
597 /* return the const char* string data referred to by the given string_id */
dexGetStringData(const DexFile * pDexFile,const DexStringId * pStringId)598 DEX_INLINE const char* dexGetStringData(const DexFile* pDexFile,
599 const DexStringId* pStringId) {
600 const u1* ptr = pDexFile->baseAddr + pStringId->stringDataOff;
601
602 // Skip the uleb128 length.
603 while (*(ptr++) > 0x7f) /* empty */ ;
604
605 return (const char*) ptr;
606 }
607 /* return the StringId with the specified index */
dexGetStringId(const DexFile * pDexFile,u4 idx)608 DEX_INLINE const DexStringId* dexGetStringId(const DexFile* pDexFile, u4 idx) {
609 assert(idx < pDexFile->pHeader->stringIdsSize);
610 return &pDexFile->pStringIds[idx];
611 }
612 /* return the UTF-8 encoded string with the specified string_id index */
dexStringById(const DexFile * pDexFile,u4 idx)613 DEX_INLINE const char* dexStringById(const DexFile* pDexFile, u4 idx) {
614 const DexStringId* pStringId = dexGetStringId(pDexFile, idx);
615 return dexGetStringData(pDexFile, pStringId);
616 }
617
618 /* Return the UTF-8 encoded string with the specified string_id index,
619 * also filling in the UTF-16 size (number of 16-bit code points).*/
620 const char* dexStringAndSizeById(const DexFile* pDexFile, u4 idx,
621 u4* utf16Size);
622
623 /* return the TypeId with the specified index */
dexGetTypeId(const DexFile * pDexFile,u4 idx)624 DEX_INLINE const DexTypeId* dexGetTypeId(const DexFile* pDexFile, u4 idx) {
625 assert(idx < pDexFile->pHeader->typeIdsSize);
626 return &pDexFile->pTypeIds[idx];
627 }
628
629 /*
630 * Get the descriptor string associated with a given type index.
631 * The caller should not free() the returned string.
632 */
dexStringByTypeIdx(const DexFile * pDexFile,u4 idx)633 DEX_INLINE const char* dexStringByTypeIdx(const DexFile* pDexFile, u4 idx) {
634 const DexTypeId* typeId = dexGetTypeId(pDexFile, idx);
635 return dexStringById(pDexFile, typeId->descriptorIdx);
636 }
637
638 /* return the MethodId with the specified index */
dexGetMethodId(const DexFile * pDexFile,u4 idx)639 DEX_INLINE const DexMethodId* dexGetMethodId(const DexFile* pDexFile, u4 idx) {
640 assert(idx < pDexFile->pHeader->methodIdsSize);
641 return &pDexFile->pMethodIds[idx];
642 }
643
644 /* return the FieldId with the specified index */
dexGetFieldId(const DexFile * pDexFile,u4 idx)645 DEX_INLINE const DexFieldId* dexGetFieldId(const DexFile* pDexFile, u4 idx) {
646 assert(idx < pDexFile->pHeader->fieldIdsSize);
647 return &pDexFile->pFieldIds[idx];
648 }
649
650 /* return the ProtoId with the specified index */
dexGetProtoId(const DexFile * pDexFile,u4 idx)651 DEX_INLINE const DexProtoId* dexGetProtoId(const DexFile* pDexFile, u4 idx) {
652 assert(idx < pDexFile->pHeader->protoIdsSize);
653 return &pDexFile->pProtoIds[idx];
654 }
655
656 /*
657 * Get the parameter list from a ProtoId. The returns NULL if the ProtoId
658 * does not have a parameter list.
659 */
dexGetProtoParameters(const DexFile * pDexFile,const DexProtoId * pProtoId)660 DEX_INLINE const DexTypeList* dexGetProtoParameters(
661 const DexFile *pDexFile, const DexProtoId* pProtoId) {
662 if (pProtoId->parametersOff == 0) {
663 return NULL;
664 }
665 return (const DexTypeList*)
666 (pDexFile->baseAddr + pProtoId->parametersOff);
667 }
668
669 /* return the ClassDef with the specified index */
dexGetClassDef(const DexFile * pDexFile,u4 idx)670 DEX_INLINE const DexClassDef* dexGetClassDef(const DexFile* pDexFile, u4 idx) {
671 assert(idx < pDexFile->pHeader->classDefsSize);
672 return &pDexFile->pClassDefs[idx];
673 }
674
675 /* get the interface list for a DexClass */
dexGetInterfacesList(const DexFile * pDexFile,const DexClassDef * pClassDef)676 DEX_INLINE const DexTypeList* dexGetInterfacesList(const DexFile* pDexFile,
677 const DexClassDef* pClassDef)
678 {
679 if (pClassDef->interfacesOff == 0)
680 return NULL;
681 return (const DexTypeList*)
682 (pDexFile->baseAddr + pClassDef->interfacesOff);
683 }
684 /* return the Nth entry in a DexTypeList. */
dexGetTypeItem(const DexTypeList * pList,u4 idx)685 DEX_INLINE const DexTypeItem* dexGetTypeItem(const DexTypeList* pList,
686 u4 idx)
687 {
688 assert(idx < pList->size);
689 return &pList->list[idx];
690 }
691 /* return the type_idx for the Nth entry in a TypeList */
dexTypeListGetIdx(const DexTypeList * pList,u4 idx)692 DEX_INLINE u4 dexTypeListGetIdx(const DexTypeList* pList, u4 idx) {
693 const DexTypeItem* pItem = dexGetTypeItem(pList, idx);
694 return pItem->typeIdx;
695 }
696
697 /* get the static values list for a DexClass */
dexGetStaticValuesList(const DexFile * pDexFile,const DexClassDef * pClassDef)698 DEX_INLINE const DexEncodedArray* dexGetStaticValuesList(
699 const DexFile* pDexFile, const DexClassDef* pClassDef)
700 {
701 if (pClassDef->staticValuesOff == 0)
702 return NULL;
703 return (const DexEncodedArray*)
704 (pDexFile->baseAddr + pClassDef->staticValuesOff);
705 }
706
707 /* get the annotations directory item for a DexClass */
dexGetAnnotationsDirectoryItem(const DexFile * pDexFile,const DexClassDef * pClassDef)708 DEX_INLINE const DexAnnotationsDirectoryItem* dexGetAnnotationsDirectoryItem(
709 const DexFile* pDexFile, const DexClassDef* pClassDef)
710 {
711 if (pClassDef->annotationsOff == 0)
712 return NULL;
713 return (const DexAnnotationsDirectoryItem*)
714 (pDexFile->baseAddr + pClassDef->annotationsOff);
715 }
716
717 /* get the source file string */
dexGetSourceFile(const DexFile * pDexFile,const DexClassDef * pClassDef)718 DEX_INLINE const char* dexGetSourceFile(
719 const DexFile* pDexFile, const DexClassDef* pClassDef)
720 {
721 if (pClassDef->sourceFileIdx == 0xffffffff)
722 return NULL;
723 return dexStringById(pDexFile, pClassDef->sourceFileIdx);
724 }
725
726 /* Get the list of "tries" for the given DexCode. */
dexGetTries(const DexCode * pCode)727 DEX_INLINE const DexTry* dexGetTries(const DexCode* pCode) {
728 const u2* insnsEnd = &pCode->insns[pCode->insnsSize];
729
730 // Round to four bytes.
731 if ((((u4) insnsEnd) & 3) != 0) {
732 insnsEnd++;
733 }
734
735 return (const DexTry*) insnsEnd;
736 }
737
738 /* Get the base of the encoded data for the given DexCode. */
dexGetCatchHandlerData(const DexCode * pCode)739 DEX_INLINE const u1* dexGetCatchHandlerData(const DexCode* pCode) {
740 const DexTry* pTries = dexGetTries(pCode);
741 return (const u1*) &pTries[pCode->triesSize];
742 }
743
dexGetDebugInfoStream(const DexFile * pDexFile,const DexCode * pCode)744 DEX_INLINE const u1* dexGetDebugInfoStream(const DexFile* pDexFile,
745 const DexCode* pCode)
746 {
747 if (pCode->debugInfoOff == 0) {
748 return NULL;
749 } else {
750 return pDexFile->baseAddr + pCode->debugInfoOff;
751 }
752 }
753
754 /*
755 * Callback for "new position table entry".
756 * Returning non-0 causes the decoder to stop early.
757 */
758 typedef int (*DexDebugNewPositionCb)(void *cnxt, u4 address, u4 lineNum);
759
760 /*
761 * Callback for "new locals table entry". "signature" is an empty string
762 * if no signature is available for an entry.
763 */
764 typedef void (*DexDebugNewLocalCb)(void *cnxt, u2 reg, u4 startAddress,
765 u4 endAddress, const char *name, const char *descriptor,
766 const char *signature);
767
768 /*
769 * Decode debug info for method.
770 *
771 * posCb is called in ascending address order.
772 * localCb is called in order of ascending end address.
773 */
774 void dexDecodeDebugInfo(
775 const DexFile* pDexFile,
776 const DexCode* pDexCode,
777 const char* classDescriptor,
778 u4 protoIdx,
779 u4 accessFlags,
780 DexDebugNewPositionCb posCb, DexDebugNewLocalCb localCb,
781 void* cnxt);
782
783 /* DexClassDef convenience - get class descriptor */
dexGetClassDescriptor(const DexFile * pDexFile,const DexClassDef * pClassDef)784 DEX_INLINE const char* dexGetClassDescriptor(const DexFile* pDexFile,
785 const DexClassDef* pClassDef)
786 {
787 return dexStringByTypeIdx(pDexFile, pClassDef->classIdx);
788 }
789
790 /* DexClassDef convenience - get superclass descriptor */
dexGetSuperClassDescriptor(const DexFile * pDexFile,const DexClassDef * pClassDef)791 DEX_INLINE const char* dexGetSuperClassDescriptor(const DexFile* pDexFile,
792 const DexClassDef* pClassDef)
793 {
794 if (pClassDef->superclassIdx == 0)
795 return NULL;
796 return dexStringByTypeIdx(pDexFile, pClassDef->superclassIdx);
797 }
798
799 /* DexClassDef convenience - get class_data_item pointer */
dexGetClassData(const DexFile * pDexFile,const DexClassDef * pClassDef)800 DEX_INLINE const u1* dexGetClassData(const DexFile* pDexFile,
801 const DexClassDef* pClassDef)
802 {
803 if (pClassDef->classDataOff == 0)
804 return NULL;
805 return (const u1*) (pDexFile->baseAddr + pClassDef->classDataOff);
806 }
807
808 /* Get an annotation set at a particular offset. */
dexGetAnnotationSetItem(const DexFile * pDexFile,u4 offset)809 DEX_INLINE const DexAnnotationSetItem* dexGetAnnotationSetItem(
810 const DexFile* pDexFile, u4 offset)
811 {
812 return (const DexAnnotationSetItem*) (pDexFile->baseAddr + offset);
813 }
814 /* get the class' annotation set */
dexGetClassAnnotationSet(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)815 DEX_INLINE const DexAnnotationSetItem* dexGetClassAnnotationSet(
816 const DexFile* pDexFile, const DexAnnotationsDirectoryItem* pAnnoDir)
817 {
818 if (pAnnoDir->classAnnotationsOff == 0)
819 return NULL;
820 return dexGetAnnotationSetItem(pDexFile, pAnnoDir->classAnnotationsOff);
821 }
822
823 /* get the class' field annotation list */
dexGetFieldAnnotations(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)824 DEX_INLINE const DexFieldAnnotationsItem* dexGetFieldAnnotations(
825 const DexFile* pDexFile, const DexAnnotationsDirectoryItem* pAnnoDir)
826 {
827 if (pAnnoDir->fieldsSize == 0)
828 return NULL;
829
830 // Skip past the header to the start of the field annotations.
831 return (const DexFieldAnnotationsItem*) &pAnnoDir[1];
832 }
833
834 /* get field annotation list size */
dexGetFieldAnnotationsSize(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)835 DEX_INLINE int dexGetFieldAnnotationsSize(const DexFile* pDexFile,
836 const DexAnnotationsDirectoryItem* pAnnoDir)
837 {
838 return pAnnoDir->fieldsSize;
839 }
840
841 /* return a pointer to the field's annotation set */
dexGetFieldAnnotationSetItem(const DexFile * pDexFile,const DexFieldAnnotationsItem * pItem)842 DEX_INLINE const DexAnnotationSetItem* dexGetFieldAnnotationSetItem(
843 const DexFile* pDexFile, const DexFieldAnnotationsItem* pItem)
844 {
845 return dexGetAnnotationSetItem(pDexFile, pItem->annotationsOff);
846 }
847
848 /* get the class' method annotation list */
dexGetMethodAnnotations(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)849 DEX_INLINE const DexMethodAnnotationsItem* dexGetMethodAnnotations(
850 const DexFile* pDexFile, const DexAnnotationsDirectoryItem* pAnnoDir)
851 {
852 if (pAnnoDir->methodsSize == 0)
853 return NULL;
854
855 /*
856 * Skip past the header and field annotations to the start of the
857 * method annotations.
858 */
859 const u1* addr = (const u1*) &pAnnoDir[1];
860 addr += pAnnoDir->fieldsSize * sizeof (DexFieldAnnotationsItem);
861 return (const DexMethodAnnotationsItem*) addr;
862 }
863
864 /* get method annotation list size */
dexGetMethodAnnotationsSize(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)865 DEX_INLINE int dexGetMethodAnnotationsSize(const DexFile* pDexFile,
866 const DexAnnotationsDirectoryItem* pAnnoDir)
867 {
868 return pAnnoDir->methodsSize;
869 }
870
871 /* return a pointer to the method's annotation set */
dexGetMethodAnnotationSetItem(const DexFile * pDexFile,const DexMethodAnnotationsItem * pItem)872 DEX_INLINE const DexAnnotationSetItem* dexGetMethodAnnotationSetItem(
873 const DexFile* pDexFile, const DexMethodAnnotationsItem* pItem)
874 {
875 return dexGetAnnotationSetItem(pDexFile, pItem->annotationsOff);
876 }
877
878 /* get the class' parameter annotation list */
dexGetParameterAnnotations(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)879 DEX_INLINE const DexParameterAnnotationsItem* dexGetParameterAnnotations(
880 const DexFile* pDexFile, const DexAnnotationsDirectoryItem* pAnnoDir)
881 {
882 if (pAnnoDir->parametersSize == 0)
883 return NULL;
884
885 /*
886 * Skip past the header, field annotations, and method annotations
887 * to the start of the parameter annotations.
888 */
889 const u1* addr = (const u1*) &pAnnoDir[1];
890 addr += pAnnoDir->fieldsSize * sizeof (DexFieldAnnotationsItem);
891 addr += pAnnoDir->methodsSize * sizeof (DexMethodAnnotationsItem);
892 return (const DexParameterAnnotationsItem*) addr;
893 }
894
895 /* get method annotation list size */
dexGetParameterAnnotationsSize(const DexFile * pDexFile,const DexAnnotationsDirectoryItem * pAnnoDir)896 DEX_INLINE int dexGetParameterAnnotationsSize(const DexFile* pDexFile,
897 const DexAnnotationsDirectoryItem* pAnnoDir)
898 {
899 return pAnnoDir->parametersSize;
900 }
901
902 /* return the parameter annotation ref list */
dexGetParameterAnnotationSetRefList(const DexFile * pDexFile,const DexParameterAnnotationsItem * pItem)903 DEX_INLINE const DexAnnotationSetRefList* dexGetParameterAnnotationSetRefList(
904 const DexFile* pDexFile, const DexParameterAnnotationsItem* pItem)
905 {
906 return (const DexAnnotationSetRefList*)
907 (pDexFile->baseAddr + pItem->annotationsOff);
908 }
909
910 /* get method annotation list size */
dexGetParameterAnnotationSetRefSize(const DexFile * pDexFile,const DexParameterAnnotationsItem * pItem)911 DEX_INLINE int dexGetParameterAnnotationSetRefSize(const DexFile* pDexFile,
912 const DexParameterAnnotationsItem* pItem)
913 {
914 if (pItem->annotationsOff == 0)
915 return 0;
916 return dexGetParameterAnnotationSetRefList(pDexFile, pItem)->size;
917 }
918
919 /* return the Nth entry from an annotation set ref list */
dexGetParameterAnnotationSetRef(const DexAnnotationSetRefList * pList,u4 idx)920 DEX_INLINE const DexAnnotationSetRefItem* dexGetParameterAnnotationSetRef(
921 const DexAnnotationSetRefList* pList, u4 idx)
922 {
923 assert(idx < pList->size);
924 return &pList->list[idx];
925 }
926
927 /* given a DexAnnotationSetRefItem, return the DexAnnotationSetItem */
dexGetSetRefItemItem(const DexFile * pDexFile,const DexAnnotationSetRefItem * pItem)928 DEX_INLINE const DexAnnotationSetItem* dexGetSetRefItemItem(
929 const DexFile* pDexFile, const DexAnnotationSetRefItem* pItem)
930 {
931 return dexGetAnnotationSetItem(pDexFile, pItem->annotationsOff);
932 }
933
934 /* return the Nth annotation offset from a DexAnnotationSetItem */
dexGetAnnotationOff(const DexAnnotationSetItem * pAnnoSet,u4 idx)935 DEX_INLINE u4 dexGetAnnotationOff(
936 const DexAnnotationSetItem* pAnnoSet, u4 idx)
937 {
938 assert(idx < pAnnoSet->size);
939 return pAnnoSet->entries[idx];
940 }
941
942 /* return the Nth annotation item from a DexAnnotationSetItem */
dexGetAnnotationItem(const DexFile * pDexFile,const DexAnnotationSetItem * pAnnoSet,u4 idx)943 DEX_INLINE const DexAnnotationItem* dexGetAnnotationItem(
944 const DexFile* pDexFile, const DexAnnotationSetItem* pAnnoSet, u4 idx)
945 {
946 return (const DexAnnotationItem*)
947 (pDexFile->baseAddr + dexGetAnnotationOff(pAnnoSet, idx));
948 }
949
950
951 /*
952 * ===========================================================================
953 * Utility Functions
954 * ===========================================================================
955 */
956
957 /*
958 * Retrieve the next UTF-16 character from a UTF-8 string.
959 *
960 * Advances "*pUtf8Ptr" to the start of the next character.
961 *
962 * WARNING: If a string is corrupted by dropping a '\0' in the middle
963 * of a 3-byte sequence, you can end up overrunning the buffer with
964 * reads (and possibly with the writes if the length was computed and
965 * cached before the damage). For performance reasons, this function
966 * assumes that the string being parsed is known to be valid (e.g., by
967 * already being verified). Most strings we process here are coming
968 * out of dex files or other internal translations, so the only real
969 * risk comes from the JNI NewStringUTF call.
970 */
dexGetUtf16FromUtf8(const char ** pUtf8Ptr)971 DEX_INLINE u2 dexGetUtf16FromUtf8(const char** pUtf8Ptr)
972 {
973 unsigned int one, two, three;
974
975 one = *(*pUtf8Ptr)++;
976 if ((one & 0x80) != 0) {
977 /* two- or three-byte encoding */
978 two = *(*pUtf8Ptr)++;
979 if ((one & 0x20) != 0) {
980 /* three-byte encoding */
981 three = *(*pUtf8Ptr)++;
982 return ((one & 0x0f) << 12) |
983 ((two & 0x3f) << 6) |
984 (three & 0x3f);
985 } else {
986 /* two-byte encoding */
987 return ((one & 0x1f) << 6) |
988 (two & 0x3f);
989 }
990 } else {
991 /* one-byte encoding */
992 return one;
993 }
994 }
995
996 /* Compare two '\0'-terminated modified UTF-8 strings, using Unicode
997 * code point values for comparison. This treats different encodings
998 * for the same code point as equivalent, except that only a real '\0'
999 * byte is considered the string terminator. The return value is as
1000 * for strcmp(). */
1001 int dexUtf8Cmp(const char* s1, const char* s2);
1002
1003
1004 /* for dexIsValidMemberNameUtf8(), a bit vector indicating valid low ascii */
1005 extern u4 DEX_MEMBER_VALID_LOW_ASCII[4];
1006
1007 /* Helper for dexIsValidMemberUtf8(); do not call directly. */
1008 bool dexIsValidMemberNameUtf8_0(const char** pUtf8Ptr);
1009
1010 /* Return whether the pointed-at modified-UTF-8 encoded character is
1011 * valid as part of a member name, updating the pointer to point past
1012 * the consumed character. This will consume two encoded UTF-16 code
1013 * points if the character is encoded as a surrogate pair. Also, if
1014 * this function returns false, then the given pointer may only have
1015 * been partially advanced. */
dexIsValidMemberNameUtf8(const char ** pUtf8Ptr)1016 DEX_INLINE bool dexIsValidMemberNameUtf8(const char** pUtf8Ptr) {
1017 u1 c = (u1) **pUtf8Ptr;
1018 if (c <= 0x7f) {
1019 // It's low-ascii, so check the table.
1020 u4 wordIdx = c >> 5;
1021 u4 bitIdx = c & 0x1f;
1022 (*pUtf8Ptr)++;
1023 return (DEX_MEMBER_VALID_LOW_ASCII[wordIdx] & (1 << bitIdx)) != 0;
1024 }
1025
1026 /*
1027 * It's a multibyte encoded character. Call a non-inline function
1028 * for the heavy lifting.
1029 */
1030 return dexIsValidMemberNameUtf8_0(pUtf8Ptr);
1031 }
1032
1033 /* Return whether the given string is a valid field or method name. */
1034 bool dexIsValidMemberName(const char* s);
1035
1036 /* Return whether the given string is a valid type descriptor. */
1037 bool dexIsValidTypeDescriptor(const char* s);
1038
1039 /* Return whether the given string is a valid reference descriptor. This
1040 * is true if dexIsValidTypeDescriptor() returns true and the descriptor
1041 * is for a class or array and not a primitive type. */
1042 bool dexIsReferenceDescriptor(const char* s);
1043
1044 /* Return whether the given string is a valid class descriptor. This
1045 * is true if dexIsValidTypeDescriptor() returns true and the descriptor
1046 * is for a class and not an array or primitive type. */
1047 bool dexIsClassDescriptor(const char* s);
1048
1049 /* Return whether the given string is a valid field type descriptor. This
1050 * is true if dexIsValidTypeDescriptor() returns true and the descriptor
1051 * is for anything but "void". */
1052 bool dexIsFieldDescriptor(const char* s);
1053
1054 #endif /*_LIBDEX_DEXFILE*/
1055