oatdump.cc revision b9beb2e2efb6a204a69ca660d478b45f851e8f09
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <stdio.h>
18#include <stdlib.h>
19
20#include <fstream>
21#include <iostream>
22#include <string>
23#include <vector>
24
25#include "base/stringpiece.h"
26#include "base/unix_file/fd_file.h"
27#include "class_linker.h"
28#include "class_linker-inl.h"
29#include "dex_file-inl.h"
30#include "dex_instruction.h"
31#include "disassembler.h"
32#include "gc_map.h"
33#include "gc/space/image_space.h"
34#include "gc/space/large_object_space.h"
35#include "gc/space/space-inl.h"
36#include "image.h"
37#include "indenter.h"
38#include "mapping_table.h"
39#include "mirror/art_field-inl.h"
40#include "mirror/art_method-inl.h"
41#include "mirror/array-inl.h"
42#include "mirror/class-inl.h"
43#include "mirror/object-inl.h"
44#include "mirror/object_array-inl.h"
45#include "noop_compiler_callbacks.h"
46#include "oat.h"
47#include "oat_file-inl.h"
48#include "object_utils.h"
49#include "os.h"
50#include "runtime.h"
51#include "safe_map.h"
52#include "scoped_thread_state_change.h"
53#include "thread_list.h"
54#include "verifier/dex_gc_map.h"
55#include "verifier/method_verifier.h"
56#include "vmap_table.h"
57
58namespace art {
59
60static void usage() {
61  fprintf(stderr,
62          "Usage: oatdump [options] ...\n"
63          "    Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art\n"
64          "    Example: adb shell oatdump --image=/system/framework/boot.art\n"
65          "\n");
66  fprintf(stderr,
67          "  --oat-file=<file.oat>: specifies an input oat filename.\n"
68          "      Example: --oat-file=/system/framework/boot.oat\n"
69          "\n");
70  fprintf(stderr,
71          "  --image=<file.art>: specifies an input image filename.\n"
72          "      Example: --image=/system/framework/boot.art\n"
73          "\n");
74  fprintf(stderr,
75          "  --boot-image=<file.art>: provide the image file for the boot class path.\n"
76          "      Example: --boot-image=/system/framework/boot.art\n"
77          "\n");
78  fprintf(stderr,
79          "  --output=<file> may be used to send the output to a file.\n"
80          "      Example: --output=/tmp/oatdump.txt\n"
81          "\n");
82  fprintf(stderr,
83          "  --dump:[raw_mapping_table|raw_gc_map]\n"
84          "    Example: --dump:raw_gc_map\n"
85          "    Default: neither\n"
86          "\n");
87  exit(EXIT_FAILURE);
88}
89
90const char* image_roots_descriptions_[] = {
91  "kResolutionMethod",
92  "kImtConflictMethod",
93  "kDefaultImt",
94  "kCalleeSaveMethod",
95  "kRefsOnlySaveMethod",
96  "kRefsAndArgsSaveMethod",
97  "kDexCaches",
98  "kClassRoots",
99};
100
101class OatDumper {
102 public:
103  explicit OatDumper(const OatFile& oat_file, bool dump_raw_mapping_table, bool dump_raw_gc_map)
104    : oat_file_(oat_file),
105      oat_dex_files_(oat_file.GetOatDexFiles()),
106      dump_raw_mapping_table_(dump_raw_mapping_table),
107      dump_raw_gc_map_(dump_raw_gc_map),
108      disassembler_(Disassembler::Create(oat_file_.GetOatHeader().GetInstructionSet())) {
109    AddAllOffsets();
110  }
111
112  void Dump(std::ostream& os) {
113    const OatHeader& oat_header = oat_file_.GetOatHeader();
114
115    os << "MAGIC:\n";
116    os << oat_header.GetMagic() << "\n\n";
117
118    os << "CHECKSUM:\n";
119    os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum());
120
121    os << "INSTRUCTION SET:\n";
122    os << oat_header.GetInstructionSet() << "\n\n";
123
124    os << "INSTRUCTION SET FEATURES:\n";
125    os << oat_header.GetInstructionSetFeatures().GetFeatureString() << "\n\n";
126
127    os << "DEX FILE COUNT:\n";
128    os << oat_header.GetDexFileCount() << "\n\n";
129
130#define DUMP_OAT_HEADER_OFFSET(label, offset) \
131    os << label " OFFSET:\n"; \
132    os << StringPrintf("0x%08x", oat_header.offset()); \
133    if (oat_header.offset() != 0) { \
134      os << StringPrintf(" (%p)", oat_file_.Begin() + oat_header.offset()); \
135    } \
136    os << StringPrintf("\n\n");
137
138    DUMP_OAT_HEADER_OFFSET("EXECUTABLE", GetExecutableOffset);
139    DUMP_OAT_HEADER_OFFSET("INTERPRETER TO INTERPRETER BRIDGE",
140                           GetInterpreterToInterpreterBridgeOffset);
141    DUMP_OAT_HEADER_OFFSET("INTERPRETER TO COMPILED CODE BRIDGE",
142                           GetInterpreterToCompiledCodeBridgeOffset);
143    DUMP_OAT_HEADER_OFFSET("JNI DLSYM LOOKUP",
144                           GetJniDlsymLookupOffset);
145    DUMP_OAT_HEADER_OFFSET("PORTABLE IMT CONFLICT TRAMPOLINE",
146                           GetPortableImtConflictTrampolineOffset);
147    DUMP_OAT_HEADER_OFFSET("PORTABLE RESOLUTION TRAMPOLINE",
148                           GetPortableResolutionTrampolineOffset);
149    DUMP_OAT_HEADER_OFFSET("PORTABLE TO INTERPRETER BRIDGE",
150                           GetPortableToInterpreterBridgeOffset);
151    DUMP_OAT_HEADER_OFFSET("QUICK GENERIC JNI TRAMPOLINE",
152                           GetQuickGenericJniTrampolineOffset);
153    DUMP_OAT_HEADER_OFFSET("QUICK IMT CONFLICT TRAMPOLINE",
154                           GetQuickImtConflictTrampolineOffset);
155    DUMP_OAT_HEADER_OFFSET("QUICK RESOLUTION TRAMPOLINE",
156                           GetQuickResolutionTrampolineOffset);
157    DUMP_OAT_HEADER_OFFSET("QUICK TO INTERPRETER BRIDGE",
158                           GetQuickToInterpreterBridgeOffset);
159#undef DUMP_OAT_HEADER_OFFSET
160
161    os << "IMAGE FILE LOCATION OAT CHECKSUM:\n";
162    os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatChecksum());
163
164    os << "IMAGE FILE LOCATION OAT BEGIN:\n";
165    os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatDataBegin());
166
167    os << "IMAGE FILE LOCATION:\n";
168    const std::string image_file_location(oat_header.GetImageFileLocation());
169    os << image_file_location;
170    os << "\n\n";
171
172    os << "BEGIN:\n";
173    os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n";
174
175    os << "END:\n";
176    os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n";
177
178    os << std::flush;
179
180    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
181      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
182      CHECK(oat_dex_file != NULL);
183      DumpOatDexFile(os, *oat_dex_file);
184    }
185  }
186
187  size_t ComputeSize(const void* oat_data) {
188    if (reinterpret_cast<const byte*>(oat_data) < oat_file_.Begin() ||
189        reinterpret_cast<const byte*>(oat_data) > oat_file_.End()) {
190      return 0;  // Address not in oat file
191    }
192    uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) -
193                             reinterpret_cast<uintptr_t>(oat_file_.Begin());
194    auto it = offsets_.upper_bound(begin_offset);
195    CHECK(it != offsets_.end());
196    uintptr_t end_offset = *it;
197    return end_offset - begin_offset;
198  }
199
200  InstructionSet GetInstructionSet() {
201    return oat_file_.GetOatHeader().GetInstructionSet();
202  }
203
204  const void* GetQuickOatCode(mirror::ArtMethod* m) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
205    MethodHelper mh(m);
206    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
207      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
208      CHECK(oat_dex_file != nullptr);
209      std::string error_msg;
210      UniquePtr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
211      if (dex_file.get() == nullptr) {
212        LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
213            << "': " << error_msg;
214      } else {
215        const DexFile::ClassDef* class_def =
216            dex_file->FindClassDef(mh.GetDeclaringClassDescriptor());
217        if (class_def != NULL) {
218          uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def);
219          const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
220          size_t method_index = m->GetMethodIndex();
221          return oat_class.GetOatMethod(method_index).GetQuickCode();
222        }
223      }
224    }
225    return NULL;
226  }
227
228 private:
229  void AddAllOffsets() {
230    // We don't know the length of the code for each method, but we need to know where to stop
231    // when disassembling. What we do know is that a region of code will be followed by some other
232    // region, so if we keep a sorted sequence of the start of each region, we can infer the length
233    // of a piece of code by using upper_bound to find the start of the next region.
234    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
235      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
236      CHECK(oat_dex_file != NULL);
237      std::string error_msg;
238      UniquePtr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
239      if (dex_file.get() == nullptr) {
240        LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
241            << "': " << error_msg;
242        continue;
243      }
244      offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader()));
245      for (size_t class_def_index = 0;
246           class_def_index < dex_file->NumClassDefs();
247           class_def_index++) {
248        const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
249        const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
250        const byte* class_data = dex_file->GetClassData(class_def);
251        if (class_data != NULL) {
252          ClassDataItemIterator it(*dex_file, class_data);
253          SkipAllFields(it);
254          uint32_t class_method_index = 0;
255          while (it.HasNextDirectMethod()) {
256            AddOffsets(oat_class.GetOatMethod(class_method_index++));
257            it.Next();
258          }
259          while (it.HasNextVirtualMethod()) {
260            AddOffsets(oat_class.GetOatMethod(class_method_index++));
261            it.Next();
262          }
263        }
264      }
265    }
266
267    // If the last thing in the file is code for a method, there won't be an offset for the "next"
268    // thing. Instead of having a special case in the upper_bound code, let's just add an entry
269    // for the end of the file.
270    offsets_.insert(oat_file_.Size());
271  }
272
273  void AddOffsets(const OatFile::OatMethod& oat_method) {
274    uint32_t code_offset = oat_method.GetCodeOffset();
275    if (oat_file_.GetOatHeader().GetInstructionSet() == kThumb2) {
276      code_offset &= ~0x1;
277    }
278    offsets_.insert(code_offset);
279    offsets_.insert(oat_method.GetMappingTableOffset());
280    offsets_.insert(oat_method.GetVmapTableOffset());
281    offsets_.insert(oat_method.GetNativeGcMapOffset());
282  }
283
284  void DumpOatDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) {
285    os << "OAT DEX FILE:\n";
286    os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str());
287    os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum());
288
289    // Create the verifier early.
290
291    std::string error_msg;
292    UniquePtr<const DexFile> dex_file(oat_dex_file.OpenDexFile(&error_msg));
293    if (dex_file.get() == NULL) {
294      os << "NOT FOUND: " << error_msg << "\n\n";
295      return;
296    }
297    for (size_t class_def_index = 0;
298         class_def_index < dex_file->NumClassDefs();
299         class_def_index++) {
300      const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
301      const char* descriptor = dex_file->GetClassDescriptor(class_def);
302      const OatFile::OatClass oat_class = oat_dex_file.GetOatClass(class_def_index);
303      os << StringPrintf("%zd: %s (type_idx=%d)", class_def_index, descriptor, class_def.class_idx_)
304         << " (" << oat_class.GetStatus() << ")"
305         << " (" << oat_class.GetType() << ")\n";
306      // TODO: include bitmap here if type is kOatClassSomeCompiled?
307      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
308      std::ostream indented_os(&indent_filter);
309      DumpOatClass(indented_os, oat_class, *(dex_file.get()), class_def);
310    }
311
312    os << std::flush;
313  }
314
315  static void SkipAllFields(ClassDataItemIterator& it) {
316    while (it.HasNextStaticField()) {
317      it.Next();
318    }
319    while (it.HasNextInstanceField()) {
320      it.Next();
321    }
322  }
323
324  void DumpOatClass(std::ostream& os, const OatFile::OatClass& oat_class, const DexFile& dex_file,
325                    const DexFile::ClassDef& class_def) {
326    const byte* class_data = dex_file.GetClassData(class_def);
327    if (class_data == NULL) {  // empty class such as a marker interface?
328      return;
329    }
330    ClassDataItemIterator it(dex_file, class_data);
331    SkipAllFields(it);
332    uint32_t class_method_idx = 0;
333    while (it.HasNextDirectMethod()) {
334      const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx);
335      DumpOatMethod(os, class_def, class_method_idx, oat_method, dex_file,
336                    it.GetMemberIndex(), it.GetMethodCodeItem(), it.GetMemberAccessFlags());
337      class_method_idx++;
338      it.Next();
339    }
340    while (it.HasNextVirtualMethod()) {
341      const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx);
342      DumpOatMethod(os, class_def, class_method_idx, oat_method, dex_file,
343                    it.GetMemberIndex(), it.GetMethodCodeItem(), it.GetMemberAccessFlags());
344      class_method_idx++;
345      it.Next();
346    }
347    DCHECK(!it.HasNext());
348    os << std::flush;
349  }
350
351  void DumpOatMethod(std::ostream& os, const DexFile::ClassDef& class_def,
352                     uint32_t class_method_index,
353                     const OatFile::OatMethod& oat_method, const DexFile& dex_file,
354                     uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
355                     uint32_t method_access_flags) {
356    os << StringPrintf("%d: %s (dex_method_idx=%d)\n",
357                       class_method_index, PrettyMethod(dex_method_idx, dex_file, true).c_str(),
358                       dex_method_idx);
359    Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
360    std::ostream indent1_os(&indent1_filter);
361    {
362      indent1_os << "DEX CODE:\n";
363      Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
364      std::ostream indent2_os(&indent2_filter);
365      DumpDexCode(indent2_os, dex_file, code_item);
366    }
367    if (Runtime::Current() != NULL) {
368      indent1_os << "VERIFIER TYPE ANALYSIS:\n";
369      Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
370      std::ostream indent2_os(&indent2_filter);
371      DumpVerifier(indent2_os, dex_method_idx, &dex_file, class_def, code_item,
372                   method_access_flags);
373    }
374    {
375      indent1_os << "OAT DATA:\n";
376      Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
377      std::ostream indent2_os(&indent2_filter);
378
379      indent2_os << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes());
380      indent2_os << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask());
381      DumpSpillMask(indent2_os, oat_method.GetCoreSpillMask(), false);
382      indent2_os << StringPrintf("\nfp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask());
383      DumpSpillMask(indent2_os, oat_method.GetFpSpillMask(), true);
384      indent2_os << StringPrintf("\nvmap_table: %p (offset=0x%08x)\n",
385                                 oat_method.GetVmapTable(), oat_method.GetVmapTableOffset());
386      DumpVmap(indent2_os, oat_method);
387      indent2_os << StringPrintf("mapping_table: %p (offset=0x%08x)\n",
388                                 oat_method.GetMappingTable(), oat_method.GetMappingTableOffset());
389      if (dump_raw_mapping_table_) {
390        Indenter indent3_filter(indent2_os.rdbuf(), kIndentChar, kIndentBy1Count);
391        std::ostream indent3_os(&indent3_filter);
392        DumpMappingTable(indent3_os, oat_method);
393      }
394      indent2_os << StringPrintf("gc_map: %p (offset=0x%08x)\n",
395                                 oat_method.GetNativeGcMap(), oat_method.GetNativeGcMapOffset());
396      if (dump_raw_gc_map_) {
397        Indenter indent3_filter(indent2_os.rdbuf(), kIndentChar, kIndentBy1Count);
398        std::ostream indent3_os(&indent3_filter);
399        DumpGcMap(indent3_os, oat_method, code_item);
400      }
401    }
402    {
403      const void* code = oat_method.GetQuickCode();
404      uint32_t code_size = oat_method.GetQuickCodeSize();
405      if (code == nullptr) {
406        code = oat_method.GetPortableCode();
407        code_size = oat_method.GetPortableCodeSize();
408      }
409      indent1_os << StringPrintf("CODE: %p (offset=0x%08x size=%d)%s\n",
410                                 code,
411                                 oat_method.GetCodeOffset(),
412                                 code_size,
413                                 code != nullptr ? "..." : "");
414      Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
415      std::ostream indent2_os(&indent2_filter);
416
417      Runtime* runtime = Runtime::Current();
418      if (runtime != nullptr) {
419        ScopedObjectAccess soa(Thread::Current());
420        SirtRef<mirror::DexCache> dex_cache(
421            soa.Self(), runtime->GetClassLinker()->FindDexCache(dex_file));
422        SirtRef<mirror::ClassLoader> class_loader(soa.Self(), nullptr);
423        verifier::MethodVerifier verifier(&dex_file, &dex_cache, &class_loader, &class_def,
424                                          code_item, dex_method_idx, nullptr, method_access_flags,
425                                          true, true);
426        verifier.Verify();
427        DumpCode(indent2_os, &verifier, oat_method, code_item);
428      } else {
429        DumpCode(indent2_os, nullptr, oat_method, code_item);
430      }
431    }
432  }
433
434  void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) {
435    if (spill_mask == 0) {
436      return;
437    }
438    os << "(";
439    for (size_t i = 0; i < 32; i++) {
440      if ((spill_mask & (1 << i)) != 0) {
441        if (is_float) {
442          os << "fr" << i;
443        } else {
444          os << "r" << i;
445        }
446        spill_mask ^= 1 << i;  // clear bit
447        if (spill_mask != 0) {
448          os << ", ";
449        } else {
450          break;
451        }
452      }
453    }
454    os << ")";
455  }
456
457  void DumpVmap(std::ostream& os, const OatFile::OatMethod& oat_method) {
458    const uint8_t* raw_table = oat_method.GetVmapTable();
459    if (raw_table != NULL) {
460      const VmapTable vmap_table(raw_table);
461      bool first = true;
462      bool processing_fp = false;
463      uint32_t spill_mask = oat_method.GetCoreSpillMask();
464      for (size_t i = 0; i < vmap_table.Size(); i++) {
465        uint16_t dex_reg = vmap_table[i];
466        uint32_t cpu_reg = vmap_table.ComputeRegister(spill_mask, i,
467                                                      processing_fp ? kFloatVReg : kIntVReg);
468        os << (first ? "v" : ", v")  << dex_reg;
469        if (!processing_fp) {
470          os << "/r" << cpu_reg;
471        } else {
472          os << "/fr" << cpu_reg;
473        }
474        first = false;
475        if (!processing_fp && dex_reg == 0xFFFF) {
476          processing_fp = true;
477          spill_mask = oat_method.GetFpSpillMask();
478        }
479      }
480      os << "\n";
481    }
482  }
483
484  void DescribeVReg(std::ostream& os, const OatFile::OatMethod& oat_method,
485                    const DexFile::CodeItem* code_item, size_t reg, VRegKind kind) {
486    const uint8_t* raw_table = oat_method.GetVmapTable();
487    if (raw_table != NULL) {
488      const VmapTable vmap_table(raw_table);
489      uint32_t vmap_offset;
490      if (vmap_table.IsInContext(reg, kind, &vmap_offset)) {
491        bool is_float = (kind == kFloatVReg) || (kind == kDoubleLoVReg) || (kind == kDoubleHiVReg);
492        uint32_t spill_mask = is_float ? oat_method.GetFpSpillMask()
493                                       : oat_method.GetCoreSpillMask();
494        os << (is_float ? "fr" : "r") << vmap_table.ComputeRegister(spill_mask, vmap_offset, kind);
495      } else {
496        uint32_t offset = StackVisitor::GetVRegOffset(code_item, oat_method.GetCoreSpillMask(),
497                                                      oat_method.GetFpSpillMask(),
498                                                      oat_method.GetFrameSizeInBytes(), reg,
499                                                      GetInstructionSet());
500        os << "[sp + #" << offset << "]";
501      }
502    }
503  }
504
505  void DumpGcMapRegisters(std::ostream& os, const OatFile::OatMethod& oat_method,
506                          const DexFile::CodeItem* code_item,
507                          size_t num_regs, const uint8_t* reg_bitmap) {
508    bool first = true;
509    for (size_t reg = 0; reg < num_regs; reg++) {
510      if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
511        if (first) {
512          os << "  v" << reg << " (";
513          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
514          os << ")";
515          first = false;
516        } else {
517          os << ", v" << reg << " (";
518          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
519          os << ")";
520        }
521      }
522    }
523    if (first) {
524      os << "No registers in GC map\n";
525    } else {
526      os << "\n";
527    }
528  }
529  void DumpGcMap(std::ostream& os, const OatFile::OatMethod& oat_method,
530                 const DexFile::CodeItem* code_item) {
531    const uint8_t* gc_map_raw = oat_method.GetNativeGcMap();
532    if (gc_map_raw == nullptr) {
533      return;  // No GC map.
534    }
535    const void* quick_code = oat_method.GetQuickCode();
536    if (quick_code != nullptr) {
537      NativePcOffsetToReferenceMap map(gc_map_raw);
538      for (size_t entry = 0; entry < map.NumEntries(); entry++) {
539        const uint8_t* native_pc = reinterpret_cast<const uint8_t*>(quick_code) +
540            map.GetNativePcOffset(entry);
541        os << StringPrintf("%p", native_pc);
542        DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
543      }
544    } else {
545      const void* portable_code = oat_method.GetPortableCode();
546      CHECK(portable_code != nullptr);
547      verifier::DexPcToReferenceMap map(gc_map_raw);
548      for (size_t entry = 0; entry < map.NumEntries(); entry++) {
549        uint32_t dex_pc = map.GetDexPc(entry);
550        os << StringPrintf("0x%08x", dex_pc);
551        DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
552      }
553    }
554  }
555
556  void DumpMappingTable(std::ostream& os, const OatFile::OatMethod& oat_method) {
557    const void* quick_code = oat_method.GetQuickCode();
558    if (quick_code == nullptr) {
559      return;
560    }
561    MappingTable table(oat_method.GetMappingTable());
562    if (table.TotalSize() != 0) {
563      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
564      std::ostream indent_os(&indent_filter);
565      if (table.PcToDexSize() != 0) {
566        typedef MappingTable::PcToDexIterator It;
567        os << "suspend point mappings {\n";
568        for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
569          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
570        }
571        os << "}\n";
572      }
573      if (table.DexToPcSize() != 0) {
574        typedef MappingTable::DexToPcIterator It;
575        os << "catch entry mappings {\n";
576        for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
577          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
578        }
579        os << "}\n";
580      }
581    }
582  }
583
584  uint32_t DumpMappingAtOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
585                               size_t offset, bool suspend_point_mapping) {
586    MappingTable table(oat_method.GetMappingTable());
587    if (suspend_point_mapping && table.PcToDexSize() > 0) {
588      typedef MappingTable::PcToDexIterator It;
589      for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
590        if (offset == cur.NativePcOffset()) {
591          os << StringPrintf("suspend point dex PC: 0x%04x\n", cur.DexPc());
592          return cur.DexPc();
593        }
594      }
595    } else if (!suspend_point_mapping && table.DexToPcSize() > 0) {
596      typedef MappingTable::DexToPcIterator It;
597      for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
598        if (offset == cur.NativePcOffset()) {
599          os << StringPrintf("catch entry dex PC: 0x%04x\n", cur.DexPc());
600          return cur.DexPc();
601        }
602      }
603    }
604    return DexFile::kDexNoIndex;
605  }
606
607  void DumpGcMapAtNativePcOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
608                                 const DexFile::CodeItem* code_item, size_t native_pc_offset) {
609    const uint8_t* gc_map_raw = oat_method.GetNativeGcMap();
610    if (gc_map_raw != NULL) {
611      NativePcOffsetToReferenceMap map(gc_map_raw);
612      if (map.HasEntry(native_pc_offset)) {
613        size_t num_regs = map.RegWidth() * 8;
614        const uint8_t* reg_bitmap = map.FindBitMap(native_pc_offset);
615        bool first = true;
616        for (size_t reg = 0; reg < num_regs; reg++) {
617          if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
618            if (first) {
619              os << "GC map objects:  v" << reg << " (";
620              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
621              os << ")";
622              first = false;
623            } else {
624              os << ", v" << reg << " (";
625              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
626              os << ")";
627            }
628          }
629        }
630        if (!first) {
631          os << "\n";
632        }
633      }
634    }
635  }
636
637  void DumpVRegsAtDexPc(std::ostream& os, verifier::MethodVerifier* verifier,
638                        const OatFile::OatMethod& oat_method,
639                        const DexFile::CodeItem* code_item, uint32_t dex_pc) {
640    DCHECK(verifier != nullptr);
641    std::vector<int32_t> kinds = verifier->DescribeVRegs(dex_pc);
642    bool first = true;
643    for (size_t reg = 0; reg < code_item->registers_size_; reg++) {
644      VRegKind kind = static_cast<VRegKind>(kinds.at(reg * 2));
645      if (kind != kUndefined) {
646        if (first) {
647          os << "VRegs:  v";
648          first = false;
649        } else {
650          os << ", v";
651        }
652        os << reg << " (";
653        switch (kind) {
654          case kImpreciseConstant:
655            os << "Imprecise Constant: " << kinds.at((reg * 2) + 1) << ", ";
656            DescribeVReg(os, oat_method, code_item, reg, kind);
657            break;
658          case kConstant:
659            os << "Constant: " << kinds.at((reg * 2) + 1);
660            break;
661          default:
662            DescribeVReg(os, oat_method, code_item, reg, kind);
663            break;
664        }
665        os << ")";
666      }
667    }
668    if (!first) {
669      os << "\n";
670    }
671  }
672
673
674  void DumpDexCode(std::ostream& os, const DexFile& dex_file, const DexFile::CodeItem* code_item) {
675    if (code_item != NULL) {
676      size_t i = 0;
677      while (i < code_item->insns_size_in_code_units_) {
678        const Instruction* instruction = Instruction::At(&code_item->insns_[i]);
679        os << StringPrintf("0x%04zx: %s\n", i, instruction->DumpString(&dex_file).c_str());
680        i += instruction->SizeInCodeUnits();
681      }
682    }
683  }
684
685  void DumpVerifier(std::ostream& os, uint32_t dex_method_idx, const DexFile* dex_file,
686                    const DexFile::ClassDef& class_def, const DexFile::CodeItem* code_item,
687                    uint32_t method_access_flags) {
688    if ((method_access_flags & kAccNative) == 0) {
689      ScopedObjectAccess soa(Thread::Current());
690      SirtRef<mirror::DexCache> dex_cache(
691          soa.Self(), Runtime::Current()->GetClassLinker()->FindDexCache(*dex_file));
692      SirtRef<mirror::ClassLoader> class_loader(soa.Self(), nullptr);
693      verifier::MethodVerifier::VerifyMethodAndDump(os, dex_method_idx, dex_file, dex_cache,
694                                                    class_loader, &class_def, code_item, NULL,
695                                                    method_access_flags);
696    }
697  }
698
699  void DumpCode(std::ostream& os, verifier::MethodVerifier* verifier,
700                const OatFile::OatMethod& oat_method, const DexFile::CodeItem* code_item) {
701    const void* portable_code = oat_method.GetPortableCode();
702    const void* quick_code = oat_method.GetQuickCode();
703
704    size_t code_size = oat_method.GetQuickCodeSize();
705    if ((code_size == 0) || ((portable_code == nullptr) && (quick_code == nullptr))) {
706      os << "NO CODE!\n";
707      return;
708    } else if (quick_code != nullptr) {
709      const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
710      size_t offset = 0;
711      while (offset < code_size) {
712        DumpMappingAtOffset(os, oat_method, offset, false);
713        offset += disassembler_->Dump(os, quick_native_pc + offset);
714        uint32_t dex_pc = DumpMappingAtOffset(os, oat_method, offset, true);
715        if (dex_pc != DexFile::kDexNoIndex) {
716          DumpGcMapAtNativePcOffset(os, oat_method, code_item, offset);
717          if (verifier != nullptr) {
718            DumpVRegsAtDexPc(os, verifier, oat_method, code_item, dex_pc);
719          }
720        }
721      }
722    } else {
723      CHECK(portable_code != nullptr);
724      CHECK_EQ(code_size, 0U);  // TODO: disassembly of portable is currently not supported.
725    }
726  }
727
728  const OatFile& oat_file_;
729  std::vector<const OatFile::OatDexFile*> oat_dex_files_;
730  bool dump_raw_mapping_table_;
731  bool dump_raw_gc_map_;
732  std::set<uintptr_t> offsets_;
733  UniquePtr<Disassembler> disassembler_;
734};
735
736class ImageDumper {
737 public:
738  explicit ImageDumper(std::ostream* os, gc::space::ImageSpace& image_space,
739                       const ImageHeader& image_header, bool dump_raw_mapping_table,
740                       bool dump_raw_gc_map)
741      : os_(os), image_space_(image_space), image_header_(image_header),
742        dump_raw_mapping_table_(dump_raw_mapping_table),
743        dump_raw_gc_map_(dump_raw_gc_map) {}
744
745  void Dump() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
746    std::ostream& os = *os_;
747    os << "MAGIC: " << image_header_.GetMagic() << "\n\n";
748
749    os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n";
750
751    os << "IMAGE BITMAP OFFSET: " << reinterpret_cast<void*>(image_header_.GetImageBitmapOffset())
752       << " SIZE: " << reinterpret_cast<void*>(image_header_.GetImageBitmapSize()) << "\n\n";
753
754    os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum());
755
756    os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n";
757
758    os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n";
759
760    os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n";
761
762    os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n";
763
764    {
765      os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n";
766      Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
767      std::ostream indent1_os(&indent1_filter);
768      CHECK_EQ(arraysize(image_roots_descriptions_), size_t(ImageHeader::kImageRootsMax));
769      for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
770        ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i);
771        const char* image_root_description = image_roots_descriptions_[i];
772        mirror::Object* image_root_object = image_header_.GetImageRoot(image_root);
773        indent1_os << StringPrintf("%s: %p\n", image_root_description, image_root_object);
774        if (image_root_object->IsObjectArray()) {
775          Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
776          std::ostream indent2_os(&indent2_filter);
777          mirror::ObjectArray<mirror::Object>* image_root_object_array
778              = image_root_object->AsObjectArray<mirror::Object>();
779          for (int i = 0; i < image_root_object_array->GetLength(); i++) {
780            mirror::Object* value = image_root_object_array->Get(i);
781            size_t run = 0;
782            for (int32_t j = i + 1; j < image_root_object_array->GetLength(); j++) {
783              if (value == image_root_object_array->Get(j)) {
784                run++;
785              } else {
786                break;
787              }
788            }
789            if (run == 0) {
790              indent2_os << StringPrintf("%d: ", i);
791            } else {
792              indent2_os << StringPrintf("%d to %zd: ", i, i + run);
793              i = i + run;
794            }
795            if (value != NULL) {
796              PrettyObjectValue(indent2_os, value->GetClass(), value);
797            } else {
798              indent2_os << i << ": null\n";
799            }
800          }
801        }
802      }
803    }
804    os << "\n";
805
806    ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
807    std::string image_filename = image_space_.GetImageFilename();
808    std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename);
809    os << "OAT LOCATION: " << oat_location;
810    os << "\n";
811    std::string error_msg;
812    const OatFile* oat_file = class_linker->FindOatFileFromOatLocation(oat_location, &error_msg);
813    if (oat_file == NULL) {
814      os << "NOT FOUND: " << error_msg << "\n";
815      return;
816    }
817    os << "\n";
818
819    stats_.oat_file_bytes = oat_file->Size();
820
821    oat_dumper_.reset(new OatDumper(*oat_file, dump_raw_mapping_table_,
822        dump_raw_gc_map_));
823
824    for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
825      CHECK(oat_dex_file != NULL);
826      stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(),
827                                                         oat_dex_file->FileSize()));
828    }
829
830    os << "OBJECTS:\n" << std::flush;
831
832    // Loop through all the image spaces and dump their objects.
833    gc::Heap* heap = Runtime::Current()->GetHeap();
834    const std::vector<gc::space::ContinuousSpace*>& spaces = heap->GetContinuousSpaces();
835    Thread* self = Thread::Current();
836    {
837      {
838        WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
839        heap->FlushAllocStack();
840      }
841      // Since FlushAllocStack() above resets the (active) allocation
842      // stack. Need to revoke the thread-local allocation stacks that
843      // point into it.
844      {
845        self->TransitionFromRunnableToSuspended(kNative);
846        ThreadList* thread_list = Runtime::Current()->GetThreadList();
847        thread_list->SuspendAll();
848        heap->RevokeAllThreadLocalAllocationStacks(self);
849        thread_list->ResumeAll();
850        self->TransitionFromSuspendedToRunnable();
851      }
852    }
853    {
854      std::ostream* saved_os = os_;
855      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
856      std::ostream indent_os(&indent_filter);
857      os_ = &indent_os;
858      ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
859      for (const auto& space : spaces) {
860        if (space->IsImageSpace()) {
861          gc::space::ImageSpace* image_space = space->AsImageSpace();
862          image_space->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
863          indent_os << "\n";
864        }
865      }
866      // Dump the large objects separately.
867      heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
868      indent_os << "\n";
869      os_ = saved_os;
870    }
871    os << "STATS:\n" << std::flush;
872    UniquePtr<File> file(OS::OpenFileForReading(image_filename.c_str()));
873    if (file.get() == NULL) {
874      LOG(WARNING) << "Failed to find image in " << image_filename;
875    }
876    if (file.get() != NULL) {
877      stats_.file_bytes = file->GetLength();
878    }
879    size_t header_bytes = sizeof(ImageHeader);
880    stats_.header_bytes = header_bytes;
881    size_t alignment_bytes = RoundUp(header_bytes, kObjectAlignment) - header_bytes;
882    stats_.alignment_bytes += alignment_bytes;
883    stats_.alignment_bytes += image_header_.GetImageBitmapOffset() - image_header_.GetImageSize();
884    stats_.bitmap_bytes += image_header_.GetImageBitmapSize();
885    stats_.Dump(os);
886    os << "\n";
887
888    os << std::flush;
889
890    oat_dumper_->Dump(os);
891  }
892
893 private:
894  static void PrettyObjectValue(std::ostream& os, mirror::Class* type, mirror::Object* value)
895      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
896    CHECK(type != NULL);
897    if (value == NULL) {
898      os << StringPrintf("null   %s\n", PrettyDescriptor(type).c_str());
899    } else if (type->IsStringClass()) {
900      mirror::String* string = value->AsString();
901      os << StringPrintf("%p   String: %s\n", string,
902                         PrintableString(string->ToModifiedUtf8()).c_str());
903    } else if (type->IsClassClass()) {
904      mirror::Class* klass = value->AsClass();
905      os << StringPrintf("%p   Class: %s\n", klass, PrettyDescriptor(klass).c_str());
906    } else if (type->IsArtFieldClass()) {
907      mirror::ArtField* field = value->AsArtField();
908      os << StringPrintf("%p   Field: %s\n", field, PrettyField(field).c_str());
909    } else if (type->IsArtMethodClass()) {
910      mirror::ArtMethod* method = value->AsArtMethod();
911      os << StringPrintf("%p   Method: %s\n", method, PrettyMethod(method).c_str());
912    } else {
913      os << StringPrintf("%p   %s\n", value, PrettyDescriptor(type).c_str());
914    }
915  }
916
917  static void PrintField(std::ostream& os, mirror::ArtField* field, mirror::Object* obj)
918      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
919    FieldHelper fh(field);
920    const char* descriptor = fh.GetTypeDescriptor();
921    os << StringPrintf("%s: ", fh.GetName());
922    if (descriptor[0] != 'L' && descriptor[0] != '[') {
923      mirror::Class* type = fh.GetType();
924      if (type->IsPrimitiveLong()) {
925        os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj));
926      } else if (type->IsPrimitiveDouble()) {
927        os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj));
928      } else if (type->IsPrimitiveFloat()) {
929        os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj));
930      } else {
931        DCHECK(type->IsPrimitive());
932        os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj));
933      }
934    } else {
935      // Get the value, don't compute the type unless it is non-null as we don't want
936      // to cause class loading.
937      mirror::Object* value = field->GetObj(obj);
938      if (value == NULL) {
939        os << StringPrintf("null   %s\n", PrettyDescriptor(descriptor).c_str());
940      } else {
941        // Grab the field type without causing resolution.
942        mirror::Class* field_type = fh.GetType(false);
943        if (field_type != NULL) {
944          PrettyObjectValue(os, field_type, value);
945        } else {
946          os << StringPrintf("%p   %s\n", value, PrettyDescriptor(descriptor).c_str());
947        }
948      }
949    }
950  }
951
952  static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass)
953      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
954    mirror::Class* super = klass->GetSuperClass();
955    if (super != NULL) {
956      DumpFields(os, obj, super);
957    }
958    mirror::ObjectArray<mirror::ArtField>* fields = klass->GetIFields();
959    if (fields != NULL) {
960      for (int32_t i = 0; i < fields->GetLength(); i++) {
961        mirror::ArtField* field = fields->Get(i);
962        PrintField(os, field, obj);
963      }
964    }
965  }
966
967  bool InDumpSpace(const mirror::Object* object) {
968    return image_space_.Contains(object);
969  }
970
971  const void* GetQuickOatCodeBegin(mirror::ArtMethod* m)
972      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
973    const void* quick_code = m->GetEntryPointFromQuickCompiledCode();
974    if (quick_code == GetQuickResolutionTrampoline(Runtime::Current()->GetClassLinker())) {
975      quick_code = oat_dumper_->GetQuickOatCode(m);
976    }
977    if (oat_dumper_->GetInstructionSet() == kThumb2) {
978      quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1);
979    }
980    return quick_code;
981  }
982
983  uint32_t GetQuickOatCodeSize(mirror::ArtMethod* m)
984      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
985    const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m));
986    if (oat_code_begin == nullptr) {
987      return 0;
988    }
989    return oat_code_begin[-1];
990  }
991
992  const void* GetQuickOatCodeEnd(mirror::ArtMethod* m)
993      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
994    const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m));
995    if (oat_code_begin == NULL) {
996      return NULL;
997    }
998    return oat_code_begin + GetQuickOatCodeSize(m);
999  }
1000
1001  static void Callback(mirror::Object* obj, void* arg)
1002      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1003    DCHECK(obj != NULL);
1004    DCHECK(arg != NULL);
1005    ImageDumper* state = reinterpret_cast<ImageDumper*>(arg);
1006    if (!state->InDumpSpace(obj)) {
1007      return;
1008    }
1009
1010    size_t object_bytes = obj->SizeOf();
1011    size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes;
1012    state->stats_.object_bytes += object_bytes;
1013    state->stats_.alignment_bytes += alignment_bytes;
1014
1015    std::ostream& os = *state->os_;
1016    mirror::Class* obj_class = obj->GetClass();
1017    if (obj_class->IsArrayClass()) {
1018      os << StringPrintf("%p: %s length:%d\n", obj, PrettyDescriptor(obj_class).c_str(),
1019                         obj->AsArray()->GetLength());
1020    } else if (obj->IsClass()) {
1021      mirror::Class* klass = obj->AsClass();
1022      os << StringPrintf("%p: java.lang.Class \"%s\" (", obj, PrettyDescriptor(klass).c_str())
1023         << klass->GetStatus() << ")\n";
1024    } else if (obj->IsArtField()) {
1025      os << StringPrintf("%p: java.lang.reflect.ArtField %s\n", obj,
1026                         PrettyField(obj->AsArtField()).c_str());
1027    } else if (obj->IsArtMethod()) {
1028      os << StringPrintf("%p: java.lang.reflect.ArtMethod %s\n", obj,
1029                         PrettyMethod(obj->AsArtMethod()).c_str());
1030    } else if (obj_class->IsStringClass()) {
1031      os << StringPrintf("%p: java.lang.String %s\n", obj,
1032                         PrintableString(obj->AsString()->ToModifiedUtf8()).c_str());
1033    } else {
1034      os << StringPrintf("%p: %s\n", obj, PrettyDescriptor(obj_class).c_str());
1035    }
1036    Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1037    std::ostream indent_os(&indent_filter);
1038    DumpFields(indent_os, obj, obj_class);
1039    if (obj->IsObjectArray()) {
1040      mirror::ObjectArray<mirror::Object>* obj_array = obj->AsObjectArray<mirror::Object>();
1041      int32_t length = obj_array->GetLength();
1042      for (int32_t i = 0; i < length; i++) {
1043        mirror::Object* value = obj_array->Get(i);
1044        size_t run = 0;
1045        for (int32_t j = i + 1; j < length; j++) {
1046          if (value == obj_array->Get(j)) {
1047            run++;
1048          } else {
1049            break;
1050          }
1051        }
1052        if (run == 0) {
1053          indent_os << StringPrintf("%d: ", i);
1054        } else {
1055          indent_os << StringPrintf("%d to %zd: ", i, i + run);
1056          i = i + run;
1057        }
1058        mirror::Class* value_class =
1059            (value == NULL) ? obj_class->GetComponentType() : value->GetClass();
1060        PrettyObjectValue(indent_os, value_class, value);
1061      }
1062    } else if (obj->IsClass()) {
1063      mirror::ObjectArray<mirror::ArtField>* sfields = obj->AsClass()->GetSFields();
1064      if (sfields != NULL) {
1065        indent_os << "STATICS:\n";
1066        Indenter indent2_filter(indent_os.rdbuf(), kIndentChar, kIndentBy1Count);
1067        std::ostream indent2_os(&indent2_filter);
1068        for (int32_t i = 0; i < sfields->GetLength(); i++) {
1069          mirror::ArtField* field = sfields->Get(i);
1070          PrintField(indent2_os, field, field->GetDeclaringClass());
1071        }
1072      }
1073    } else if (obj->IsArtMethod()) {
1074      mirror::ArtMethod* method = obj->AsArtMethod();
1075      if (method->IsNative()) {
1076        // TODO: portable dumping.
1077        DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method);
1078        DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method);
1079        bool first_occurrence;
1080        const void* quick_oat_code = state->GetQuickOatCodeBegin(method);
1081        uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1082        state->ComputeOatSize(quick_oat_code, &first_occurrence);
1083        if (first_occurrence) {
1084          state->stats_.native_to_managed_code_bytes += quick_oat_code_size;
1085        }
1086        if (quick_oat_code != method->GetEntryPointFromQuickCompiledCode()) {
1087          indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code);
1088        }
1089      } else if (method->IsAbstract() || method->IsCalleeSaveMethod() ||
1090          method->IsResolutionMethod() || method->IsImtConflictMethod() ||
1091          MethodHelper(method).IsClassInitializer()) {
1092        DCHECK(method->GetNativeGcMap() == NULL) << PrettyMethod(method);
1093        DCHECK(method->GetMappingTable() == NULL) << PrettyMethod(method);
1094      } else {
1095        const DexFile::CodeItem* code_item = MethodHelper(method).GetCodeItem();
1096        size_t dex_instruction_bytes = code_item->insns_size_in_code_units_ * 2;
1097        state->stats_.dex_instruction_bytes += dex_instruction_bytes;
1098
1099        bool first_occurrence;
1100        size_t gc_map_bytes = state->ComputeOatSize(method->GetNativeGcMap(), &first_occurrence);
1101        if (first_occurrence) {
1102          state->stats_.gc_map_bytes += gc_map_bytes;
1103        }
1104
1105        size_t pc_mapping_table_bytes =
1106            state->ComputeOatSize(method->GetMappingTable(), &first_occurrence);
1107        if (first_occurrence) {
1108          state->stats_.pc_mapping_table_bytes += pc_mapping_table_bytes;
1109        }
1110
1111        size_t vmap_table_bytes =
1112            state->ComputeOatSize(method->GetVmapTable(), &first_occurrence);
1113        if (first_occurrence) {
1114          state->stats_.vmap_table_bytes += vmap_table_bytes;
1115        }
1116
1117        // TODO: portable dumping.
1118        const void* quick_oat_code_begin = state->GetQuickOatCodeBegin(method);
1119        const void* quick_oat_code_end = state->GetQuickOatCodeEnd(method);
1120        uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1121        state->ComputeOatSize(quick_oat_code_begin, &first_occurrence);
1122        if (first_occurrence) {
1123          state->stats_.managed_code_bytes += quick_oat_code_size;
1124          if (method->IsConstructor()) {
1125            if (method->IsStatic()) {
1126              state->stats_.class_initializer_code_bytes += quick_oat_code_size;
1127            } else if (dex_instruction_bytes > kLargeConstructorDexBytes) {
1128              state->stats_.large_initializer_code_bytes += quick_oat_code_size;
1129            }
1130          } else if (dex_instruction_bytes > kLargeMethodDexBytes) {
1131            state->stats_.large_method_code_bytes += quick_oat_code_size;
1132          }
1133        }
1134        state->stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size;
1135
1136        indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end);
1137        indent_os << StringPrintf("SIZE: Dex Instructions=%zd GC=%zd Mapping=%zd\n",
1138                                  dex_instruction_bytes, gc_map_bytes, pc_mapping_table_bytes);
1139
1140        size_t total_size = dex_instruction_bytes + gc_map_bytes + pc_mapping_table_bytes +
1141            vmap_table_bytes + quick_oat_code_size + object_bytes;
1142
1143        double expansion =
1144            static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes);
1145        state->stats_.ComputeOutliers(total_size, expansion, method);
1146      }
1147    }
1148    state->stats_.Update(ClassHelper(obj_class).GetDescriptor(), object_bytes);
1149  }
1150
1151  std::set<const void*> already_seen_;
1152  // Compute the size of the given data within the oat file and whether this is the first time
1153  // this data has been requested
1154  size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) {
1155    if (already_seen_.count(oat_data) == 0) {
1156      *first_occurrence = true;
1157      already_seen_.insert(oat_data);
1158    } else {
1159      *first_occurrence = false;
1160    }
1161    return oat_dumper_->ComputeSize(oat_data);
1162  }
1163
1164 public:
1165  struct Stats {
1166    size_t oat_file_bytes;
1167    size_t file_bytes;
1168
1169    size_t header_bytes;
1170    size_t object_bytes;
1171    size_t bitmap_bytes;
1172    size_t alignment_bytes;
1173
1174    size_t managed_code_bytes;
1175    size_t managed_code_bytes_ignoring_deduplication;
1176    size_t managed_to_native_code_bytes;
1177    size_t native_to_managed_code_bytes;
1178    size_t class_initializer_code_bytes;
1179    size_t large_initializer_code_bytes;
1180    size_t large_method_code_bytes;
1181
1182    size_t gc_map_bytes;
1183    size_t pc_mapping_table_bytes;
1184    size_t vmap_table_bytes;
1185
1186    size_t dex_instruction_bytes;
1187
1188    std::vector<mirror::ArtMethod*> method_outlier;
1189    std::vector<size_t> method_outlier_size;
1190    std::vector<double> method_outlier_expansion;
1191    std::vector<std::pair<std::string, size_t> > oat_dex_file_sizes;
1192
1193    explicit Stats()
1194        : oat_file_bytes(0),
1195          file_bytes(0),
1196          header_bytes(0),
1197          object_bytes(0),
1198          bitmap_bytes(0),
1199          alignment_bytes(0),
1200          managed_code_bytes(0),
1201          managed_code_bytes_ignoring_deduplication(0),
1202          managed_to_native_code_bytes(0),
1203          native_to_managed_code_bytes(0),
1204          class_initializer_code_bytes(0),
1205          large_initializer_code_bytes(0),
1206          large_method_code_bytes(0),
1207          gc_map_bytes(0),
1208          pc_mapping_table_bytes(0),
1209          vmap_table_bytes(0),
1210          dex_instruction_bytes(0) {}
1211
1212    struct SizeAndCount {
1213      SizeAndCount(size_t bytes, size_t count) : bytes(bytes), count(count) {}
1214      size_t bytes;
1215      size_t count;
1216    };
1217    typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable;
1218    SizeAndCountTable sizes_and_counts;
1219
1220    void Update(const char* descriptor, size_t object_bytes) {
1221      SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor);
1222      if (it != sizes_and_counts.end()) {
1223        it->second.bytes += object_bytes;
1224        it->second.count += 1;
1225      } else {
1226        sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes, 1));
1227      }
1228    }
1229
1230    double PercentOfOatBytes(size_t size) {
1231      return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100;
1232    }
1233
1234    double PercentOfFileBytes(size_t size) {
1235      return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100;
1236    }
1237
1238    double PercentOfObjectBytes(size_t size) {
1239      return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100;
1240    }
1241
1242    void ComputeOutliers(size_t total_size, double expansion, mirror::ArtMethod* method) {
1243      method_outlier_size.push_back(total_size);
1244      method_outlier_expansion.push_back(expansion);
1245      method_outlier.push_back(method);
1246    }
1247
1248    void DumpOutliers(std::ostream& os)
1249        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1250      size_t sum_of_sizes = 0;
1251      size_t sum_of_sizes_squared = 0;
1252      size_t sum_of_expansion = 0;
1253      size_t sum_of_expansion_squared = 0;
1254      size_t n = method_outlier_size.size();
1255      for (size_t i = 0; i < n; i++) {
1256        size_t cur_size = method_outlier_size[i];
1257        sum_of_sizes += cur_size;
1258        sum_of_sizes_squared += cur_size * cur_size;
1259        double cur_expansion = method_outlier_expansion[i];
1260        sum_of_expansion += cur_expansion;
1261        sum_of_expansion_squared += cur_expansion * cur_expansion;
1262      }
1263      size_t size_mean = sum_of_sizes / n;
1264      size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1);
1265      double expansion_mean = sum_of_expansion / n;
1266      double expansion_variance =
1267          (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1);
1268
1269      // Dump methods whose size is a certain number of standard deviations from the mean
1270      size_t dumped_values = 0;
1271      size_t skipped_values = 0;
1272      for (size_t i = 100; i > 0; i--) {  // i is the current number of standard deviations
1273        size_t cur_size_variance = i * i * size_variance;
1274        bool first = true;
1275        for (size_t j = 0; j < n; j++) {
1276          size_t cur_size = method_outlier_size[j];
1277          if (cur_size > size_mean) {
1278            size_t cur_var = cur_size - size_mean;
1279            cur_var = cur_var * cur_var;
1280            if (cur_var > cur_size_variance) {
1281              if (dumped_values > 20) {
1282                if (i == 1) {
1283                  skipped_values++;
1284                } else {
1285                  i = 2;  // jump to counting for 1 standard deviation
1286                  break;
1287                }
1288              } else {
1289                if (first) {
1290                  os << "\nBig methods (size > " << i << " standard deviations the norm):\n";
1291                  first = false;
1292                }
1293                os << PrettyMethod(method_outlier[j]) << " requires storage of "
1294                    << PrettySize(cur_size) << "\n";
1295                method_outlier_size[j] = 0;  // don't consider this method again
1296                dumped_values++;
1297              }
1298            }
1299          }
1300        }
1301      }
1302      if (skipped_values > 0) {
1303        os << "... skipped " << skipped_values
1304           << " methods with size > 1 standard deviation from the norm\n";
1305      }
1306      os << std::flush;
1307
1308      // Dump methods whose expansion is a certain number of standard deviations from the mean
1309      dumped_values = 0;
1310      skipped_values = 0;
1311      for (size_t i = 10; i > 0; i--) {  // i is the current number of standard deviations
1312        double cur_expansion_variance = i * i * expansion_variance;
1313        bool first = true;
1314        for (size_t j = 0; j < n; j++) {
1315          double cur_expansion = method_outlier_expansion[j];
1316          if (cur_expansion > expansion_mean) {
1317            size_t cur_var = cur_expansion - expansion_mean;
1318            cur_var = cur_var * cur_var;
1319            if (cur_var > cur_expansion_variance) {
1320              if (dumped_values > 20) {
1321                if (i == 1) {
1322                  skipped_values++;
1323                } else {
1324                  i = 2;  // jump to counting for 1 standard deviation
1325                  break;
1326                }
1327              } else {
1328                if (first) {
1329                  os << "\nLarge expansion methods (size > " << i
1330                      << " standard deviations the norm):\n";
1331                  first = false;
1332                }
1333                os << PrettyMethod(method_outlier[j]) << " expanded code by "
1334                   << cur_expansion << "\n";
1335                method_outlier_expansion[j] = 0.0;  // don't consider this method again
1336                dumped_values++;
1337              }
1338            }
1339          }
1340        }
1341      }
1342      if (skipped_values > 0) {
1343        os << "... skipped " << skipped_values
1344           << " methods with expansion > 1 standard deviation from the norm\n";
1345      }
1346      os << "\n" << std::flush;
1347    }
1348
1349    void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1350      {
1351        os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n"
1352           << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n";
1353        Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1354        std::ostream indent_os(&indent_filter);
1355        indent_os << StringPrintf("header_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1356                                  "object_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1357                                  "bitmap_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1358                                  "alignment_bytes =  %8zd (%2.0f%% of art file bytes)\n\n",
1359                                  header_bytes, PercentOfFileBytes(header_bytes),
1360                                  object_bytes, PercentOfFileBytes(object_bytes),
1361                                  bitmap_bytes, PercentOfFileBytes(bitmap_bytes),
1362                                  alignment_bytes, PercentOfFileBytes(alignment_bytes))
1363            << std::flush;
1364        CHECK_EQ(file_bytes, bitmap_bytes + header_bytes + object_bytes + alignment_bytes);
1365      }
1366
1367      os << "object_bytes breakdown:\n";
1368      size_t object_bytes_total = 0;
1369      for (const auto& sizes_and_count : sizes_and_counts) {
1370        const std::string& descriptor(sizes_and_count.first);
1371        double average = static_cast<double>(sizes_and_count.second.bytes) /
1372            static_cast<double>(sizes_and_count.second.count);
1373        double percent = PercentOfObjectBytes(sizes_and_count.second.bytes);
1374        os << StringPrintf("%32s %8zd bytes %6zd instances "
1375                           "(%4.0f bytes/instance) %2.0f%% of object_bytes\n",
1376                           descriptor.c_str(), sizes_and_count.second.bytes,
1377                           sizes_and_count.second.count, average, percent);
1378        object_bytes_total += sizes_and_count.second.bytes;
1379      }
1380      os << "\n" << std::flush;
1381      CHECK_EQ(object_bytes, object_bytes_total);
1382
1383      os << StringPrintf("oat_file_bytes               = %8zd\n"
1384                         "managed_code_bytes           = %8zd (%2.0f%% of oat file bytes)\n"
1385                         "managed_to_native_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1386                         "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n"
1387                         "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1388                         "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1389                         "large_method_code_bytes      = %8zd (%2.0f%% of oat file bytes)\n\n",
1390                         oat_file_bytes,
1391                         managed_code_bytes,
1392                         PercentOfOatBytes(managed_code_bytes),
1393                         managed_to_native_code_bytes,
1394                         PercentOfOatBytes(managed_to_native_code_bytes),
1395                         native_to_managed_code_bytes,
1396                         PercentOfOatBytes(native_to_managed_code_bytes),
1397                         class_initializer_code_bytes,
1398                         PercentOfOatBytes(class_initializer_code_bytes),
1399                         large_initializer_code_bytes,
1400                         PercentOfOatBytes(large_initializer_code_bytes),
1401                         large_method_code_bytes,
1402                         PercentOfOatBytes(large_method_code_bytes))
1403            << "DexFile sizes:\n";
1404      for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) {
1405        os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n",
1406                           oat_dex_file_size.first.c_str(), oat_dex_file_size.second,
1407                           PercentOfOatBytes(oat_dex_file_size.second));
1408      }
1409
1410      os << "\n" << StringPrintf("gc_map_bytes           = %7zd (%2.0f%% of oat file bytes)\n"
1411                                 "pc_mapping_table_bytes = %7zd (%2.0f%% of oat file bytes)\n"
1412                                 "vmap_table_bytes       = %7zd (%2.0f%% of oat file bytes)\n\n",
1413                                 gc_map_bytes, PercentOfOatBytes(gc_map_bytes),
1414                                 pc_mapping_table_bytes, PercentOfOatBytes(pc_mapping_table_bytes),
1415                                 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes))
1416         << std::flush;
1417
1418      os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes)
1419         << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n",
1420                         static_cast<double>(managed_code_bytes) /
1421                             static_cast<double>(dex_instruction_bytes),
1422                         static_cast<double>(managed_code_bytes_ignoring_deduplication) /
1423                             static_cast<double>(dex_instruction_bytes))
1424         << std::flush;
1425
1426      DumpOutliers(os);
1427    }
1428  } stats_;
1429
1430 private:
1431  enum {
1432    // Number of bytes for a constructor to be considered large. Based on the 1000 basic block
1433    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
1434    kLargeConstructorDexBytes = 4000,
1435    // Number of bytes for a method to be considered large. Based on the 4000 basic block
1436    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
1437    kLargeMethodDexBytes = 16000
1438  };
1439  UniquePtr<OatDumper> oat_dumper_;
1440  std::ostream* os_;
1441  gc::space::ImageSpace& image_space_;
1442  const ImageHeader& image_header_;
1443  bool dump_raw_mapping_table_;
1444  bool dump_raw_gc_map_;
1445
1446  DISALLOW_COPY_AND_ASSIGN(ImageDumper);
1447};
1448
1449static int oatdump(int argc, char** argv) {
1450  InitLogging(argv);
1451
1452  // Skip over argv[0].
1453  argv++;
1454  argc--;
1455
1456  if (argc == 0) {
1457    fprintf(stderr, "No arguments specified\n");
1458    usage();
1459  }
1460
1461  const char* oat_filename = NULL;
1462  const char* image_filename = NULL;
1463  const char* boot_image_filename = NULL;
1464  std::string elf_filename_prefix;
1465  std::ostream* os = &std::cout;
1466  UniquePtr<std::ofstream> out;
1467  bool dump_raw_mapping_table = false;
1468  bool dump_raw_gc_map = false;
1469
1470  for (int i = 0; i < argc; i++) {
1471    const StringPiece option(argv[i]);
1472    if (option.starts_with("--oat-file=")) {
1473      oat_filename = option.substr(strlen("--oat-file=")).data();
1474    } else if (option.starts_with("--image=")) {
1475      image_filename = option.substr(strlen("--image=")).data();
1476    } else if (option.starts_with("--boot-image=")) {
1477      boot_image_filename = option.substr(strlen("--boot-image=")).data();
1478    } else if (option.starts_with("--dump:")) {
1479        if (option == "--dump:raw_mapping_table") {
1480          dump_raw_mapping_table = true;
1481        } else if (option == "--dump:raw_gc_map") {
1482          dump_raw_gc_map = true;
1483        } else {
1484          fprintf(stderr, "Unknown argument %s\n", option.data());
1485          usage();
1486        }
1487    } else if (option.starts_with("--output=")) {
1488      const char* filename = option.substr(strlen("--output=")).data();
1489      out.reset(new std::ofstream(filename));
1490      if (!out->good()) {
1491        fprintf(stderr, "Failed to open output filename %s\n", filename);
1492        usage();
1493      }
1494      os = out.get();
1495    } else {
1496      fprintf(stderr, "Unknown argument %s\n", option.data());
1497      usage();
1498    }
1499  }
1500
1501  if (image_filename == NULL && oat_filename == NULL) {
1502    fprintf(stderr, "Either --image or --oat must be specified\n");
1503    return EXIT_FAILURE;
1504  }
1505
1506  if (image_filename != NULL && oat_filename != NULL) {
1507    fprintf(stderr, "Either --image or --oat must be specified but not both\n");
1508    return EXIT_FAILURE;
1509  }
1510
1511  if (oat_filename != NULL) {
1512    std::string error_msg;
1513    OatFile* oat_file =
1514        OatFile::Open(oat_filename, oat_filename, NULL, false, &error_msg);
1515    if (oat_file == NULL) {
1516      fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
1517      return EXIT_FAILURE;
1518    }
1519    OatDumper oat_dumper(*oat_file, dump_raw_mapping_table, dump_raw_gc_map);
1520    oat_dumper.Dump(*os);
1521    return EXIT_SUCCESS;
1522  }
1523
1524  Runtime::Options options;
1525  std::string image_option;
1526  std::string oat_option;
1527  std::string boot_image_option;
1528  std::string boot_oat_option;
1529
1530  // We are more like a compiler than a run-time. We don't want to execute code.
1531  NoopCompilerCallbacks callbacks;
1532  options.push_back(std::make_pair("compilercallbacks", &callbacks));
1533
1534  if (boot_image_filename != NULL) {
1535    boot_image_option += "-Ximage:";
1536    boot_image_option += boot_image_filename;
1537    options.push_back(std::make_pair(boot_image_option.c_str(), reinterpret_cast<void*>(NULL)));
1538  }
1539  if (image_filename != NULL) {
1540    image_option += "-Ximage:";
1541    image_option += image_filename;
1542    options.push_back(std::make_pair(image_option.c_str(), reinterpret_cast<void*>(NULL)));
1543  }
1544
1545  if (!Runtime::Create(options, false)) {
1546    fprintf(stderr, "Failed to create runtime\n");
1547    return EXIT_FAILURE;
1548  }
1549  UniquePtr<Runtime> runtime(Runtime::Current());
1550  // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
1551  // give it away now and then switch to a more manageable ScopedObjectAccess.
1552  Thread::Current()->TransitionFromRunnableToSuspended(kNative);
1553  ScopedObjectAccess soa(Thread::Current());
1554  gc::Heap* heap = Runtime::Current()->GetHeap();
1555  gc::space::ImageSpace* image_space = heap->GetImageSpace();
1556  CHECK(image_space != NULL);
1557  const ImageHeader& image_header = image_space->GetImageHeader();
1558  if (!image_header.IsValid()) {
1559    fprintf(stderr, "Invalid image header %s\n", image_filename);
1560    return EXIT_FAILURE;
1561  }
1562  ImageDumper image_dumper(os, *image_space, image_header,
1563                           dump_raw_mapping_table, dump_raw_gc_map);
1564  image_dumper.Dump();
1565  return EXIT_SUCCESS;
1566}
1567
1568}  // namespace art
1569
1570int main(int argc, char** argv) {
1571  return art::oatdump(argc, argv);
1572}
1573