oatdump.cc revision 8a630577ed2d9e9571c3434c505e5de223b23c07
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        os << "[sp + #" << offset << "]";
500      }
501    }
502  }
503
504  void DumpGcMapRegisters(std::ostream& os, const OatFile::OatMethod& oat_method,
505                          const DexFile::CodeItem* code_item,
506                          size_t num_regs, const uint8_t* reg_bitmap) {
507    bool first = true;
508    for (size_t reg = 0; reg < num_regs; reg++) {
509      if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
510        if (first) {
511          os << "  v" << reg << " (";
512          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
513          os << ")";
514          first = false;
515        } else {
516          os << ", v" << reg << " (";
517          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
518          os << ")";
519        }
520      }
521    }
522    if (first) {
523      os << "No registers in GC map\n";
524    } else {
525      os << "\n";
526    }
527  }
528  void DumpGcMap(std::ostream& os, const OatFile::OatMethod& oat_method,
529                 const DexFile::CodeItem* code_item) {
530    const uint8_t* gc_map_raw = oat_method.GetNativeGcMap();
531    if (gc_map_raw == nullptr) {
532      return;  // No GC map.
533    }
534    const void* quick_code = oat_method.GetQuickCode();
535    if (quick_code != nullptr) {
536      NativePcOffsetToReferenceMap map(gc_map_raw);
537      for (size_t entry = 0; entry < map.NumEntries(); entry++) {
538        const uint8_t* native_pc = reinterpret_cast<const uint8_t*>(quick_code) +
539            map.GetNativePcOffset(entry);
540        os << StringPrintf("%p", native_pc);
541        DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
542      }
543    } else {
544      const void* portable_code = oat_method.GetPortableCode();
545      CHECK(portable_code != nullptr);
546      verifier::DexPcToReferenceMap map(gc_map_raw);
547      for (size_t entry = 0; entry < map.NumEntries(); entry++) {
548        uint32_t dex_pc = map.GetDexPc(entry);
549        os << StringPrintf("0x%08x", dex_pc);
550        DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
551      }
552    }
553  }
554
555  void DumpMappingTable(std::ostream& os, const OatFile::OatMethod& oat_method) {
556    const void* quick_code = oat_method.GetQuickCode();
557    if (quick_code == nullptr) {
558      return;
559    }
560    MappingTable table(oat_method.GetMappingTable());
561    if (table.TotalSize() != 0) {
562      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
563      std::ostream indent_os(&indent_filter);
564      if (table.PcToDexSize() != 0) {
565        typedef MappingTable::PcToDexIterator It;
566        os << "suspend point mappings {\n";
567        for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
568          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
569        }
570        os << "}\n";
571      }
572      if (table.DexToPcSize() != 0) {
573        typedef MappingTable::DexToPcIterator It;
574        os << "catch entry mappings {\n";
575        for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
576          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
577        }
578        os << "}\n";
579      }
580    }
581  }
582
583  uint32_t DumpMappingAtOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
584                               size_t offset, bool suspend_point_mapping) {
585    MappingTable table(oat_method.GetMappingTable());
586    if (suspend_point_mapping && table.PcToDexSize() > 0) {
587      typedef MappingTable::PcToDexIterator It;
588      for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
589        if (offset == cur.NativePcOffset()) {
590          os << StringPrintf("suspend point dex PC: 0x%04x\n", cur.DexPc());
591          return cur.DexPc();
592        }
593      }
594    } else if (!suspend_point_mapping && table.DexToPcSize() > 0) {
595      typedef MappingTable::DexToPcIterator It;
596      for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
597        if (offset == cur.NativePcOffset()) {
598          os << StringPrintf("catch entry dex PC: 0x%04x\n", cur.DexPc());
599          return cur.DexPc();
600        }
601      }
602    }
603    return DexFile::kDexNoIndex;
604  }
605
606  void DumpGcMapAtNativePcOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
607                                 const DexFile::CodeItem* code_item, size_t native_pc_offset) {
608    const uint8_t* gc_map_raw = oat_method.GetNativeGcMap();
609    if (gc_map_raw != NULL) {
610      NativePcOffsetToReferenceMap map(gc_map_raw);
611      if (map.HasEntry(native_pc_offset)) {
612        size_t num_regs = map.RegWidth() * 8;
613        const uint8_t* reg_bitmap = map.FindBitMap(native_pc_offset);
614        bool first = true;
615        for (size_t reg = 0; reg < num_regs; reg++) {
616          if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
617            if (first) {
618              os << "GC map objects:  v" << reg << " (";
619              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
620              os << ")";
621              first = false;
622            } else {
623              os << ", v" << reg << " (";
624              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
625              os << ")";
626            }
627          }
628        }
629        if (!first) {
630          os << "\n";
631        }
632      }
633    }
634  }
635
636  void DumpVRegsAtDexPc(std::ostream& os, verifier::MethodVerifier* verifier,
637                        const OatFile::OatMethod& oat_method,
638                        const DexFile::CodeItem* code_item, uint32_t dex_pc) {
639    DCHECK(verifier != nullptr);
640    std::vector<int32_t> kinds = verifier->DescribeVRegs(dex_pc);
641    bool first = true;
642    for (size_t reg = 0; reg < code_item->registers_size_; reg++) {
643      VRegKind kind = static_cast<VRegKind>(kinds.at(reg * 2));
644      if (kind != kUndefined) {
645        if (first) {
646          os << "VRegs:  v";
647          first = false;
648        } else {
649          os << ", v";
650        }
651        os << reg << " (";
652        switch (kind) {
653          case kImpreciseConstant:
654            os << "Imprecise Constant: " << kinds.at((reg * 2) + 1) << ", ";
655            DescribeVReg(os, oat_method, code_item, reg, kind);
656            break;
657          case kConstant:
658            os << "Constant: " << kinds.at((reg * 2) + 1);
659            break;
660          default:
661            DescribeVReg(os, oat_method, code_item, reg, kind);
662            break;
663        }
664        os << ")";
665      }
666    }
667    if (!first) {
668      os << "\n";
669    }
670  }
671
672
673  void DumpDexCode(std::ostream& os, const DexFile& dex_file, const DexFile::CodeItem* code_item) {
674    if (code_item != NULL) {
675      size_t i = 0;
676      while (i < code_item->insns_size_in_code_units_) {
677        const Instruction* instruction = Instruction::At(&code_item->insns_[i]);
678        os << StringPrintf("0x%04zx: %s\n", i, instruction->DumpString(&dex_file).c_str());
679        i += instruction->SizeInCodeUnits();
680      }
681    }
682  }
683
684  void DumpVerifier(std::ostream& os, uint32_t dex_method_idx, const DexFile* dex_file,
685                    const DexFile::ClassDef& class_def, const DexFile::CodeItem* code_item,
686                    uint32_t method_access_flags) {
687    if ((method_access_flags & kAccNative) == 0) {
688      ScopedObjectAccess soa(Thread::Current());
689      SirtRef<mirror::DexCache> dex_cache(
690          soa.Self(), Runtime::Current()->GetClassLinker()->FindDexCache(*dex_file));
691      SirtRef<mirror::ClassLoader> class_loader(soa.Self(), nullptr);
692      verifier::MethodVerifier::VerifyMethodAndDump(os, dex_method_idx, dex_file, dex_cache,
693                                                    class_loader, &class_def, code_item, NULL,
694                                                    method_access_flags);
695    }
696  }
697
698  void DumpCode(std::ostream& os, verifier::MethodVerifier* verifier,
699                const OatFile::OatMethod& oat_method, const DexFile::CodeItem* code_item) {
700    const void* portable_code = oat_method.GetPortableCode();
701    const void* quick_code = oat_method.GetQuickCode();
702
703    size_t code_size = oat_method.GetQuickCodeSize();
704    if ((code_size == 0) || ((portable_code == nullptr) && (quick_code == nullptr))) {
705      os << "NO CODE!\n";
706      return;
707    } else if (quick_code != nullptr) {
708      const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
709      size_t offset = 0;
710      while (offset < code_size) {
711        DumpMappingAtOffset(os, oat_method, offset, false);
712        offset += disassembler_->Dump(os, quick_native_pc + offset);
713        uint32_t dex_pc = DumpMappingAtOffset(os, oat_method, offset, true);
714        if (dex_pc != DexFile::kDexNoIndex) {
715          DumpGcMapAtNativePcOffset(os, oat_method, code_item, offset);
716          if (verifier != nullptr) {
717            DumpVRegsAtDexPc(os, verifier, oat_method, code_item, dex_pc);
718          }
719        }
720      }
721    } else {
722      CHECK(portable_code != nullptr);
723      CHECK_EQ(code_size, 0U);  // TODO: disassembly of portable is currently not supported.
724    }
725  }
726
727  const OatFile& oat_file_;
728  std::vector<const OatFile::OatDexFile*> oat_dex_files_;
729  bool dump_raw_mapping_table_;
730  bool dump_raw_gc_map_;
731  std::set<uintptr_t> offsets_;
732  UniquePtr<Disassembler> disassembler_;
733};
734
735class ImageDumper {
736 public:
737  explicit ImageDumper(std::ostream* os, gc::space::ImageSpace& image_space,
738                       const ImageHeader& image_header, bool dump_raw_mapping_table,
739                       bool dump_raw_gc_map)
740      : os_(os), image_space_(image_space), image_header_(image_header),
741        dump_raw_mapping_table_(dump_raw_mapping_table),
742        dump_raw_gc_map_(dump_raw_gc_map) {}
743
744  void Dump() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
745    std::ostream& os = *os_;
746    os << "MAGIC: " << image_header_.GetMagic() << "\n\n";
747
748    os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n";
749
750    os << "IMAGE BITMAP OFFSET: " << reinterpret_cast<void*>(image_header_.GetImageBitmapOffset())
751       << " SIZE: " << reinterpret_cast<void*>(image_header_.GetImageBitmapSize()) << "\n\n";
752
753    os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum());
754
755    os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n";
756
757    os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n";
758
759    os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n";
760
761    os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n";
762
763    {
764      os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n";
765      Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
766      std::ostream indent1_os(&indent1_filter);
767      CHECK_EQ(arraysize(image_roots_descriptions_), size_t(ImageHeader::kImageRootsMax));
768      for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
769        ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i);
770        const char* image_root_description = image_roots_descriptions_[i];
771        mirror::Object* image_root_object = image_header_.GetImageRoot(image_root);
772        indent1_os << StringPrintf("%s: %p\n", image_root_description, image_root_object);
773        if (image_root_object->IsObjectArray()) {
774          Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
775          std::ostream indent2_os(&indent2_filter);
776          mirror::ObjectArray<mirror::Object>* image_root_object_array
777              = image_root_object->AsObjectArray<mirror::Object>();
778          for (int i = 0; i < image_root_object_array->GetLength(); i++) {
779            mirror::Object* value = image_root_object_array->Get(i);
780            size_t run = 0;
781            for (int32_t j = i + 1; j < image_root_object_array->GetLength(); j++) {
782              if (value == image_root_object_array->Get(j)) {
783                run++;
784              } else {
785                break;
786              }
787            }
788            if (run == 0) {
789              indent2_os << StringPrintf("%d: ", i);
790            } else {
791              indent2_os << StringPrintf("%d to %zd: ", i, i + run);
792              i = i + run;
793            }
794            if (value != NULL) {
795              PrettyObjectValue(indent2_os, value->GetClass(), value);
796            } else {
797              indent2_os << i << ": null\n";
798            }
799          }
800        }
801      }
802    }
803    os << "\n";
804
805    ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
806    std::string image_filename = image_space_.GetImageFilename();
807    std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename);
808    os << "OAT LOCATION: " << oat_location;
809    os << "\n";
810    std::string error_msg;
811    const OatFile* oat_file = class_linker->FindOatFileFromOatLocation(oat_location, &error_msg);
812    if (oat_file == NULL) {
813      os << "NOT FOUND: " << error_msg << "\n";
814      return;
815    }
816    os << "\n";
817
818    stats_.oat_file_bytes = oat_file->Size();
819
820    oat_dumper_.reset(new OatDumper(*oat_file, dump_raw_mapping_table_,
821        dump_raw_gc_map_));
822
823    for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
824      CHECK(oat_dex_file != NULL);
825      stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(),
826                                                         oat_dex_file->FileSize()));
827    }
828
829    os << "OBJECTS:\n" << std::flush;
830
831    // Loop through all the image spaces and dump their objects.
832    gc::Heap* heap = Runtime::Current()->GetHeap();
833    const std::vector<gc::space::ContinuousSpace*>& spaces = heap->GetContinuousSpaces();
834    Thread* self = Thread::Current();
835    {
836      {
837        WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
838        heap->FlushAllocStack();
839      }
840      // Since FlushAllocStack() above resets the (active) allocation
841      // stack. Need to revoke the thread-local allocation stacks that
842      // point into it.
843      {
844        self->TransitionFromRunnableToSuspended(kNative);
845        ThreadList* thread_list = Runtime::Current()->GetThreadList();
846        thread_list->SuspendAll();
847        heap->RevokeAllThreadLocalAllocationStacks(self);
848        thread_list->ResumeAll();
849        self->TransitionFromSuspendedToRunnable();
850      }
851    }
852    {
853      std::ostream* saved_os = os_;
854      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
855      std::ostream indent_os(&indent_filter);
856      os_ = &indent_os;
857      ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
858      for (const auto& space : spaces) {
859        if (space->IsImageSpace()) {
860          gc::space::ImageSpace* image_space = space->AsImageSpace();
861          image_space->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
862          indent_os << "\n";
863        }
864      }
865      // Dump the large objects separately.
866      heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
867      indent_os << "\n";
868      os_ = saved_os;
869    }
870    os << "STATS:\n" << std::flush;
871    UniquePtr<File> file(OS::OpenFileForReading(image_filename.c_str()));
872    if (file.get() == NULL) {
873      LOG(WARNING) << "Failed to find image in " << image_filename;
874    }
875    if (file.get() != NULL) {
876      stats_.file_bytes = file->GetLength();
877    }
878    size_t header_bytes = sizeof(ImageHeader);
879    stats_.header_bytes = header_bytes;
880    size_t alignment_bytes = RoundUp(header_bytes, kObjectAlignment) - header_bytes;
881    stats_.alignment_bytes += alignment_bytes;
882    stats_.alignment_bytes += image_header_.GetImageBitmapOffset() - image_header_.GetImageSize();
883    stats_.bitmap_bytes += image_header_.GetImageBitmapSize();
884    stats_.Dump(os);
885    os << "\n";
886
887    os << std::flush;
888
889    oat_dumper_->Dump(os);
890  }
891
892 private:
893  static void PrettyObjectValue(std::ostream& os, mirror::Class* type, mirror::Object* value)
894      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
895    CHECK(type != NULL);
896    if (value == NULL) {
897      os << StringPrintf("null   %s\n", PrettyDescriptor(type).c_str());
898    } else if (type->IsStringClass()) {
899      mirror::String* string = value->AsString();
900      os << StringPrintf("%p   String: %s\n", string,
901                         PrintableString(string->ToModifiedUtf8()).c_str());
902    } else if (type->IsClassClass()) {
903      mirror::Class* klass = value->AsClass();
904      os << StringPrintf("%p   Class: %s\n", klass, PrettyDescriptor(klass).c_str());
905    } else if (type->IsArtFieldClass()) {
906      mirror::ArtField* field = value->AsArtField();
907      os << StringPrintf("%p   Field: %s\n", field, PrettyField(field).c_str());
908    } else if (type->IsArtMethodClass()) {
909      mirror::ArtMethod* method = value->AsArtMethod();
910      os << StringPrintf("%p   Method: %s\n", method, PrettyMethod(method).c_str());
911    } else {
912      os << StringPrintf("%p   %s\n", value, PrettyDescriptor(type).c_str());
913    }
914  }
915
916  static void PrintField(std::ostream& os, mirror::ArtField* field, mirror::Object* obj)
917      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
918    FieldHelper fh(field);
919    const char* descriptor = fh.GetTypeDescriptor();
920    os << StringPrintf("%s: ", fh.GetName());
921    if (descriptor[0] != 'L' && descriptor[0] != '[') {
922      mirror::Class* type = fh.GetType();
923      if (type->IsPrimitiveLong()) {
924        os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj));
925      } else if (type->IsPrimitiveDouble()) {
926        os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj));
927      } else if (type->IsPrimitiveFloat()) {
928        os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj));
929      } else {
930        DCHECK(type->IsPrimitive());
931        os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj));
932      }
933    } else {
934      // Get the value, don't compute the type unless it is non-null as we don't want
935      // to cause class loading.
936      mirror::Object* value = field->GetObj(obj);
937      if (value == NULL) {
938        os << StringPrintf("null   %s\n", PrettyDescriptor(descriptor).c_str());
939      } else {
940        // Grab the field type without causing resolution.
941        mirror::Class* field_type = fh.GetType(false);
942        if (field_type != NULL) {
943          PrettyObjectValue(os, field_type, value);
944        } else {
945          os << StringPrintf("%p   %s\n", value, PrettyDescriptor(descriptor).c_str());
946        }
947      }
948    }
949  }
950
951  static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass)
952      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
953    mirror::Class* super = klass->GetSuperClass();
954    if (super != NULL) {
955      DumpFields(os, obj, super);
956    }
957    mirror::ObjectArray<mirror::ArtField>* fields = klass->GetIFields();
958    if (fields != NULL) {
959      for (int32_t i = 0; i < fields->GetLength(); i++) {
960        mirror::ArtField* field = fields->Get(i);
961        PrintField(os, field, obj);
962      }
963    }
964  }
965
966  bool InDumpSpace(const mirror::Object* object) {
967    return image_space_.Contains(object);
968  }
969
970  const void* GetQuickOatCodeBegin(mirror::ArtMethod* m)
971      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
972    const void* quick_code = m->GetEntryPointFromQuickCompiledCode();
973    if (quick_code == GetQuickResolutionTrampoline(Runtime::Current()->GetClassLinker())) {
974      quick_code = oat_dumper_->GetQuickOatCode(m);
975    }
976    if (oat_dumper_->GetInstructionSet() == kThumb2) {
977      quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1);
978    }
979    return quick_code;
980  }
981
982  uint32_t GetQuickOatCodeSize(mirror::ArtMethod* m)
983      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
984    const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m));
985    if (oat_code_begin == nullptr) {
986      return 0;
987    }
988    return oat_code_begin[-1];
989  }
990
991  const void* GetQuickOatCodeEnd(mirror::ArtMethod* m)
992      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
993    const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m));
994    if (oat_code_begin == NULL) {
995      return NULL;
996    }
997    return oat_code_begin + GetQuickOatCodeSize(m);
998  }
999
1000  static void Callback(mirror::Object* obj, void* arg)
1001      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1002    DCHECK(obj != NULL);
1003    DCHECK(arg != NULL);
1004    ImageDumper* state = reinterpret_cast<ImageDumper*>(arg);
1005    if (!state->InDumpSpace(obj)) {
1006      return;
1007    }
1008
1009    size_t object_bytes = obj->SizeOf();
1010    size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes;
1011    state->stats_.object_bytes += object_bytes;
1012    state->stats_.alignment_bytes += alignment_bytes;
1013
1014    std::ostream& os = *state->os_;
1015    mirror::Class* obj_class = obj->GetClass();
1016    if (obj_class->IsArrayClass()) {
1017      os << StringPrintf("%p: %s length:%d\n", obj, PrettyDescriptor(obj_class).c_str(),
1018                         obj->AsArray()->GetLength());
1019    } else if (obj->IsClass()) {
1020      mirror::Class* klass = obj->AsClass();
1021      os << StringPrintf("%p: java.lang.Class \"%s\" (", obj, PrettyDescriptor(klass).c_str())
1022         << klass->GetStatus() << ")\n";
1023    } else if (obj->IsArtField()) {
1024      os << StringPrintf("%p: java.lang.reflect.ArtField %s\n", obj,
1025                         PrettyField(obj->AsArtField()).c_str());
1026    } else if (obj->IsArtMethod()) {
1027      os << StringPrintf("%p: java.lang.reflect.ArtMethod %s\n", obj,
1028                         PrettyMethod(obj->AsArtMethod()).c_str());
1029    } else if (obj_class->IsStringClass()) {
1030      os << StringPrintf("%p: java.lang.String %s\n", obj,
1031                         PrintableString(obj->AsString()->ToModifiedUtf8()).c_str());
1032    } else {
1033      os << StringPrintf("%p: %s\n", obj, PrettyDescriptor(obj_class).c_str());
1034    }
1035    Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1036    std::ostream indent_os(&indent_filter);
1037    DumpFields(indent_os, obj, obj_class);
1038    if (obj->IsObjectArray()) {
1039      mirror::ObjectArray<mirror::Object>* obj_array = obj->AsObjectArray<mirror::Object>();
1040      int32_t length = obj_array->GetLength();
1041      for (int32_t i = 0; i < length; i++) {
1042        mirror::Object* value = obj_array->Get(i);
1043        size_t run = 0;
1044        for (int32_t j = i + 1; j < length; j++) {
1045          if (value == obj_array->Get(j)) {
1046            run++;
1047          } else {
1048            break;
1049          }
1050        }
1051        if (run == 0) {
1052          indent_os << StringPrintf("%d: ", i);
1053        } else {
1054          indent_os << StringPrintf("%d to %zd: ", i, i + run);
1055          i = i + run;
1056        }
1057        mirror::Class* value_class =
1058            (value == NULL) ? obj_class->GetComponentType() : value->GetClass();
1059        PrettyObjectValue(indent_os, value_class, value);
1060      }
1061    } else if (obj->IsClass()) {
1062      mirror::ObjectArray<mirror::ArtField>* sfields = obj->AsClass()->GetSFields();
1063      if (sfields != NULL) {
1064        indent_os << "STATICS:\n";
1065        Indenter indent2_filter(indent_os.rdbuf(), kIndentChar, kIndentBy1Count);
1066        std::ostream indent2_os(&indent2_filter);
1067        for (int32_t i = 0; i < sfields->GetLength(); i++) {
1068          mirror::ArtField* field = sfields->Get(i);
1069          PrintField(indent2_os, field, field->GetDeclaringClass());
1070        }
1071      }
1072    } else if (obj->IsArtMethod()) {
1073      mirror::ArtMethod* method = obj->AsArtMethod();
1074      if (method->IsNative()) {
1075        // TODO: portable dumping.
1076        DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method);
1077        DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method);
1078        bool first_occurrence;
1079        const void* quick_oat_code = state->GetQuickOatCodeBegin(method);
1080        uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1081        state->ComputeOatSize(quick_oat_code, &first_occurrence);
1082        if (first_occurrence) {
1083          state->stats_.native_to_managed_code_bytes += quick_oat_code_size;
1084        }
1085        if (quick_oat_code != method->GetEntryPointFromQuickCompiledCode()) {
1086          indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code);
1087        }
1088      } else if (method->IsAbstract() || method->IsCalleeSaveMethod() ||
1089          method->IsResolutionMethod() || method->IsImtConflictMethod() ||
1090          MethodHelper(method).IsClassInitializer()) {
1091        DCHECK(method->GetNativeGcMap() == NULL) << PrettyMethod(method);
1092        DCHECK(method->GetMappingTable() == NULL) << PrettyMethod(method);
1093      } else {
1094        const DexFile::CodeItem* code_item = MethodHelper(method).GetCodeItem();
1095        size_t dex_instruction_bytes = code_item->insns_size_in_code_units_ * 2;
1096        state->stats_.dex_instruction_bytes += dex_instruction_bytes;
1097
1098        bool first_occurrence;
1099        size_t gc_map_bytes = state->ComputeOatSize(method->GetNativeGcMap(), &first_occurrence);
1100        if (first_occurrence) {
1101          state->stats_.gc_map_bytes += gc_map_bytes;
1102        }
1103
1104        size_t pc_mapping_table_bytes =
1105            state->ComputeOatSize(method->GetMappingTable(), &first_occurrence);
1106        if (first_occurrence) {
1107          state->stats_.pc_mapping_table_bytes += pc_mapping_table_bytes;
1108        }
1109
1110        size_t vmap_table_bytes =
1111            state->ComputeOatSize(method->GetVmapTable(), &first_occurrence);
1112        if (first_occurrence) {
1113          state->stats_.vmap_table_bytes += vmap_table_bytes;
1114        }
1115
1116        // TODO: portable dumping.
1117        const void* quick_oat_code_begin = state->GetQuickOatCodeBegin(method);
1118        const void* quick_oat_code_end = state->GetQuickOatCodeEnd(method);
1119        uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1120        state->ComputeOatSize(quick_oat_code_begin, &first_occurrence);
1121        if (first_occurrence) {
1122          state->stats_.managed_code_bytes += quick_oat_code_size;
1123          if (method->IsConstructor()) {
1124            if (method->IsStatic()) {
1125              state->stats_.class_initializer_code_bytes += quick_oat_code_size;
1126            } else if (dex_instruction_bytes > kLargeConstructorDexBytes) {
1127              state->stats_.large_initializer_code_bytes += quick_oat_code_size;
1128            }
1129          } else if (dex_instruction_bytes > kLargeMethodDexBytes) {
1130            state->stats_.large_method_code_bytes += quick_oat_code_size;
1131          }
1132        }
1133        state->stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size;
1134
1135        indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end);
1136        indent_os << StringPrintf("SIZE: Dex Instructions=%zd GC=%zd Mapping=%zd\n",
1137                                  dex_instruction_bytes, gc_map_bytes, pc_mapping_table_bytes);
1138
1139        size_t total_size = dex_instruction_bytes + gc_map_bytes + pc_mapping_table_bytes +
1140            vmap_table_bytes + quick_oat_code_size + object_bytes;
1141
1142        double expansion =
1143            static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes);
1144        state->stats_.ComputeOutliers(total_size, expansion, method);
1145      }
1146    }
1147    state->stats_.Update(ClassHelper(obj_class).GetDescriptor(), object_bytes);
1148  }
1149
1150  std::set<const void*> already_seen_;
1151  // Compute the size of the given data within the oat file and whether this is the first time
1152  // this data has been requested
1153  size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) {
1154    if (already_seen_.count(oat_data) == 0) {
1155      *first_occurrence = true;
1156      already_seen_.insert(oat_data);
1157    } else {
1158      *first_occurrence = false;
1159    }
1160    return oat_dumper_->ComputeSize(oat_data);
1161  }
1162
1163 public:
1164  struct Stats {
1165    size_t oat_file_bytes;
1166    size_t file_bytes;
1167
1168    size_t header_bytes;
1169    size_t object_bytes;
1170    size_t bitmap_bytes;
1171    size_t alignment_bytes;
1172
1173    size_t managed_code_bytes;
1174    size_t managed_code_bytes_ignoring_deduplication;
1175    size_t managed_to_native_code_bytes;
1176    size_t native_to_managed_code_bytes;
1177    size_t class_initializer_code_bytes;
1178    size_t large_initializer_code_bytes;
1179    size_t large_method_code_bytes;
1180
1181    size_t gc_map_bytes;
1182    size_t pc_mapping_table_bytes;
1183    size_t vmap_table_bytes;
1184
1185    size_t dex_instruction_bytes;
1186
1187    std::vector<mirror::ArtMethod*> method_outlier;
1188    std::vector<size_t> method_outlier_size;
1189    std::vector<double> method_outlier_expansion;
1190    std::vector<std::pair<std::string, size_t> > oat_dex_file_sizes;
1191
1192    explicit Stats()
1193        : oat_file_bytes(0),
1194          file_bytes(0),
1195          header_bytes(0),
1196          object_bytes(0),
1197          bitmap_bytes(0),
1198          alignment_bytes(0),
1199          managed_code_bytes(0),
1200          managed_code_bytes_ignoring_deduplication(0),
1201          managed_to_native_code_bytes(0),
1202          native_to_managed_code_bytes(0),
1203          class_initializer_code_bytes(0),
1204          large_initializer_code_bytes(0),
1205          large_method_code_bytes(0),
1206          gc_map_bytes(0),
1207          pc_mapping_table_bytes(0),
1208          vmap_table_bytes(0),
1209          dex_instruction_bytes(0) {}
1210
1211    struct SizeAndCount {
1212      SizeAndCount(size_t bytes, size_t count) : bytes(bytes), count(count) {}
1213      size_t bytes;
1214      size_t count;
1215    };
1216    typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable;
1217    SizeAndCountTable sizes_and_counts;
1218
1219    void Update(const char* descriptor, size_t object_bytes) {
1220      SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor);
1221      if (it != sizes_and_counts.end()) {
1222        it->second.bytes += object_bytes;
1223        it->second.count += 1;
1224      } else {
1225        sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes, 1));
1226      }
1227    }
1228
1229    double PercentOfOatBytes(size_t size) {
1230      return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100;
1231    }
1232
1233    double PercentOfFileBytes(size_t size) {
1234      return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100;
1235    }
1236
1237    double PercentOfObjectBytes(size_t size) {
1238      return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100;
1239    }
1240
1241    void ComputeOutliers(size_t total_size, double expansion, mirror::ArtMethod* method) {
1242      method_outlier_size.push_back(total_size);
1243      method_outlier_expansion.push_back(expansion);
1244      method_outlier.push_back(method);
1245    }
1246
1247    void DumpOutliers(std::ostream& os)
1248        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1249      size_t sum_of_sizes = 0;
1250      size_t sum_of_sizes_squared = 0;
1251      size_t sum_of_expansion = 0;
1252      size_t sum_of_expansion_squared = 0;
1253      size_t n = method_outlier_size.size();
1254      for (size_t i = 0; i < n; i++) {
1255        size_t cur_size = method_outlier_size[i];
1256        sum_of_sizes += cur_size;
1257        sum_of_sizes_squared += cur_size * cur_size;
1258        double cur_expansion = method_outlier_expansion[i];
1259        sum_of_expansion += cur_expansion;
1260        sum_of_expansion_squared += cur_expansion * cur_expansion;
1261      }
1262      size_t size_mean = sum_of_sizes / n;
1263      size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1);
1264      double expansion_mean = sum_of_expansion / n;
1265      double expansion_variance =
1266          (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1);
1267
1268      // Dump methods whose size is a certain number of standard deviations from the mean
1269      size_t dumped_values = 0;
1270      size_t skipped_values = 0;
1271      for (size_t i = 100; i > 0; i--) {  // i is the current number of standard deviations
1272        size_t cur_size_variance = i * i * size_variance;
1273        bool first = true;
1274        for (size_t j = 0; j < n; j++) {
1275          size_t cur_size = method_outlier_size[j];
1276          if (cur_size > size_mean) {
1277            size_t cur_var = cur_size - size_mean;
1278            cur_var = cur_var * cur_var;
1279            if (cur_var > cur_size_variance) {
1280              if (dumped_values > 20) {
1281                if (i == 1) {
1282                  skipped_values++;
1283                } else {
1284                  i = 2;  // jump to counting for 1 standard deviation
1285                  break;
1286                }
1287              } else {
1288                if (first) {
1289                  os << "\nBig methods (size > " << i << " standard deviations the norm):\n";
1290                  first = false;
1291                }
1292                os << PrettyMethod(method_outlier[j]) << " requires storage of "
1293                    << PrettySize(cur_size) << "\n";
1294                method_outlier_size[j] = 0;  // don't consider this method again
1295                dumped_values++;
1296              }
1297            }
1298          }
1299        }
1300      }
1301      if (skipped_values > 0) {
1302        os << "... skipped " << skipped_values
1303           << " methods with size > 1 standard deviation from the norm\n";
1304      }
1305      os << std::flush;
1306
1307      // Dump methods whose expansion is a certain number of standard deviations from the mean
1308      dumped_values = 0;
1309      skipped_values = 0;
1310      for (size_t i = 10; i > 0; i--) {  // i is the current number of standard deviations
1311        double cur_expansion_variance = i * i * expansion_variance;
1312        bool first = true;
1313        for (size_t j = 0; j < n; j++) {
1314          double cur_expansion = method_outlier_expansion[j];
1315          if (cur_expansion > expansion_mean) {
1316            size_t cur_var = cur_expansion - expansion_mean;
1317            cur_var = cur_var * cur_var;
1318            if (cur_var > cur_expansion_variance) {
1319              if (dumped_values > 20) {
1320                if (i == 1) {
1321                  skipped_values++;
1322                } else {
1323                  i = 2;  // jump to counting for 1 standard deviation
1324                  break;
1325                }
1326              } else {
1327                if (first) {
1328                  os << "\nLarge expansion methods (size > " << i
1329                      << " standard deviations the norm):\n";
1330                  first = false;
1331                }
1332                os << PrettyMethod(method_outlier[j]) << " expanded code by "
1333                   << cur_expansion << "\n";
1334                method_outlier_expansion[j] = 0.0;  // don't consider this method again
1335                dumped_values++;
1336              }
1337            }
1338          }
1339        }
1340      }
1341      if (skipped_values > 0) {
1342        os << "... skipped " << skipped_values
1343           << " methods with expansion > 1 standard deviation from the norm\n";
1344      }
1345      os << "\n" << std::flush;
1346    }
1347
1348    void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1349      {
1350        os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n"
1351           << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n";
1352        Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1353        std::ostream indent_os(&indent_filter);
1354        indent_os << StringPrintf("header_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1355                                  "object_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1356                                  "bitmap_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1357                                  "alignment_bytes =  %8zd (%2.0f%% of art file bytes)\n\n",
1358                                  header_bytes, PercentOfFileBytes(header_bytes),
1359                                  object_bytes, PercentOfFileBytes(object_bytes),
1360                                  bitmap_bytes, PercentOfFileBytes(bitmap_bytes),
1361                                  alignment_bytes, PercentOfFileBytes(alignment_bytes))
1362            << std::flush;
1363        CHECK_EQ(file_bytes, bitmap_bytes + header_bytes + object_bytes + alignment_bytes);
1364      }
1365
1366      os << "object_bytes breakdown:\n";
1367      size_t object_bytes_total = 0;
1368      for (const auto& sizes_and_count : sizes_and_counts) {
1369        const std::string& descriptor(sizes_and_count.first);
1370        double average = static_cast<double>(sizes_and_count.second.bytes) /
1371            static_cast<double>(sizes_and_count.second.count);
1372        double percent = PercentOfObjectBytes(sizes_and_count.second.bytes);
1373        os << StringPrintf("%32s %8zd bytes %6zd instances "
1374                           "(%4.0f bytes/instance) %2.0f%% of object_bytes\n",
1375                           descriptor.c_str(), sizes_and_count.second.bytes,
1376                           sizes_and_count.second.count, average, percent);
1377        object_bytes_total += sizes_and_count.second.bytes;
1378      }
1379      os << "\n" << std::flush;
1380      CHECK_EQ(object_bytes, object_bytes_total);
1381
1382      os << StringPrintf("oat_file_bytes               = %8zd\n"
1383                         "managed_code_bytes           = %8zd (%2.0f%% of oat file bytes)\n"
1384                         "managed_to_native_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1385                         "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n"
1386                         "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1387                         "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1388                         "large_method_code_bytes      = %8zd (%2.0f%% of oat file bytes)\n\n",
1389                         oat_file_bytes,
1390                         managed_code_bytes,
1391                         PercentOfOatBytes(managed_code_bytes),
1392                         managed_to_native_code_bytes,
1393                         PercentOfOatBytes(managed_to_native_code_bytes),
1394                         native_to_managed_code_bytes,
1395                         PercentOfOatBytes(native_to_managed_code_bytes),
1396                         class_initializer_code_bytes,
1397                         PercentOfOatBytes(class_initializer_code_bytes),
1398                         large_initializer_code_bytes,
1399                         PercentOfOatBytes(large_initializer_code_bytes),
1400                         large_method_code_bytes,
1401                         PercentOfOatBytes(large_method_code_bytes))
1402            << "DexFile sizes:\n";
1403      for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) {
1404        os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n",
1405                           oat_dex_file_size.first.c_str(), oat_dex_file_size.second,
1406                           PercentOfOatBytes(oat_dex_file_size.second));
1407      }
1408
1409      os << "\n" << StringPrintf("gc_map_bytes           = %7zd (%2.0f%% of oat file bytes)\n"
1410                                 "pc_mapping_table_bytes = %7zd (%2.0f%% of oat file bytes)\n"
1411                                 "vmap_table_bytes       = %7zd (%2.0f%% of oat file bytes)\n\n",
1412                                 gc_map_bytes, PercentOfOatBytes(gc_map_bytes),
1413                                 pc_mapping_table_bytes, PercentOfOatBytes(pc_mapping_table_bytes),
1414                                 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes))
1415         << std::flush;
1416
1417      os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes)
1418         << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n",
1419                         static_cast<double>(managed_code_bytes) /
1420                             static_cast<double>(dex_instruction_bytes),
1421                         static_cast<double>(managed_code_bytes_ignoring_deduplication) /
1422                             static_cast<double>(dex_instruction_bytes))
1423         << std::flush;
1424
1425      DumpOutliers(os);
1426    }
1427  } stats_;
1428
1429 private:
1430  enum {
1431    // Number of bytes for a constructor to be considered large. Based on the 1000 basic block
1432    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
1433    kLargeConstructorDexBytes = 4000,
1434    // Number of bytes for a method to be considered large. Based on the 4000 basic block
1435    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
1436    kLargeMethodDexBytes = 16000
1437  };
1438  UniquePtr<OatDumper> oat_dumper_;
1439  std::ostream* os_;
1440  gc::space::ImageSpace& image_space_;
1441  const ImageHeader& image_header_;
1442  bool dump_raw_mapping_table_;
1443  bool dump_raw_gc_map_;
1444
1445  DISALLOW_COPY_AND_ASSIGN(ImageDumper);
1446};
1447
1448static int oatdump(int argc, char** argv) {
1449  InitLogging(argv);
1450
1451  // Skip over argv[0].
1452  argv++;
1453  argc--;
1454
1455  if (argc == 0) {
1456    fprintf(stderr, "No arguments specified\n");
1457    usage();
1458  }
1459
1460  const char* oat_filename = NULL;
1461  const char* image_filename = NULL;
1462  const char* boot_image_filename = NULL;
1463  std::string elf_filename_prefix;
1464  std::ostream* os = &std::cout;
1465  UniquePtr<std::ofstream> out;
1466  bool dump_raw_mapping_table = false;
1467  bool dump_raw_gc_map = false;
1468
1469  for (int i = 0; i < argc; i++) {
1470    const StringPiece option(argv[i]);
1471    if (option.starts_with("--oat-file=")) {
1472      oat_filename = option.substr(strlen("--oat-file=")).data();
1473    } else if (option.starts_with("--image=")) {
1474      image_filename = option.substr(strlen("--image=")).data();
1475    } else if (option.starts_with("--boot-image=")) {
1476      boot_image_filename = option.substr(strlen("--boot-image=")).data();
1477    } else if (option.starts_with("--dump:")) {
1478        if (option == "--dump:raw_mapping_table") {
1479          dump_raw_mapping_table = true;
1480        } else if (option == "--dump:raw_gc_map") {
1481          dump_raw_gc_map = true;
1482        } else {
1483          fprintf(stderr, "Unknown argument %s\n", option.data());
1484          usage();
1485        }
1486    } else if (option.starts_with("--output=")) {
1487      const char* filename = option.substr(strlen("--output=")).data();
1488      out.reset(new std::ofstream(filename));
1489      if (!out->good()) {
1490        fprintf(stderr, "Failed to open output filename %s\n", filename);
1491        usage();
1492      }
1493      os = out.get();
1494    } else {
1495      fprintf(stderr, "Unknown argument %s\n", option.data());
1496      usage();
1497    }
1498  }
1499
1500  if (image_filename == NULL && oat_filename == NULL) {
1501    fprintf(stderr, "Either --image or --oat must be specified\n");
1502    return EXIT_FAILURE;
1503  }
1504
1505  if (image_filename != NULL && oat_filename != NULL) {
1506    fprintf(stderr, "Either --image or --oat must be specified but not both\n");
1507    return EXIT_FAILURE;
1508  }
1509
1510  if (oat_filename != NULL) {
1511    std::string error_msg;
1512    OatFile* oat_file =
1513        OatFile::Open(oat_filename, oat_filename, NULL, false, &error_msg);
1514    if (oat_file == NULL) {
1515      fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
1516      return EXIT_FAILURE;
1517    }
1518    OatDumper oat_dumper(*oat_file, dump_raw_mapping_table, dump_raw_gc_map);
1519    oat_dumper.Dump(*os);
1520    return EXIT_SUCCESS;
1521  }
1522
1523  Runtime::Options options;
1524  std::string image_option;
1525  std::string oat_option;
1526  std::string boot_image_option;
1527  std::string boot_oat_option;
1528
1529  // We are more like a compiler than a run-time. We don't want to execute code.
1530  NoopCompilerCallbacks callbacks;
1531  options.push_back(std::make_pair("compilercallbacks", &callbacks));
1532
1533  if (boot_image_filename != NULL) {
1534    boot_image_option += "-Ximage:";
1535    boot_image_option += boot_image_filename;
1536    options.push_back(std::make_pair(boot_image_option.c_str(), reinterpret_cast<void*>(NULL)));
1537  }
1538  if (image_filename != NULL) {
1539    image_option += "-Ximage:";
1540    image_option += image_filename;
1541    options.push_back(std::make_pair(image_option.c_str(), reinterpret_cast<void*>(NULL)));
1542  }
1543
1544  if (!Runtime::Create(options, false)) {
1545    fprintf(stderr, "Failed to create runtime\n");
1546    return EXIT_FAILURE;
1547  }
1548  UniquePtr<Runtime> runtime(Runtime::Current());
1549  // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
1550  // give it away now and then switch to a more managable ScopedObjectAccess.
1551  Thread::Current()->TransitionFromRunnableToSuspended(kNative);
1552  ScopedObjectAccess soa(Thread::Current());
1553  gc::Heap* heap = Runtime::Current()->GetHeap();
1554  gc::space::ImageSpace* image_space = heap->GetImageSpace();
1555  CHECK(image_space != NULL);
1556  const ImageHeader& image_header = image_space->GetImageHeader();
1557  if (!image_header.IsValid()) {
1558    fprintf(stderr, "Invalid image header %s\n", image_filename);
1559    return EXIT_FAILURE;
1560  }
1561  ImageDumper image_dumper(os, *image_space, image_header,
1562                           dump_raw_mapping_table, dump_raw_gc_map);
1563  image_dumper.Dump();
1564  return EXIT_SUCCESS;
1565}
1566
1567}  // namespace art
1568
1569int main(int argc, char** argv) {
1570  return art::oatdump(argc, argv);
1571}
1572