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