blob: 9536381ed0404cdb23e5120de5c83109c8be0826 [file] [log] [blame]
Aart Bik69ae54a2015-07-01 14:52:26 -07001/*
2 * Copyright (C) 2015 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 * Implementation file of the dexdump utility.
17 *
18 * This is a re-implementation of the original dexdump utility that was
19 * based on Dalvik functions in libdex into a new dexdump that is now
Aart Bikdce50862016-06-10 16:04:03 -070020 * based on Art functions in libart instead. The output is very similar to
21 * to the original for correct DEX files. Error messages may differ, however.
Aart Bik69ae54a2015-07-01 14:52:26 -070022 * Also, ODEX files are no longer supported.
23 *
24 * The dexdump tool is intended to mimic objdump. When possible, use
25 * similar command-line arguments.
26 *
27 * Differences between XML output and the "current.xml" file:
28 * - classes in same package are not all grouped together; nothing is sorted
29 * - no "deprecated" on fields and methods
Aart Bik69ae54a2015-07-01 14:52:26 -070030 * - no parameter names
31 * - no generic signatures on parameters, e.g. type="java.lang.Class<?>"
32 * - class shows declared fields and methods; does not show inherited fields
33 */
34
35#include "dexdump.h"
36
37#include <inttypes.h>
38#include <stdio.h>
39
40#include <memory>
Andreas Gampe5073fed2015-08-10 11:40:25 -070041#include <sstream>
Aart Bik69ae54a2015-07-01 14:52:26 -070042#include <vector>
43
David Sehr999646d2018-02-16 10:22:33 -080044#include "android-base/file.h"
Andreas Gampe221d9812018-01-22 17:48:56 -080045#include "android-base/logging.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080046#include "android-base/stringprintf.h"
47
David Sehr0225f8e2018-01-31 08:52:24 +000048#include "dex/code_item_accessors-inl.h"
David Sehr9e734c72018-01-04 17:56:19 -080049#include "dex/dex_file-inl.h"
50#include "dex/dex_file_exception_helpers.h"
51#include "dex/dex_file_loader.h"
52#include "dex/dex_file_types.h"
53#include "dex/dex_instruction-inl.h"
Andreas Gampe8cf9cb32017-07-19 09:28:38 -070054#include "dexdump_cfg.h"
Aart Bik69ae54a2015-07-01 14:52:26 -070055
56namespace art {
57
58/*
59 * Options parsed in main driver.
60 */
61struct Options gOptions;
62
63/*
Aart Bik4e149602015-07-09 11:45:28 -070064 * Output file. Defaults to stdout.
Aart Bik69ae54a2015-07-01 14:52:26 -070065 */
66FILE* gOutFile = stdout;
67
68/*
69 * Data types that match the definitions in the VM specification.
70 */
71typedef uint8_t u1;
72typedef uint16_t u2;
73typedef uint32_t u4;
74typedef uint64_t u8;
Aart Bikdce50862016-06-10 16:04:03 -070075typedef int8_t s1;
76typedef int16_t s2;
Aart Bik69ae54a2015-07-01 14:52:26 -070077typedef int32_t s4;
78typedef int64_t s8;
79
80/*
81 * Basic information about a field or a method.
82 */
83struct FieldMethodInfo {
84 const char* classDescriptor;
85 const char* name;
86 const char* signature;
87};
88
89/*
90 * Flags for use with createAccessFlagStr().
91 */
92enum AccessFor {
93 kAccessForClass = 0, kAccessForMethod = 1, kAccessForField = 2, kAccessForMAX
94};
95const int kNumFlags = 18;
96
97/*
98 * Gets 2 little-endian bytes.
99 */
100static inline u2 get2LE(unsigned char const* pSrc) {
101 return pSrc[0] | (pSrc[1] << 8);
102}
103
104/*
105 * Converts a single-character primitive type into human-readable form.
106 */
107static const char* primitiveTypeLabel(char typeChar) {
108 switch (typeChar) {
109 case 'B': return "byte";
110 case 'C': return "char";
111 case 'D': return "double";
112 case 'F': return "float";
113 case 'I': return "int";
114 case 'J': return "long";
115 case 'S': return "short";
116 case 'V': return "void";
117 case 'Z': return "boolean";
118 default: return "UNKNOWN";
119 } // switch
120}
121
122/*
123 * Converts a type descriptor to human-readable "dotted" form. For
124 * example, "Ljava/lang/String;" becomes "java.lang.String", and
125 * "[I" becomes "int[]". Also converts '$' to '.', which means this
126 * form can't be converted back to a descriptor.
127 */
Aart Bikc05e2f22016-07-12 15:53:13 -0700128static std::unique_ptr<char[]> descriptorToDot(const char* str) {
Aart Bik69ae54a2015-07-01 14:52:26 -0700129 int targetLen = strlen(str);
130 int offset = 0;
131
132 // Strip leading [s; will be added to end.
133 while (targetLen > 1 && str[offset] == '[') {
134 offset++;
135 targetLen--;
136 } // while
137
138 const int arrayDepth = offset;
139
140 if (targetLen == 1) {
141 // Primitive type.
142 str = primitiveTypeLabel(str[offset]);
143 offset = 0;
144 targetLen = strlen(str);
145 } else {
146 // Account for leading 'L' and trailing ';'.
147 if (targetLen >= 2 && str[offset] == 'L' &&
148 str[offset + targetLen - 1] == ';') {
149 targetLen -= 2;
150 offset++;
151 }
152 }
153
154 // Copy class name over.
Aart Bikc05e2f22016-07-12 15:53:13 -0700155 std::unique_ptr<char[]> newStr(new char[targetLen + arrayDepth * 2 + 1]);
Aart Bik69ae54a2015-07-01 14:52:26 -0700156 int i = 0;
157 for (; i < targetLen; i++) {
158 const char ch = str[offset + i];
159 newStr[i] = (ch == '/' || ch == '$') ? '.' : ch;
160 } // for
161
162 // Add the appropriate number of brackets for arrays.
163 for (int j = 0; j < arrayDepth; j++) {
164 newStr[i++] = '[';
165 newStr[i++] = ']';
166 } // for
167
168 newStr[i] = '\0';
169 return newStr;
170}
171
172/*
173 * Converts the class name portion of a type descriptor to human-readable
Aart Bikc05e2f22016-07-12 15:53:13 -0700174 * "dotted" form. For example, "Ljava/lang/String;" becomes "String".
Aart Bik69ae54a2015-07-01 14:52:26 -0700175 */
Aart Bikc05e2f22016-07-12 15:53:13 -0700176static std::unique_ptr<char[]> descriptorClassToDot(const char* str) {
177 // Reduce to just the class name prefix.
Aart Bik69ae54a2015-07-01 14:52:26 -0700178 const char* lastSlash = strrchr(str, '/');
179 if (lastSlash == nullptr) {
180 lastSlash = str + 1; // start past 'L'
181 } else {
182 lastSlash++; // start past '/'
183 }
184
Aart Bikc05e2f22016-07-12 15:53:13 -0700185 // Copy class name over, trimming trailing ';'.
186 const int targetLen = strlen(lastSlash);
187 std::unique_ptr<char[]> newStr(new char[targetLen]);
188 for (int i = 0; i < targetLen - 1; i++) {
189 const char ch = lastSlash[i];
190 newStr[i] = ch == '$' ? '.' : ch;
Aart Bik69ae54a2015-07-01 14:52:26 -0700191 } // for
Aart Bikc05e2f22016-07-12 15:53:13 -0700192 newStr[targetLen - 1] = '\0';
Aart Bik69ae54a2015-07-01 14:52:26 -0700193 return newStr;
194}
195
196/*
Aart Bikdce50862016-06-10 16:04:03 -0700197 * Returns string representing the boolean value.
198 */
199static const char* strBool(bool val) {
200 return val ? "true" : "false";
201}
202
203/*
Aart Bik69ae54a2015-07-01 14:52:26 -0700204 * Returns a quoted string representing the boolean value.
205 */
206static const char* quotedBool(bool val) {
207 return val ? "\"true\"" : "\"false\"";
208}
209
210/*
211 * Returns a quoted string representing the access flags.
212 */
213static const char* quotedVisibility(u4 accessFlags) {
214 if (accessFlags & kAccPublic) {
215 return "\"public\"";
216 } else if (accessFlags & kAccProtected) {
217 return "\"protected\"";
218 } else if (accessFlags & kAccPrivate) {
219 return "\"private\"";
220 } else {
221 return "\"package\"";
222 }
223}
224
225/*
226 * Counts the number of '1' bits in a word.
227 */
228static int countOnes(u4 val) {
229 val = val - ((val >> 1) & 0x55555555);
230 val = (val & 0x33333333) + ((val >> 2) & 0x33333333);
231 return (((val + (val >> 4)) & 0x0F0F0F0F) * 0x01010101) >> 24;
232}
233
234/*
235 * Creates a new string with human-readable access flags.
236 *
237 * In the base language the access_flags fields are type u2; in Dalvik
238 * they're u4.
239 */
240static char* createAccessFlagStr(u4 flags, AccessFor forWhat) {
241 static const char* kAccessStrings[kAccessForMAX][kNumFlags] = {
242 {
243 "PUBLIC", /* 0x00001 */
244 "PRIVATE", /* 0x00002 */
245 "PROTECTED", /* 0x00004 */
246 "STATIC", /* 0x00008 */
247 "FINAL", /* 0x00010 */
248 "?", /* 0x00020 */
249 "?", /* 0x00040 */
250 "?", /* 0x00080 */
251 "?", /* 0x00100 */
252 "INTERFACE", /* 0x00200 */
253 "ABSTRACT", /* 0x00400 */
254 "?", /* 0x00800 */
255 "SYNTHETIC", /* 0x01000 */
256 "ANNOTATION", /* 0x02000 */
257 "ENUM", /* 0x04000 */
258 "?", /* 0x08000 */
259 "VERIFIED", /* 0x10000 */
260 "OPTIMIZED", /* 0x20000 */
261 }, {
262 "PUBLIC", /* 0x00001 */
263 "PRIVATE", /* 0x00002 */
264 "PROTECTED", /* 0x00004 */
265 "STATIC", /* 0x00008 */
266 "FINAL", /* 0x00010 */
267 "SYNCHRONIZED", /* 0x00020 */
268 "BRIDGE", /* 0x00040 */
269 "VARARGS", /* 0x00080 */
270 "NATIVE", /* 0x00100 */
271 "?", /* 0x00200 */
272 "ABSTRACT", /* 0x00400 */
273 "STRICT", /* 0x00800 */
274 "SYNTHETIC", /* 0x01000 */
275 "?", /* 0x02000 */
276 "?", /* 0x04000 */
277 "MIRANDA", /* 0x08000 */
278 "CONSTRUCTOR", /* 0x10000 */
279 "DECLARED_SYNCHRONIZED", /* 0x20000 */
280 }, {
281 "PUBLIC", /* 0x00001 */
282 "PRIVATE", /* 0x00002 */
283 "PROTECTED", /* 0x00004 */
284 "STATIC", /* 0x00008 */
285 "FINAL", /* 0x00010 */
286 "?", /* 0x00020 */
287 "VOLATILE", /* 0x00040 */
288 "TRANSIENT", /* 0x00080 */
289 "?", /* 0x00100 */
290 "?", /* 0x00200 */
291 "?", /* 0x00400 */
292 "?", /* 0x00800 */
293 "SYNTHETIC", /* 0x01000 */
294 "?", /* 0x02000 */
295 "ENUM", /* 0x04000 */
296 "?", /* 0x08000 */
297 "?", /* 0x10000 */
298 "?", /* 0x20000 */
299 },
300 };
301
302 // Allocate enough storage to hold the expected number of strings,
303 // plus a space between each. We over-allocate, using the longest
304 // string above as the base metric.
305 const int kLongest = 21; // The strlen of longest string above.
306 const int count = countOnes(flags);
307 char* str;
308 char* cp;
309 cp = str = reinterpret_cast<char*>(malloc(count * (kLongest + 1) + 1));
310
311 for (int i = 0; i < kNumFlags; i++) {
312 if (flags & 0x01) {
313 const char* accessStr = kAccessStrings[forWhat][i];
314 const int len = strlen(accessStr);
315 if (cp != str) {
316 *cp++ = ' ';
317 }
318 memcpy(cp, accessStr, len);
319 cp += len;
320 }
321 flags >>= 1;
322 } // for
323
324 *cp = '\0';
325 return str;
326}
327
328/*
329 * Copies character data from "data" to "out", converting non-ASCII values
330 * to fprintf format chars or an ASCII filler ('.' or '?').
331 *
332 * The output buffer must be able to hold (2*len)+1 bytes. The result is
333 * NULL-terminated.
334 */
335static void asciify(char* out, const unsigned char* data, size_t len) {
336 while (len--) {
337 if (*data < 0x20) {
338 // Could do more here, but we don't need them yet.
339 switch (*data) {
340 case '\0':
341 *out++ = '\\';
342 *out++ = '0';
343 break;
344 case '\n':
345 *out++ = '\\';
346 *out++ = 'n';
347 break;
348 default:
349 *out++ = '.';
350 break;
351 } // switch
352 } else if (*data >= 0x80) {
353 *out++ = '?';
354 } else {
355 *out++ = *data;
356 }
357 data++;
358 } // while
359 *out = '\0';
360}
361
362/*
Aart Bikdce50862016-06-10 16:04:03 -0700363 * Dumps a string value with some escape characters.
364 */
365static void dumpEscapedString(const char* p) {
366 fputs("\"", gOutFile);
367 for (; *p; p++) {
368 switch (*p) {
369 case '\\':
370 fputs("\\\\", gOutFile);
371 break;
372 case '\"':
373 fputs("\\\"", gOutFile);
374 break;
375 case '\t':
376 fputs("\\t", gOutFile);
377 break;
378 case '\n':
379 fputs("\\n", gOutFile);
380 break;
381 case '\r':
382 fputs("\\r", gOutFile);
383 break;
384 default:
385 putc(*p, gOutFile);
386 } // switch
387 } // for
388 fputs("\"", gOutFile);
389}
390
391/*
392 * Dumps a string as an XML attribute value.
393 */
394static void dumpXmlAttribute(const char* p) {
395 for (; *p; p++) {
396 switch (*p) {
397 case '&':
398 fputs("&amp;", gOutFile);
399 break;
400 case '<':
401 fputs("&lt;", gOutFile);
402 break;
403 case '>':
404 fputs("&gt;", gOutFile);
405 break;
406 case '"':
407 fputs("&quot;", gOutFile);
408 break;
409 case '\t':
410 fputs("&#x9;", gOutFile);
411 break;
412 case '\n':
413 fputs("&#xA;", gOutFile);
414 break;
415 case '\r':
416 fputs("&#xD;", gOutFile);
417 break;
418 default:
419 putc(*p, gOutFile);
420 } // switch
421 } // for
422}
423
424/*
425 * Reads variable width value, possibly sign extended at the last defined byte.
426 */
427static u8 readVarWidth(const u1** data, u1 arg, bool sign_extend) {
428 u8 value = 0;
429 for (u4 i = 0; i <= arg; i++) {
430 value |= static_cast<u8>(*(*data)++) << (i * 8);
431 }
432 if (sign_extend) {
433 int shift = (7 - arg) * 8;
434 return (static_cast<s8>(value) << shift) >> shift;
435 }
436 return value;
437}
438
439/*
440 * Dumps encoded value.
441 */
442static void dumpEncodedValue(const DexFile* pDexFile, const u1** data); // forward
443static void dumpEncodedValue(const DexFile* pDexFile, const u1** data, u1 type, u1 arg) {
444 switch (type) {
445 case DexFile::kDexAnnotationByte:
446 fprintf(gOutFile, "%" PRId8, static_cast<s1>(readVarWidth(data, arg, false)));
447 break;
448 case DexFile::kDexAnnotationShort:
449 fprintf(gOutFile, "%" PRId16, static_cast<s2>(readVarWidth(data, arg, true)));
450 break;
451 case DexFile::kDexAnnotationChar:
452 fprintf(gOutFile, "%" PRIu16, static_cast<u2>(readVarWidth(data, arg, false)));
453 break;
454 case DexFile::kDexAnnotationInt:
455 fprintf(gOutFile, "%" PRId32, static_cast<s4>(readVarWidth(data, arg, true)));
456 break;
457 case DexFile::kDexAnnotationLong:
458 fprintf(gOutFile, "%" PRId64, static_cast<s8>(readVarWidth(data, arg, true)));
459 break;
460 case DexFile::kDexAnnotationFloat: {
461 // Fill on right.
462 union {
463 float f;
464 u4 data;
465 } conv;
466 conv.data = static_cast<u4>(readVarWidth(data, arg, false)) << (3 - arg) * 8;
467 fprintf(gOutFile, "%g", conv.f);
468 break;
469 }
470 case DexFile::kDexAnnotationDouble: {
471 // Fill on right.
472 union {
473 double d;
474 u8 data;
475 } conv;
476 conv.data = readVarWidth(data, arg, false) << (7 - arg) * 8;
477 fprintf(gOutFile, "%g", conv.d);
478 break;
479 }
480 case DexFile::kDexAnnotationString: {
481 const u4 idx = static_cast<u4>(readVarWidth(data, arg, false));
482 if (gOptions.outputFormat == OUTPUT_PLAIN) {
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800483 dumpEscapedString(pDexFile->StringDataByIdx(dex::StringIndex(idx)));
Aart Bikdce50862016-06-10 16:04:03 -0700484 } else {
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800485 dumpXmlAttribute(pDexFile->StringDataByIdx(dex::StringIndex(idx)));
Aart Bikdce50862016-06-10 16:04:03 -0700486 }
487 break;
488 }
489 case DexFile::kDexAnnotationType: {
490 const u4 str_idx = static_cast<u4>(readVarWidth(data, arg, false));
Andreas Gampea5b09a62016-11-17 15:21:22 -0800491 fputs(pDexFile->StringByTypeIdx(dex::TypeIndex(str_idx)), gOutFile);
Aart Bikdce50862016-06-10 16:04:03 -0700492 break;
493 }
494 case DexFile::kDexAnnotationField:
495 case DexFile::kDexAnnotationEnum: {
496 const u4 field_idx = static_cast<u4>(readVarWidth(data, arg, false));
497 const DexFile::FieldId& pFieldId = pDexFile->GetFieldId(field_idx);
498 fputs(pDexFile->StringDataByIdx(pFieldId.name_idx_), gOutFile);
499 break;
500 }
501 case DexFile::kDexAnnotationMethod: {
502 const u4 method_idx = static_cast<u4>(readVarWidth(data, arg, false));
503 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(method_idx);
504 fputs(pDexFile->StringDataByIdx(pMethodId.name_idx_), gOutFile);
505 break;
506 }
507 case DexFile::kDexAnnotationArray: {
508 fputc('{', gOutFile);
509 // Decode and display all elements.
510 const u4 size = DecodeUnsignedLeb128(data);
511 for (u4 i = 0; i < size; i++) {
512 fputc(' ', gOutFile);
513 dumpEncodedValue(pDexFile, data);
514 }
515 fputs(" }", gOutFile);
516 break;
517 }
518 case DexFile::kDexAnnotationAnnotation: {
519 const u4 type_idx = DecodeUnsignedLeb128(data);
Andreas Gampea5b09a62016-11-17 15:21:22 -0800520 fputs(pDexFile->StringByTypeIdx(dex::TypeIndex(type_idx)), gOutFile);
Aart Bikdce50862016-06-10 16:04:03 -0700521 // Decode and display all name=value pairs.
522 const u4 size = DecodeUnsignedLeb128(data);
523 for (u4 i = 0; i < size; i++) {
524 const u4 name_idx = DecodeUnsignedLeb128(data);
525 fputc(' ', gOutFile);
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800526 fputs(pDexFile->StringDataByIdx(dex::StringIndex(name_idx)), gOutFile);
Aart Bikdce50862016-06-10 16:04:03 -0700527 fputc('=', gOutFile);
528 dumpEncodedValue(pDexFile, data);
529 }
530 break;
531 }
532 case DexFile::kDexAnnotationNull:
533 fputs("null", gOutFile);
534 break;
535 case DexFile::kDexAnnotationBoolean:
536 fputs(strBool(arg), gOutFile);
537 break;
538 default:
539 fputs("????", gOutFile);
540 break;
541 } // switch
542}
543
544/*
545 * Dumps encoded value with prefix.
546 */
547static void dumpEncodedValue(const DexFile* pDexFile, const u1** data) {
548 const u1 enc = *(*data)++;
549 dumpEncodedValue(pDexFile, data, enc & 0x1f, enc >> 5);
550}
551
552/*
Aart Bik69ae54a2015-07-01 14:52:26 -0700553 * Dumps the file header.
Aart Bik69ae54a2015-07-01 14:52:26 -0700554 */
555static void dumpFileHeader(const DexFile* pDexFile) {
556 const DexFile::Header& pHeader = pDexFile->GetHeader();
557 char sanitized[sizeof(pHeader.magic_) * 2 + 1];
558 fprintf(gOutFile, "DEX file header:\n");
559 asciify(sanitized, pHeader.magic_, sizeof(pHeader.magic_));
560 fprintf(gOutFile, "magic : '%s'\n", sanitized);
561 fprintf(gOutFile, "checksum : %08x\n", pHeader.checksum_);
562 fprintf(gOutFile, "signature : %02x%02x...%02x%02x\n",
563 pHeader.signature_[0], pHeader.signature_[1],
564 pHeader.signature_[DexFile::kSha1DigestSize - 2],
565 pHeader.signature_[DexFile::kSha1DigestSize - 1]);
566 fprintf(gOutFile, "file_size : %d\n", pHeader.file_size_);
567 fprintf(gOutFile, "header_size : %d\n", pHeader.header_size_);
568 fprintf(gOutFile, "link_size : %d\n", pHeader.link_size_);
569 fprintf(gOutFile, "link_off : %d (0x%06x)\n",
570 pHeader.link_off_, pHeader.link_off_);
571 fprintf(gOutFile, "string_ids_size : %d\n", pHeader.string_ids_size_);
572 fprintf(gOutFile, "string_ids_off : %d (0x%06x)\n",
573 pHeader.string_ids_off_, pHeader.string_ids_off_);
574 fprintf(gOutFile, "type_ids_size : %d\n", pHeader.type_ids_size_);
575 fprintf(gOutFile, "type_ids_off : %d (0x%06x)\n",
576 pHeader.type_ids_off_, pHeader.type_ids_off_);
Aart Bikdce50862016-06-10 16:04:03 -0700577 fprintf(gOutFile, "proto_ids_size : %d\n", pHeader.proto_ids_size_);
578 fprintf(gOutFile, "proto_ids_off : %d (0x%06x)\n",
Aart Bik69ae54a2015-07-01 14:52:26 -0700579 pHeader.proto_ids_off_, pHeader.proto_ids_off_);
580 fprintf(gOutFile, "field_ids_size : %d\n", pHeader.field_ids_size_);
581 fprintf(gOutFile, "field_ids_off : %d (0x%06x)\n",
582 pHeader.field_ids_off_, pHeader.field_ids_off_);
583 fprintf(gOutFile, "method_ids_size : %d\n", pHeader.method_ids_size_);
584 fprintf(gOutFile, "method_ids_off : %d (0x%06x)\n",
585 pHeader.method_ids_off_, pHeader.method_ids_off_);
586 fprintf(gOutFile, "class_defs_size : %d\n", pHeader.class_defs_size_);
587 fprintf(gOutFile, "class_defs_off : %d (0x%06x)\n",
588 pHeader.class_defs_off_, pHeader.class_defs_off_);
589 fprintf(gOutFile, "data_size : %d\n", pHeader.data_size_);
590 fprintf(gOutFile, "data_off : %d (0x%06x)\n\n",
591 pHeader.data_off_, pHeader.data_off_);
592}
593
594/*
595 * Dumps a class_def_item.
596 */
597static void dumpClassDef(const DexFile* pDexFile, int idx) {
598 // General class information.
599 const DexFile::ClassDef& pClassDef = pDexFile->GetClassDef(idx);
600 fprintf(gOutFile, "Class #%d header:\n", idx);
Andreas Gampea5b09a62016-11-17 15:21:22 -0800601 fprintf(gOutFile, "class_idx : %d\n", pClassDef.class_idx_.index_);
Aart Bik69ae54a2015-07-01 14:52:26 -0700602 fprintf(gOutFile, "access_flags : %d (0x%04x)\n",
603 pClassDef.access_flags_, pClassDef.access_flags_);
Andreas Gampea5b09a62016-11-17 15:21:22 -0800604 fprintf(gOutFile, "superclass_idx : %d\n", pClassDef.superclass_idx_.index_);
Aart Bik69ae54a2015-07-01 14:52:26 -0700605 fprintf(gOutFile, "interfaces_off : %d (0x%06x)\n",
606 pClassDef.interfaces_off_, pClassDef.interfaces_off_);
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800607 fprintf(gOutFile, "source_file_idx : %d\n", pClassDef.source_file_idx_.index_);
Aart Bik69ae54a2015-07-01 14:52:26 -0700608 fprintf(gOutFile, "annotations_off : %d (0x%06x)\n",
609 pClassDef.annotations_off_, pClassDef.annotations_off_);
610 fprintf(gOutFile, "class_data_off : %d (0x%06x)\n",
611 pClassDef.class_data_off_, pClassDef.class_data_off_);
612
613 // Fields and methods.
614 const u1* pEncodedData = pDexFile->GetClassData(pClassDef);
615 if (pEncodedData != nullptr) {
616 ClassDataItemIterator pClassData(*pDexFile, pEncodedData);
617 fprintf(gOutFile, "static_fields_size : %d\n", pClassData.NumStaticFields());
618 fprintf(gOutFile, "instance_fields_size: %d\n", pClassData.NumInstanceFields());
619 fprintf(gOutFile, "direct_methods_size : %d\n", pClassData.NumDirectMethods());
620 fprintf(gOutFile, "virtual_methods_size: %d\n", pClassData.NumVirtualMethods());
621 } else {
622 fprintf(gOutFile, "static_fields_size : 0\n");
623 fprintf(gOutFile, "instance_fields_size: 0\n");
624 fprintf(gOutFile, "direct_methods_size : 0\n");
625 fprintf(gOutFile, "virtual_methods_size: 0\n");
626 }
627 fprintf(gOutFile, "\n");
628}
629
Aart Bikdce50862016-06-10 16:04:03 -0700630/**
631 * Dumps an annotation set item.
632 */
633static void dumpAnnotationSetItem(const DexFile* pDexFile, const DexFile::AnnotationSetItem* set_item) {
634 if (set_item == nullptr || set_item->size_ == 0) {
635 fputs(" empty-annotation-set\n", gOutFile);
636 return;
637 }
638 for (u4 i = 0; i < set_item->size_; i++) {
639 const DexFile::AnnotationItem* annotation = pDexFile->GetAnnotationItem(set_item, i);
640 if (annotation == nullptr) {
641 continue;
642 }
643 fputs(" ", gOutFile);
644 switch (annotation->visibility_) {
645 case DexFile::kDexVisibilityBuild: fputs("VISIBILITY_BUILD ", gOutFile); break;
646 case DexFile::kDexVisibilityRuntime: fputs("VISIBILITY_RUNTIME ", gOutFile); break;
647 case DexFile::kDexVisibilitySystem: fputs("VISIBILITY_SYSTEM ", gOutFile); break;
648 default: fputs("VISIBILITY_UNKNOWN ", gOutFile); break;
649 } // switch
650 // Decode raw bytes in annotation.
651 const u1* rData = annotation->annotation_;
652 dumpEncodedValue(pDexFile, &rData, DexFile::kDexAnnotationAnnotation, 0);
653 fputc('\n', gOutFile);
654 }
655}
656
657/*
658 * Dumps class annotations.
659 */
660static void dumpClassAnnotations(const DexFile* pDexFile, int idx) {
661 const DexFile::ClassDef& pClassDef = pDexFile->GetClassDef(idx);
662 const DexFile::AnnotationsDirectoryItem* dir = pDexFile->GetAnnotationsDirectory(pClassDef);
663 if (dir == nullptr) {
664 return; // none
665 }
666
667 fprintf(gOutFile, "Class #%d annotations:\n", idx);
668
669 const DexFile::AnnotationSetItem* class_set_item = pDexFile->GetClassAnnotationSet(dir);
670 const DexFile::FieldAnnotationsItem* fields = pDexFile->GetFieldAnnotations(dir);
671 const DexFile::MethodAnnotationsItem* methods = pDexFile->GetMethodAnnotations(dir);
672 const DexFile::ParameterAnnotationsItem* pars = pDexFile->GetParameterAnnotations(dir);
673
674 // Annotations on the class itself.
675 if (class_set_item != nullptr) {
676 fprintf(gOutFile, "Annotations on class\n");
677 dumpAnnotationSetItem(pDexFile, class_set_item);
678 }
679
680 // Annotations on fields.
681 if (fields != nullptr) {
682 for (u4 i = 0; i < dir->fields_size_; i++) {
683 const u4 field_idx = fields[i].field_idx_;
684 const DexFile::FieldId& pFieldId = pDexFile->GetFieldId(field_idx);
685 const char* field_name = pDexFile->StringDataByIdx(pFieldId.name_idx_);
686 fprintf(gOutFile, "Annotations on field #%u '%s'\n", field_idx, field_name);
687 dumpAnnotationSetItem(pDexFile, pDexFile->GetFieldAnnotationSetItem(fields[i]));
688 }
689 }
690
691 // Annotations on methods.
692 if (methods != nullptr) {
693 for (u4 i = 0; i < dir->methods_size_; i++) {
694 const u4 method_idx = methods[i].method_idx_;
695 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(method_idx);
696 const char* method_name = pDexFile->StringDataByIdx(pMethodId.name_idx_);
697 fprintf(gOutFile, "Annotations on method #%u '%s'\n", method_idx, method_name);
698 dumpAnnotationSetItem(pDexFile, pDexFile->GetMethodAnnotationSetItem(methods[i]));
699 }
700 }
701
702 // Annotations on method parameters.
703 if (pars != nullptr) {
704 for (u4 i = 0; i < dir->parameters_size_; i++) {
705 const u4 method_idx = pars[i].method_idx_;
706 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(method_idx);
707 const char* method_name = pDexFile->StringDataByIdx(pMethodId.name_idx_);
708 fprintf(gOutFile, "Annotations on method #%u '%s' parameters\n", method_idx, method_name);
709 const DexFile::AnnotationSetRefList*
710 list = pDexFile->GetParameterAnnotationSetRefList(&pars[i]);
711 if (list != nullptr) {
712 for (u4 j = 0; j < list->size_; j++) {
713 fprintf(gOutFile, "#%u\n", j);
714 dumpAnnotationSetItem(pDexFile, pDexFile->GetSetRefItemItem(&list->list_[j]));
715 }
716 }
717 }
718 }
719
720 fputc('\n', gOutFile);
721}
722
Aart Bik69ae54a2015-07-01 14:52:26 -0700723/*
724 * Dumps an interface that a class declares to implement.
725 */
726static void dumpInterface(const DexFile* pDexFile, const DexFile::TypeItem& pTypeItem, int i) {
727 const char* interfaceName = pDexFile->StringByTypeIdx(pTypeItem.type_idx_);
728 if (gOptions.outputFormat == OUTPUT_PLAIN) {
729 fprintf(gOutFile, " #%d : '%s'\n", i, interfaceName);
730 } else {
Aart Bikc05e2f22016-07-12 15:53:13 -0700731 std::unique_ptr<char[]> dot(descriptorToDot(interfaceName));
732 fprintf(gOutFile, "<implements name=\"%s\">\n</implements>\n", dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -0700733 }
734}
735
736/*
737 * Dumps the catches table associated with the code.
738 */
739static void dumpCatches(const DexFile* pDexFile, const DexFile::CodeItem* pCode) {
Mathieu Chartier698ebbc2018-01-05 11:00:42 -0800740 CodeItemDataAccessor accessor(*pDexFile, pCode);
Mathieu Chartierdc578c72017-12-27 11:51:45 -0800741 const u4 triesSize = accessor.TriesSize();
Aart Bik69ae54a2015-07-01 14:52:26 -0700742
743 // No catch table.
744 if (triesSize == 0) {
745 fprintf(gOutFile, " catches : (none)\n");
746 return;
747 }
748
749 // Dump all table entries.
750 fprintf(gOutFile, " catches : %d\n", triesSize);
Mathieu Chartierdc578c72017-12-27 11:51:45 -0800751 for (const DexFile::TryItem& try_item : accessor.TryItems()) {
752 const u4 start = try_item.start_addr_;
753 const u4 end = start + try_item.insn_count_;
Aart Bik69ae54a2015-07-01 14:52:26 -0700754 fprintf(gOutFile, " 0x%04x - 0x%04x\n", start, end);
Mathieu Chartierdc578c72017-12-27 11:51:45 -0800755 for (CatchHandlerIterator it(accessor, try_item); it.HasNext(); it.Next()) {
Andreas Gampea5b09a62016-11-17 15:21:22 -0800756 const dex::TypeIndex tidx = it.GetHandlerTypeIndex();
757 const char* descriptor = (!tidx.IsValid()) ? "<any>" : pDexFile->StringByTypeIdx(tidx);
Aart Bik69ae54a2015-07-01 14:52:26 -0700758 fprintf(gOutFile, " %s -> 0x%04x\n", descriptor, it.GetHandlerAddress());
759 } // for
760 } // for
761}
762
763/*
764 * Callback for dumping each positions table entry.
765 */
David Srbeckyb06e28e2015-12-10 13:15:00 +0000766static bool dumpPositionsCb(void* /*context*/, const DexFile::PositionInfo& entry) {
767 fprintf(gOutFile, " 0x%04x line=%d\n", entry.address_, entry.line_);
Aart Bik69ae54a2015-07-01 14:52:26 -0700768 return false;
769}
770
771/*
772 * Callback for dumping locals table entry.
773 */
David Srbeckyb06e28e2015-12-10 13:15:00 +0000774static void dumpLocalsCb(void* /*context*/, const DexFile::LocalInfo& entry) {
775 const char* signature = entry.signature_ != nullptr ? entry.signature_ : "";
Aart Bik69ae54a2015-07-01 14:52:26 -0700776 fprintf(gOutFile, " 0x%04x - 0x%04x reg=%d %s %s %s\n",
David Srbeckyb06e28e2015-12-10 13:15:00 +0000777 entry.start_address_, entry.end_address_, entry.reg_,
778 entry.name_, entry.descriptor_, signature);
Aart Bik69ae54a2015-07-01 14:52:26 -0700779}
780
781/*
782 * Helper for dumpInstruction(), which builds the string
Aart Bika0e33fd2016-07-08 18:32:45 -0700783 * representation for the index in the given instruction.
784 * Returns a pointer to a buffer of sufficient size.
Aart Bik69ae54a2015-07-01 14:52:26 -0700785 */
Aart Bika0e33fd2016-07-08 18:32:45 -0700786static std::unique_ptr<char[]> indexString(const DexFile* pDexFile,
787 const Instruction* pDecInsn,
788 size_t bufSize) {
Orion Hodsonb34bb192016-10-18 17:02:58 +0100789 static const u4 kInvalidIndex = std::numeric_limits<u4>::max();
Aart Bika0e33fd2016-07-08 18:32:45 -0700790 std::unique_ptr<char[]> buf(new char[bufSize]);
Aart Bik69ae54a2015-07-01 14:52:26 -0700791 // Determine index and width of the string.
792 u4 index = 0;
Orion Hodsonb34bb192016-10-18 17:02:58 +0100793 u4 secondary_index = kInvalidIndex;
Aart Bik69ae54a2015-07-01 14:52:26 -0700794 u4 width = 4;
795 switch (Instruction::FormatOf(pDecInsn->Opcode())) {
796 // SOME NOT SUPPORTED:
797 // case Instruction::k20bc:
798 case Instruction::k21c:
799 case Instruction::k35c:
800 // case Instruction::k35ms:
801 case Instruction::k3rc:
802 // case Instruction::k3rms:
803 // case Instruction::k35mi:
804 // case Instruction::k3rmi:
805 index = pDecInsn->VRegB();
806 width = 4;
807 break;
808 case Instruction::k31c:
809 index = pDecInsn->VRegB();
810 width = 8;
811 break;
812 case Instruction::k22c:
813 // case Instruction::k22cs:
814 index = pDecInsn->VRegC();
815 width = 4;
816 break;
Orion Hodsonb34bb192016-10-18 17:02:58 +0100817 case Instruction::k45cc:
818 case Instruction::k4rcc:
819 index = pDecInsn->VRegB();
820 secondary_index = pDecInsn->VRegH();
821 width = 4;
822 break;
Aart Bik69ae54a2015-07-01 14:52:26 -0700823 default:
824 break;
825 } // switch
826
827 // Determine index type.
828 size_t outSize = 0;
829 switch (Instruction::IndexTypeOf(pDecInsn->Opcode())) {
830 case Instruction::kIndexUnknown:
831 // This function should never get called for this type, but do
832 // something sensible here, just to help with debugging.
Aart Bika0e33fd2016-07-08 18:32:45 -0700833 outSize = snprintf(buf.get(), bufSize, "<unknown-index>");
Aart Bik69ae54a2015-07-01 14:52:26 -0700834 break;
835 case Instruction::kIndexNone:
836 // This function should never get called for this type, but do
837 // something sensible here, just to help with debugging.
Aart Bika0e33fd2016-07-08 18:32:45 -0700838 outSize = snprintf(buf.get(), bufSize, "<no-index>");
Aart Bik69ae54a2015-07-01 14:52:26 -0700839 break;
840 case Instruction::kIndexTypeRef:
841 if (index < pDexFile->GetHeader().type_ids_size_) {
Andreas Gampea5b09a62016-11-17 15:21:22 -0800842 const char* tp = pDexFile->StringByTypeIdx(dex::TypeIndex(index));
Aart Bika0e33fd2016-07-08 18:32:45 -0700843 outSize = snprintf(buf.get(), bufSize, "%s // type@%0*x", tp, width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700844 } else {
Aart Bika0e33fd2016-07-08 18:32:45 -0700845 outSize = snprintf(buf.get(), bufSize, "<type?> // type@%0*x", width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700846 }
847 break;
848 case Instruction::kIndexStringRef:
849 if (index < pDexFile->GetHeader().string_ids_size_) {
Andreas Gampe8a0128a2016-11-28 07:38:35 -0800850 const char* st = pDexFile->StringDataByIdx(dex::StringIndex(index));
Aart Bika0e33fd2016-07-08 18:32:45 -0700851 outSize = snprintf(buf.get(), bufSize, "\"%s\" // string@%0*x", st, width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700852 } else {
Aart Bika0e33fd2016-07-08 18:32:45 -0700853 outSize = snprintf(buf.get(), bufSize, "<string?> // string@%0*x", width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700854 }
855 break;
856 case Instruction::kIndexMethodRef:
857 if (index < pDexFile->GetHeader().method_ids_size_) {
858 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(index);
859 const char* name = pDexFile->StringDataByIdx(pMethodId.name_idx_);
860 const Signature signature = pDexFile->GetMethodSignature(pMethodId);
861 const char* backDescriptor = pDexFile->StringByTypeIdx(pMethodId.class_idx_);
Aart Bika0e33fd2016-07-08 18:32:45 -0700862 outSize = snprintf(buf.get(), bufSize, "%s.%s:%s // method@%0*x",
Aart Bik69ae54a2015-07-01 14:52:26 -0700863 backDescriptor, name, signature.ToString().c_str(), width, index);
864 } else {
Aart Bika0e33fd2016-07-08 18:32:45 -0700865 outSize = snprintf(buf.get(), bufSize, "<method?> // method@%0*x", width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700866 }
867 break;
868 case Instruction::kIndexFieldRef:
869 if (index < pDexFile->GetHeader().field_ids_size_) {
870 const DexFile::FieldId& pFieldId = pDexFile->GetFieldId(index);
871 const char* name = pDexFile->StringDataByIdx(pFieldId.name_idx_);
872 const char* typeDescriptor = pDexFile->StringByTypeIdx(pFieldId.type_idx_);
873 const char* backDescriptor = pDexFile->StringByTypeIdx(pFieldId.class_idx_);
Aart Bika0e33fd2016-07-08 18:32:45 -0700874 outSize = snprintf(buf.get(), bufSize, "%s.%s:%s // field@%0*x",
Aart Bik69ae54a2015-07-01 14:52:26 -0700875 backDescriptor, name, typeDescriptor, width, index);
876 } else {
Aart Bika0e33fd2016-07-08 18:32:45 -0700877 outSize = snprintf(buf.get(), bufSize, "<field?> // field@%0*x", width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700878 }
879 break;
880 case Instruction::kIndexVtableOffset:
Aart Bika0e33fd2016-07-08 18:32:45 -0700881 outSize = snprintf(buf.get(), bufSize, "[%0*x] // vtable #%0*x",
Aart Bik69ae54a2015-07-01 14:52:26 -0700882 width, index, width, index);
883 break;
884 case Instruction::kIndexFieldOffset:
Aart Bika0e33fd2016-07-08 18:32:45 -0700885 outSize = snprintf(buf.get(), bufSize, "[obj+%0*x]", width, index);
Aart Bik69ae54a2015-07-01 14:52:26 -0700886 break;
Orion Hodsonb34bb192016-10-18 17:02:58 +0100887 case Instruction::kIndexMethodAndProtoRef: {
Orion Hodsonc069a302017-01-18 09:23:12 +0000888 std::string method("<method?>");
889 std::string proto("<proto?>");
890 if (index < pDexFile->GetHeader().method_ids_size_) {
891 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(index);
892 const char* name = pDexFile->StringDataByIdx(pMethodId.name_idx_);
893 const Signature signature = pDexFile->GetMethodSignature(pMethodId);
894 const char* backDescriptor = pDexFile->StringByTypeIdx(pMethodId.class_idx_);
895 method = android::base::StringPrintf("%s.%s:%s",
896 backDescriptor,
897 name,
898 signature.ToString().c_str());
Orion Hodsonb34bb192016-10-18 17:02:58 +0100899 }
Orion Hodsonc069a302017-01-18 09:23:12 +0000900 if (secondary_index < pDexFile->GetHeader().proto_ids_size_) {
901 const DexFile::ProtoId& protoId = pDexFile->GetProtoId(secondary_index);
902 const Signature signature = pDexFile->GetProtoSignature(protoId);
903 proto = signature.ToString();
904 }
905 outSize = snprintf(buf.get(), bufSize, "%s, %s // method@%0*x, proto@%0*x",
906 method.c_str(), proto.c_str(), width, index, width, secondary_index);
907 break;
908 }
909 case Instruction::kIndexCallSiteRef:
910 // Call site information is too large to detail in disassembly so just output the index.
911 outSize = snprintf(buf.get(), bufSize, "call_site@%0*x", width, index);
Orion Hodsonb34bb192016-10-18 17:02:58 +0100912 break;
Orion Hodson2e599942017-09-22 16:17:41 +0100913 case Instruction::kIndexMethodHandleRef:
914 // Method handle information is too large to detail in disassembly so just output the index.
915 outSize = snprintf(buf.get(), bufSize, "method_handle@%0*x", width, index);
916 break;
917 case Instruction::kIndexProtoRef:
918 if (index < pDexFile->GetHeader().proto_ids_size_) {
919 const DexFile::ProtoId& protoId = pDexFile->GetProtoId(index);
920 const Signature signature = pDexFile->GetProtoSignature(protoId);
921 const std::string& proto = signature.ToString();
922 outSize = snprintf(buf.get(), bufSize, "%s // proto@%0*x", proto.c_str(), width, index);
923 } else {
924 outSize = snprintf(buf.get(), bufSize, "<?> // proto@%0*x", width, index);
925 }
Aart Bik69ae54a2015-07-01 14:52:26 -0700926 break;
927 } // switch
928
Orion Hodson2e599942017-09-22 16:17:41 +0100929 if (outSize == 0) {
930 // The index type has not been handled in the switch above.
931 outSize = snprintf(buf.get(), bufSize, "<?>");
932 }
933
Aart Bik69ae54a2015-07-01 14:52:26 -0700934 // Determine success of string construction.
935 if (outSize >= bufSize) {
Aart Bika0e33fd2016-07-08 18:32:45 -0700936 // The buffer wasn't big enough; retry with computed size. Note: snprintf()
937 // doesn't count/ the '\0' as part of its returned size, so we add explicit
938 // space for it here.
939 return indexString(pDexFile, pDecInsn, outSize + 1);
Aart Bik69ae54a2015-07-01 14:52:26 -0700940 }
941 return buf;
942}
943
944/*
945 * Dumps a single instruction.
946 */
947static void dumpInstruction(const DexFile* pDexFile,
948 const DexFile::CodeItem* pCode,
949 u4 codeOffset, u4 insnIdx, u4 insnWidth,
950 const Instruction* pDecInsn) {
951 // Address of instruction (expressed as byte offset).
952 fprintf(gOutFile, "%06x:", codeOffset + 0x10 + insnIdx * 2);
953
954 // Dump (part of) raw bytes.
Mathieu Chartier698ebbc2018-01-05 11:00:42 -0800955 CodeItemInstructionAccessor accessor(*pDexFile, pCode);
Aart Bik69ae54a2015-07-01 14:52:26 -0700956 for (u4 i = 0; i < 8; i++) {
957 if (i < insnWidth) {
958 if (i == 7) {
959 fprintf(gOutFile, " ... ");
960 } else {
961 // Print 16-bit value in little-endian order.
Mathieu Chartier641a3af2017-12-15 11:42:58 -0800962 const u1* bytePtr = (const u1*) &accessor.Insns()[insnIdx + i];
Aart Bik69ae54a2015-07-01 14:52:26 -0700963 fprintf(gOutFile, " %02x%02x", bytePtr[0], bytePtr[1]);
964 }
965 } else {
966 fputs(" ", gOutFile);
967 }
968 } // for
969
970 // Dump pseudo-instruction or opcode.
971 if (pDecInsn->Opcode() == Instruction::NOP) {
Mathieu Chartier641a3af2017-12-15 11:42:58 -0800972 const u2 instr = get2LE((const u1*) &accessor.Insns()[insnIdx]);
Aart Bik69ae54a2015-07-01 14:52:26 -0700973 if (instr == Instruction::kPackedSwitchSignature) {
974 fprintf(gOutFile, "|%04x: packed-switch-data (%d units)", insnIdx, insnWidth);
975 } else if (instr == Instruction::kSparseSwitchSignature) {
976 fprintf(gOutFile, "|%04x: sparse-switch-data (%d units)", insnIdx, insnWidth);
977 } else if (instr == Instruction::kArrayDataSignature) {
978 fprintf(gOutFile, "|%04x: array-data (%d units)", insnIdx, insnWidth);
979 } else {
980 fprintf(gOutFile, "|%04x: nop // spacer", insnIdx);
981 }
982 } else {
983 fprintf(gOutFile, "|%04x: %s", insnIdx, pDecInsn->Name());
984 }
985
986 // Set up additional argument.
Aart Bika0e33fd2016-07-08 18:32:45 -0700987 std::unique_ptr<char[]> indexBuf;
Aart Bik69ae54a2015-07-01 14:52:26 -0700988 if (Instruction::IndexTypeOf(pDecInsn->Opcode()) != Instruction::kIndexNone) {
Aart Bika0e33fd2016-07-08 18:32:45 -0700989 indexBuf = indexString(pDexFile, pDecInsn, 200);
Aart Bik69ae54a2015-07-01 14:52:26 -0700990 }
991
992 // Dump the instruction.
993 //
994 // NOTE: pDecInsn->DumpString(pDexFile) differs too much from original.
995 //
996 switch (Instruction::FormatOf(pDecInsn->Opcode())) {
997 case Instruction::k10x: // op
998 break;
999 case Instruction::k12x: // op vA, vB
1000 fprintf(gOutFile, " v%d, v%d", pDecInsn->VRegA(), pDecInsn->VRegB());
1001 break;
1002 case Instruction::k11n: // op vA, #+B
1003 fprintf(gOutFile, " v%d, #int %d // #%x",
1004 pDecInsn->VRegA(), (s4) pDecInsn->VRegB(), (u1)pDecInsn->VRegB());
1005 break;
1006 case Instruction::k11x: // op vAA
1007 fprintf(gOutFile, " v%d", pDecInsn->VRegA());
1008 break;
1009 case Instruction::k10t: // op +AA
Aart Bikdce50862016-06-10 16:04:03 -07001010 case Instruction::k20t: { // op +AAAA
1011 const s4 targ = (s4) pDecInsn->VRegA();
1012 fprintf(gOutFile, " %04x // %c%04x",
1013 insnIdx + targ,
1014 (targ < 0) ? '-' : '+',
1015 (targ < 0) ? -targ : targ);
Aart Bik69ae54a2015-07-01 14:52:26 -07001016 break;
Aart Bikdce50862016-06-10 16:04:03 -07001017 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001018 case Instruction::k22x: // op vAA, vBBBB
1019 fprintf(gOutFile, " v%d, v%d", pDecInsn->VRegA(), pDecInsn->VRegB());
1020 break;
Aart Bikdce50862016-06-10 16:04:03 -07001021 case Instruction::k21t: { // op vAA, +BBBB
1022 const s4 targ = (s4) pDecInsn->VRegB();
1023 fprintf(gOutFile, " v%d, %04x // %c%04x", pDecInsn->VRegA(),
1024 insnIdx + targ,
1025 (targ < 0) ? '-' : '+',
1026 (targ < 0) ? -targ : targ);
Aart Bik69ae54a2015-07-01 14:52:26 -07001027 break;
Aart Bikdce50862016-06-10 16:04:03 -07001028 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001029 case Instruction::k21s: // op vAA, #+BBBB
1030 fprintf(gOutFile, " v%d, #int %d // #%x",
1031 pDecInsn->VRegA(), (s4) pDecInsn->VRegB(), (u2)pDecInsn->VRegB());
1032 break;
1033 case Instruction::k21h: // op vAA, #+BBBB0000[00000000]
1034 // The printed format varies a bit based on the actual opcode.
1035 if (pDecInsn->Opcode() == Instruction::CONST_HIGH16) {
1036 const s4 value = pDecInsn->VRegB() << 16;
1037 fprintf(gOutFile, " v%d, #int %d // #%x",
1038 pDecInsn->VRegA(), value, (u2) pDecInsn->VRegB());
1039 } else {
1040 const s8 value = ((s8) pDecInsn->VRegB()) << 48;
1041 fprintf(gOutFile, " v%d, #long %" PRId64 " // #%x",
1042 pDecInsn->VRegA(), value, (u2) pDecInsn->VRegB());
1043 }
1044 break;
1045 case Instruction::k21c: // op vAA, thing@BBBB
1046 case Instruction::k31c: // op vAA, thing@BBBBBBBB
Aart Bika0e33fd2016-07-08 18:32:45 -07001047 fprintf(gOutFile, " v%d, %s", pDecInsn->VRegA(), indexBuf.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001048 break;
1049 case Instruction::k23x: // op vAA, vBB, vCC
1050 fprintf(gOutFile, " v%d, v%d, v%d",
1051 pDecInsn->VRegA(), pDecInsn->VRegB(), pDecInsn->VRegC());
1052 break;
1053 case Instruction::k22b: // op vAA, vBB, #+CC
1054 fprintf(gOutFile, " v%d, v%d, #int %d // #%02x",
1055 pDecInsn->VRegA(), pDecInsn->VRegB(),
1056 (s4) pDecInsn->VRegC(), (u1) pDecInsn->VRegC());
1057 break;
Aart Bikdce50862016-06-10 16:04:03 -07001058 case Instruction::k22t: { // op vA, vB, +CCCC
1059 const s4 targ = (s4) pDecInsn->VRegC();
1060 fprintf(gOutFile, " v%d, v%d, %04x // %c%04x",
1061 pDecInsn->VRegA(), pDecInsn->VRegB(),
1062 insnIdx + targ,
1063 (targ < 0) ? '-' : '+',
1064 (targ < 0) ? -targ : targ);
Aart Bik69ae54a2015-07-01 14:52:26 -07001065 break;
Aart Bikdce50862016-06-10 16:04:03 -07001066 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001067 case Instruction::k22s: // op vA, vB, #+CCCC
1068 fprintf(gOutFile, " v%d, v%d, #int %d // #%04x",
1069 pDecInsn->VRegA(), pDecInsn->VRegB(),
1070 (s4) pDecInsn->VRegC(), (u2) pDecInsn->VRegC());
1071 break;
1072 case Instruction::k22c: // op vA, vB, thing@CCCC
1073 // NOT SUPPORTED:
1074 // case Instruction::k22cs: // [opt] op vA, vB, field offset CCCC
1075 fprintf(gOutFile, " v%d, v%d, %s",
Aart Bika0e33fd2016-07-08 18:32:45 -07001076 pDecInsn->VRegA(), pDecInsn->VRegB(), indexBuf.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001077 break;
1078 case Instruction::k30t:
1079 fprintf(gOutFile, " #%08x", pDecInsn->VRegA());
1080 break;
Aart Bikdce50862016-06-10 16:04:03 -07001081 case Instruction::k31i: { // op vAA, #+BBBBBBBB
1082 // This is often, but not always, a float.
1083 union {
1084 float f;
1085 u4 i;
1086 } conv;
1087 conv.i = pDecInsn->VRegB();
1088 fprintf(gOutFile, " v%d, #float %g // #%08x",
1089 pDecInsn->VRegA(), conv.f, pDecInsn->VRegB());
Aart Bik69ae54a2015-07-01 14:52:26 -07001090 break;
Aart Bikdce50862016-06-10 16:04:03 -07001091 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001092 case Instruction::k31t: // op vAA, offset +BBBBBBBB
1093 fprintf(gOutFile, " v%d, %08x // +%08x",
1094 pDecInsn->VRegA(), insnIdx + pDecInsn->VRegB(), pDecInsn->VRegB());
1095 break;
1096 case Instruction::k32x: // op vAAAA, vBBBB
1097 fprintf(gOutFile, " v%d, v%d", pDecInsn->VRegA(), pDecInsn->VRegB());
1098 break;
Orion Hodsonb34bb192016-10-18 17:02:58 +01001099 case Instruction::k35c: // op {vC, vD, vE, vF, vG}, thing@BBBB
1100 case Instruction::k45cc: { // op {vC, vD, vE, vF, vG}, method@BBBB, proto@HHHH
Aart Bik69ae54a2015-07-01 14:52:26 -07001101 // NOT SUPPORTED:
1102 // case Instruction::k35ms: // [opt] invoke-virtual+super
1103 // case Instruction::k35mi: // [opt] inline invoke
Aart Bikdce50862016-06-10 16:04:03 -07001104 u4 arg[Instruction::kMaxVarArgRegs];
1105 pDecInsn->GetVarArgs(arg);
1106 fputs(" {", gOutFile);
1107 for (int i = 0, n = pDecInsn->VRegA(); i < n; i++) {
1108 if (i == 0) {
1109 fprintf(gOutFile, "v%d", arg[i]);
1110 } else {
1111 fprintf(gOutFile, ", v%d", arg[i]);
1112 }
1113 } // for
Aart Bika0e33fd2016-07-08 18:32:45 -07001114 fprintf(gOutFile, "}, %s", indexBuf.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001115 break;
Aart Bikdce50862016-06-10 16:04:03 -07001116 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001117 case Instruction::k3rc: // op {vCCCC .. v(CCCC+AA-1)}, thing@BBBB
Orion Hodsonb34bb192016-10-18 17:02:58 +01001118 case Instruction::k4rcc: { // op {vCCCC .. v(CCCC+AA-1)}, method@BBBB, proto@HHHH
Aart Bik69ae54a2015-07-01 14:52:26 -07001119 // NOT SUPPORTED:
1120 // case Instruction::k3rms: // [opt] invoke-virtual+super/range
1121 // case Instruction::k3rmi: // [opt] execute-inline/range
Aart Bik69ae54a2015-07-01 14:52:26 -07001122 // This doesn't match the "dx" output when some of the args are
1123 // 64-bit values -- dx only shows the first register.
1124 fputs(" {", gOutFile);
1125 for (int i = 0, n = pDecInsn->VRegA(); i < n; i++) {
1126 if (i == 0) {
1127 fprintf(gOutFile, "v%d", pDecInsn->VRegC() + i);
1128 } else {
1129 fprintf(gOutFile, ", v%d", pDecInsn->VRegC() + i);
1130 }
1131 } // for
Aart Bika0e33fd2016-07-08 18:32:45 -07001132 fprintf(gOutFile, "}, %s", indexBuf.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001133 }
1134 break;
Aart Bikdce50862016-06-10 16:04:03 -07001135 case Instruction::k51l: { // op vAA, #+BBBBBBBBBBBBBBBB
1136 // This is often, but not always, a double.
1137 union {
1138 double d;
1139 u8 j;
1140 } conv;
1141 conv.j = pDecInsn->WideVRegB();
1142 fprintf(gOutFile, " v%d, #double %g // #%016" PRIx64,
1143 pDecInsn->VRegA(), conv.d, pDecInsn->WideVRegB());
Aart Bik69ae54a2015-07-01 14:52:26 -07001144 break;
Aart Bikdce50862016-06-10 16:04:03 -07001145 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001146 // NOT SUPPORTED:
1147 // case Instruction::k00x: // unknown op or breakpoint
1148 // break;
1149 default:
1150 fprintf(gOutFile, " ???");
1151 break;
1152 } // switch
1153
1154 fputc('\n', gOutFile);
Aart Bik69ae54a2015-07-01 14:52:26 -07001155}
1156
1157/*
1158 * Dumps a bytecode disassembly.
1159 */
1160static void dumpBytecodes(const DexFile* pDexFile, u4 idx,
1161 const DexFile::CodeItem* pCode, u4 codeOffset) {
1162 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(idx);
1163 const char* name = pDexFile->StringDataByIdx(pMethodId.name_idx_);
1164 const Signature signature = pDexFile->GetMethodSignature(pMethodId);
1165 const char* backDescriptor = pDexFile->StringByTypeIdx(pMethodId.class_idx_);
1166
1167 // Generate header.
Aart Bikc05e2f22016-07-12 15:53:13 -07001168 std::unique_ptr<char[]> dot(descriptorToDot(backDescriptor));
1169 fprintf(gOutFile, "%06x: |[%06x] %s.%s:%s\n",
1170 codeOffset, codeOffset, dot.get(), name, signature.ToString().c_str());
Aart Bik69ae54a2015-07-01 14:52:26 -07001171
1172 // Iterate over all instructions.
Mathieu Chartier698ebbc2018-01-05 11:00:42 -08001173 CodeItemDataAccessor accessor(*pDexFile, pCode);
Aart Bik7a9aaf12018-02-05 17:00:40 -08001174 const u4 maxPc = accessor.InsnsSizeInCodeUnits();
Mathieu Chartier641a3af2017-12-15 11:42:58 -08001175 for (const DexInstructionPcPair& pair : accessor) {
Aart Bik7a9aaf12018-02-05 17:00:40 -08001176 const u4 dexPc = pair.DexPc();
1177 if (dexPc >= maxPc) {
1178 LOG(WARNING) << "GLITCH: run-away instruction at idx=0x" << std::hex << dexPc;
1179 break;
1180 }
Mathieu Chartier641a3af2017-12-15 11:42:58 -08001181 const Instruction* instruction = &pair.Inst();
Aart Bik69ae54a2015-07-01 14:52:26 -07001182 const u4 insnWidth = instruction->SizeInCodeUnits();
1183 if (insnWidth == 0) {
Aart Bik7a9aaf12018-02-05 17:00:40 -08001184 LOG(WARNING) << "GLITCH: zero-width instruction at idx=0x" << std::hex << dexPc;
Aart Bik69ae54a2015-07-01 14:52:26 -07001185 break;
1186 }
Aart Bik7a9aaf12018-02-05 17:00:40 -08001187 dumpInstruction(pDexFile, pCode, codeOffset, dexPc, insnWidth, instruction);
Aart Bik69ae54a2015-07-01 14:52:26 -07001188 } // for
1189}
1190
1191/*
1192 * Dumps code of a method.
1193 */
1194static void dumpCode(const DexFile* pDexFile, u4 idx, u4 flags,
1195 const DexFile::CodeItem* pCode, u4 codeOffset) {
Mathieu Chartier8892c6b2018-01-09 15:10:17 -08001196 CodeItemDebugInfoAccessor accessor(*pDexFile, pCode, idx);
Mathieu Chartier641a3af2017-12-15 11:42:58 -08001197
1198 fprintf(gOutFile, " registers : %d\n", accessor.RegistersSize());
1199 fprintf(gOutFile, " ins : %d\n", accessor.InsSize());
1200 fprintf(gOutFile, " outs : %d\n", accessor.OutsSize());
Aart Bik69ae54a2015-07-01 14:52:26 -07001201 fprintf(gOutFile, " insns size : %d 16-bit code units\n",
Mathieu Chartier641a3af2017-12-15 11:42:58 -08001202 accessor.InsnsSizeInCodeUnits());
Aart Bik69ae54a2015-07-01 14:52:26 -07001203
1204 // Bytecode disassembly, if requested.
1205 if (gOptions.disassemble) {
1206 dumpBytecodes(pDexFile, idx, pCode, codeOffset);
1207 }
1208
1209 // Try-catch blocks.
1210 dumpCatches(pDexFile, pCode);
1211
1212 // Positions and locals table in the debug info.
1213 bool is_static = (flags & kAccStatic) != 0;
1214 fprintf(gOutFile, " positions : \n");
Mathieu Chartier641a3af2017-12-15 11:42:58 -08001215 pDexFile->DecodeDebugPositionInfo(accessor.DebugInfoOffset(), dumpPositionsCb, nullptr);
Aart Bik69ae54a2015-07-01 14:52:26 -07001216 fprintf(gOutFile, " locals : \n");
Mathieu Chartier641a3af2017-12-15 11:42:58 -08001217 accessor.DecodeDebugLocalInfo(is_static, idx, dumpLocalsCb, nullptr);
Aart Bik69ae54a2015-07-01 14:52:26 -07001218}
1219
1220/*
1221 * Dumps a method.
1222 */
1223static void dumpMethod(const DexFile* pDexFile, u4 idx, u4 flags,
1224 const DexFile::CodeItem* pCode, u4 codeOffset, int i) {
1225 // Bail for anything private if export only requested.
1226 if (gOptions.exportsOnly && (flags & (kAccPublic | kAccProtected)) == 0) {
1227 return;
1228 }
1229
1230 const DexFile::MethodId& pMethodId = pDexFile->GetMethodId(idx);
1231 const char* name = pDexFile->StringDataByIdx(pMethodId.name_idx_);
1232 const Signature signature = pDexFile->GetMethodSignature(pMethodId);
1233 char* typeDescriptor = strdup(signature.ToString().c_str());
1234 const char* backDescriptor = pDexFile->StringByTypeIdx(pMethodId.class_idx_);
1235 char* accessStr = createAccessFlagStr(flags, kAccessForMethod);
1236
1237 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1238 fprintf(gOutFile, " #%d : (in %s)\n", i, backDescriptor);
1239 fprintf(gOutFile, " name : '%s'\n", name);
1240 fprintf(gOutFile, " type : '%s'\n", typeDescriptor);
1241 fprintf(gOutFile, " access : 0x%04x (%s)\n", flags, accessStr);
1242 if (pCode == nullptr) {
1243 fprintf(gOutFile, " code : (none)\n");
1244 } else {
1245 fprintf(gOutFile, " code -\n");
1246 dumpCode(pDexFile, idx, flags, pCode, codeOffset);
1247 }
1248 if (gOptions.disassemble) {
1249 fputc('\n', gOutFile);
1250 }
1251 } else if (gOptions.outputFormat == OUTPUT_XML) {
1252 const bool constructor = (name[0] == '<');
1253
1254 // Method name and prototype.
1255 if (constructor) {
Aart Bikc05e2f22016-07-12 15:53:13 -07001256 std::unique_ptr<char[]> dot(descriptorClassToDot(backDescriptor));
1257 fprintf(gOutFile, "<constructor name=\"%s\"\n", dot.get());
1258 dot = descriptorToDot(backDescriptor);
1259 fprintf(gOutFile, " type=\"%s\"\n", dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001260 } else {
1261 fprintf(gOutFile, "<method name=\"%s\"\n", name);
1262 const char* returnType = strrchr(typeDescriptor, ')');
1263 if (returnType == nullptr) {
Andreas Gampe221d9812018-01-22 17:48:56 -08001264 LOG(ERROR) << "bad method type descriptor '" << typeDescriptor << "'";
Aart Bik69ae54a2015-07-01 14:52:26 -07001265 goto bail;
1266 }
Aart Bikc05e2f22016-07-12 15:53:13 -07001267 std::unique_ptr<char[]> dot(descriptorToDot(returnType + 1));
1268 fprintf(gOutFile, " return=\"%s\"\n", dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001269 fprintf(gOutFile, " abstract=%s\n", quotedBool((flags & kAccAbstract) != 0));
1270 fprintf(gOutFile, " native=%s\n", quotedBool((flags & kAccNative) != 0));
1271 fprintf(gOutFile, " synchronized=%s\n", quotedBool(
1272 (flags & (kAccSynchronized | kAccDeclaredSynchronized)) != 0));
1273 }
1274
1275 // Additional method flags.
1276 fprintf(gOutFile, " static=%s\n", quotedBool((flags & kAccStatic) != 0));
1277 fprintf(gOutFile, " final=%s\n", quotedBool((flags & kAccFinal) != 0));
1278 // The "deprecated=" not knowable w/o parsing annotations.
1279 fprintf(gOutFile, " visibility=%s\n>\n", quotedVisibility(flags));
1280
1281 // Parameters.
1282 if (typeDescriptor[0] != '(') {
Andreas Gampe221d9812018-01-22 17:48:56 -08001283 LOG(ERROR) << "ERROR: bad descriptor '" << typeDescriptor << "'";
Aart Bik69ae54a2015-07-01 14:52:26 -07001284 goto bail;
1285 }
1286 char* tmpBuf = reinterpret_cast<char*>(malloc(strlen(typeDescriptor) + 1));
1287 const char* base = typeDescriptor + 1;
1288 int argNum = 0;
1289 while (*base != ')') {
1290 char* cp = tmpBuf;
1291 while (*base == '[') {
1292 *cp++ = *base++;
1293 }
1294 if (*base == 'L') {
1295 // Copy through ';'.
1296 do {
1297 *cp = *base++;
1298 } while (*cp++ != ';');
1299 } else {
1300 // Primitive char, copy it.
Aart Bikc05e2f22016-07-12 15:53:13 -07001301 if (strchr("ZBCSIFJD", *base) == nullptr) {
Andreas Gampe221d9812018-01-22 17:48:56 -08001302 LOG(ERROR) << "ERROR: bad method signature '" << base << "'";
Aart Bika0e33fd2016-07-08 18:32:45 -07001303 break; // while
Aart Bik69ae54a2015-07-01 14:52:26 -07001304 }
1305 *cp++ = *base++;
1306 }
1307 // Null terminate and display.
1308 *cp++ = '\0';
Aart Bikc05e2f22016-07-12 15:53:13 -07001309 std::unique_ptr<char[]> dot(descriptorToDot(tmpBuf));
Aart Bik69ae54a2015-07-01 14:52:26 -07001310 fprintf(gOutFile, "<parameter name=\"arg%d\" type=\"%s\">\n"
Aart Bikc05e2f22016-07-12 15:53:13 -07001311 "</parameter>\n", argNum++, dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001312 } // while
1313 free(tmpBuf);
1314 if (constructor) {
1315 fprintf(gOutFile, "</constructor>\n");
1316 } else {
1317 fprintf(gOutFile, "</method>\n");
1318 }
1319 }
1320
1321 bail:
1322 free(typeDescriptor);
1323 free(accessStr);
1324}
1325
1326/*
1327 * Dumps a static (class) field.
1328 */
Aart Bikdce50862016-06-10 16:04:03 -07001329static void dumpSField(const DexFile* pDexFile, u4 idx, u4 flags, int i, const u1** data) {
Aart Bik69ae54a2015-07-01 14:52:26 -07001330 // Bail for anything private if export only requested.
1331 if (gOptions.exportsOnly && (flags & (kAccPublic | kAccProtected)) == 0) {
1332 return;
1333 }
1334
1335 const DexFile::FieldId& pFieldId = pDexFile->GetFieldId(idx);
1336 const char* name = pDexFile->StringDataByIdx(pFieldId.name_idx_);
1337 const char* typeDescriptor = pDexFile->StringByTypeIdx(pFieldId.type_idx_);
1338 const char* backDescriptor = pDexFile->StringByTypeIdx(pFieldId.class_idx_);
1339 char* accessStr = createAccessFlagStr(flags, kAccessForField);
1340
1341 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1342 fprintf(gOutFile, " #%d : (in %s)\n", i, backDescriptor);
1343 fprintf(gOutFile, " name : '%s'\n", name);
1344 fprintf(gOutFile, " type : '%s'\n", typeDescriptor);
1345 fprintf(gOutFile, " access : 0x%04x (%s)\n", flags, accessStr);
Aart Bikdce50862016-06-10 16:04:03 -07001346 if (data != nullptr) {
Shinichiro Hamaji82863f02015-11-05 16:51:33 +09001347 fputs(" value : ", gOutFile);
Aart Bikdce50862016-06-10 16:04:03 -07001348 dumpEncodedValue(pDexFile, data);
Shinichiro Hamaji82863f02015-11-05 16:51:33 +09001349 fputs("\n", gOutFile);
1350 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001351 } else if (gOptions.outputFormat == OUTPUT_XML) {
1352 fprintf(gOutFile, "<field name=\"%s\"\n", name);
Aart Bikc05e2f22016-07-12 15:53:13 -07001353 std::unique_ptr<char[]> dot(descriptorToDot(typeDescriptor));
1354 fprintf(gOutFile, " type=\"%s\"\n", dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001355 fprintf(gOutFile, " transient=%s\n", quotedBool((flags & kAccTransient) != 0));
1356 fprintf(gOutFile, " volatile=%s\n", quotedBool((flags & kAccVolatile) != 0));
1357 // The "value=" is not knowable w/o parsing annotations.
1358 fprintf(gOutFile, " static=%s\n", quotedBool((flags & kAccStatic) != 0));
1359 fprintf(gOutFile, " final=%s\n", quotedBool((flags & kAccFinal) != 0));
1360 // The "deprecated=" is not knowable w/o parsing annotations.
1361 fprintf(gOutFile, " visibility=%s\n", quotedVisibility(flags));
Aart Bikdce50862016-06-10 16:04:03 -07001362 if (data != nullptr) {
Shinichiro Hamaji82863f02015-11-05 16:51:33 +09001363 fputs(" value=\"", gOutFile);
Aart Bikdce50862016-06-10 16:04:03 -07001364 dumpEncodedValue(pDexFile, data);
Shinichiro Hamaji82863f02015-11-05 16:51:33 +09001365 fputs("\"\n", gOutFile);
1366 }
1367 fputs(">\n</field>\n", gOutFile);
Aart Bik69ae54a2015-07-01 14:52:26 -07001368 }
1369
1370 free(accessStr);
1371}
1372
1373/*
1374 * Dumps an instance field.
1375 */
1376static void dumpIField(const DexFile* pDexFile, u4 idx, u4 flags, int i) {
Aart Bikdce50862016-06-10 16:04:03 -07001377 dumpSField(pDexFile, idx, flags, i, nullptr);
Aart Bik69ae54a2015-07-01 14:52:26 -07001378}
1379
1380/*
Andreas Gampe5073fed2015-08-10 11:40:25 -07001381 * Dumping a CFG. Note that this will do duplicate work. utils.h doesn't expose the code-item
1382 * version, so the DumpMethodCFG code will have to iterate again to find it. But dexdump is a
1383 * tool, so this is not performance-critical.
1384 */
1385
1386static void dumpCfg(const DexFile* dex_file,
Aart Bikdce50862016-06-10 16:04:03 -07001387 u4 dex_method_idx,
Andreas Gampe5073fed2015-08-10 11:40:25 -07001388 const DexFile::CodeItem* code_item) {
1389 if (code_item != nullptr) {
1390 std::ostringstream oss;
1391 DumpMethodCFG(dex_file, dex_method_idx, oss);
David Sehrcaacd112016-10-20 16:27:02 -07001392 fputs(oss.str().c_str(), gOutFile);
Andreas Gampe5073fed2015-08-10 11:40:25 -07001393 }
1394}
1395
1396static void dumpCfg(const DexFile* dex_file, int idx) {
1397 const DexFile::ClassDef& class_def = dex_file->GetClassDef(idx);
Aart Bikdce50862016-06-10 16:04:03 -07001398 const u1* class_data = dex_file->GetClassData(class_def);
Andreas Gampe5073fed2015-08-10 11:40:25 -07001399 if (class_data == nullptr) { // empty class such as a marker interface?
1400 return;
1401 }
1402 ClassDataItemIterator it(*dex_file, class_data);
Mathieu Chartiere17cf242017-06-19 11:05:51 -07001403 it.SkipAllFields();
Mathieu Chartierb7c273c2017-11-10 18:07:56 -08001404 while (it.HasNextMethod()) {
Andreas Gampe5073fed2015-08-10 11:40:25 -07001405 dumpCfg(dex_file,
1406 it.GetMemberIndex(),
1407 it.GetMethodCodeItem());
1408 it.Next();
1409 }
Andreas Gampe5073fed2015-08-10 11:40:25 -07001410}
1411
1412/*
Aart Bik69ae54a2015-07-01 14:52:26 -07001413 * Dumps the class.
1414 *
1415 * Note "idx" is a DexClassDef index, not a DexTypeId index.
1416 *
1417 * If "*pLastPackage" is nullptr or does not match the current class' package,
1418 * the value will be replaced with a newly-allocated string.
1419 */
1420static void dumpClass(const DexFile* pDexFile, int idx, char** pLastPackage) {
1421 const DexFile::ClassDef& pClassDef = pDexFile->GetClassDef(idx);
1422
1423 // Omitting non-public class.
1424 if (gOptions.exportsOnly && (pClassDef.access_flags_ & kAccPublic) == 0) {
1425 return;
1426 }
1427
Aart Bikdce50862016-06-10 16:04:03 -07001428 if (gOptions.showSectionHeaders) {
1429 dumpClassDef(pDexFile, idx);
1430 }
1431
1432 if (gOptions.showAnnotations) {
1433 dumpClassAnnotations(pDexFile, idx);
1434 }
1435
1436 if (gOptions.showCfg) {
Andreas Gampe5073fed2015-08-10 11:40:25 -07001437 dumpCfg(pDexFile, idx);
1438 return;
1439 }
1440
Aart Bik69ae54a2015-07-01 14:52:26 -07001441 // For the XML output, show the package name. Ideally we'd gather
1442 // up the classes, sort them, and dump them alphabetically so the
1443 // package name wouldn't jump around, but that's not a great plan
1444 // for something that needs to run on the device.
1445 const char* classDescriptor = pDexFile->StringByTypeIdx(pClassDef.class_idx_);
1446 if (!(classDescriptor[0] == 'L' &&
1447 classDescriptor[strlen(classDescriptor)-1] == ';')) {
1448 // Arrays and primitives should not be defined explicitly. Keep going?
Andreas Gampe221d9812018-01-22 17:48:56 -08001449 LOG(WARNING) << "Malformed class name '" << classDescriptor << "'";
Aart Bik69ae54a2015-07-01 14:52:26 -07001450 } else if (gOptions.outputFormat == OUTPUT_XML) {
1451 char* mangle = strdup(classDescriptor + 1);
1452 mangle[strlen(mangle)-1] = '\0';
1453
1454 // Reduce to just the package name.
1455 char* lastSlash = strrchr(mangle, '/');
1456 if (lastSlash != nullptr) {
1457 *lastSlash = '\0';
1458 } else {
1459 *mangle = '\0';
1460 }
1461
1462 for (char* cp = mangle; *cp != '\0'; cp++) {
1463 if (*cp == '/') {
1464 *cp = '.';
1465 }
1466 } // for
1467
1468 if (*pLastPackage == nullptr || strcmp(mangle, *pLastPackage) != 0) {
1469 // Start of a new package.
1470 if (*pLastPackage != nullptr) {
1471 fprintf(gOutFile, "</package>\n");
1472 }
1473 fprintf(gOutFile, "<package name=\"%s\"\n>\n", mangle);
1474 free(*pLastPackage);
1475 *pLastPackage = mangle;
1476 } else {
1477 free(mangle);
1478 }
1479 }
1480
1481 // General class information.
1482 char* accessStr = createAccessFlagStr(pClassDef.access_flags_, kAccessForClass);
1483 const char* superclassDescriptor;
Andreas Gampea5b09a62016-11-17 15:21:22 -08001484 if (!pClassDef.superclass_idx_.IsValid()) {
Aart Bik69ae54a2015-07-01 14:52:26 -07001485 superclassDescriptor = nullptr;
1486 } else {
1487 superclassDescriptor = pDexFile->StringByTypeIdx(pClassDef.superclass_idx_);
1488 }
1489 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1490 fprintf(gOutFile, "Class #%d -\n", idx);
1491 fprintf(gOutFile, " Class descriptor : '%s'\n", classDescriptor);
1492 fprintf(gOutFile, " Access flags : 0x%04x (%s)\n", pClassDef.access_flags_, accessStr);
1493 if (superclassDescriptor != nullptr) {
1494 fprintf(gOutFile, " Superclass : '%s'\n", superclassDescriptor);
1495 }
1496 fprintf(gOutFile, " Interfaces -\n");
1497 } else {
Aart Bikc05e2f22016-07-12 15:53:13 -07001498 std::unique_ptr<char[]> dot(descriptorClassToDot(classDescriptor));
1499 fprintf(gOutFile, "<class name=\"%s\"\n", dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001500 if (superclassDescriptor != nullptr) {
Aart Bikc05e2f22016-07-12 15:53:13 -07001501 dot = descriptorToDot(superclassDescriptor);
1502 fprintf(gOutFile, " extends=\"%s\"\n", dot.get());
Aart Bik69ae54a2015-07-01 14:52:26 -07001503 }
Alex Light1f12e282015-12-10 16:49:47 -08001504 fprintf(gOutFile, " interface=%s\n",
1505 quotedBool((pClassDef.access_flags_ & kAccInterface) != 0));
Aart Bik69ae54a2015-07-01 14:52:26 -07001506 fprintf(gOutFile, " abstract=%s\n", quotedBool((pClassDef.access_flags_ & kAccAbstract) != 0));
1507 fprintf(gOutFile, " static=%s\n", quotedBool((pClassDef.access_flags_ & kAccStatic) != 0));
1508 fprintf(gOutFile, " final=%s\n", quotedBool((pClassDef.access_flags_ & kAccFinal) != 0));
1509 // The "deprecated=" not knowable w/o parsing annotations.
1510 fprintf(gOutFile, " visibility=%s\n", quotedVisibility(pClassDef.access_flags_));
1511 fprintf(gOutFile, ">\n");
1512 }
1513
1514 // Interfaces.
1515 const DexFile::TypeList* pInterfaces = pDexFile->GetInterfacesList(pClassDef);
1516 if (pInterfaces != nullptr) {
1517 for (u4 i = 0; i < pInterfaces->Size(); i++) {
1518 dumpInterface(pDexFile, pInterfaces->GetTypeItem(i), i);
1519 } // for
1520 }
1521
1522 // Fields and methods.
1523 const u1* pEncodedData = pDexFile->GetClassData(pClassDef);
1524 if (pEncodedData == nullptr) {
1525 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1526 fprintf(gOutFile, " Static fields -\n");
1527 fprintf(gOutFile, " Instance fields -\n");
1528 fprintf(gOutFile, " Direct methods -\n");
1529 fprintf(gOutFile, " Virtual methods -\n");
1530 }
1531 } else {
1532 ClassDataItemIterator pClassData(*pDexFile, pEncodedData);
Aart Bikdce50862016-06-10 16:04:03 -07001533
1534 // Prepare data for static fields.
1535 const u1* sData = pDexFile->GetEncodedStaticFieldValuesArray(pClassDef);
1536 const u4 sSize = sData != nullptr ? DecodeUnsignedLeb128(&sData) : 0;
1537
1538 // Static fields.
Aart Bik69ae54a2015-07-01 14:52:26 -07001539 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1540 fprintf(gOutFile, " Static fields -\n");
1541 }
Aart Bikdce50862016-06-10 16:04:03 -07001542 for (u4 i = 0; pClassData.HasNextStaticField(); i++, pClassData.Next()) {
1543 dumpSField(pDexFile,
1544 pClassData.GetMemberIndex(),
1545 pClassData.GetRawMemberAccessFlags(),
1546 i,
1547 i < sSize ? &sData : nullptr);
Aart Bik69ae54a2015-07-01 14:52:26 -07001548 } // for
Aart Bikdce50862016-06-10 16:04:03 -07001549
1550 // Instance fields.
Aart Bik69ae54a2015-07-01 14:52:26 -07001551 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1552 fprintf(gOutFile, " Instance fields -\n");
1553 }
Aart Bikdce50862016-06-10 16:04:03 -07001554 for (u4 i = 0; pClassData.HasNextInstanceField(); i++, pClassData.Next()) {
1555 dumpIField(pDexFile,
1556 pClassData.GetMemberIndex(),
1557 pClassData.GetRawMemberAccessFlags(),
1558 i);
Aart Bik69ae54a2015-07-01 14:52:26 -07001559 } // for
Aart Bikdce50862016-06-10 16:04:03 -07001560
1561 // Direct methods.
Aart Bik69ae54a2015-07-01 14:52:26 -07001562 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1563 fprintf(gOutFile, " Direct methods -\n");
1564 }
1565 for (int i = 0; pClassData.HasNextDirectMethod(); i++, pClassData.Next()) {
1566 dumpMethod(pDexFile, pClassData.GetMemberIndex(),
1567 pClassData.GetRawMemberAccessFlags(),
1568 pClassData.GetMethodCodeItem(),
1569 pClassData.GetMethodCodeItemOffset(), i);
1570 } // for
Aart Bikdce50862016-06-10 16:04:03 -07001571
1572 // Virtual methods.
Aart Bik69ae54a2015-07-01 14:52:26 -07001573 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1574 fprintf(gOutFile, " Virtual methods -\n");
1575 }
1576 for (int i = 0; pClassData.HasNextVirtualMethod(); i++, pClassData.Next()) {
1577 dumpMethod(pDexFile, pClassData.GetMemberIndex(),
1578 pClassData.GetRawMemberAccessFlags(),
1579 pClassData.GetMethodCodeItem(),
1580 pClassData.GetMethodCodeItemOffset(), i);
1581 } // for
1582 }
1583
1584 // End of class.
1585 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1586 const char* fileName;
Andreas Gampe8a0128a2016-11-28 07:38:35 -08001587 if (pClassDef.source_file_idx_.IsValid()) {
Aart Bik69ae54a2015-07-01 14:52:26 -07001588 fileName = pDexFile->StringDataByIdx(pClassDef.source_file_idx_);
1589 } else {
1590 fileName = "unknown";
1591 }
1592 fprintf(gOutFile, " source_file_idx : %d (%s)\n\n",
Andreas Gampe8a0128a2016-11-28 07:38:35 -08001593 pClassDef.source_file_idx_.index_, fileName);
Aart Bik69ae54a2015-07-01 14:52:26 -07001594 } else if (gOptions.outputFormat == OUTPUT_XML) {
1595 fprintf(gOutFile, "</class>\n");
1596 }
1597
1598 free(accessStr);
1599}
1600
Orion Hodsonc069a302017-01-18 09:23:12 +00001601static void dumpMethodHandle(const DexFile* pDexFile, u4 idx) {
1602 const DexFile::MethodHandleItem& mh = pDexFile->GetMethodHandle(idx);
Orion Hodson631827d2017-04-10 14:53:47 +01001603 const char* type = nullptr;
1604 bool is_instance = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001605 bool is_invoke = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001606 switch (static_cast<DexFile::MethodHandleType>(mh.method_handle_type_)) {
1607 case DexFile::MethodHandleType::kStaticPut:
1608 type = "put-static";
Orion Hodson631827d2017-04-10 14:53:47 +01001609 is_instance = false;
1610 is_invoke = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001611 break;
1612 case DexFile::MethodHandleType::kStaticGet:
1613 type = "get-static";
Orion Hodson631827d2017-04-10 14:53:47 +01001614 is_instance = false;
1615 is_invoke = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001616 break;
1617 case DexFile::MethodHandleType::kInstancePut:
1618 type = "put-instance";
Orion Hodson631827d2017-04-10 14:53:47 +01001619 is_instance = true;
1620 is_invoke = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001621 break;
1622 case DexFile::MethodHandleType::kInstanceGet:
1623 type = "get-instance";
Orion Hodson631827d2017-04-10 14:53:47 +01001624 is_instance = true;
1625 is_invoke = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001626 break;
1627 case DexFile::MethodHandleType::kInvokeStatic:
1628 type = "invoke-static";
Orion Hodson631827d2017-04-10 14:53:47 +01001629 is_instance = false;
Orion Hodsonc069a302017-01-18 09:23:12 +00001630 is_invoke = true;
1631 break;
1632 case DexFile::MethodHandleType::kInvokeInstance:
1633 type = "invoke-instance";
Orion Hodson631827d2017-04-10 14:53:47 +01001634 is_instance = true;
Orion Hodsonc069a302017-01-18 09:23:12 +00001635 is_invoke = true;
1636 break;
1637 case DexFile::MethodHandleType::kInvokeConstructor:
1638 type = "invoke-constructor";
Orion Hodson631827d2017-04-10 14:53:47 +01001639 is_instance = true;
1640 is_invoke = true;
1641 break;
1642 case DexFile::MethodHandleType::kInvokeDirect:
1643 type = "invoke-direct";
1644 is_instance = true;
1645 is_invoke = true;
1646 break;
1647 case DexFile::MethodHandleType::kInvokeInterface:
1648 type = "invoke-interface";
1649 is_instance = true;
Orion Hodsonc069a302017-01-18 09:23:12 +00001650 is_invoke = true;
1651 break;
1652 }
1653
1654 const char* declaring_class;
1655 const char* member;
1656 std::string member_type;
Orion Hodson631827d2017-04-10 14:53:47 +01001657 if (type != nullptr) {
1658 if (is_invoke) {
1659 const DexFile::MethodId& method_id = pDexFile->GetMethodId(mh.field_or_method_idx_);
1660 declaring_class = pDexFile->GetMethodDeclaringClassDescriptor(method_id);
1661 member = pDexFile->GetMethodName(method_id);
1662 member_type = pDexFile->GetMethodSignature(method_id).ToString();
1663 } else {
1664 const DexFile::FieldId& field_id = pDexFile->GetFieldId(mh.field_or_method_idx_);
1665 declaring_class = pDexFile->GetFieldDeclaringClassDescriptor(field_id);
1666 member = pDexFile->GetFieldName(field_id);
1667 member_type = pDexFile->GetFieldTypeDescriptor(field_id);
1668 }
1669 if (is_instance) {
1670 member_type = android::base::StringPrintf("(%s%s", declaring_class, member_type.c_str() + 1);
1671 }
Orion Hodsonc069a302017-01-18 09:23:12 +00001672 } else {
Orion Hodson631827d2017-04-10 14:53:47 +01001673 type = "?";
1674 declaring_class = "?";
1675 member = "?";
1676 member_type = "?";
Orion Hodsonc069a302017-01-18 09:23:12 +00001677 }
1678
1679 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1680 fprintf(gOutFile, "Method handle #%u:\n", idx);
1681 fprintf(gOutFile, " type : %s\n", type);
1682 fprintf(gOutFile, " target : %s %s\n", declaring_class, member);
1683 fprintf(gOutFile, " target_type : %s\n", member_type.c_str());
1684 } else {
1685 fprintf(gOutFile, "<method_handle index=\"%u\"\n", idx);
1686 fprintf(gOutFile, " type=\"%s\"\n", type);
1687 fprintf(gOutFile, " target_class=\"%s\"\n", declaring_class);
1688 fprintf(gOutFile, " target_member=\"%s\"\n", member);
1689 fprintf(gOutFile, " target_member_type=");
1690 dumpEscapedString(member_type.c_str());
1691 fprintf(gOutFile, "\n>\n</method_handle>\n");
1692 }
1693}
1694
1695static void dumpCallSite(const DexFile* pDexFile, u4 idx) {
1696 const DexFile::CallSiteIdItem& call_site_id = pDexFile->GetCallSiteId(idx);
1697 CallSiteArrayValueIterator it(*pDexFile, call_site_id);
1698 if (it.Size() < 3) {
Andreas Gampe221d9812018-01-22 17:48:56 -08001699 LOG(ERROR) << "ERROR: Call site " << idx << " has too few values.";
Orion Hodsonc069a302017-01-18 09:23:12 +00001700 return;
1701 }
1702
1703 uint32_t method_handle_idx = static_cast<uint32_t>(it.GetJavaValue().i);
1704 it.Next();
1705 dex::StringIndex method_name_idx = static_cast<dex::StringIndex>(it.GetJavaValue().i);
1706 const char* method_name = pDexFile->StringDataByIdx(method_name_idx);
1707 it.Next();
1708 uint32_t method_type_idx = static_cast<uint32_t>(it.GetJavaValue().i);
1709 const DexFile::ProtoId& method_type_id = pDexFile->GetProtoId(method_type_idx);
1710 std::string method_type = pDexFile->GetProtoSignature(method_type_id).ToString();
1711 it.Next();
1712
1713 if (gOptions.outputFormat == OUTPUT_PLAIN) {
Orion Hodson775224d2017-07-05 11:04:01 +01001714 fprintf(gOutFile, "Call site #%u: // offset %u\n", idx, call_site_id.data_off_);
Orion Hodsonc069a302017-01-18 09:23:12 +00001715 fprintf(gOutFile, " link_argument[0] : %u (MethodHandle)\n", method_handle_idx);
1716 fprintf(gOutFile, " link_argument[1] : %s (String)\n", method_name);
1717 fprintf(gOutFile, " link_argument[2] : %s (MethodType)\n", method_type.c_str());
1718 } else {
Orion Hodson775224d2017-07-05 11:04:01 +01001719 fprintf(gOutFile, "<call_site index=\"%u\" offset=\"%u\">\n", idx, call_site_id.data_off_);
Orion Hodsonc069a302017-01-18 09:23:12 +00001720 fprintf(gOutFile,
1721 "<link_argument index=\"0\" type=\"MethodHandle\" value=\"%u\"/>\n",
1722 method_handle_idx);
1723 fprintf(gOutFile,
1724 "<link_argument index=\"1\" type=\"String\" values=\"%s\"/>\n",
1725 method_name);
1726 fprintf(gOutFile,
1727 "<link_argument index=\"2\" type=\"MethodType\" value=\"%s\"/>\n",
1728 method_type.c_str());
1729 }
1730
1731 size_t argument = 3;
1732 while (it.HasNext()) {
1733 const char* type;
1734 std::string value;
1735 switch (it.GetValueType()) {
1736 case EncodedArrayValueIterator::ValueType::kByte:
1737 type = "byte";
1738 value = android::base::StringPrintf("%u", it.GetJavaValue().b);
1739 break;
1740 case EncodedArrayValueIterator::ValueType::kShort:
1741 type = "short";
1742 value = android::base::StringPrintf("%d", it.GetJavaValue().s);
1743 break;
1744 case EncodedArrayValueIterator::ValueType::kChar:
1745 type = "char";
1746 value = android::base::StringPrintf("%u", it.GetJavaValue().c);
1747 break;
1748 case EncodedArrayValueIterator::ValueType::kInt:
1749 type = "int";
1750 value = android::base::StringPrintf("%d", it.GetJavaValue().i);
1751 break;
1752 case EncodedArrayValueIterator::ValueType::kLong:
1753 type = "long";
1754 value = android::base::StringPrintf("%" PRId64, it.GetJavaValue().j);
1755 break;
1756 case EncodedArrayValueIterator::ValueType::kFloat:
1757 type = "float";
1758 value = android::base::StringPrintf("%g", it.GetJavaValue().f);
1759 break;
1760 case EncodedArrayValueIterator::ValueType::kDouble:
1761 type = "double";
1762 value = android::base::StringPrintf("%g", it.GetJavaValue().d);
1763 break;
1764 case EncodedArrayValueIterator::ValueType::kMethodType: {
1765 type = "MethodType";
1766 uint32_t proto_idx = static_cast<uint32_t>(it.GetJavaValue().i);
1767 const DexFile::ProtoId& proto_id = pDexFile->GetProtoId(proto_idx);
1768 value = pDexFile->GetProtoSignature(proto_id).ToString();
1769 break;
1770 }
1771 case EncodedArrayValueIterator::ValueType::kMethodHandle:
1772 type = "MethodHandle";
1773 value = android::base::StringPrintf("%d", it.GetJavaValue().i);
1774 break;
1775 case EncodedArrayValueIterator::ValueType::kString: {
1776 type = "String";
1777 dex::StringIndex string_idx = static_cast<dex::StringIndex>(it.GetJavaValue().i);
1778 value = pDexFile->StringDataByIdx(string_idx);
1779 break;
1780 }
1781 case EncodedArrayValueIterator::ValueType::kType: {
1782 type = "Class";
1783 dex::TypeIndex type_idx = static_cast<dex::TypeIndex>(it.GetJavaValue().i);
1784 const DexFile::ClassDef* class_def = pDexFile->FindClassDef(type_idx);
1785 value = pDexFile->GetClassDescriptor(*class_def);
1786 value = descriptorClassToDot(value.c_str()).get();
1787 break;
1788 }
1789 case EncodedArrayValueIterator::ValueType::kField:
1790 case EncodedArrayValueIterator::ValueType::kMethod:
1791 case EncodedArrayValueIterator::ValueType::kEnum:
1792 case EncodedArrayValueIterator::ValueType::kArray:
1793 case EncodedArrayValueIterator::ValueType::kAnnotation:
1794 // Unreachable based on current EncodedArrayValueIterator::Next().
Andreas Gampef45d61c2017-06-07 10:29:33 -07001795 UNIMPLEMENTED(FATAL) << " type " << it.GetValueType();
Orion Hodsonc069a302017-01-18 09:23:12 +00001796 UNREACHABLE();
Orion Hodsonc069a302017-01-18 09:23:12 +00001797 case EncodedArrayValueIterator::ValueType::kNull:
1798 type = "Null";
1799 value = "null";
1800 break;
1801 case EncodedArrayValueIterator::ValueType::kBoolean:
1802 type = "boolean";
1803 value = it.GetJavaValue().z ? "true" : "false";
1804 break;
1805 }
1806
1807 if (gOptions.outputFormat == OUTPUT_PLAIN) {
1808 fprintf(gOutFile, " link_argument[%zu] : %s (%s)\n", argument, value.c_str(), type);
1809 } else {
1810 fprintf(gOutFile, "<link_argument index=\"%zu\" type=\"%s\" value=", argument, type);
1811 dumpEscapedString(value.c_str());
1812 fprintf(gOutFile, "/>\n");
1813 }
1814
1815 it.Next();
1816 argument++;
1817 }
1818
1819 if (gOptions.outputFormat == OUTPUT_XML) {
1820 fprintf(gOutFile, "</call_site>\n");
1821 }
1822}
1823
Aart Bik69ae54a2015-07-01 14:52:26 -07001824/*
1825 * Dumps the requested sections of the file.
1826 */
Aart Bik7b45a8a2016-10-24 16:07:59 -07001827static void processDexFile(const char* fileName,
1828 const DexFile* pDexFile, size_t i, size_t n) {
Aart Bik69ae54a2015-07-01 14:52:26 -07001829 if (gOptions.verbose) {
Aart Bik7b45a8a2016-10-24 16:07:59 -07001830 fputs("Opened '", gOutFile);
1831 fputs(fileName, gOutFile);
1832 if (n > 1) {
Mathieu Chartier79c87da2017-10-10 11:54:29 -07001833 fprintf(gOutFile, ":%s", DexFileLoader::GetMultiDexClassesDexName(i).c_str());
Aart Bik7b45a8a2016-10-24 16:07:59 -07001834 }
1835 fprintf(gOutFile, "', DEX version '%.3s'\n", pDexFile->GetHeader().magic_ + 4);
Aart Bik69ae54a2015-07-01 14:52:26 -07001836 }
1837
1838 // Headers.
1839 if (gOptions.showFileHeaders) {
1840 dumpFileHeader(pDexFile);
1841 }
1842
1843 // Open XML context.
1844 if (gOptions.outputFormat == OUTPUT_XML) {
1845 fprintf(gOutFile, "<api>\n");
1846 }
1847
1848 // Iterate over all classes.
1849 char* package = nullptr;
1850 const u4 classDefsSize = pDexFile->GetHeader().class_defs_size_;
1851 for (u4 i = 0; i < classDefsSize; i++) {
Aart Bik69ae54a2015-07-01 14:52:26 -07001852 dumpClass(pDexFile, i, &package);
1853 } // for
1854
Orion Hodsonc069a302017-01-18 09:23:12 +00001855 // Iterate over all method handles.
1856 for (u4 i = 0; i < pDexFile->NumMethodHandles(); ++i) {
1857 dumpMethodHandle(pDexFile, i);
1858 } // for
1859
1860 // Iterate over all call site ids.
1861 for (u4 i = 0; i < pDexFile->NumCallSiteIds(); ++i) {
1862 dumpCallSite(pDexFile, i);
1863 } // for
1864
Aart Bik69ae54a2015-07-01 14:52:26 -07001865 // Free the last package allocated.
1866 if (package != nullptr) {
1867 fprintf(gOutFile, "</package>\n");
1868 free(package);
1869 }
1870
1871 // Close XML context.
1872 if (gOptions.outputFormat == OUTPUT_XML) {
1873 fprintf(gOutFile, "</api>\n");
1874 }
1875}
1876
1877/*
1878 * Processes a single file (either direct .dex or indirect .zip/.jar/.apk).
1879 */
1880int processFile(const char* fileName) {
1881 if (gOptions.verbose) {
1882 fprintf(gOutFile, "Processing '%s'...\n", fileName);
1883 }
1884
Nicolas Geoffrayc1d8caa2018-02-27 10:15:14 +00001885 const bool kVerifyChecksum = !gOptions.ignoreBadChecksum;
1886 const bool kVerify = !gOptions.disableVerifier;
1887 std::string content;
Aart Bik69ae54a2015-07-01 14:52:26 -07001888 // If the file is not a .dex file, the function tries .zip/.jar/.apk files,
Aart Bikdce50862016-06-10 16:04:03 -07001889 // all of which are Zip archives with "classes.dex" inside.
David Sehr999646d2018-02-16 10:22:33 -08001890 // TODO: add an api to android::base to read a std::vector<uint8_t>.
1891 if (!android::base::ReadFileToString(fileName, &content)) {
1892 LOG(ERROR) << "ReadFileToString failed";
David Sehr5a1f6292018-01-19 11:08:51 -08001893 return -1;
1894 }
1895 const DexFileLoader dex_file_loader;
David Sehr999646d2018-02-16 10:22:33 -08001896 std::string error_msg;
Aart Bik69ae54a2015-07-01 14:52:26 -07001897 std::vector<std::unique_ptr<const DexFile>> dex_files;
David Sehr999646d2018-02-16 10:22:33 -08001898 if (!dex_file_loader.OpenAll(reinterpret_cast<const uint8_t*>(content.data()),
1899 content.size(),
1900 fileName,
Nicolas Geoffrayc1d8caa2018-02-27 10:15:14 +00001901 kVerify,
David Sehr999646d2018-02-16 10:22:33 -08001902 kVerifyChecksum,
1903 &error_msg,
1904 &dex_files)) {
Aart Bik69ae54a2015-07-01 14:52:26 -07001905 // Display returned error message to user. Note that this error behavior
1906 // differs from the error messages shown by the original Dalvik dexdump.
Andreas Gampe221d9812018-01-22 17:48:56 -08001907 LOG(ERROR) << error_msg;
Aart Bik69ae54a2015-07-01 14:52:26 -07001908 return -1;
1909 }
1910
Aart Bik4e149602015-07-09 11:45:28 -07001911 // Success. Either report checksum verification or process
1912 // all dex files found in given file.
Aart Bik69ae54a2015-07-01 14:52:26 -07001913 if (gOptions.checksumOnly) {
1914 fprintf(gOutFile, "Checksum verified\n");
1915 } else {
Aart Bik7b45a8a2016-10-24 16:07:59 -07001916 for (size_t i = 0, n = dex_files.size(); i < n; i++) {
1917 processDexFile(fileName, dex_files[i].get(), i, n);
Aart Bik4e149602015-07-09 11:45:28 -07001918 }
Aart Bik69ae54a2015-07-01 14:52:26 -07001919 }
1920 return 0;
1921}
1922
1923} // namespace art