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