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