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