oatdump.cc revision 2cbaccb67e22c0b313a9785bfc65bcb4b25d0676 
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 <unordered_map>
24#include <vector>
25
26#include "base/stringpiece.h"
27#include "base/unix_file/fd_file.h"
28#include "class_linker.h"
29#include "class_linker-inl.h"
30#include "dex_file-inl.h"
31#include "dex_instruction.h"
32#include "disassembler.h"
33#include "elf_builder.h"
34#include "field_helper.h"
35#include "gc_map.h"
36#include "gc/space/image_space.h"
37#include "gc/space/large_object_space.h"
38#include "gc/space/space-inl.h"
39#include "image.h"
40#include "indenter.h"
41#include "mapping_table.h"
42#include "mirror/art_field-inl.h"
43#include "mirror/art_method-inl.h"
44#include "mirror/array-inl.h"
45#include "mirror/class-inl.h"
46#include "mirror/object-inl.h"
47#include "mirror/object_array-inl.h"
48#include "noop_compiler_callbacks.h"
49#include "oat.h"
50#include "oat_file-inl.h"
51#include "os.h"
52#include "output_stream.h"
53#include "runtime.h"
54#include "safe_map.h"
55#include "scoped_thread_state_change.h"
56#include "thread_list.h"
57#include "verifier/dex_gc_map.h"
58#include "verifier/method_verifier.h"
59#include "vmap_table.h"
60
61namespace art {
62
63static void usage() {
64  fprintf(stderr,
65          "Usage: oatdump [options] ...\n"
66          "    Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art\n"
67          "    Example: adb shell oatdump --image=/system/framework/boot.art\n"
68          "\n");
69  fprintf(stderr,
70          "  --oat-file=<file.oat>: specifies an input oat filename.\n"
71          "      Example: --oat-file=/system/framework/boot.oat\n"
72          "\n");
73  fprintf(stderr,
74          "  --image=<file.art>: specifies an input image filename.\n"
75          "      Example: --image=/system/framework/boot.art\n"
76          "\n");
77  fprintf(stderr,
78          "  --boot-image=<file.art>: provide the image file for the boot class path.\n"
79          "      Example: --boot-image=/system/framework/boot.art\n"
80          "\n");
81  fprintf(stderr,
82          "  --instruction-set=(arm|arm64|mips|x86|x86_64): for locating the image\n"
83          "      file based on the image location set.\n"
84          "      Example: --instruction-set=x86\n"
85          "      Default: %s\n"
86          "\n",
87          GetInstructionSetString(kRuntimeISA));
88  fprintf(stderr,
89          "  --output=<file> may be used to send the output to a file.\n"
90          "      Example: --output=/tmp/oatdump.txt\n"
91          "\n");
92  fprintf(stderr,
93          "  --dump:raw_mapping_table enables dumping of the mapping table.\n"
94          "      Example: --dump:raw_mapping_table\n"
95          "\n");
96  fprintf(stderr,
97          "  --dump:raw_mapping_table enables dumping of the GC map.\n"
98          "      Example: --dump:raw_gc_map\n"
99          "\n");
100  fprintf(stderr,
101          "  --no-dump:vmap may be used to disable vmap dumping.\n"
102          "      Example: --no-dump:vmap\n"
103          "\n");
104  fprintf(stderr,
105          "  --no-disassemble may be used to disable disassembly.\n"
106          "      Example: --no-disassemble\n"
107          "\n");
108  exit(EXIT_FAILURE);
109}
110
111const char* image_roots_descriptions_[] = {
112  "kResolutionMethod",
113  "kImtConflictMethod",
114  "kDefaultImt",
115  "kCalleeSaveMethod",
116  "kRefsOnlySaveMethod",
117  "kRefsAndArgsSaveMethod",
118  "kDexCaches",
119  "kClassRoots",
120};
121
122class OatSymbolizer : public CodeOutput {
123 public:
124  explicit OatSymbolizer(const OatFile* oat_file, std::string& output_name) :
125      oat_file_(oat_file), builder_(nullptr), elf_output_(nullptr), output_name_(output_name) {}
126
127  bool Init() {
128    Elf32_Word oat_data_size = oat_file_->GetOatHeader().GetExecutableOffset();
129
130    uint32_t diff = static_cast<uint32_t>(oat_file_->End() - oat_file_->Begin());
131    uint32_t oat_exec_size = diff - oat_data_size;
132
133    if (output_name_.empty()) {
134      output_name_ = "symbolized.oat";
135    }
136    elf_output_ = OS::CreateEmptyFile(output_name_.c_str());
137
138    builder_.reset(new ElfBuilder<Elf32_Word, Elf32_Sword, Elf32_Addr, Elf32_Dyn,
139                                  Elf32_Sym, Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr>(
140        this,
141        elf_output_,
142        oat_file_->GetOatHeader().GetInstructionSet(),
143        0,
144        oat_data_size,
145        oat_data_size,
146        oat_exec_size,
147        true,
148        false));
149
150    if (!builder_->Init()) {
151      builder_.reset(nullptr);
152      return false;
153    }
154
155    return true;
156  }
157
158  typedef void (OatSymbolizer::*Callback)(const DexFile::ClassDef&,
159                                          uint32_t,
160                                          const OatFile::OatMethod&,
161                                          const DexFile&,
162                                          uint32_t,
163                                          const DexFile::CodeItem*,
164                                          uint32_t);
165
166  bool Symbolize() {
167    if (builder_.get() == nullptr) {
168      return false;
169    }
170
171    Walk(&art::OatSymbolizer::RegisterForDedup);
172
173    NormalizeState();
174
175    Walk(&art::OatSymbolizer::AddSymbol);
176
177    bool result = builder_->Write();
178
179    elf_output_->Flush();
180    elf_output_->Close();
181
182    return result;
183  }
184
185  void Walk(Callback callback) {
186    std::vector<const OatFile::OatDexFile*> oat_dex_files = oat_file_->GetOatDexFiles();
187    for (size_t i = 0; i < oat_dex_files.size(); i++) {
188      const OatFile::OatDexFile* oat_dex_file = oat_dex_files[i];
189      CHECK(oat_dex_file != NULL);
190      WalkOatDexFile(oat_dex_file, callback);
191    }
192  }
193
194  void WalkOatDexFile(const OatFile::OatDexFile* oat_dex_file, Callback callback) {
195    std::string error_msg;
196    std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
197    if (dex_file.get() == nullptr) {
198      return;
199    }
200    for (size_t class_def_index = 0;
201        class_def_index < dex_file->NumClassDefs();
202        class_def_index++) {
203      const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
204      const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
205      OatClassType type = oat_class.GetType();
206      switch (type) {
207        case kOatClassAllCompiled:
208        case kOatClassSomeCompiled:
209          WalkOatClass(oat_class, *dex_file.get(), class_def, callback);
210          break;
211
212        case kOatClassNoneCompiled:
213        case kOatClassMax:
214          // Ignore.
215          break;
216      }
217    }
218  }
219
220  void WalkOatClass(const OatFile::OatClass& oat_class, const DexFile& dex_file,
221                    const DexFile::ClassDef& class_def, Callback callback) {
222    const byte* class_data = dex_file.GetClassData(class_def);
223    if (class_data == nullptr) {  // empty class such as a marker interface?
224      return;
225    }
226    // Note: even if this is an interface or a native class, we still have to walk it, as there
227    //       might be a static initializer.
228    ClassDataItemIterator it(dex_file, class_data);
229    SkipAllFields(&it);
230    uint32_t class_method_idx = 0;
231    while (it.HasNextDirectMethod()) {
232      const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx);
233      WalkOatMethod(class_def, class_method_idx, oat_method, dex_file, it.GetMemberIndex(),
234                    it.GetMethodCodeItem(), it.GetMethodAccessFlags(), callback);
235      class_method_idx++;
236      it.Next();
237    }
238    while (it.HasNextVirtualMethod()) {
239      const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx);
240      WalkOatMethod(class_def, class_method_idx, oat_method, dex_file, it.GetMemberIndex(),
241                    it.GetMethodCodeItem(), it.GetMethodAccessFlags(), callback);
242      class_method_idx++;
243      it.Next();
244    }
245    DCHECK(!it.HasNext());
246  }
247
248  void WalkOatMethod(const DexFile::ClassDef& class_def, uint32_t class_method_index,
249                     const OatFile::OatMethod& oat_method, const DexFile& dex_file,
250                     uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
251                     uint32_t method_access_flags, Callback callback) {
252    if ((method_access_flags & kAccAbstract) != 0) {
253      // Abstract method, no code.
254      return;
255    }
256    if (oat_method.GetCodeOffset() == 0) {
257      // No code.
258      return;
259    }
260
261    (this->*callback)(class_def, class_method_index, oat_method, dex_file, dex_method_idx, code_item,
262                      method_access_flags);
263  }
264
265  void RegisterForDedup(const DexFile::ClassDef& class_def, uint32_t class_method_index,
266                        const OatFile::OatMethod& oat_method, const DexFile& dex_file,
267                        uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
268                        uint32_t method_access_flags) {
269    state_[oat_method.GetCodeOffset()]++;
270  }
271
272  void NormalizeState() {
273    for (auto& x : state_) {
274      if (x.second == 1) {
275        state_[x.first] = 0;
276      }
277    }
278  }
279
280  enum class DedupState {  // private
281    kNotDeduplicated,
282    kDeduplicatedFirst,
283    kDeduplicatedOther
284  };
285  DedupState IsDuplicated(uint32_t offset) {
286    if (state_[offset] == 0) {
287      return DedupState::kNotDeduplicated;
288    }
289    if (state_[offset] == 1) {
290      return DedupState::kDeduplicatedOther;
291    }
292    state_[offset] = 1;
293    return DedupState::kDeduplicatedFirst;
294  }
295
296  void AddSymbol(const DexFile::ClassDef& class_def, uint32_t class_method_index,
297                 const OatFile::OatMethod& oat_method, const DexFile& dex_file,
298                 uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
299                 uint32_t method_access_flags) {
300    DedupState dedup = IsDuplicated(oat_method.GetCodeOffset());
301    if (dedup != DedupState::kDeduplicatedOther) {
302      std::string pretty_name = PrettyMethod(dex_method_idx, dex_file, true);
303
304      if (dedup == DedupState::kDeduplicatedFirst) {
305        pretty_name = "[Dedup]" + pretty_name;
306      }
307
308      ElfSymtabBuilder<Elf32_Word, Elf32_Sword, Elf32_Addr,
309      Elf32_Sym, Elf32_Shdr>* symtab = &builder_->symtab_builder_;
310
311      symtab->AddSymbol(pretty_name, &builder_->text_builder_, oat_method.GetCodeOffset() -
312                        oat_file_->GetOatHeader().GetExecutableOffset(), true,
313                        oat_method.GetQuickCodeSize(), STB_GLOBAL, STT_FUNC);
314    }
315  }
316
317  // Write oat code. Required by ElfBuilder/CodeOutput.
318  bool Write(OutputStream* out) {
319    return out->WriteFully(oat_file_->Begin(), oat_file_->End() - oat_file_->Begin());
320  }
321
322 private:
323  static void SkipAllFields(ClassDataItemIterator* it) {
324    while (it->HasNextStaticField()) {
325      it->Next();
326    }
327    while (it->HasNextInstanceField()) {
328      it->Next();
329    }
330  }
331
332  const OatFile* oat_file_;
333  std::unique_ptr<ElfBuilder<Elf32_Word, Elf32_Sword, Elf32_Addr, Elf32_Dyn,
334                              Elf32_Sym, Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr> > builder_;
335  File* elf_output_;
336  std::unordered_map<uint32_t, uint32_t> state_;
337  std::string output_name_;
338};
339
340class OatDumperOptions {
341 public:
342  OatDumperOptions(bool dump_raw_mapping_table,
343                   bool dump_raw_gc_map,
344                   bool dump_vmap,
345                   bool disassemble_code,
346                   bool absolute_addresses)
347    : dump_raw_mapping_table_(dump_raw_mapping_table),
348      dump_raw_gc_map_(dump_raw_gc_map),
349      dump_vmap_(dump_vmap),
350      disassemble_code_(disassemble_code),
351      absolute_addresses_(absolute_addresses) {}
352
353  const bool dump_raw_mapping_table_;
354  const bool dump_raw_gc_map_;
355  const bool dump_vmap_;
356  const bool disassemble_code_;
357  const bool absolute_addresses_;
358};
359
360class OatDumper {
361 public:
362  explicit OatDumper(const OatFile& oat_file, OatDumperOptions* options)
363    : oat_file_(oat_file),
364      oat_dex_files_(oat_file.GetOatDexFiles()),
365      options_(options),
366      disassembler_(Disassembler::Create(oat_file_.GetOatHeader().GetInstructionSet(),
367                                         new DisassemblerOptions(options_->absolute_addresses_,
368                                                                 oat_file.Begin()))) {
369    AddAllOffsets();
370  }
371
372  ~OatDumper() {
373    delete options_;
374    delete disassembler_;
375  }
376
377  bool Dump(std::ostream& os) {
378    bool success = true;
379    const OatHeader& oat_header = oat_file_.GetOatHeader();
380
381    os << "MAGIC:\n";
382    os << oat_header.GetMagic() << "\n\n";
383
384    os << "CHECKSUM:\n";
385    os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum());
386
387    os << "INSTRUCTION SET:\n";
388    os << oat_header.GetInstructionSet() << "\n\n";
389
390    os << "INSTRUCTION SET FEATURES:\n";
391    os << oat_header.GetInstructionSetFeatures().GetFeatureString() << "\n\n";
392
393    os << "DEX FILE COUNT:\n";
394    os << oat_header.GetDexFileCount() << "\n\n";
395
396#define DUMP_OAT_HEADER_OFFSET(label, offset) \
397    os << label " OFFSET:\n"; \
398    os << StringPrintf("0x%08x", oat_header.offset()); \
399    if (oat_header.offset() != 0 && options_->absolute_addresses_) { \
400      os << StringPrintf(" (%p)", oat_file_.Begin() + oat_header.offset()); \
401    } \
402    os << StringPrintf("\n\n");
403
404    DUMP_OAT_HEADER_OFFSET("EXECUTABLE", GetExecutableOffset);
405    DUMP_OAT_HEADER_OFFSET("INTERPRETER TO INTERPRETER BRIDGE",
406                           GetInterpreterToInterpreterBridgeOffset);
407    DUMP_OAT_HEADER_OFFSET("INTERPRETER TO COMPILED CODE BRIDGE",
408                           GetInterpreterToCompiledCodeBridgeOffset);
409    DUMP_OAT_HEADER_OFFSET("JNI DLSYM LOOKUP",
410                           GetJniDlsymLookupOffset);
411    DUMP_OAT_HEADER_OFFSET("PORTABLE IMT CONFLICT TRAMPOLINE",
412                           GetPortableImtConflictTrampolineOffset);
413    DUMP_OAT_HEADER_OFFSET("PORTABLE RESOLUTION TRAMPOLINE",
414                           GetPortableResolutionTrampolineOffset);
415    DUMP_OAT_HEADER_OFFSET("PORTABLE TO INTERPRETER BRIDGE",
416                           GetPortableToInterpreterBridgeOffset);
417    DUMP_OAT_HEADER_OFFSET("QUICK GENERIC JNI TRAMPOLINE",
418                           GetQuickGenericJniTrampolineOffset);
419    DUMP_OAT_HEADER_OFFSET("QUICK IMT CONFLICT TRAMPOLINE",
420                           GetQuickImtConflictTrampolineOffset);
421    DUMP_OAT_HEADER_OFFSET("QUICK RESOLUTION TRAMPOLINE",
422                           GetQuickResolutionTrampolineOffset);
423    DUMP_OAT_HEADER_OFFSET("QUICK TO INTERPRETER BRIDGE",
424                           GetQuickToInterpreterBridgeOffset);
425#undef DUMP_OAT_HEADER_OFFSET
426
427    os << "IMAGE PATCH DELTA:\n";
428    os << StringPrintf("%d (0x%08x)\n\n",
429                       oat_header.GetImagePatchDelta(),
430                       oat_header.GetImagePatchDelta());
431
432    os << "IMAGE FILE LOCATION OAT CHECKSUM:\n";
433    os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatChecksum());
434
435    os << "IMAGE FILE LOCATION OAT BEGIN:\n";
436    os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatDataBegin());
437
438    // Print the key-value store.
439    {
440      os << "KEY VALUE STORE:\n";
441      size_t index = 0;
442      const char* key;
443      const char* value;
444      while (oat_header.GetStoreKeyValuePairByIndex(index, &key, &value)) {
445        os << key << " = " << value << "\n";
446        index++;
447      }
448      os << "\n";
449    }
450
451    if (options_->absolute_addresses_) {
452      os << "BEGIN:\n";
453      os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n";
454
455      os << "END:\n";
456      os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n";
457    }
458
459    os << "SIZE:\n";
460    os << oat_file_.Size() << "\n\n";
461
462    os << std::flush;
463
464    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
465      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
466      CHECK(oat_dex_file != nullptr);
467      if (!DumpOatDexFile(os, *oat_dex_file)) {
468        success = false;
469      }
470    }
471    os << std::flush;
472    return success;
473  }
474
475  size_t ComputeSize(const void* oat_data) {
476    if (reinterpret_cast<const byte*>(oat_data) < oat_file_.Begin() ||
477        reinterpret_cast<const byte*>(oat_data) > oat_file_.End()) {
478      return 0;  // Address not in oat file
479    }
480    uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) -
481                             reinterpret_cast<uintptr_t>(oat_file_.Begin());
482    auto it = offsets_.upper_bound(begin_offset);
483    CHECK(it != offsets_.end());
484    uintptr_t end_offset = *it;
485    return end_offset - begin_offset;
486  }
487
488  InstructionSet GetInstructionSet() {
489    return oat_file_.GetOatHeader().GetInstructionSet();
490  }
491
492  const void* GetQuickOatCode(mirror::ArtMethod* m) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
493    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
494      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
495      CHECK(oat_dex_file != nullptr);
496      std::string error_msg;
497      std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
498      if (dex_file.get() == nullptr) {
499        LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
500            << "': " << error_msg;
501      } else {
502        const DexFile::ClassDef* class_def =
503            dex_file->FindClassDef(m->GetDeclaringClassDescriptor());
504        if (class_def != nullptr) {
505          uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def);
506          const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
507          size_t method_index = m->GetMethodIndex();
508          return oat_class.GetOatMethod(method_index).GetQuickCode();
509        }
510      }
511    }
512    return nullptr;
513  }
514
515 private:
516  void AddAllOffsets() {
517    // We don't know the length of the code for each method, but we need to know where to stop
518    // when disassembling. What we do know is that a region of code will be followed by some other
519    // region, so if we keep a sorted sequence of the start of each region, we can infer the length
520    // of a piece of code by using upper_bound to find the start of the next region.
521    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
522      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
523      CHECK(oat_dex_file != nullptr);
524      std::string error_msg;
525      std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
526      if (dex_file.get() == nullptr) {
527        LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
528            << "': " << error_msg;
529        continue;
530      }
531      offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader()));
532      for (size_t class_def_index = 0;
533           class_def_index < dex_file->NumClassDefs();
534           class_def_index++) {
535        const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
536        const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
537        const byte* class_data = dex_file->GetClassData(class_def);
538        if (class_data != nullptr) {
539          ClassDataItemIterator it(*dex_file, class_data);
540          SkipAllFields(it);
541          uint32_t class_method_index = 0;
542          while (it.HasNextDirectMethod()) {
543            AddOffsets(oat_class.GetOatMethod(class_method_index++));
544            it.Next();
545          }
546          while (it.HasNextVirtualMethod()) {
547            AddOffsets(oat_class.GetOatMethod(class_method_index++));
548            it.Next();
549          }
550        }
551      }
552    }
553
554    // If the last thing in the file is code for a method, there won't be an offset for the "next"
555    // thing. Instead of having a special case in the upper_bound code, let's just add an entry
556    // for the end of the file.
557    offsets_.insert(oat_file_.Size());
558  }
559
560  static uint32_t AlignCodeOffset(uint32_t maybe_thumb_offset) {
561    return maybe_thumb_offset & ~0x1;  // TODO: Make this Thumb2 specific.
562  }
563
564  void AddOffsets(const OatFile::OatMethod& oat_method) {
565    uint32_t code_offset = oat_method.GetCodeOffset();
566    if (oat_file_.GetOatHeader().GetInstructionSet() == kThumb2) {
567      code_offset &= ~0x1;
568    }
569    offsets_.insert(code_offset);
570    offsets_.insert(oat_method.GetMappingTableOffset());
571    offsets_.insert(oat_method.GetVmapTableOffset());
572    offsets_.insert(oat_method.GetNativeGcMapOffset());
573  }
574
575  bool DumpOatDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) {
576    bool success = true;
577    os << "OatDexFile:\n";
578    os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str());
579    os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum());
580
581    // Create the verifier early.
582
583    std::string error_msg;
584    std::unique_ptr<const DexFile> dex_file(oat_dex_file.OpenDexFile(&error_msg));
585    if (dex_file.get() == nullptr) {
586      os << "NOT FOUND: " << error_msg << "\n\n";
587      os << std::flush;
588      return false;
589    }
590    for (size_t class_def_index = 0;
591         class_def_index < dex_file->NumClassDefs();
592         class_def_index++) {
593      const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
594      const char* descriptor = dex_file->GetClassDescriptor(class_def);
595      uint32_t oat_class_offset = oat_dex_file.GetOatClassOffset(class_def_index);
596      const OatFile::OatClass oat_class = oat_dex_file.GetOatClass(class_def_index);
597      os << StringPrintf("%zd: %s (offset=0x%08x) (type_idx=%d)",
598                         class_def_index, descriptor, oat_class_offset, class_def.class_idx_)
599         << " (" << oat_class.GetStatus() << ")"
600         << " (" << oat_class.GetType() << ")\n";
601      // TODO: include bitmap here if type is kOatClassSomeCompiled?
602      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
603      std::ostream indented_os(&indent_filter);
604      if (!DumpOatClass(indented_os, oat_class, *(dex_file.get()), class_def)) {
605        success = false;
606      }
607    }
608
609    os << std::flush;
610    return success;
611  }
612
613  static void SkipAllFields(ClassDataItemIterator& it) {
614    while (it.HasNextStaticField()) {
615      it.Next();
616    }
617    while (it.HasNextInstanceField()) {
618      it.Next();
619    }
620  }
621
622  bool DumpOatClass(std::ostream& os, const OatFile::OatClass& oat_class, const DexFile& dex_file,
623                    const DexFile::ClassDef& class_def) {
624    bool success = true;
625    const byte* class_data = dex_file.GetClassData(class_def);
626    if (class_data == nullptr) {  // empty class such as a marker interface?
627      os << std::flush;
628      return success;
629    }
630    ClassDataItemIterator it(dex_file, class_data);
631    SkipAllFields(it);
632    uint32_t class_method_index = 0;
633    while (it.HasNextDirectMethod()) {
634      if (!DumpOatMethod(os, class_def, class_method_index, oat_class, dex_file,
635                         it.GetMemberIndex(), it.GetMethodCodeItem(),
636                         it.GetRawMemberAccessFlags())) {
637        success = false;
638      }
639      class_method_index++;
640      it.Next();
641    }
642    while (it.HasNextVirtualMethod()) {
643      if (!DumpOatMethod(os, class_def, class_method_index, oat_class, dex_file,
644                         it.GetMemberIndex(), it.GetMethodCodeItem(),
645                         it.GetRawMemberAccessFlags())) {
646        success = false;
647      }
648      class_method_index++;
649      it.Next();
650    }
651    DCHECK(!it.HasNext());
652    os << std::flush;
653    return success;
654  }
655
656  static constexpr uint32_t kPrologueBytes = 16;
657
658  // When this was picked, the largest arm method was 55,256 bytes and arm64 was 50,412 bytes.
659  static constexpr uint32_t kMaxCodeSize = 100 * 1000;
660
661  bool DumpOatMethod(std::ostream& os, const DexFile::ClassDef& class_def,
662                     uint32_t class_method_index,
663                     const OatFile::OatClass& oat_class, const DexFile& dex_file,
664                     uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
665                     uint32_t method_access_flags) {
666    bool success = true;
667    os << StringPrintf("%d: %s (dex_method_idx=%d)\n",
668                       class_method_index, PrettyMethod(dex_method_idx, dex_file, true).c_str(),
669                       dex_method_idx);
670    Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
671    std::unique_ptr<std::ostream> indent1_os(new std::ostream(&indent1_filter));
672    Indenter indent2_filter(indent1_os->rdbuf(), kIndentChar, kIndentBy1Count);
673    std::unique_ptr<std::ostream> indent2_os(new std::ostream(&indent2_filter));
674    {
675      *indent1_os << "DEX CODE:\n";
676      DumpDexCode(*indent2_os, dex_file, code_item);
677    }
678
679    std::unique_ptr<verifier::MethodVerifier> verifier;
680    if (Runtime::Current() != nullptr) {
681      *indent1_os << "VERIFIER TYPE ANALYSIS:\n";
682      verifier.reset(DumpVerifier(*indent2_os, dex_method_idx, &dex_file, class_def, code_item,
683                                  method_access_flags));
684    }
685
686    uint32_t oat_method_offsets_offset = oat_class.GetOatMethodOffsetsOffset(class_method_index);
687    const OatMethodOffsets* oat_method_offsets = oat_class.GetOatMethodOffsets(class_method_index);
688    const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_index);
689    {
690      *indent1_os << "OatMethodOffsets ";
691      if (options_->absolute_addresses_) {
692        *indent1_os << StringPrintf("%p ", oat_method_offsets);
693      }
694      *indent1_os << StringPrintf("(offset=0x%08x)\n", oat_method_offsets_offset);
695      if (oat_method_offsets_offset > oat_file_.Size()) {
696        *indent1_os << StringPrintf(
697            "WARNING: oat method offsets offset 0x%08x is past end of file 0x%08zx.\n",
698            oat_method_offsets_offset, oat_file_.Size());
699        // If we can't read OatMethodOffsets, the rest of the data is dangerous to read.
700        os << std::flush;
701        return false;
702      }
703
704      uint32_t code_offset = oat_method.GetCodeOffset();
705      *indent2_os << StringPrintf("code_offset: 0x%08x ", code_offset);
706      uint32_t aligned_code_begin = AlignCodeOffset(oat_method.GetCodeOffset());
707      if (aligned_code_begin > oat_file_.Size()) {
708        *indent2_os << StringPrintf("WARNING: "
709                                    "code offset 0x%08x is past end of file 0x%08zx.\n",
710                                    aligned_code_begin, oat_file_.Size());
711        success = false;
712      }
713      *indent2_os << "\n";
714
715      *indent2_os << "gc_map: ";
716      if (options_->absolute_addresses_) {
717        *indent2_os << StringPrintf("%p ", oat_method.GetNativeGcMap());
718      }
719      uint32_t gc_map_offset = oat_method.GetNativeGcMapOffset();
720      *indent2_os << StringPrintf("(offset=0x%08x)\n", gc_map_offset);
721      if (gc_map_offset > oat_file_.Size()) {
722        *indent2_os << StringPrintf("WARNING: "
723                                    "gc map table offset 0x%08x is past end of file 0x%08zx.\n",
724                                    gc_map_offset, oat_file_.Size());
725        success = false;
726      } else if (options_->dump_raw_gc_map_) {
727        Indenter indent3_filter(indent2_os->rdbuf(), kIndentChar, kIndentBy1Count);
728        std::ostream indent3_os(&indent3_filter);
729        DumpGcMap(indent3_os, oat_method, code_item);
730      }
731    }
732    {
733      *indent1_os << "OatQuickMethodHeader ";
734      uint32_t method_header_offset = oat_method.GetOatQuickMethodHeaderOffset();
735      const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader();
736
737      if (options_->absolute_addresses_) {
738        *indent1_os << StringPrintf("%p ", method_header);
739      }
740      *indent1_os << StringPrintf("(offset=0x%08x)\n", method_header_offset);
741      if (method_header_offset > oat_file_.Size()) {
742        *indent1_os << StringPrintf(
743            "WARNING: oat quick method header offset 0x%08x is past end of file 0x%08zx.\n",
744            method_header_offset, oat_file_.Size());
745        // If we can't read the OatQuickMethodHeader, the rest of the data is dangerous to read.
746        os << std::flush;
747        return false;
748      }
749
750      *indent2_os << "mapping_table: ";
751      if (options_->absolute_addresses_) {
752        *indent2_os << StringPrintf("%p ", oat_method.GetMappingTable());
753      }
754      uint32_t mapping_table_offset = oat_method.GetMappingTableOffset();
755      *indent2_os << StringPrintf("(offset=0x%08x)\n", oat_method.GetMappingTableOffset());
756      if (mapping_table_offset > oat_file_.Size()) {
757        *indent2_os << StringPrintf("WARNING: "
758                                    "mapping table offset 0x%08x is past end of file 0x%08zx. "
759                                    "mapping table offset was loaded from offset 0x%08x.\n",
760                                    mapping_table_offset, oat_file_.Size(),
761                                    oat_method.GetMappingTableOffsetOffset());
762        success = false;
763      } else if (options_->dump_raw_mapping_table_) {
764        Indenter indent3_filter(indent2_os->rdbuf(), kIndentChar, kIndentBy1Count);
765        std::ostream indent3_os(&indent3_filter);
766        DumpMappingTable(indent3_os, oat_method);
767      }
768
769      *indent2_os << "vmap_table: ";
770      if (options_->absolute_addresses_) {
771        *indent2_os << StringPrintf("%p ", oat_method.GetVmapTable());
772      }
773      uint32_t vmap_table_offset = oat_method.GetVmapTableOffset();
774      *indent2_os << StringPrintf("(offset=0x%08x)\n", vmap_table_offset);
775      if (vmap_table_offset > oat_file_.Size()) {
776        *indent2_os << StringPrintf("WARNING: "
777                                    "vmap table offset 0x%08x is past end of file 0x%08zx. "
778                                    "vmap table offset was loaded from offset 0x%08x.\n",
779                                    vmap_table_offset, oat_file_.Size(),
780                                    oat_method.GetVmapTableOffsetOffset());
781        success = false;
782      } else if (options_->dump_vmap_) {
783        if (oat_method.GetNativeGcMap() != nullptr) {
784          // The native GC map is null for methods compiled with the optimizing compiler.
785          DumpVmap(*indent2_os, oat_method);
786        }
787      }
788    }
789    {
790      *indent1_os << "QuickMethodFrameInfo\n";
791
792      *indent2_os << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes());
793      *indent2_os << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask());
794      DumpSpillMask(*indent2_os, oat_method.GetCoreSpillMask(), false);
795      *indent2_os << "\n";
796      *indent2_os << StringPrintf("fp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask());
797      DumpSpillMask(*indent2_os, oat_method.GetFpSpillMask(), true);
798      *indent2_os << "\n";
799    }
800    {
801        // Based on spill masks from QuickMethodFrameInfo so placed
802        // after it is dumped, but useful for understanding quick
803        // code, so dumped here.
804        DumpVregLocations(*indent2_os, oat_method, code_item);
805    }
806    {
807      *indent1_os << "CODE: ";
808      uint32_t code_size_offset = oat_method.GetQuickCodeSizeOffset();
809      if (code_size_offset > oat_file_.Size()) {
810        *indent2_os << StringPrintf("WARNING: "
811                                    "code size offset 0x%08x is past end of file 0x%08zx.",
812                                    code_size_offset, oat_file_.Size());
813        success = false;
814      } else {
815        const void* code = oat_method.GetQuickCode();
816        uint32_t code_size = oat_method.GetQuickCodeSize();
817        if (code == nullptr) {
818          code = oat_method.GetPortableCode();
819          code_size = oat_method.GetPortableCodeSize();
820          code_size_offset = 0;
821        }
822        uint32_t code_offset = oat_method.GetCodeOffset();
823        uint32_t aligned_code_begin = AlignCodeOffset(code_offset);
824        uint64_t aligned_code_end = aligned_code_begin + code_size;
825
826        if (options_->absolute_addresses_) {
827          *indent1_os << StringPrintf("%p ", code);
828        }
829        *indent1_os << StringPrintf("(code_offset=0x%08x size_offset=0x%08x size=%u)%s\n",
830                                    code_offset,
831                                    code_size_offset,
832                                    code_size,
833                                    code != nullptr ? "..." : "");
834
835        if (aligned_code_begin > oat_file_.Size()) {
836          *indent2_os << StringPrintf("WARNING: "
837                                      "start of code at 0x%08x is past end of file 0x%08zx.",
838                                      aligned_code_begin, oat_file_.Size());
839          success = false;
840        } else if (aligned_code_end > oat_file_.Size()) {
841          *indent2_os << StringPrintf("WARNING: "
842                                      "end of code at 0x%08" PRIx64 " is past end of file 0x%08zx. "
843                                      "code size is 0x%08x loaded from offset 0x%08x.\n",
844                                      aligned_code_end, oat_file_.Size(),
845                                      code_size, code_size_offset);
846          success = false;
847          if (options_->disassemble_code_) {
848            if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
849              DumpCode(*indent2_os, verifier.get(), oat_method, code_item, true, kPrologueBytes);
850            }
851          }
852        } else if (code_size > kMaxCodeSize) {
853          *indent2_os << StringPrintf("WARNING: "
854                                      "code size %d is bigger than max expected threshold of %d. "
855                                      "code size is 0x%08x loaded from offset 0x%08x.\n",
856                                      code_size, kMaxCodeSize,
857                                      code_size, code_size_offset);
858          success = false;
859          if (options_->disassemble_code_) {
860            if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
861              DumpCode(*indent2_os, verifier.get(), oat_method, code_item, true, kPrologueBytes);
862            }
863          }
864        } else if (options_->disassemble_code_) {
865          DumpCode(*indent2_os, verifier.get(), oat_method, code_item, !success, 0);
866        }
867      }
868    }
869    os << std::flush;
870    return success;
871  }
872
873  void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) {
874    if (spill_mask == 0) {
875      return;
876    }
877    os << "(";
878    for (size_t i = 0; i < 32; i++) {
879      if ((spill_mask & (1 << i)) != 0) {
880        if (is_float) {
881          os << "fr" << i;
882        } else {
883          os << "r" << i;
884        }
885        spill_mask ^= 1 << i;  // clear bit
886        if (spill_mask != 0) {
887          os << ", ";
888        } else {
889          break;
890        }
891      }
892    }
893    os << ")";
894  }
895
896  void DumpVmap(std::ostream& os, const OatFile::OatMethod& oat_method) {
897    const uint8_t* raw_table = oat_method.GetVmapTable();
898    if (raw_table != nullptr) {
899      const VmapTable vmap_table(raw_table);
900      bool first = true;
901      bool processing_fp = false;
902      uint32_t spill_mask = oat_method.GetCoreSpillMask();
903      for (size_t i = 0; i < vmap_table.Size(); i++) {
904        uint16_t dex_reg = vmap_table[i];
905        uint32_t cpu_reg = vmap_table.ComputeRegister(spill_mask, i,
906                                                      processing_fp ? kFloatVReg : kIntVReg);
907        os << (first ? "v" : ", v")  << dex_reg;
908        if (!processing_fp) {
909          os << "/r" << cpu_reg;
910        } else {
911          os << "/fr" << cpu_reg;
912        }
913        first = false;
914        if (!processing_fp && dex_reg == 0xFFFF) {
915          processing_fp = true;
916          spill_mask = oat_method.GetFpSpillMask();
917        }
918      }
919      os << "\n";
920    }
921  }
922
923  void DumpVregLocations(std::ostream& os, const OatFile::OatMethod& oat_method,
924                         const DexFile::CodeItem* code_item) {
925    if (code_item != nullptr) {
926      size_t num_locals_ins = code_item->registers_size_;
927      size_t num_ins = code_item->ins_size_;
928      size_t num_locals = num_locals_ins - num_ins;
929      size_t num_outs = code_item->outs_size_;
930
931      os << "vr_stack_locations:";
932      for (size_t reg = 0; reg <= num_locals_ins; reg++) {
933        // For readability, delimit the different kinds of VRs.
934        if (reg == num_locals_ins) {
935          os << "\n\tmethod*:";
936        } else if (reg == num_locals && num_ins > 0) {
937          os << "\n\tins:";
938        } else if (reg == 0 && num_locals > 0) {
939          os << "\n\tlocals:";
940        }
941
942        uint32_t offset = StackVisitor::GetVRegOffset(code_item, oat_method.GetCoreSpillMask(),
943                                                      oat_method.GetFpSpillMask(),
944                                                      oat_method.GetFrameSizeInBytes(), reg,
945                                                      GetInstructionSet());
946        os << " v" << reg << "[sp + #" << offset << "]";
947      }
948
949      for (size_t out_reg = 0; out_reg < num_outs; out_reg++) {
950        if (out_reg == 0) {
951          os << "\n\touts:";
952        }
953
954        uint32_t offset = StackVisitor::GetOutVROffset(out_reg, GetInstructionSet());
955        os << " v" << out_reg << "[sp + #" << offset << "]";
956      }
957
958      os << "\n";
959    }
960  }
961
962  void DescribeVReg(std::ostream& os, const OatFile::OatMethod& oat_method,
963                    const DexFile::CodeItem* code_item, size_t reg, VRegKind kind) {
964    const uint8_t* raw_table = oat_method.GetVmapTable();
965    if (raw_table != nullptr) {
966      const VmapTable vmap_table(raw_table);
967      uint32_t vmap_offset;
968      if (vmap_table.IsInContext(reg, kind, &vmap_offset)) {
969        bool is_float = (kind == kFloatVReg) || (kind == kDoubleLoVReg) || (kind == kDoubleHiVReg);
970        uint32_t spill_mask = is_float ? oat_method.GetFpSpillMask()
971                                       : oat_method.GetCoreSpillMask();
972        os << (is_float ? "fr" : "r") << vmap_table.ComputeRegister(spill_mask, vmap_offset, kind);
973      } else {
974        uint32_t offset = StackVisitor::GetVRegOffset(code_item, oat_method.GetCoreSpillMask(),
975                                                      oat_method.GetFpSpillMask(),
976                                                      oat_method.GetFrameSizeInBytes(), reg,
977                                                      GetInstructionSet());
978        os << "[sp + #" << offset << "]";
979      }
980    }
981  }
982
983  void DumpGcMapRegisters(std::ostream& os, const OatFile::OatMethod& oat_method,
984                          const DexFile::CodeItem* code_item,
985                          size_t num_regs, const uint8_t* reg_bitmap) {
986    bool first = true;
987    for (size_t reg = 0; reg < num_regs; reg++) {
988      if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
989        if (first) {
990          os << "  v" << reg << " (";
991          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
992          os << ")";
993          first = false;
994        } else {
995          os << ", v" << reg << " (";
996          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
997          os << ")";
998        }
999      }
1000    }
1001    if (first) {
1002      os << "No registers in GC map\n";
1003    } else {
1004      os << "\n";
1005    }
1006  }
1007  void DumpGcMap(std::ostream& os, const OatFile::OatMethod& oat_method,
1008                 const DexFile::CodeItem* code_item) {
1009    const uint8_t* gc_map_raw = oat_method.GetNativeGcMap();
1010    if (gc_map_raw == nullptr) {
1011      return;  // No GC map.
1012    }
1013    const void* quick_code = oat_method.GetQuickCode();
1014    if (quick_code != nullptr) {
1015      NativePcOffsetToReferenceMap map(gc_map_raw);
1016      for (size_t entry = 0; entry < map.NumEntries(); entry++) {
1017        const uint8_t* native_pc = reinterpret_cast<const uint8_t*>(quick_code) +
1018            map.GetNativePcOffset(entry);
1019        os << StringPrintf("%p", native_pc);
1020        DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
1021      }
1022    } else {
1023      const void* portable_code = oat_method.GetPortableCode();
1024      CHECK(portable_code != nullptr);
1025      verifier::DexPcToReferenceMap map(gc_map_raw);
1026      for (size_t entry = 0; entry < map.NumEntries(); entry++) {
1027        uint32_t dex_pc = map.GetDexPc(entry);
1028        os << StringPrintf("0x%08x", dex_pc);
1029        DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
1030      }
1031    }
1032  }
1033
1034  void DumpMappingTable(std::ostream& os, const OatFile::OatMethod& oat_method) {
1035    const void* quick_code = oat_method.GetQuickCode();
1036    if (quick_code == nullptr) {
1037      return;
1038    }
1039    MappingTable table(oat_method.GetMappingTable());
1040    if (table.TotalSize() != 0) {
1041      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1042      std::ostream indent_os(&indent_filter);
1043      if (table.PcToDexSize() != 0) {
1044        typedef MappingTable::PcToDexIterator It;
1045        os << "suspend point mappings {\n";
1046        for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
1047          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
1048        }
1049        os << "}\n";
1050      }
1051      if (table.DexToPcSize() != 0) {
1052        typedef MappingTable::DexToPcIterator It;
1053        os << "catch entry mappings {\n";
1054        for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
1055          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
1056        }
1057        os << "}\n";
1058      }
1059    }
1060  }
1061
1062  uint32_t DumpMappingAtOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
1063                               size_t offset, bool suspend_point_mapping) {
1064    MappingTable table(oat_method.GetMappingTable());
1065    if (suspend_point_mapping && table.PcToDexSize() > 0) {
1066      typedef MappingTable::PcToDexIterator It;
1067      for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
1068        if (offset == cur.NativePcOffset()) {
1069          os << StringPrintf("suspend point dex PC: 0x%04x\n", cur.DexPc());
1070          return cur.DexPc();
1071        }
1072      }
1073    } else if (!suspend_point_mapping && table.DexToPcSize() > 0) {
1074      typedef MappingTable::DexToPcIterator It;
1075      for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
1076        if (offset == cur.NativePcOffset()) {
1077          os << StringPrintf("catch entry dex PC: 0x%04x\n", cur.DexPc());
1078          return cur.DexPc();
1079        }
1080      }
1081    }
1082    return DexFile::kDexNoIndex;
1083  }
1084
1085  void DumpGcMapAtNativePcOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
1086                                 const DexFile::CodeItem* code_item, size_t native_pc_offset) {
1087    const uint8_t* gc_map_raw = oat_method.GetNativeGcMap();
1088    if (gc_map_raw != nullptr) {
1089      NativePcOffsetToReferenceMap map(gc_map_raw);
1090      if (map.HasEntry(native_pc_offset)) {
1091        size_t num_regs = map.RegWidth() * 8;
1092        const uint8_t* reg_bitmap = map.FindBitMap(native_pc_offset);
1093        bool first = true;
1094        for (size_t reg = 0; reg < num_regs; reg++) {
1095          if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
1096            if (first) {
1097              os << "GC map objects:  v" << reg << " (";
1098              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
1099              os << ")";
1100              first = false;
1101            } else {
1102              os << ", v" << reg << " (";
1103              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
1104              os << ")";
1105            }
1106          }
1107        }
1108        if (!first) {
1109          os << "\n";
1110        }
1111      }
1112    }
1113  }
1114
1115  void DumpVRegsAtDexPc(std::ostream& os, verifier::MethodVerifier* verifier,
1116                        const OatFile::OatMethod& oat_method,
1117                        const DexFile::CodeItem* code_item, uint32_t dex_pc) {
1118    DCHECK(verifier != nullptr);
1119    std::vector<int32_t> kinds = verifier->DescribeVRegs(dex_pc);
1120    bool first = true;
1121    for (size_t reg = 0; reg < code_item->registers_size_; reg++) {
1122      VRegKind kind = static_cast<VRegKind>(kinds.at(reg * 2));
1123      if (kind != kUndefined) {
1124        if (first) {
1125          os << "VRegs:  v";
1126          first = false;
1127        } else {
1128          os << ", v";
1129        }
1130        os << reg << " (";
1131        switch (kind) {
1132          case kImpreciseConstant:
1133            os << "Imprecise Constant: " << kinds.at((reg * 2) + 1) << ", ";
1134            DescribeVReg(os, oat_method, code_item, reg, kind);
1135            break;
1136          case kConstant:
1137            os << "Constant: " << kinds.at((reg * 2) + 1);
1138            break;
1139          default:
1140            DescribeVReg(os, oat_method, code_item, reg, kind);
1141            break;
1142        }
1143        os << ")";
1144      }
1145    }
1146    if (!first) {
1147      os << "\n";
1148    }
1149  }
1150
1151
1152  void DumpDexCode(std::ostream& os, const DexFile& dex_file, const DexFile::CodeItem* code_item) {
1153    if (code_item != nullptr) {
1154      size_t i = 0;
1155      while (i < code_item->insns_size_in_code_units_) {
1156        const Instruction* instruction = Instruction::At(&code_item->insns_[i]);
1157        os << StringPrintf("0x%04zx: %s\n", i, instruction->DumpString(&dex_file).c_str());
1158        i += instruction->SizeInCodeUnits();
1159      }
1160    }
1161  }
1162
1163  verifier::MethodVerifier* DumpVerifier(std::ostream& os, uint32_t dex_method_idx,
1164                                         const DexFile* dex_file,
1165                                         const DexFile::ClassDef& class_def,
1166                                         const DexFile::CodeItem* code_item,
1167                                         uint32_t method_access_flags) {
1168    if ((method_access_flags & kAccNative) == 0) {
1169      ScopedObjectAccess soa(Thread::Current());
1170      StackHandleScope<1> hs(soa.Self());
1171      Handle<mirror::DexCache> dex_cache(
1172          hs.NewHandle(Runtime::Current()->GetClassLinker()->FindDexCache(*dex_file)));
1173      return verifier::MethodVerifier::VerifyMethodAndDump(soa.Self(), os, dex_method_idx, dex_file,
1174                                                           dex_cache,
1175                                                           NullHandle<mirror::ClassLoader>(),
1176                                                           &class_def, code_item,
1177                                                           NullHandle<mirror::ArtMethod>(),
1178                                                           method_access_flags);
1179    }
1180
1181    return nullptr;
1182  }
1183
1184  void DumpCode(std::ostream& os, verifier::MethodVerifier* verifier,
1185                const OatFile::OatMethod& oat_method, const DexFile::CodeItem* code_item,
1186                bool bad_input, size_t code_size) {
1187    const void* portable_code = oat_method.GetPortableCode();
1188    const void* quick_code = oat_method.GetQuickCode();
1189
1190    if (code_size == 0) {
1191      code_size = oat_method.GetQuickCodeSize();
1192    }
1193    if ((code_size == 0) || ((portable_code == nullptr) && (quick_code == nullptr))) {
1194      os << "NO CODE!\n";
1195      return;
1196    } else if (quick_code != nullptr) {
1197      const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
1198      size_t offset = 0;
1199      while (offset < code_size) {
1200        if (!bad_input) {
1201          DumpMappingAtOffset(os, oat_method, offset, false);
1202        }
1203        offset += disassembler_->Dump(os, quick_native_pc + offset);
1204        if (!bad_input) {
1205          uint32_t dex_pc = DumpMappingAtOffset(os, oat_method, offset, true);
1206          if (dex_pc != DexFile::kDexNoIndex) {
1207            DumpGcMapAtNativePcOffset(os, oat_method, code_item, offset);
1208            if (verifier != nullptr) {
1209              DumpVRegsAtDexPc(os, verifier, oat_method, code_item, dex_pc);
1210            }
1211          }
1212        }
1213      }
1214    } else {
1215      CHECK(portable_code != nullptr);
1216      CHECK_EQ(code_size, 0U);  // TODO: disassembly of portable is currently not supported.
1217    }
1218  }
1219
1220  const OatFile& oat_file_;
1221  const std::vector<const OatFile::OatDexFile*> oat_dex_files_;
1222  const OatDumperOptions* options_;
1223  std::set<uintptr_t> offsets_;
1224  Disassembler* disassembler_;
1225};
1226
1227class ImageDumper {
1228 public:
1229  explicit ImageDumper(std::ostream* os, gc::space::ImageSpace& image_space,
1230                       const ImageHeader& image_header, OatDumperOptions* oat_dumper_options)
1231      : os_(os),
1232        image_space_(image_space),
1233        image_header_(image_header),
1234        oat_dumper_options_(oat_dumper_options) {}
1235
1236  bool Dump() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1237    std::ostream& os = *os_;
1238    os << "MAGIC: " << image_header_.GetMagic() << "\n\n";
1239
1240    os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n";
1241
1242    os << "IMAGE BITMAP OFFSET: " << reinterpret_cast<void*>(image_header_.GetImageBitmapOffset())
1243       << " SIZE: " << reinterpret_cast<void*>(image_header_.GetImageBitmapSize()) << "\n\n";
1244
1245    os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum());
1246
1247    os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n";
1248
1249    os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n";
1250
1251    os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n";
1252
1253    os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n";
1254
1255    os << "PATCH DELTA:" << image_header_.GetPatchDelta() << "\n\n";
1256
1257    {
1258      os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n";
1259      Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1260      std::ostream indent1_os(&indent1_filter);
1261      CHECK_EQ(arraysize(image_roots_descriptions_), size_t(ImageHeader::kImageRootsMax));
1262      for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
1263        ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i);
1264        const char* image_root_description = image_roots_descriptions_[i];
1265        mirror::Object* image_root_object = image_header_.GetImageRoot(image_root);
1266        indent1_os << StringPrintf("%s: %p\n", image_root_description, image_root_object);
1267        if (image_root_object->IsObjectArray()) {
1268          Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
1269          std::ostream indent2_os(&indent2_filter);
1270          mirror::ObjectArray<mirror::Object>* image_root_object_array
1271              = image_root_object->AsObjectArray<mirror::Object>();
1272          for (int i = 0; i < image_root_object_array->GetLength(); i++) {
1273            mirror::Object* value = image_root_object_array->Get(i);
1274            size_t run = 0;
1275            for (int32_t j = i + 1; j < image_root_object_array->GetLength(); j++) {
1276              if (value == image_root_object_array->Get(j)) {
1277                run++;
1278              } else {
1279                break;
1280              }
1281            }
1282            if (run == 0) {
1283              indent2_os << StringPrintf("%d: ", i);
1284            } else {
1285              indent2_os << StringPrintf("%d to %zd: ", i, i + run);
1286              i = i + run;
1287            }
1288            if (value != nullptr) {
1289              PrettyObjectValue(indent2_os, value->GetClass(), value);
1290            } else {
1291              indent2_os << i << ": null\n";
1292            }
1293          }
1294        }
1295      }
1296    }
1297    os << "\n";
1298
1299    ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1300    std::string image_filename = image_space_.GetImageFilename();
1301    std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename);
1302    os << "OAT LOCATION: " << oat_location;
1303    os << "\n";
1304    std::string error_msg;
1305    const OatFile* oat_file = class_linker->FindOpenedOatFileFromOatLocation(oat_location);
1306    if (oat_file == nullptr) {
1307      oat_file = OatFile::Open(oat_location, oat_location, nullptr, false, &error_msg);
1308      if (oat_file == nullptr) {
1309        os << "NOT FOUND: " << error_msg << "\n";
1310        return false;
1311      }
1312    }
1313    os << "\n";
1314
1315    stats_.oat_file_bytes = oat_file->Size();
1316
1317    oat_dumper_.reset(new OatDumper(*oat_file, oat_dumper_options_.release()));
1318
1319    for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
1320      CHECK(oat_dex_file != nullptr);
1321      stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(),
1322                                                         oat_dex_file->FileSize()));
1323    }
1324
1325    os << "OBJECTS:\n" << std::flush;
1326
1327    // Loop through all the image spaces and dump their objects.
1328    gc::Heap* heap = Runtime::Current()->GetHeap();
1329    const std::vector<gc::space::ContinuousSpace*>& spaces = heap->GetContinuousSpaces();
1330    Thread* self = Thread::Current();
1331    {
1332      {
1333        WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1334        heap->FlushAllocStack();
1335      }
1336      // Since FlushAllocStack() above resets the (active) allocation
1337      // stack. Need to revoke the thread-local allocation stacks that
1338      // point into it.
1339      {
1340        self->TransitionFromRunnableToSuspended(kNative);
1341        ThreadList* thread_list = Runtime::Current()->GetThreadList();
1342        thread_list->SuspendAll();
1343        heap->RevokeAllThreadLocalAllocationStacks(self);
1344        thread_list->ResumeAll();
1345        self->TransitionFromSuspendedToRunnable();
1346      }
1347    }
1348    {
1349      std::ostream* saved_os = os_;
1350      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1351      std::ostream indent_os(&indent_filter);
1352      os_ = &indent_os;
1353      ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
1354      for (const auto& space : spaces) {
1355        if (space->IsImageSpace()) {
1356          gc::space::ImageSpace* image_space = space->AsImageSpace();
1357          image_space->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
1358          indent_os << "\n";
1359        }
1360      }
1361      // Dump the large objects separately.
1362      heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
1363      indent_os << "\n";
1364      os_ = saved_os;
1365    }
1366    os << "STATS:\n" << std::flush;
1367    std::unique_ptr<File> file(OS::OpenFileForReading(image_filename.c_str()));
1368    if (file.get() == nullptr) {
1369      LOG(WARNING) << "Failed to find image in " << image_filename;
1370    }
1371    if (file.get() != nullptr) {
1372      stats_.file_bytes = file->GetLength();
1373    }
1374    size_t header_bytes = sizeof(ImageHeader);
1375    stats_.header_bytes = header_bytes;
1376    size_t alignment_bytes = RoundUp(header_bytes, kObjectAlignment) - header_bytes;
1377    stats_.alignment_bytes += alignment_bytes;
1378    stats_.alignment_bytes += image_header_.GetImageBitmapOffset() - image_header_.GetImageSize();
1379    stats_.bitmap_bytes += image_header_.GetImageBitmapSize();
1380    stats_.Dump(os);
1381    os << "\n";
1382
1383    os << std::flush;
1384
1385    return oat_dumper_->Dump(os);
1386  }
1387
1388 private:
1389  static void PrettyObjectValue(std::ostream& os, mirror::Class* type, mirror::Object* value)
1390      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1391    CHECK(type != nullptr);
1392    if (value == nullptr) {
1393      os << StringPrintf("null   %s\n", PrettyDescriptor(type).c_str());
1394    } else if (type->IsStringClass()) {
1395      mirror::String* string = value->AsString();
1396      os << StringPrintf("%p   String: %s\n", string,
1397                         PrintableString(string->ToModifiedUtf8().c_str()).c_str());
1398    } else if (type->IsClassClass()) {
1399      mirror::Class* klass = value->AsClass();
1400      os << StringPrintf("%p   Class: %s\n", klass, PrettyDescriptor(klass).c_str());
1401    } else if (type->IsArtFieldClass()) {
1402      mirror::ArtField* field = value->AsArtField();
1403      os << StringPrintf("%p   Field: %s\n", field, PrettyField(field).c_str());
1404    } else if (type->IsArtMethodClass()) {
1405      mirror::ArtMethod* method = value->AsArtMethod();
1406      os << StringPrintf("%p   Method: %s\n", method, PrettyMethod(method).c_str());
1407    } else {
1408      os << StringPrintf("%p   %s\n", value, PrettyDescriptor(type).c_str());
1409    }
1410  }
1411
1412  static void PrintField(std::ostream& os, mirror::ArtField* field, mirror::Object* obj)
1413      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1414    const char* descriptor = field->GetTypeDescriptor();
1415    os << StringPrintf("%s: ", field->GetName());
1416    if (descriptor[0] != 'L' && descriptor[0] != '[') {
1417      StackHandleScope<1> hs(Thread::Current());
1418      FieldHelper fh(hs.NewHandle(field));
1419      mirror::Class* type = fh.GetType();
1420      DCHECK(type->IsPrimitive());
1421      if (type->IsPrimitiveLong()) {
1422        os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj));
1423      } else if (type->IsPrimitiveDouble()) {
1424        os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj));
1425      } else if (type->IsPrimitiveFloat()) {
1426        os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj));
1427      } else if (type->IsPrimitiveInt()) {
1428        os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj));
1429      } else if (type->IsPrimitiveChar()) {
1430        os << StringPrintf("%u (0x%x)\n", field->GetChar(obj), field->GetChar(obj));
1431      } else if (type->IsPrimitiveShort()) {
1432        os << StringPrintf("%d (0x%x)\n", field->GetShort(obj), field->GetShort(obj));
1433      } else if (type->IsPrimitiveBoolean()) {
1434        os << StringPrintf("%s (0x%x)\n", field->GetBoolean(obj)? "true" : "false",
1435            field->GetBoolean(obj));
1436      } else if (type->IsPrimitiveByte()) {
1437        os << StringPrintf("%d (0x%x)\n", field->GetByte(obj), field->GetByte(obj));
1438      } else {
1439        LOG(FATAL) << "Unknown type: " << PrettyClass(type);
1440      }
1441    } else {
1442      // Get the value, don't compute the type unless it is non-null as we don't want
1443      // to cause class loading.
1444      mirror::Object* value = field->GetObj(obj);
1445      if (value == nullptr) {
1446        os << StringPrintf("null   %s\n", PrettyDescriptor(descriptor).c_str());
1447      } else {
1448        // Grab the field type without causing resolution.
1449        StackHandleScope<1> hs(Thread::Current());
1450        FieldHelper fh(hs.NewHandle(field));
1451        mirror::Class* field_type = fh.GetType(false);
1452        if (field_type != nullptr) {
1453          PrettyObjectValue(os, field_type, value);
1454        } else {
1455          os << StringPrintf("%p   %s\n", value, PrettyDescriptor(descriptor).c_str());
1456        }
1457      }
1458    }
1459  }
1460
1461  static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass)
1462      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1463    mirror::Class* super = klass->GetSuperClass();
1464    if (super != nullptr) {
1465      DumpFields(os, obj, super);
1466    }
1467    mirror::ObjectArray<mirror::ArtField>* fields = klass->GetIFields();
1468    if (fields != nullptr) {
1469      for (int32_t i = 0; i < fields->GetLength(); i++) {
1470        mirror::ArtField* field = fields->Get(i);
1471        PrintField(os, field, obj);
1472      }
1473    }
1474  }
1475
1476  bool InDumpSpace(const mirror::Object* object) {
1477    return image_space_.Contains(object);
1478  }
1479
1480  const void* GetQuickOatCodeBegin(mirror::ArtMethod* m)
1481      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1482    const void* quick_code = m->GetEntryPointFromQuickCompiledCode();
1483    if (quick_code == Runtime::Current()->GetClassLinker()->GetQuickResolutionTrampoline()) {
1484      quick_code = oat_dumper_->GetQuickOatCode(m);
1485    }
1486    if (oat_dumper_->GetInstructionSet() == kThumb2) {
1487      quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1);
1488    }
1489    return quick_code;
1490  }
1491
1492  uint32_t GetQuickOatCodeSize(mirror::ArtMethod* m)
1493      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1494    const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m));
1495    if (oat_code_begin == nullptr) {
1496      return 0;
1497    }
1498    return oat_code_begin[-1];
1499  }
1500
1501  const void* GetQuickOatCodeEnd(mirror::ArtMethod* m)
1502      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1503    const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m));
1504    if (oat_code_begin == nullptr) {
1505      return nullptr;
1506    }
1507    return oat_code_begin + GetQuickOatCodeSize(m);
1508  }
1509
1510  static void Callback(mirror::Object* obj, void* arg)
1511      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1512    DCHECK(obj != nullptr);
1513    DCHECK(arg != nullptr);
1514    ImageDumper* state = reinterpret_cast<ImageDumper*>(arg);
1515    if (!state->InDumpSpace(obj)) {
1516      return;
1517    }
1518
1519    size_t object_bytes = obj->SizeOf();
1520    size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes;
1521    state->stats_.object_bytes += object_bytes;
1522    state->stats_.alignment_bytes += alignment_bytes;
1523
1524    std::ostream& os = *state->os_;
1525    mirror::Class* obj_class = obj->GetClass();
1526    if (obj_class->IsArrayClass()) {
1527      os << StringPrintf("%p: %s length:%d\n", obj, PrettyDescriptor(obj_class).c_str(),
1528                         obj->AsArray()->GetLength());
1529    } else if (obj->IsClass()) {
1530      mirror::Class* klass = obj->AsClass();
1531      os << StringPrintf("%p: java.lang.Class \"%s\" (", obj, PrettyDescriptor(klass).c_str())
1532         << klass->GetStatus() << ")\n";
1533    } else if (obj->IsArtField()) {
1534      os << StringPrintf("%p: java.lang.reflect.ArtField %s\n", obj,
1535                         PrettyField(obj->AsArtField()).c_str());
1536    } else if (obj->IsArtMethod()) {
1537      os << StringPrintf("%p: java.lang.reflect.ArtMethod %s\n", obj,
1538                         PrettyMethod(obj->AsArtMethod()).c_str());
1539    } else if (obj_class->IsStringClass()) {
1540      os << StringPrintf("%p: java.lang.String %s\n", obj,
1541                         PrintableString(obj->AsString()->ToModifiedUtf8().c_str()).c_str());
1542    } else {
1543      os << StringPrintf("%p: %s\n", obj, PrettyDescriptor(obj_class).c_str());
1544    }
1545    Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1546    std::ostream indent_os(&indent_filter);
1547    DumpFields(indent_os, obj, obj_class);
1548    if (obj->IsObjectArray()) {
1549      mirror::ObjectArray<mirror::Object>* obj_array = obj->AsObjectArray<mirror::Object>();
1550      int32_t length = obj_array->GetLength();
1551      for (int32_t i = 0; i < length; i++) {
1552        mirror::Object* value = obj_array->Get(i);
1553        size_t run = 0;
1554        for (int32_t j = i + 1; j < length; j++) {
1555          if (value == obj_array->Get(j)) {
1556            run++;
1557          } else {
1558            break;
1559          }
1560        }
1561        if (run == 0) {
1562          indent_os << StringPrintf("%d: ", i);
1563        } else {
1564          indent_os << StringPrintf("%d to %zd: ", i, i + run);
1565          i = i + run;
1566        }
1567        mirror::Class* value_class =
1568            (value == nullptr) ? obj_class->GetComponentType() : value->GetClass();
1569        PrettyObjectValue(indent_os, value_class, value);
1570      }
1571    } else if (obj->IsClass()) {
1572      mirror::ObjectArray<mirror::ArtField>* sfields = obj->AsClass()->GetSFields();
1573      if (sfields != nullptr) {
1574        indent_os << "STATICS:\n";
1575        Indenter indent2_filter(indent_os.rdbuf(), kIndentChar, kIndentBy1Count);
1576        std::ostream indent2_os(&indent2_filter);
1577        for (int32_t i = 0; i < sfields->GetLength(); i++) {
1578          mirror::ArtField* field = sfields->Get(i);
1579          PrintField(indent2_os, field, field->GetDeclaringClass());
1580        }
1581      }
1582    } else if (obj->IsArtMethod()) {
1583      mirror::ArtMethod* method = obj->AsArtMethod();
1584      if (method->IsNative()) {
1585        // TODO: portable dumping.
1586        DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method);
1587        DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method);
1588        bool first_occurrence;
1589        const void* quick_oat_code = state->GetQuickOatCodeBegin(method);
1590        uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1591        state->ComputeOatSize(quick_oat_code, &first_occurrence);
1592        if (first_occurrence) {
1593          state->stats_.native_to_managed_code_bytes += quick_oat_code_size;
1594        }
1595        if (quick_oat_code != method->GetEntryPointFromQuickCompiledCode()) {
1596          indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code);
1597        }
1598      } else if (method->IsAbstract() || method->IsCalleeSaveMethod() ||
1599          method->IsResolutionMethod() || method->IsImtConflictMethod() ||
1600          method->IsClassInitializer()) {
1601        DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method);
1602        DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method);
1603      } else {
1604        const DexFile::CodeItem* code_item = method->GetCodeItem();
1605        size_t dex_instruction_bytes = code_item->insns_size_in_code_units_ * 2;
1606        state->stats_.dex_instruction_bytes += dex_instruction_bytes;
1607
1608        bool first_occurrence;
1609        size_t gc_map_bytes = state->ComputeOatSize(method->GetNativeGcMap(), &first_occurrence);
1610        if (first_occurrence) {
1611          state->stats_.gc_map_bytes += gc_map_bytes;
1612        }
1613
1614        size_t pc_mapping_table_bytes =
1615            state->ComputeOatSize(method->GetMappingTable(), &first_occurrence);
1616        if (first_occurrence) {
1617          state->stats_.pc_mapping_table_bytes += pc_mapping_table_bytes;
1618        }
1619
1620        size_t vmap_table_bytes =
1621            state->ComputeOatSize(method->GetVmapTable(), &first_occurrence);
1622        if (first_occurrence) {
1623          state->stats_.vmap_table_bytes += vmap_table_bytes;
1624        }
1625
1626        // TODO: portable dumping.
1627        const void* quick_oat_code_begin = state->GetQuickOatCodeBegin(method);
1628        const void* quick_oat_code_end = state->GetQuickOatCodeEnd(method);
1629        uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1630        state->ComputeOatSize(quick_oat_code_begin, &first_occurrence);
1631        if (first_occurrence) {
1632          state->stats_.managed_code_bytes += quick_oat_code_size;
1633          if (method->IsConstructor()) {
1634            if (method->IsStatic()) {
1635              state->stats_.class_initializer_code_bytes += quick_oat_code_size;
1636            } else if (dex_instruction_bytes > kLargeConstructorDexBytes) {
1637              state->stats_.large_initializer_code_bytes += quick_oat_code_size;
1638            }
1639          } else if (dex_instruction_bytes > kLargeMethodDexBytes) {
1640            state->stats_.large_method_code_bytes += quick_oat_code_size;
1641          }
1642        }
1643        state->stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size;
1644
1645        indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end);
1646        indent_os << StringPrintf("SIZE: Dex Instructions=%zd GC=%zd Mapping=%zd\n",
1647                                  dex_instruction_bytes, gc_map_bytes, pc_mapping_table_bytes);
1648
1649        size_t total_size = dex_instruction_bytes + gc_map_bytes + pc_mapping_table_bytes +
1650            vmap_table_bytes + quick_oat_code_size + object_bytes;
1651
1652        double expansion =
1653            static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes);
1654        state->stats_.ComputeOutliers(total_size, expansion, method);
1655      }
1656    }
1657    std::string temp;
1658    state->stats_.Update(obj_class->GetDescriptor(&temp), object_bytes);
1659  }
1660
1661  std::set<const void*> already_seen_;
1662  // Compute the size of the given data within the oat file and whether this is the first time
1663  // this data has been requested
1664  size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) {
1665    if (already_seen_.count(oat_data) == 0) {
1666      *first_occurrence = true;
1667      already_seen_.insert(oat_data);
1668    } else {
1669      *first_occurrence = false;
1670    }
1671    return oat_dumper_->ComputeSize(oat_data);
1672  }
1673
1674 public:
1675  struct Stats {
1676    size_t oat_file_bytes;
1677    size_t file_bytes;
1678
1679    size_t header_bytes;
1680    size_t object_bytes;
1681    size_t bitmap_bytes;
1682    size_t alignment_bytes;
1683
1684    size_t managed_code_bytes;
1685    size_t managed_code_bytes_ignoring_deduplication;
1686    size_t managed_to_native_code_bytes;
1687    size_t native_to_managed_code_bytes;
1688    size_t class_initializer_code_bytes;
1689    size_t large_initializer_code_bytes;
1690    size_t large_method_code_bytes;
1691
1692    size_t gc_map_bytes;
1693    size_t pc_mapping_table_bytes;
1694    size_t vmap_table_bytes;
1695
1696    size_t dex_instruction_bytes;
1697
1698    std::vector<mirror::ArtMethod*> method_outlier;
1699    std::vector<size_t> method_outlier_size;
1700    std::vector<double> method_outlier_expansion;
1701    std::vector<std::pair<std::string, size_t>> oat_dex_file_sizes;
1702
1703    explicit Stats()
1704        : oat_file_bytes(0),
1705          file_bytes(0),
1706          header_bytes(0),
1707          object_bytes(0),
1708          bitmap_bytes(0),
1709          alignment_bytes(0),
1710          managed_code_bytes(0),
1711          managed_code_bytes_ignoring_deduplication(0),
1712          managed_to_native_code_bytes(0),
1713          native_to_managed_code_bytes(0),
1714          class_initializer_code_bytes(0),
1715          large_initializer_code_bytes(0),
1716          large_method_code_bytes(0),
1717          gc_map_bytes(0),
1718          pc_mapping_table_bytes(0),
1719          vmap_table_bytes(0),
1720          dex_instruction_bytes(0) {}
1721
1722    struct SizeAndCount {
1723      SizeAndCount(size_t bytes, size_t count) : bytes(bytes), count(count) {}
1724      size_t bytes;
1725      size_t count;
1726    };
1727    typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable;
1728    SizeAndCountTable sizes_and_counts;
1729
1730    void Update(const char* descriptor, size_t object_bytes) {
1731      SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor);
1732      if (it != sizes_and_counts.end()) {
1733        it->second.bytes += object_bytes;
1734        it->second.count += 1;
1735      } else {
1736        sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes, 1));
1737      }
1738    }
1739
1740    double PercentOfOatBytes(size_t size) {
1741      return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100;
1742    }
1743
1744    double PercentOfFileBytes(size_t size) {
1745      return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100;
1746    }
1747
1748    double PercentOfObjectBytes(size_t size) {
1749      return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100;
1750    }
1751
1752    void ComputeOutliers(size_t total_size, double expansion, mirror::ArtMethod* method) {
1753      method_outlier_size.push_back(total_size);
1754      method_outlier_expansion.push_back(expansion);
1755      method_outlier.push_back(method);
1756    }
1757
1758    void DumpOutliers(std::ostream& os)
1759        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1760      size_t sum_of_sizes = 0;
1761      size_t sum_of_sizes_squared = 0;
1762      size_t sum_of_expansion = 0;
1763      size_t sum_of_expansion_squared = 0;
1764      size_t n = method_outlier_size.size();
1765      for (size_t i = 0; i < n; i++) {
1766        size_t cur_size = method_outlier_size[i];
1767        sum_of_sizes += cur_size;
1768        sum_of_sizes_squared += cur_size * cur_size;
1769        double cur_expansion = method_outlier_expansion[i];
1770        sum_of_expansion += cur_expansion;
1771        sum_of_expansion_squared += cur_expansion * cur_expansion;
1772      }
1773      size_t size_mean = sum_of_sizes / n;
1774      size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1);
1775      double expansion_mean = sum_of_expansion / n;
1776      double expansion_variance =
1777          (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1);
1778
1779      // Dump methods whose size is a certain number of standard deviations from the mean
1780      size_t dumped_values = 0;
1781      size_t skipped_values = 0;
1782      for (size_t i = 100; i > 0; i--) {  // i is the current number of standard deviations
1783        size_t cur_size_variance = i * i * size_variance;
1784        bool first = true;
1785        for (size_t j = 0; j < n; j++) {
1786          size_t cur_size = method_outlier_size[j];
1787          if (cur_size > size_mean) {
1788            size_t cur_var = cur_size - size_mean;
1789            cur_var = cur_var * cur_var;
1790            if (cur_var > cur_size_variance) {
1791              if (dumped_values > 20) {
1792                if (i == 1) {
1793                  skipped_values++;
1794                } else {
1795                  i = 2;  // jump to counting for 1 standard deviation
1796                  break;
1797                }
1798              } else {
1799                if (first) {
1800                  os << "\nBig methods (size > " << i << " standard deviations the norm):\n";
1801                  first = false;
1802                }
1803                os << PrettyMethod(method_outlier[j]) << " requires storage of "
1804                    << PrettySize(cur_size) << "\n";
1805                method_outlier_size[j] = 0;  // don't consider this method again
1806                dumped_values++;
1807              }
1808            }
1809          }
1810        }
1811      }
1812      if (skipped_values > 0) {
1813        os << "... skipped " << skipped_values
1814           << " methods with size > 1 standard deviation from the norm\n";
1815      }
1816      os << std::flush;
1817
1818      // Dump methods whose expansion is a certain number of standard deviations from the mean
1819      dumped_values = 0;
1820      skipped_values = 0;
1821      for (size_t i = 10; i > 0; i--) {  // i is the current number of standard deviations
1822        double cur_expansion_variance = i * i * expansion_variance;
1823        bool first = true;
1824        for (size_t j = 0; j < n; j++) {
1825          double cur_expansion = method_outlier_expansion[j];
1826          if (cur_expansion > expansion_mean) {
1827            size_t cur_var = cur_expansion - expansion_mean;
1828            cur_var = cur_var * cur_var;
1829            if (cur_var > cur_expansion_variance) {
1830              if (dumped_values > 20) {
1831                if (i == 1) {
1832                  skipped_values++;
1833                } else {
1834                  i = 2;  // jump to counting for 1 standard deviation
1835                  break;
1836                }
1837              } else {
1838                if (first) {
1839                  os << "\nLarge expansion methods (size > " << i
1840                      << " standard deviations the norm):\n";
1841                  first = false;
1842                }
1843                os << PrettyMethod(method_outlier[j]) << " expanded code by "
1844                   << cur_expansion << "\n";
1845                method_outlier_expansion[j] = 0.0;  // don't consider this method again
1846                dumped_values++;
1847              }
1848            }
1849          }
1850        }
1851      }
1852      if (skipped_values > 0) {
1853        os << "... skipped " << skipped_values
1854           << " methods with expansion > 1 standard deviation from the norm\n";
1855      }
1856      os << "\n" << std::flush;
1857    }
1858
1859    void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1860      {
1861        os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n"
1862           << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n";
1863        Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1864        std::ostream indent_os(&indent_filter);
1865        indent_os << StringPrintf("header_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1866                                  "object_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1867                                  "bitmap_bytes    =  %8zd (%2.0f%% of art file bytes)\n"
1868                                  "alignment_bytes =  %8zd (%2.0f%% of art file bytes)\n\n",
1869                                  header_bytes, PercentOfFileBytes(header_bytes),
1870                                  object_bytes, PercentOfFileBytes(object_bytes),
1871                                  bitmap_bytes, PercentOfFileBytes(bitmap_bytes),
1872                                  alignment_bytes, PercentOfFileBytes(alignment_bytes))
1873            << std::flush;
1874        CHECK_EQ(file_bytes, bitmap_bytes + header_bytes + object_bytes + alignment_bytes);
1875      }
1876
1877      os << "object_bytes breakdown:\n";
1878      size_t object_bytes_total = 0;
1879      for (const auto& sizes_and_count : sizes_and_counts) {
1880        const std::string& descriptor(sizes_and_count.first);
1881        double average = static_cast<double>(sizes_and_count.second.bytes) /
1882            static_cast<double>(sizes_and_count.second.count);
1883        double percent = PercentOfObjectBytes(sizes_and_count.second.bytes);
1884        os << StringPrintf("%32s %8zd bytes %6zd instances "
1885                           "(%4.0f bytes/instance) %2.0f%% of object_bytes\n",
1886                           descriptor.c_str(), sizes_and_count.second.bytes,
1887                           sizes_and_count.second.count, average, percent);
1888        object_bytes_total += sizes_and_count.second.bytes;
1889      }
1890      os << "\n" << std::flush;
1891      CHECK_EQ(object_bytes, object_bytes_total);
1892
1893      os << StringPrintf("oat_file_bytes               = %8zd\n"
1894                         "managed_code_bytes           = %8zd (%2.0f%% of oat file bytes)\n"
1895                         "managed_to_native_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1896                         "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n"
1897                         "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1898                         "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
1899                         "large_method_code_bytes      = %8zd (%2.0f%% of oat file bytes)\n\n",
1900                         oat_file_bytes,
1901                         managed_code_bytes,
1902                         PercentOfOatBytes(managed_code_bytes),
1903                         managed_to_native_code_bytes,
1904                         PercentOfOatBytes(managed_to_native_code_bytes),
1905                         native_to_managed_code_bytes,
1906                         PercentOfOatBytes(native_to_managed_code_bytes),
1907                         class_initializer_code_bytes,
1908                         PercentOfOatBytes(class_initializer_code_bytes),
1909                         large_initializer_code_bytes,
1910                         PercentOfOatBytes(large_initializer_code_bytes),
1911                         large_method_code_bytes,
1912                         PercentOfOatBytes(large_method_code_bytes))
1913            << "DexFile sizes:\n";
1914      for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) {
1915        os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n",
1916                           oat_dex_file_size.first.c_str(), oat_dex_file_size.second,
1917                           PercentOfOatBytes(oat_dex_file_size.second));
1918      }
1919
1920      os << "\n" << StringPrintf("gc_map_bytes           = %7zd (%2.0f%% of oat file bytes)\n"
1921                                 "pc_mapping_table_bytes = %7zd (%2.0f%% of oat file bytes)\n"
1922                                 "vmap_table_bytes       = %7zd (%2.0f%% of oat file bytes)\n\n",
1923                                 gc_map_bytes, PercentOfOatBytes(gc_map_bytes),
1924                                 pc_mapping_table_bytes, PercentOfOatBytes(pc_mapping_table_bytes),
1925                                 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes))
1926         << std::flush;
1927
1928      os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes)
1929         << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n",
1930                         static_cast<double>(managed_code_bytes) /
1931                             static_cast<double>(dex_instruction_bytes),
1932                         static_cast<double>(managed_code_bytes_ignoring_deduplication) /
1933                             static_cast<double>(dex_instruction_bytes))
1934         << std::flush;
1935
1936      DumpOutliers(os);
1937    }
1938  } stats_;
1939
1940 private:
1941  enum {
1942    // Number of bytes for a constructor to be considered large. Based on the 1000 basic block
1943    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
1944    kLargeConstructorDexBytes = 4000,
1945    // Number of bytes for a method to be considered large. Based on the 4000 basic block
1946    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
1947    kLargeMethodDexBytes = 16000
1948  };
1949  std::ostream* os_;
1950  gc::space::ImageSpace& image_space_;
1951  const ImageHeader& image_header_;
1952  std::unique_ptr<OatDumper> oat_dumper_;
1953  std::unique_ptr<OatDumperOptions> oat_dumper_options_;
1954
1955  DISALLOW_COPY_AND_ASSIGN(ImageDumper);
1956};
1957
1958static int oatdump(int argc, char** argv) {
1959  InitLogging(argv);
1960
1961  // Skip over argv[0].
1962  argv++;
1963  argc--;
1964
1965  if (argc == 0) {
1966    fprintf(stderr, "No arguments specified\n");
1967    usage();
1968  }
1969
1970  const char* oat_filename = nullptr;
1971  const char* image_location = nullptr;
1972  const char* boot_image_location = nullptr;
1973  InstructionSet instruction_set = kRuntimeISA;
1974  std::string elf_filename_prefix;
1975  std::ostream* os = &std::cout;
1976  std::unique_ptr<std::ofstream> out;
1977  std::string output_name;
1978  bool dump_raw_mapping_table = false;
1979  bool dump_raw_gc_map = false;
1980  bool dump_vmap = true;
1981  bool disassemble_code = true;
1982  bool symbolize = false;
1983
1984  for (int i = 0; i < argc; i++) {
1985    const StringPiece option(argv[i]);
1986    if (option.starts_with("--oat-file=")) {
1987      oat_filename = option.substr(strlen("--oat-file=")).data();
1988    } else if (option.starts_with("--image=")) {
1989      image_location = option.substr(strlen("--image=")).data();
1990    } else if (option.starts_with("--boot-image=")) {
1991      boot_image_location = option.substr(strlen("--boot-image=")).data();
1992    } else if (option.starts_with("--instruction-set=")) {
1993      StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data();
1994      if (instruction_set_str == "arm") {
1995        instruction_set = kThumb2;
1996      } else if (instruction_set_str == "arm64") {
1997        instruction_set = kArm64;
1998      } else if (instruction_set_str == "mips") {
1999        instruction_set = kMips;
2000      } else if (instruction_set_str == "x86") {
2001        instruction_set = kX86;
2002      } else if (instruction_set_str == "x86_64") {
2003        instruction_set = kX86_64;
2004      }
2005    } else if (option =="--dump:raw_mapping_table") {
2006      dump_raw_mapping_table = true;
2007    } else if (option == "--dump:raw_gc_map") {
2008      dump_raw_gc_map = true;
2009    } else if (option == "--no-dump:vmap") {
2010      dump_vmap = false;
2011    } else if (option == "--no-disassemble") {
2012      disassemble_code = false;
2013    } else if (option.starts_with("--output=")) {
2014      output_name = option.substr(strlen("--output=")).ToString();
2015      const char* filename = output_name.c_str();
2016      out.reset(new std::ofstream(filename));
2017      if (!out->good()) {
2018        fprintf(stderr, "Failed to open output filename %s\n", filename);
2019        usage();
2020      }
2021      os = out.get();
2022    } else if (option.starts_with("--symbolize=")) {
2023      oat_filename = option.substr(strlen("--symbolize=")).data();
2024      symbolize = true;
2025    } else {
2026      fprintf(stderr, "Unknown argument %s\n", option.data());
2027      usage();
2028    }
2029  }
2030
2031  if (image_location == nullptr && oat_filename == nullptr) {
2032    fprintf(stderr, "Either --image or --oat must be specified\n");
2033    return EXIT_FAILURE;
2034  }
2035
2036  if (image_location != nullptr && oat_filename != nullptr) {
2037    fprintf(stderr, "Either --image or --oat must be specified but not both\n");
2038    return EXIT_FAILURE;
2039  }
2040
2041  // If we are only doing the oat file, disable absolute_addresses. Keep them for image dumping.
2042  bool absolute_addresses = (oat_filename == nullptr);
2043  std::unique_ptr<OatDumperOptions> oat_dumper_options(new OatDumperOptions(dump_raw_mapping_table,
2044                                                                            dump_raw_gc_map,
2045                                                                            dump_vmap,
2046                                                                            disassemble_code,
2047                                                                            absolute_addresses));
2048  if (oat_filename != nullptr) {
2049    std::string error_msg;
2050    OatFile* oat_file =
2051        OatFile::Open(oat_filename, oat_filename, nullptr, false, &error_msg);
2052    if (oat_file == nullptr) {
2053      fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
2054      return EXIT_FAILURE;
2055    }
2056    if (symbolize) {
2057      OatSymbolizer oat_symbolizer(oat_file, output_name);
2058      if (!oat_symbolizer.Init()) {
2059        fprintf(stderr, "Failed to initialize symbolizer\n");
2060        return EXIT_FAILURE;
2061      }
2062      if (!oat_symbolizer.Symbolize()) {
2063        fprintf(stderr, "Failed to symbolize\n");
2064        return EXIT_FAILURE;
2065      }
2066    } else {
2067      OatDumper oat_dumper(*oat_file, oat_dumper_options.release());
2068      bool success = oat_dumper.Dump(*os);
2069      return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2070    }
2071    return EXIT_SUCCESS;
2072  }
2073
2074  RuntimeOptions options;
2075  std::string image_option;
2076  std::string oat_option;
2077  std::string boot_image_option;
2078  std::string boot_oat_option;
2079
2080  // We are more like a compiler than a run-time. We don't want to execute code.
2081  NoopCompilerCallbacks callbacks;
2082  options.push_back(std::make_pair("compilercallbacks", &callbacks));
2083
2084  if (boot_image_location != nullptr) {
2085    boot_image_option += "-Ximage:";
2086    boot_image_option += boot_image_location;
2087    options.push_back(std::make_pair(boot_image_option.c_str(), nullptr));
2088  }
2089  if (image_location != nullptr) {
2090    image_option += "-Ximage:";
2091    image_option += image_location;
2092    options.push_back(std::make_pair(image_option.c_str(), nullptr));
2093  }
2094  options.push_back(
2095      std::make_pair("imageinstructionset",
2096                     reinterpret_cast<const void*>(GetInstructionSetString(instruction_set))));
2097
2098  if (!Runtime::Create(options, false)) {
2099    fprintf(stderr, "Failed to create runtime\n");
2100    return EXIT_FAILURE;
2101  }
2102  std::unique_ptr<Runtime> runtime(Runtime::Current());
2103  // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
2104  // give it away now and then switch to a more manageable ScopedObjectAccess.
2105  Thread::Current()->TransitionFromRunnableToSuspended(kNative);
2106  ScopedObjectAccess soa(Thread::Current());
2107  gc::Heap* heap = Runtime::Current()->GetHeap();
2108  gc::space::ImageSpace* image_space = heap->GetImageSpace();
2109  CHECK(image_space != nullptr);
2110  const ImageHeader& image_header = image_space->GetImageHeader();
2111  if (!image_header.IsValid()) {
2112    fprintf(stderr, "Invalid image header %s\n", image_location);
2113    return EXIT_FAILURE;
2114  }
2115  ImageDumper image_dumper(os, *image_space, image_header, oat_dumper_options.release());
2116  bool success = image_dumper.Dump();
2117  return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2118}
2119
2120}  // namespace art
2121
2122int main(int argc, char** argv) {
2123  return art::oatdump(argc, argv);
2124}
2125