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