oatdump.cc revision eb7b7399dbdb5e471b8ae00a567bf4f19edd3907
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 <map>
23#include <set>
24#include <string>
25#include <unordered_map>
26#include <vector>
27
28#include "arch/instruction_set_features.h"
29#include "art_field-inl.h"
30#include "art_method-inl.h"
31#include "base/unix_file/fd_file.h"
32#include "class_linker.h"
33#include "class_linker-inl.h"
34#include "dex_file-inl.h"
35#include "dex_instruction.h"
36#include "disassembler.h"
37#include "elf_builder.h"
38#include "gc_map.h"
39#include "gc/space/image_space.h"
40#include "gc/space/large_object_space.h"
41#include "gc/space/space-inl.h"
42#include "image.h"
43#include "indenter.h"
44#include "mapping_table.h"
45#include "mirror/array-inl.h"
46#include "mirror/class-inl.h"
47#include "mirror/object-inl.h"
48#include "mirror/object_array-inl.h"
49#include "oat.h"
50#include "oat_file-inl.h"
51#include "os.h"
52#include "output_stream.h"
53#include "safe_map.h"
54#include "scoped_thread_state_change.h"
55#include "ScopedLocalRef.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#include "well_known_classes.h"
61
62#include <sys/stat.h>
63#include "cmdline.h"
64
65namespace art {
66
67const char* image_methods_descriptions_[] = {
68  "kResolutionMethod",
69  "kImtConflictMethod",
70  "kImtUnimplementedMethod",
71  "kCalleeSaveMethod",
72  "kRefsOnlySaveMethod",
73  "kRefsAndArgsSaveMethod",
74};
75
76const char* image_roots_descriptions_[] = {
77  "kDexCaches",
78  "kClassRoots",
79};
80
81class OatSymbolizer FINAL {
82 public:
83  class RodataWriter FINAL : public CodeOutput {
84   public:
85    explicit RodataWriter(const OatFile* oat_file) : oat_file_(oat_file) {}
86
87    bool Write(OutputStream* out) OVERRIDE {
88      const size_t rodata_size = oat_file_->GetOatHeader().GetExecutableOffset();
89      return out->WriteFully(oat_file_->Begin(), rodata_size);
90    }
91
92   private:
93    const OatFile* oat_file_;
94  };
95
96  class TextWriter FINAL : public CodeOutput {
97   public:
98    explicit TextWriter(const OatFile* oat_file) : oat_file_(oat_file) {}
99
100    bool Write(OutputStream* out) OVERRIDE {
101      const size_t rodata_size = oat_file_->GetOatHeader().GetExecutableOffset();
102      const uint8_t* text_begin = oat_file_->Begin() + rodata_size;
103      return out->WriteFully(text_begin, oat_file_->End() - text_begin);
104    }
105
106   private:
107    const OatFile* oat_file_;
108  };
109
110  explicit OatSymbolizer(const OatFile* oat_file, const std::string& output_name) :
111      oat_file_(oat_file), builder_(nullptr),
112      output_name_(output_name.empty() ? "symbolized.oat" : output_name) {
113  }
114
115  typedef void (OatSymbolizer::*Callback)(const DexFile::ClassDef&,
116                                          uint32_t,
117                                          const OatFile::OatMethod&,
118                                          const DexFile&,
119                                          uint32_t,
120                                          const DexFile::CodeItem*,
121                                          uint32_t);
122
123  bool Symbolize() {
124    Elf32_Word rodata_size = oat_file_->GetOatHeader().GetExecutableOffset();
125    uint32_t size = static_cast<uint32_t>(oat_file_->End() - oat_file_->Begin());
126    uint32_t text_size = size - rodata_size;
127    uint32_t bss_size = oat_file_->BssSize();
128    RodataWriter rodata_writer(oat_file_);
129    TextWriter text_writer(oat_file_);
130    builder_.reset(new ElfBuilder<ElfTypes32>(
131        oat_file_->GetOatHeader().GetInstructionSet(),
132        rodata_size, &rodata_writer,
133        text_size, &text_writer,
134        bss_size));
135
136    Walk(&art::OatSymbolizer::RegisterForDedup);
137
138    NormalizeState();
139
140    Walk(&art::OatSymbolizer::AddSymbol);
141
142    File* elf_output = OS::CreateEmptyFile(output_name_.c_str());
143    bool result = builder_->Write(elf_output);
144
145    // Ignore I/O errors.
146    UNUSED(elf_output->FlushClose());
147
148    return result;
149  }
150
151  void Walk(Callback callback) {
152    std::vector<const OatFile::OatDexFile*> oat_dex_files = oat_file_->GetOatDexFiles();
153    for (size_t i = 0; i < oat_dex_files.size(); i++) {
154      const OatFile::OatDexFile* oat_dex_file = oat_dex_files[i];
155      CHECK(oat_dex_file != nullptr);
156      WalkOatDexFile(oat_dex_file, callback);
157    }
158  }
159
160  void WalkOatDexFile(const OatFile::OatDexFile* oat_dex_file, Callback callback) {
161    std::string error_msg;
162    std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
163    if (dex_file.get() == nullptr) {
164      return;
165    }
166    for (size_t class_def_index = 0;
167        class_def_index < dex_file->NumClassDefs();
168        class_def_index++) {
169      const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
170      const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
171      OatClassType type = oat_class.GetType();
172      switch (type) {
173        case kOatClassAllCompiled:
174        case kOatClassSomeCompiled:
175          WalkOatClass(oat_class, *dex_file.get(), class_def, callback);
176          break;
177
178        case kOatClassNoneCompiled:
179        case kOatClassMax:
180          // Ignore.
181          break;
182      }
183    }
184  }
185
186  void WalkOatClass(const OatFile::OatClass& oat_class, const DexFile& dex_file,
187                    const DexFile::ClassDef& class_def, Callback callback) {
188    const uint8_t* class_data = dex_file.GetClassData(class_def);
189    if (class_data == nullptr) {  // empty class such as a marker interface?
190      return;
191    }
192    // Note: even if this is an interface or a native class, we still have to walk it, as there
193    //       might be a static initializer.
194    ClassDataItemIterator it(dex_file, class_data);
195    SkipAllFields(&it);
196    uint32_t class_method_idx = 0;
197    while (it.HasNextDirectMethod()) {
198      const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx);
199      WalkOatMethod(class_def, class_method_idx, oat_method, dex_file, it.GetMemberIndex(),
200                    it.GetMethodCodeItem(), it.GetMethodAccessFlags(), callback);
201      class_method_idx++;
202      it.Next();
203    }
204    while (it.HasNextVirtualMethod()) {
205      const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx);
206      WalkOatMethod(class_def, class_method_idx, oat_method, dex_file, it.GetMemberIndex(),
207                    it.GetMethodCodeItem(), it.GetMethodAccessFlags(), callback);
208      class_method_idx++;
209      it.Next();
210    }
211    DCHECK(!it.HasNext());
212  }
213
214  void WalkOatMethod(const DexFile::ClassDef& class_def, uint32_t class_method_index,
215                     const OatFile::OatMethod& oat_method, const DexFile& dex_file,
216                     uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
217                     uint32_t method_access_flags, Callback callback) {
218    if ((method_access_flags & kAccAbstract) != 0) {
219      // Abstract method, no code.
220      return;
221    }
222    if (oat_method.GetCodeOffset() == 0) {
223      // No code.
224      return;
225    }
226
227    (this->*callback)(class_def, class_method_index, oat_method, dex_file, dex_method_idx, code_item,
228                      method_access_flags);
229  }
230
231  void RegisterForDedup(const DexFile::ClassDef& class_def ATTRIBUTE_UNUSED,
232                        uint32_t class_method_index ATTRIBUTE_UNUSED,
233                        const OatFile::OatMethod& oat_method,
234                        const DexFile& dex_file ATTRIBUTE_UNUSED,
235                        uint32_t dex_method_idx ATTRIBUTE_UNUSED,
236                        const DexFile::CodeItem* code_item ATTRIBUTE_UNUSED,
237                        uint32_t method_access_flags ATTRIBUTE_UNUSED) {
238    state_[oat_method.GetCodeOffset()]++;
239  }
240
241  void NormalizeState() {
242    for (auto& x : state_) {
243      if (x.second == 1) {
244        state_[x.first] = 0;
245      }
246    }
247  }
248
249  enum class DedupState {  // private
250    kNotDeduplicated,
251    kDeduplicatedFirst,
252    kDeduplicatedOther
253  };
254  DedupState IsDuplicated(uint32_t offset) {
255    if (state_[offset] == 0) {
256      return DedupState::kNotDeduplicated;
257    }
258    if (state_[offset] == 1) {
259      return DedupState::kDeduplicatedOther;
260    }
261    state_[offset] = 1;
262    return DedupState::kDeduplicatedFirst;
263  }
264
265  void AddSymbol(const DexFile::ClassDef& class_def ATTRIBUTE_UNUSED,
266                 uint32_t class_method_index ATTRIBUTE_UNUSED,
267                 const OatFile::OatMethod& oat_method,
268                 const DexFile& dex_file,
269                 uint32_t dex_method_idx,
270                 const DexFile::CodeItem* code_item ATTRIBUTE_UNUSED,
271                 uint32_t method_access_flags ATTRIBUTE_UNUSED) {
272    DedupState dedup = IsDuplicated(oat_method.GetCodeOffset());
273    if (dedup != DedupState::kDeduplicatedOther) {
274      std::string pretty_name = PrettyMethod(dex_method_idx, dex_file, true);
275
276      if (dedup == DedupState::kDeduplicatedFirst) {
277        pretty_name = "[Dedup]" + pretty_name;
278      }
279
280      auto* symtab = builder_->GetSymtab();
281
282      symtab->AddSymbol(pretty_name, builder_->GetText(),
283          oat_method.GetCodeOffset() - oat_file_->GetOatHeader().GetExecutableOffset(),
284          true, oat_method.GetQuickCodeSize(), STB_GLOBAL, STT_FUNC);
285    }
286  }
287
288 private:
289  static void SkipAllFields(ClassDataItemIterator* it) {
290    while (it->HasNextStaticField()) {
291      it->Next();
292    }
293    while (it->HasNextInstanceField()) {
294      it->Next();
295    }
296  }
297
298  const OatFile* oat_file_;
299  std::unique_ptr<ElfBuilder<ElfTypes32> > builder_;
300  std::unordered_map<uint32_t, uint32_t> state_;
301  const std::string output_name_;
302};
303
304class OatDumperOptions {
305 public:
306  OatDumperOptions(bool dump_raw_mapping_table,
307                   bool dump_raw_gc_map,
308                   bool dump_vmap,
309                   bool dump_code_info_stack_maps,
310                   bool disassemble_code,
311                   bool absolute_addresses,
312                   const char* class_filter,
313                   const char* method_filter,
314                   bool list_classes,
315                   bool list_methods,
316                   const char* export_dex_location,
317                   uint32_t addr2instr)
318    : dump_raw_mapping_table_(dump_raw_mapping_table),
319      dump_raw_gc_map_(dump_raw_gc_map),
320      dump_vmap_(dump_vmap),
321      dump_code_info_stack_maps_(dump_code_info_stack_maps),
322      disassemble_code_(disassemble_code),
323      absolute_addresses_(absolute_addresses),
324      class_filter_(class_filter),
325      method_filter_(method_filter),
326      list_classes_(list_classes),
327      list_methods_(list_methods),
328      export_dex_location_(export_dex_location),
329      addr2instr_(addr2instr),
330      class_loader_(nullptr) {}
331
332  const bool dump_raw_mapping_table_;
333  const bool dump_raw_gc_map_;
334  const bool dump_vmap_;
335  const bool dump_code_info_stack_maps_;
336  const bool disassemble_code_;
337  const bool absolute_addresses_;
338  const char* const class_filter_;
339  const char* const method_filter_;
340  const bool list_classes_;
341  const bool list_methods_;
342  const char* const export_dex_location_;
343  uint32_t addr2instr_;
344  Handle<mirror::ClassLoader>* class_loader_;
345};
346
347class OatDumper {
348 public:
349  explicit OatDumper(const OatFile& oat_file, const OatDumperOptions& options)
350    : oat_file_(oat_file),
351      oat_dex_files_(oat_file.GetOatDexFiles()),
352      options_(options),
353      resolved_addr2instr_(0),
354      instruction_set_(oat_file_.GetOatHeader().GetInstructionSet()),
355      disassembler_(Disassembler::Create(instruction_set_,
356                                         new DisassemblerOptions(options_.absolute_addresses_,
357                                                                 oat_file.Begin(),
358                                                                 true /* can_read_literals_ */))) {
359    CHECK(options_.class_loader_ != nullptr);
360    CHECK(options_.class_filter_ != nullptr);
361    CHECK(options_.method_filter_ != nullptr);
362    AddAllOffsets();
363  }
364
365  ~OatDumper() {
366    delete disassembler_;
367  }
368
369  InstructionSet GetInstructionSet() {
370    return instruction_set_;
371  }
372
373  bool Dump(std::ostream& os) {
374    bool success = true;
375    const OatHeader& oat_header = oat_file_.GetOatHeader();
376
377    os << "MAGIC:\n";
378    os << oat_header.GetMagic() << "\n\n";
379
380    os << "CHECKSUM:\n";
381    os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum());
382
383    os << "INSTRUCTION SET:\n";
384    os << oat_header.GetInstructionSet() << "\n\n";
385
386    {
387      std::unique_ptr<const InstructionSetFeatures> features(
388          InstructionSetFeatures::FromBitmap(oat_header.GetInstructionSet(),
389                                             oat_header.GetInstructionSetFeaturesBitmap()));
390      os << "INSTRUCTION SET FEATURES:\n";
391      os << features->GetFeatureString() << "\n\n";
392    }
393
394    os << "DEX FILE COUNT:\n";
395    os << oat_header.GetDexFileCount() << "\n\n";
396
397#define DUMP_OAT_HEADER_OFFSET(label, offset) \
398    os << label " OFFSET:\n"; \
399    os << StringPrintf("0x%08x", oat_header.offset()); \
400    if (oat_header.offset() != 0 && options_.absolute_addresses_) { \
401      os << StringPrintf(" (%p)", oat_file_.Begin() + oat_header.offset()); \
402    } \
403    os << StringPrintf("\n\n");
404
405    DUMP_OAT_HEADER_OFFSET("EXECUTABLE", GetExecutableOffset);
406    DUMP_OAT_HEADER_OFFSET("INTERPRETER TO INTERPRETER BRIDGE",
407                           GetInterpreterToInterpreterBridgeOffset);
408    DUMP_OAT_HEADER_OFFSET("INTERPRETER TO COMPILED CODE BRIDGE",
409                           GetInterpreterToCompiledCodeBridgeOffset);
410    DUMP_OAT_HEADER_OFFSET("JNI DLSYM LOOKUP",
411                           GetJniDlsymLookupOffset);
412    DUMP_OAT_HEADER_OFFSET("QUICK GENERIC JNI TRAMPOLINE",
413                           GetQuickGenericJniTrampolineOffset);
414    DUMP_OAT_HEADER_OFFSET("QUICK IMT CONFLICT TRAMPOLINE",
415                           GetQuickImtConflictTrampolineOffset);
416    DUMP_OAT_HEADER_OFFSET("QUICK RESOLUTION TRAMPOLINE",
417                           GetQuickResolutionTrampolineOffset);
418    DUMP_OAT_HEADER_OFFSET("QUICK TO INTERPRETER BRIDGE",
419                           GetQuickToInterpreterBridgeOffset);
420#undef DUMP_OAT_HEADER_OFFSET
421
422    os << "IMAGE PATCH DELTA:\n";
423    os << StringPrintf("%d (0x%08x)\n\n",
424                       oat_header.GetImagePatchDelta(),
425                       oat_header.GetImagePatchDelta());
426
427    os << "IMAGE FILE LOCATION OAT CHECKSUM:\n";
428    os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatChecksum());
429
430    os << "IMAGE FILE LOCATION OAT BEGIN:\n";
431    os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatDataBegin());
432
433    // Print the key-value store.
434    {
435      os << "KEY VALUE STORE:\n";
436      size_t index = 0;
437      const char* key;
438      const char* value;
439      while (oat_header.GetStoreKeyValuePairByIndex(index, &key, &value)) {
440        os << key << " = " << value << "\n";
441        index++;
442      }
443      os << "\n";
444    }
445
446    if (options_.absolute_addresses_) {
447      os << "BEGIN:\n";
448      os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n";
449
450      os << "END:\n";
451      os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n";
452    }
453
454    os << "SIZE:\n";
455    os << oat_file_.Size() << "\n\n";
456
457    os << std::flush;
458
459    // If set, adjust relative address to be searched
460    if (options_.addr2instr_ != 0) {
461      resolved_addr2instr_ = options_.addr2instr_ + oat_header.GetExecutableOffset();
462      os << "SEARCH ADDRESS (executable offset + input):\n";
463      os << StringPrintf("0x%08x\n\n", resolved_addr2instr_);
464    }
465
466    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
467      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
468      CHECK(oat_dex_file != nullptr);
469
470      // If file export selected skip file analysis
471      if (options_.export_dex_location_) {
472        if (!ExportDexFile(os, *oat_dex_file)) {
473          success = false;
474        }
475      } else {
476        if (!DumpOatDexFile(os, *oat_dex_file)) {
477          success = false;
478        }
479      }
480    }
481    os << std::flush;
482    return success;
483  }
484
485  size_t ComputeSize(const void* oat_data) {
486    if (reinterpret_cast<const uint8_t*>(oat_data) < oat_file_.Begin() ||
487        reinterpret_cast<const uint8_t*>(oat_data) > oat_file_.End()) {
488      return 0;  // Address not in oat file
489    }
490    uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) -
491                             reinterpret_cast<uintptr_t>(oat_file_.Begin());
492    auto it = offsets_.upper_bound(begin_offset);
493    CHECK(it != offsets_.end());
494    uintptr_t end_offset = *it;
495    return end_offset - begin_offset;
496  }
497
498  InstructionSet GetOatInstructionSet() {
499    return oat_file_.GetOatHeader().GetInstructionSet();
500  }
501
502  const void* GetQuickOatCode(ArtMethod* m) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
503    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
504      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
505      CHECK(oat_dex_file != nullptr);
506      std::string error_msg;
507      std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
508      if (dex_file.get() == nullptr) {
509        LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
510            << "': " << error_msg;
511      } else {
512        const char* descriptor = m->GetDeclaringClassDescriptor();
513        const DexFile::ClassDef* class_def =
514            dex_file->FindClassDef(descriptor, ComputeModifiedUtf8Hash(descriptor));
515        if (class_def != nullptr) {
516          uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def);
517          const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
518          size_t method_index = m->GetMethodIndex();
519          return oat_class.GetOatMethod(method_index).GetQuickCode();
520        }
521      }
522    }
523    return nullptr;
524  }
525
526 private:
527  void AddAllOffsets() {
528    // We don't know the length of the code for each method, but we need to know where to stop
529    // when disassembling. What we do know is that a region of code will be followed by some other
530    // region, so if we keep a sorted sequence of the start of each region, we can infer the length
531    // of a piece of code by using upper_bound to find the start of the next region.
532    for (size_t i = 0; i < oat_dex_files_.size(); i++) {
533      const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
534      CHECK(oat_dex_file != nullptr);
535      std::string error_msg;
536      std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg));
537      if (dex_file.get() == nullptr) {
538        LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
539            << "': " << error_msg;
540        continue;
541      }
542      offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader()));
543      for (size_t class_def_index = 0;
544           class_def_index < dex_file->NumClassDefs();
545           class_def_index++) {
546        const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
547        const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
548        const uint8_t* class_data = dex_file->GetClassData(class_def);
549        if (class_data != nullptr) {
550          ClassDataItemIterator it(*dex_file, class_data);
551          SkipAllFields(it);
552          uint32_t class_method_index = 0;
553          while (it.HasNextDirectMethod()) {
554            AddOffsets(oat_class.GetOatMethod(class_method_index++));
555            it.Next();
556          }
557          while (it.HasNextVirtualMethod()) {
558            AddOffsets(oat_class.GetOatMethod(class_method_index++));
559            it.Next();
560          }
561        }
562      }
563    }
564
565    // If the last thing in the file is code for a method, there won't be an offset for the "next"
566    // thing. Instead of having a special case in the upper_bound code, let's just add an entry
567    // for the end of the file.
568    offsets_.insert(oat_file_.Size());
569  }
570
571  static uint32_t AlignCodeOffset(uint32_t maybe_thumb_offset) {
572    return maybe_thumb_offset & ~0x1;  // TODO: Make this Thumb2 specific.
573  }
574
575  void AddOffsets(const OatFile::OatMethod& oat_method) {
576    uint32_t code_offset = oat_method.GetCodeOffset();
577    if (oat_file_.GetOatHeader().GetInstructionSet() == kThumb2) {
578      code_offset &= ~0x1;
579    }
580    offsets_.insert(code_offset);
581    offsets_.insert(oat_method.GetMappingTableOffset());
582    offsets_.insert(oat_method.GetVmapTableOffset());
583    offsets_.insert(oat_method.GetGcMapOffset());
584  }
585
586  bool DumpOatDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) {
587    bool success = true;
588    bool stop_analysis = false;
589    os << "OatDexFile:\n";
590    os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str());
591    os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum());
592
593    // Create the verifier early.
594
595    std::string error_msg;
596    std::unique_ptr<const DexFile> dex_file(oat_dex_file.OpenDexFile(&error_msg));
597    if (dex_file.get() == nullptr) {
598      os << "NOT FOUND: " << error_msg << "\n\n";
599      os << std::flush;
600      return false;
601    }
602    for (size_t class_def_index = 0;
603         class_def_index < dex_file->NumClassDefs();
604         class_def_index++) {
605      const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
606      const char* descriptor = dex_file->GetClassDescriptor(class_def);
607
608      // TODO: Support regex
609      if (DescriptorToDot(descriptor).find(options_.class_filter_) == std::string::npos) {
610        continue;
611      }
612
613      uint32_t oat_class_offset = oat_dex_file.GetOatClassOffset(class_def_index);
614      const OatFile::OatClass oat_class = oat_dex_file.GetOatClass(class_def_index);
615      os << StringPrintf("%zd: %s (offset=0x%08x) (type_idx=%d)",
616                         class_def_index, descriptor, oat_class_offset, class_def.class_idx_)
617         << " (" << oat_class.GetStatus() << ")"
618         << " (" << oat_class.GetType() << ")\n";
619      // TODO: include bitmap here if type is kOatClassSomeCompiled?
620      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
621      std::ostream indented_os(&indent_filter);
622      if (options_.list_classes_) continue;
623      if (!DumpOatClass(indented_os, oat_class, *(dex_file.get()), class_def, &stop_analysis)) {
624        success = false;
625      }
626      if (stop_analysis) {
627        os << std::flush;
628        return success;
629      }
630    }
631
632    os << std::flush;
633    return success;
634  }
635
636  bool ExportDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) {
637    std::string error_msg;
638    std::string dex_file_location = oat_dex_file.GetDexFileLocation();
639
640    std::unique_ptr<const DexFile> dex_file(oat_dex_file.OpenDexFile(&error_msg));
641    if (dex_file == nullptr) {
642      os << "Failed to open dex file '" << dex_file_location << "': " << error_msg;
643      return false;
644    }
645    size_t fsize = oat_dex_file.FileSize();
646
647    // Some quick checks just in case
648    if (fsize == 0 || fsize < sizeof(DexFile::Header)) {
649      os << "Invalid dex file\n";
650      return false;
651    }
652
653    // Verify output directory exists
654    if (!OS::DirectoryExists(options_.export_dex_location_)) {
655      // TODO: Extend OS::DirectoryExists if symlink support is required
656      os << options_.export_dex_location_ << " output directory not found or symlink\n";
657      return false;
658    }
659
660    // Beautify path names
661    if (dex_file_location.size() > PATH_MAX || dex_file_location.size() <= 0) {
662      return false;
663    }
664
665    std::string dex_orig_name;
666    size_t dex_orig_pos = dex_file_location.rfind('/');
667    if (dex_orig_pos == std::string::npos)
668      dex_orig_name = dex_file_location;
669    else
670      dex_orig_name = dex_file_location.substr(dex_orig_pos + 1);
671
672    // A more elegant approach to efficiently name user installed apps is welcome
673    if (dex_orig_name.size() == 8 && !dex_orig_name.compare("base.apk")) {
674      dex_file_location.erase(dex_orig_pos, strlen("base.apk") + 1);
675      size_t apk_orig_pos = dex_file_location.rfind('/');
676      if (apk_orig_pos != std::string::npos) {
677        dex_orig_name = dex_file_location.substr(++apk_orig_pos);
678      }
679    }
680
681    std::string out_dex_path(options_.export_dex_location_);
682    if (out_dex_path.back() != '/') {
683      out_dex_path.append("/");
684    }
685    out_dex_path.append(dex_orig_name);
686    out_dex_path.append("_export.dex");
687    if (out_dex_path.length() > PATH_MAX) {
688      return false;
689    }
690
691    std::unique_ptr<File> file(OS::CreateEmptyFile(out_dex_path.c_str()));
692    if (file.get() == nullptr) {
693      os << "Failed to open output dex file " << out_dex_path;
694      return false;
695    }
696
697    if (!file->WriteFully(dex_file->Begin(), fsize)) {
698      os << "Failed to write dex file";
699      file->Erase();
700      return false;
701    }
702
703    if (file->FlushCloseOrErase() != 0) {
704      os << "Flush and close failed";
705      return false;
706    }
707
708    os << StringPrintf("Dex file exported at %s (%zd bytes)\n", out_dex_path.c_str(), fsize);
709    os << std::flush;
710
711    return true;
712  }
713
714  static void SkipAllFields(ClassDataItemIterator& it) {
715    while (it.HasNextStaticField()) {
716      it.Next();
717    }
718    while (it.HasNextInstanceField()) {
719      it.Next();
720    }
721  }
722
723  bool DumpOatClass(std::ostream& os, const OatFile::OatClass& oat_class, const DexFile& dex_file,
724                    const DexFile::ClassDef& class_def, bool* stop_analysis) {
725    bool success = true;
726    bool addr_found = false;
727    const uint8_t* class_data = dex_file.GetClassData(class_def);
728    if (class_data == nullptr) {  // empty class such as a marker interface?
729      os << std::flush;
730      return success;
731    }
732    ClassDataItemIterator it(dex_file, class_data);
733    SkipAllFields(it);
734    uint32_t class_method_index = 0;
735    while (it.HasNextDirectMethod()) {
736      if (!DumpOatMethod(os, class_def, class_method_index, oat_class, dex_file,
737                         it.GetMemberIndex(), it.GetMethodCodeItem(),
738                         it.GetRawMemberAccessFlags(), &addr_found)) {
739        success = false;
740      }
741      if (addr_found) {
742        *stop_analysis = true;
743        return success;
744      }
745      class_method_index++;
746      it.Next();
747    }
748    while (it.HasNextVirtualMethod()) {
749      if (!DumpOatMethod(os, class_def, class_method_index, oat_class, dex_file,
750                         it.GetMemberIndex(), it.GetMethodCodeItem(),
751                         it.GetRawMemberAccessFlags(), &addr_found)) {
752        success = false;
753      }
754      if (addr_found) {
755        *stop_analysis = true;
756        return success;
757      }
758      class_method_index++;
759      it.Next();
760    }
761    DCHECK(!it.HasNext());
762    os << std::flush;
763    return success;
764  }
765
766  static constexpr uint32_t kPrologueBytes = 16;
767
768  // When this was picked, the largest arm method was 55,256 bytes and arm64 was 50,412 bytes.
769  static constexpr uint32_t kMaxCodeSize = 100 * 1000;
770
771  bool DumpOatMethod(std::ostream& os, const DexFile::ClassDef& class_def,
772                     uint32_t class_method_index,
773                     const OatFile::OatClass& oat_class, const DexFile& dex_file,
774                     uint32_t dex_method_idx, const DexFile::CodeItem* code_item,
775                     uint32_t method_access_flags, bool* addr_found) {
776    bool success = true;
777
778    // TODO: Support regex
779    std::string method_name = dex_file.GetMethodName(dex_file.GetMethodId(dex_method_idx));
780    if (method_name.find(options_.method_filter_) == std::string::npos) {
781      return success;
782    }
783
784    std::string pretty_method = PrettyMethod(dex_method_idx, dex_file, true);
785    os << StringPrintf("%d: %s (dex_method_idx=%d)\n",
786                       class_method_index, pretty_method.c_str(),
787                       dex_method_idx);
788    if (options_.list_methods_) return success;
789
790    Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
791    std::unique_ptr<std::ostream> indent1_os(new std::ostream(&indent1_filter));
792    Indenter indent2_filter(indent1_os->rdbuf(), kIndentChar, kIndentBy1Count);
793    std::unique_ptr<std::ostream> indent2_os(new std::ostream(&indent2_filter));
794
795    uint32_t oat_method_offsets_offset = oat_class.GetOatMethodOffsetsOffset(class_method_index);
796    const OatMethodOffsets* oat_method_offsets = oat_class.GetOatMethodOffsets(class_method_index);
797    const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_index);
798    uint32_t code_offset = oat_method.GetCodeOffset();
799    uint32_t code_size = oat_method.GetQuickCodeSize();
800    if (resolved_addr2instr_ != 0) {
801      if (resolved_addr2instr_ > code_offset + code_size) {
802        return success;
803      } else {
804        *addr_found = true;  // stop analyzing file at next iteration
805      }
806    }
807
808    {
809      *indent1_os << "DEX CODE:\n";
810      DumpDexCode(*indent2_os, dex_file, code_item);
811    }
812
813    std::unique_ptr<verifier::MethodVerifier> verifier;
814    if (Runtime::Current() != nullptr) {
815      *indent1_os << "VERIFIER TYPE ANALYSIS:\n";
816      verifier.reset(DumpVerifier(*indent2_os, dex_method_idx, &dex_file, class_def, code_item,
817                                  method_access_flags));
818    }
819    {
820      *indent1_os << "OatMethodOffsets ";
821      if (options_.absolute_addresses_) {
822        *indent1_os << StringPrintf("%p ", oat_method_offsets);
823      }
824      *indent1_os << StringPrintf("(offset=0x%08x)\n", oat_method_offsets_offset);
825      if (oat_method_offsets_offset > oat_file_.Size()) {
826        *indent1_os << StringPrintf(
827            "WARNING: oat method offsets offset 0x%08x is past end of file 0x%08zx.\n",
828            oat_method_offsets_offset, oat_file_.Size());
829        // If we can't read OatMethodOffsets, the rest of the data is dangerous to read.
830        os << std::flush;
831        return false;
832      }
833
834      *indent2_os << StringPrintf("code_offset: 0x%08x ", code_offset);
835      uint32_t aligned_code_begin = AlignCodeOffset(oat_method.GetCodeOffset());
836      if (aligned_code_begin > oat_file_.Size()) {
837        *indent2_os << StringPrintf("WARNING: "
838                                    "code offset 0x%08x is past end of file 0x%08zx.\n",
839                                    aligned_code_begin, oat_file_.Size());
840        success = false;
841      }
842      *indent2_os << "\n";
843
844      *indent2_os << "gc_map: ";
845      if (options_.absolute_addresses_) {
846        *indent2_os << StringPrintf("%p ", oat_method.GetGcMap());
847      }
848      uint32_t gc_map_offset = oat_method.GetGcMapOffset();
849      *indent2_os << StringPrintf("(offset=0x%08x)\n", gc_map_offset);
850      if (gc_map_offset > oat_file_.Size()) {
851        *indent2_os << StringPrintf("WARNING: "
852                                    "gc map table offset 0x%08x is past end of file 0x%08zx.\n",
853                                    gc_map_offset, oat_file_.Size());
854        success = false;
855      } else if (options_.dump_raw_gc_map_) {
856        Indenter indent3_filter(indent2_os->rdbuf(), kIndentChar, kIndentBy1Count);
857        std::ostream indent3_os(&indent3_filter);
858        DumpGcMap(indent3_os, oat_method, code_item);
859      }
860    }
861    {
862      *indent1_os << "OatQuickMethodHeader ";
863      uint32_t method_header_offset = oat_method.GetOatQuickMethodHeaderOffset();
864      const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader();
865
866      if (options_.absolute_addresses_) {
867        *indent1_os << StringPrintf("%p ", method_header);
868      }
869      *indent1_os << StringPrintf("(offset=0x%08x)\n", method_header_offset);
870      if (method_header_offset > oat_file_.Size()) {
871        *indent1_os << StringPrintf(
872            "WARNING: oat quick method header offset 0x%08x is past end of file 0x%08zx.\n",
873            method_header_offset, oat_file_.Size());
874        // If we can't read the OatQuickMethodHeader, the rest of the data is dangerous to read.
875        os << std::flush;
876        return false;
877      }
878
879      *indent2_os << "mapping_table: ";
880      if (options_.absolute_addresses_) {
881        *indent2_os << StringPrintf("%p ", oat_method.GetMappingTable());
882      }
883      uint32_t mapping_table_offset = oat_method.GetMappingTableOffset();
884      *indent2_os << StringPrintf("(offset=0x%08x)\n", oat_method.GetMappingTableOffset());
885      if (mapping_table_offset > oat_file_.Size()) {
886        *indent2_os << StringPrintf("WARNING: "
887                                    "mapping table offset 0x%08x is past end of file 0x%08zx. "
888                                    "mapping table offset was loaded from offset 0x%08x.\n",
889                                    mapping_table_offset, oat_file_.Size(),
890                                    oat_method.GetMappingTableOffsetOffset());
891        success = false;
892      } else if (options_.dump_raw_mapping_table_) {
893        Indenter indent3_filter(indent2_os->rdbuf(), kIndentChar, kIndentBy1Count);
894        std::ostream indent3_os(&indent3_filter);
895        DumpMappingTable(indent3_os, oat_method);
896      }
897
898      *indent2_os << "vmap_table: ";
899      if (options_.absolute_addresses_) {
900        *indent2_os << StringPrintf("%p ", oat_method.GetVmapTable());
901      }
902      uint32_t vmap_table_offset = oat_method.GetVmapTableOffset();
903      *indent2_os << StringPrintf("(offset=0x%08x)\n", vmap_table_offset);
904      if (vmap_table_offset > oat_file_.Size()) {
905        *indent2_os << StringPrintf("WARNING: "
906                                    "vmap table offset 0x%08x is past end of file 0x%08zx. "
907                                    "vmap table offset was loaded from offset 0x%08x.\n",
908                                    vmap_table_offset, oat_file_.Size(),
909                                    oat_method.GetVmapTableOffsetOffset());
910        success = false;
911      } else if (options_.dump_vmap_) {
912        DumpVmapData(*indent2_os, oat_method, code_item);
913      }
914    }
915    {
916      *indent1_os << "QuickMethodFrameInfo\n";
917
918      *indent2_os << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes());
919      *indent2_os << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask());
920      DumpSpillMask(*indent2_os, oat_method.GetCoreSpillMask(), false);
921      *indent2_os << "\n";
922      *indent2_os << StringPrintf("fp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask());
923      DumpSpillMask(*indent2_os, oat_method.GetFpSpillMask(), true);
924      *indent2_os << "\n";
925    }
926    {
927        // Based on spill masks from QuickMethodFrameInfo so placed
928        // after it is dumped, but useful for understanding quick
929        // code, so dumped here.
930        DumpVregLocations(*indent2_os, oat_method, code_item);
931    }
932    {
933      *indent1_os << "CODE: ";
934      uint32_t code_size_offset = oat_method.GetQuickCodeSizeOffset();
935      if (code_size_offset > oat_file_.Size()) {
936        *indent2_os << StringPrintf("WARNING: "
937                                    "code size offset 0x%08x is past end of file 0x%08zx.",
938                                    code_size_offset, oat_file_.Size());
939        success = false;
940      } else {
941        const void* code = oat_method.GetQuickCode();
942        uint32_t aligned_code_begin = AlignCodeOffset(code_offset);
943        uint64_t aligned_code_end = aligned_code_begin + code_size;
944
945        if (options_.absolute_addresses_) {
946          *indent1_os << StringPrintf("%p ", code);
947        }
948        *indent1_os << StringPrintf("(code_offset=0x%08x size_offset=0x%08x size=%u)%s\n",
949                                    code_offset,
950                                    code_size_offset,
951                                    code_size,
952                                    code != nullptr ? "..." : "");
953
954        if (aligned_code_begin > oat_file_.Size()) {
955          *indent2_os << StringPrintf("WARNING: "
956                                      "start of code at 0x%08x is past end of file 0x%08zx.",
957                                      aligned_code_begin, oat_file_.Size());
958          success = false;
959        } else if (aligned_code_end > oat_file_.Size()) {
960          *indent2_os << StringPrintf("WARNING: "
961                                      "end of code at 0x%08" PRIx64 " is past end of file 0x%08zx. "
962                                      "code size is 0x%08x loaded from offset 0x%08x.\n",
963                                      aligned_code_end, oat_file_.Size(),
964                                      code_size, code_size_offset);
965          success = false;
966          if (options_.disassemble_code_) {
967            if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
968              DumpCode(*indent2_os, verifier.get(), oat_method, code_item, true, kPrologueBytes);
969            }
970          }
971        } else if (code_size > kMaxCodeSize) {
972          *indent2_os << StringPrintf("WARNING: "
973                                      "code size %d is bigger than max expected threshold of %d. "
974                                      "code size is 0x%08x loaded from offset 0x%08x.\n",
975                                      code_size, kMaxCodeSize,
976                                      code_size, code_size_offset);
977          success = false;
978          if (options_.disassemble_code_) {
979            if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
980              DumpCode(*indent2_os, verifier.get(), oat_method, code_item, true, kPrologueBytes);
981            }
982          }
983        } else if (options_.disassemble_code_) {
984          DumpCode(*indent2_os, verifier.get(), oat_method, code_item, !success, 0);
985        }
986      }
987    }
988    os << std::flush;
989    return success;
990  }
991
992  void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) {
993    if (spill_mask == 0) {
994      return;
995    }
996    os << "(";
997    for (size_t i = 0; i < 32; i++) {
998      if ((spill_mask & (1 << i)) != 0) {
999        if (is_float) {
1000          os << "fr" << i;
1001        } else {
1002          os << "r" << i;
1003        }
1004        spill_mask ^= 1 << i;  // clear bit
1005        if (spill_mask != 0) {
1006          os << ", ";
1007        } else {
1008          break;
1009        }
1010      }
1011    }
1012    os << ")";
1013  }
1014
1015  // Display data stored at the the vmap offset of an oat method.
1016  void DumpVmapData(std::ostream& os,
1017                    const OatFile::OatMethod& oat_method,
1018                    const DexFile::CodeItem* code_item) {
1019    if (IsMethodGeneratedByOptimizingCompiler(oat_method, code_item)) {
1020      // The optimizing compiler outputs its CodeInfo data in the vmap table.
1021      const void* raw_code_info = oat_method.GetVmapTable();
1022      if (raw_code_info != nullptr) {
1023        CodeInfo code_info(raw_code_info);
1024        DCHECK(code_item != nullptr);
1025        DumpCodeInfo(os, code_info, oat_method, *code_item);
1026      }
1027    } else {
1028      // Otherwise, display the vmap table.
1029      const uint8_t* raw_table = oat_method.GetVmapTable();
1030      if (raw_table != nullptr) {
1031        VmapTable vmap_table(raw_table);
1032        DumpVmapTable(os, oat_method, vmap_table);
1033      }
1034    }
1035  }
1036
1037  // Display a CodeInfo object emitted by the optimizing compiler.
1038  void DumpCodeInfo(std::ostream& os,
1039                    const CodeInfo& code_info,
1040                    const OatFile::OatMethod& oat_method,
1041                    const DexFile::CodeItem& code_item) {
1042    code_info.Dump(os,
1043                   oat_method.GetCodeOffset(),
1044                   code_item.registers_size_,
1045                   options_.dump_code_info_stack_maps_);
1046  }
1047
1048  // Display a vmap table.
1049  void DumpVmapTable(std::ostream& os,
1050                     const OatFile::OatMethod& oat_method,
1051                     const VmapTable& vmap_table) {
1052    bool first = true;
1053    bool processing_fp = false;
1054    uint32_t spill_mask = oat_method.GetCoreSpillMask();
1055    for (size_t i = 0; i < vmap_table.Size(); i++) {
1056      uint16_t dex_reg = vmap_table[i];
1057      uint32_t cpu_reg = vmap_table.ComputeRegister(spill_mask, i,
1058                                                    processing_fp ? kFloatVReg : kIntVReg);
1059      os << (first ? "v" : ", v")  << dex_reg;
1060      if (!processing_fp) {
1061        os << "/r" << cpu_reg;
1062      } else {
1063        os << "/fr" << cpu_reg;
1064      }
1065      first = false;
1066      if (!processing_fp && dex_reg == 0xFFFF) {
1067        processing_fp = true;
1068        spill_mask = oat_method.GetFpSpillMask();
1069      }
1070    }
1071    os << "\n";
1072  }
1073
1074  void DumpVregLocations(std::ostream& os, const OatFile::OatMethod& oat_method,
1075                         const DexFile::CodeItem* code_item) {
1076    if (code_item != nullptr) {
1077      size_t num_locals_ins = code_item->registers_size_;
1078      size_t num_ins = code_item->ins_size_;
1079      size_t num_locals = num_locals_ins - num_ins;
1080      size_t num_outs = code_item->outs_size_;
1081
1082      os << "vr_stack_locations:";
1083      for (size_t reg = 0; reg <= num_locals_ins; reg++) {
1084        // For readability, delimit the different kinds of VRs.
1085        if (reg == num_locals_ins) {
1086          os << "\n\tmethod*:";
1087        } else if (reg == num_locals && num_ins > 0) {
1088          os << "\n\tins:";
1089        } else if (reg == 0 && num_locals > 0) {
1090          os << "\n\tlocals:";
1091        }
1092
1093        uint32_t offset = StackVisitor::GetVRegOffsetFromQuickCode(
1094            code_item,
1095            oat_method.GetCoreSpillMask(),
1096            oat_method.GetFpSpillMask(),
1097            oat_method.GetFrameSizeInBytes(),
1098            reg,
1099            GetInstructionSet());
1100        os << " v" << reg << "[sp + #" << offset << "]";
1101      }
1102
1103      for (size_t out_reg = 0; out_reg < num_outs; out_reg++) {
1104        if (out_reg == 0) {
1105          os << "\n\touts:";
1106        }
1107
1108        uint32_t offset = StackVisitor::GetOutVROffset(out_reg, GetInstructionSet());
1109        os << " v" << out_reg << "[sp + #" << offset << "]";
1110      }
1111
1112      os << "\n";
1113    }
1114  }
1115
1116  void DescribeVReg(std::ostream& os, const OatFile::OatMethod& oat_method,
1117                    const DexFile::CodeItem* code_item, size_t reg, VRegKind kind) {
1118    const uint8_t* raw_table = oat_method.GetVmapTable();
1119    if (raw_table != nullptr) {
1120      const VmapTable vmap_table(raw_table);
1121      uint32_t vmap_offset;
1122      if (vmap_table.IsInContext(reg, kind, &vmap_offset)) {
1123        bool is_float = (kind == kFloatVReg) || (kind == kDoubleLoVReg) || (kind == kDoubleHiVReg);
1124        uint32_t spill_mask = is_float ? oat_method.GetFpSpillMask()
1125                                       : oat_method.GetCoreSpillMask();
1126        os << (is_float ? "fr" : "r") << vmap_table.ComputeRegister(spill_mask, vmap_offset, kind);
1127      } else {
1128        uint32_t offset = StackVisitor::GetVRegOffsetFromQuickCode(
1129            code_item,
1130            oat_method.GetCoreSpillMask(),
1131            oat_method.GetFpSpillMask(),
1132            oat_method.GetFrameSizeInBytes(),
1133            reg,
1134            GetInstructionSet());
1135        os << "[sp + #" << offset << "]";
1136      }
1137    }
1138  }
1139
1140  void DumpGcMapRegisters(std::ostream& os, const OatFile::OatMethod& oat_method,
1141                          const DexFile::CodeItem* code_item,
1142                          size_t num_regs, const uint8_t* reg_bitmap) {
1143    bool first = true;
1144    for (size_t reg = 0; reg < num_regs; reg++) {
1145      if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
1146        if (first) {
1147          os << "  v" << reg << " (";
1148          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
1149          os << ")";
1150          first = false;
1151        } else {
1152          os << ", v" << reg << " (";
1153          DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
1154          os << ")";
1155        }
1156      }
1157    }
1158    if (first) {
1159      os << "No registers in GC map\n";
1160    } else {
1161      os << "\n";
1162    }
1163  }
1164  void DumpGcMap(std::ostream& os, const OatFile::OatMethod& oat_method,
1165                 const DexFile::CodeItem* code_item) {
1166    const uint8_t* gc_map_raw = oat_method.GetGcMap();
1167    if (gc_map_raw == nullptr) {
1168      return;  // No GC map.
1169    }
1170    const void* quick_code = oat_method.GetQuickCode();
1171    NativePcOffsetToReferenceMap map(gc_map_raw);
1172    for (size_t entry = 0; entry < map.NumEntries(); entry++) {
1173      const uint8_t* native_pc = reinterpret_cast<const uint8_t*>(quick_code) +
1174          map.GetNativePcOffset(entry);
1175      os << StringPrintf("%p", native_pc);
1176      DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry));
1177    }
1178  }
1179
1180  void DumpMappingTable(std::ostream& os, const OatFile::OatMethod& oat_method) {
1181    const void* quick_code = oat_method.GetQuickCode();
1182    if (quick_code == nullptr) {
1183      return;
1184    }
1185    MappingTable table(oat_method.GetMappingTable());
1186    if (table.TotalSize() != 0) {
1187      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1188      std::ostream indent_os(&indent_filter);
1189      if (table.PcToDexSize() != 0) {
1190        typedef MappingTable::PcToDexIterator It;
1191        os << "suspend point mappings {\n";
1192        for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
1193          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
1194        }
1195        os << "}\n";
1196      }
1197      if (table.DexToPcSize() != 0) {
1198        typedef MappingTable::DexToPcIterator It;
1199        os << "catch entry mappings {\n";
1200        for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
1201          indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc());
1202        }
1203        os << "}\n";
1204      }
1205    }
1206  }
1207
1208  uint32_t DumpInformationAtOffset(std::ostream& os,
1209                                   const OatFile::OatMethod& oat_method,
1210                                   const DexFile::CodeItem* code_item,
1211                                   size_t offset,
1212                                   bool suspend_point_mapping) {
1213    if (IsMethodGeneratedByOptimizingCompiler(oat_method, code_item)) {
1214      if (suspend_point_mapping) {
1215        DumpDexRegisterMapAtOffset(os, oat_method, code_item, offset);
1216      }
1217      // The return value is not used in the case of a method compiled
1218      // with the optimizing compiler.
1219      return DexFile::kDexNoIndex;
1220    } else {
1221      return DumpMappingAtOffset(os, oat_method, offset, suspend_point_mapping);
1222    }
1223  }
1224
1225  uint32_t DumpMappingAtOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
1226                               size_t offset, bool suspend_point_mapping) {
1227    MappingTable table(oat_method.GetMappingTable());
1228    if (suspend_point_mapping && table.PcToDexSize() > 0) {
1229      typedef MappingTable::PcToDexIterator It;
1230      for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) {
1231        if (offset == cur.NativePcOffset()) {
1232          os << StringPrintf("suspend point dex PC: 0x%04x\n", cur.DexPc());
1233          return cur.DexPc();
1234        }
1235      }
1236    } else if (!suspend_point_mapping && table.DexToPcSize() > 0) {
1237      typedef MappingTable::DexToPcIterator It;
1238      for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) {
1239        if (offset == cur.NativePcOffset()) {
1240          os << StringPrintf("catch entry dex PC: 0x%04x\n", cur.DexPc());
1241          return cur.DexPc();
1242        }
1243      }
1244    }
1245    return DexFile::kDexNoIndex;
1246  }
1247
1248  void DumpGcMapAtNativePcOffset(std::ostream& os, const OatFile::OatMethod& oat_method,
1249                                 const DexFile::CodeItem* code_item, size_t native_pc_offset) {
1250    const uint8_t* gc_map_raw = oat_method.GetGcMap();
1251    if (gc_map_raw != nullptr) {
1252      NativePcOffsetToReferenceMap map(gc_map_raw);
1253      if (map.HasEntry(native_pc_offset)) {
1254        size_t num_regs = map.RegWidth() * 8;
1255        const uint8_t* reg_bitmap = map.FindBitMap(native_pc_offset);
1256        bool first = true;
1257        for (size_t reg = 0; reg < num_regs; reg++) {
1258          if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) {
1259            if (first) {
1260              os << "GC map objects:  v" << reg << " (";
1261              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
1262              os << ")";
1263              first = false;
1264            } else {
1265              os << ", v" << reg << " (";
1266              DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg);
1267              os << ")";
1268            }
1269          }
1270        }
1271        if (!first) {
1272          os << "\n";
1273        }
1274      }
1275    }
1276  }
1277
1278  void DumpVRegsAtDexPc(std::ostream& os, verifier::MethodVerifier* verifier,
1279                        const OatFile::OatMethod& oat_method,
1280                        const DexFile::CodeItem* code_item, uint32_t dex_pc) {
1281    DCHECK(verifier != nullptr);
1282    std::vector<int32_t> kinds = verifier->DescribeVRegs(dex_pc);
1283    bool first = true;
1284    for (size_t reg = 0; reg < code_item->registers_size_; reg++) {
1285      VRegKind kind = static_cast<VRegKind>(kinds.at(reg * 2));
1286      if (kind != kUndefined) {
1287        if (first) {
1288          os << "VRegs:  v";
1289          first = false;
1290        } else {
1291          os << ", v";
1292        }
1293        os << reg << " (";
1294        switch (kind) {
1295          case kImpreciseConstant:
1296            os << "Imprecise Constant: " << kinds.at((reg * 2) + 1) << ", ";
1297            DescribeVReg(os, oat_method, code_item, reg, kind);
1298            break;
1299          case kConstant:
1300            os << "Constant: " << kinds.at((reg * 2) + 1);
1301            break;
1302          default:
1303            DescribeVReg(os, oat_method, code_item, reg, kind);
1304            break;
1305        }
1306        os << ")";
1307      }
1308    }
1309    if (!first) {
1310      os << "\n";
1311    }
1312  }
1313
1314
1315  void DumpDexCode(std::ostream& os, const DexFile& dex_file, const DexFile::CodeItem* code_item) {
1316    if (code_item != nullptr) {
1317      size_t i = 0;
1318      while (i < code_item->insns_size_in_code_units_) {
1319        const Instruction* instruction = Instruction::At(&code_item->insns_[i]);
1320        os << StringPrintf("0x%04zx: ", i) << instruction->DumpHexLE(5)
1321           << StringPrintf("\t| %s\n", instruction->DumpString(&dex_file).c_str());
1322        i += instruction->SizeInCodeUnits();
1323      }
1324    }
1325  }
1326
1327  // Has `oat_method` -- corresponding to the Dex `code_item` -- been compiled by
1328  // the optimizing compiler?
1329  static bool IsMethodGeneratedByOptimizingCompiler(const OatFile::OatMethod& oat_method,
1330                                                    const DexFile::CodeItem* code_item) {
1331    // If the native GC map is null and the Dex `code_item` is not
1332    // null, then this method has been compiled with the optimizing
1333    // compiler.
1334    return oat_method.GetGcMap() == nullptr && code_item != nullptr;
1335  }
1336
1337  void DumpDexRegisterMapAtOffset(std::ostream& os,
1338                                  const OatFile::OatMethod& oat_method,
1339                                  const DexFile::CodeItem* code_item,
1340                                  size_t offset) {
1341    // This method is only relevant for oat methods compiled with the
1342    // optimizing compiler.
1343    DCHECK(IsMethodGeneratedByOptimizingCompiler(oat_method, code_item));
1344
1345    // The optimizing compiler outputs its CodeInfo data in the vmap table.
1346    const void* raw_code_info = oat_method.GetVmapTable();
1347    if (raw_code_info != nullptr) {
1348      CodeInfo code_info(raw_code_info);
1349      StackMapEncoding encoding = code_info.ExtractEncoding();
1350      StackMap stack_map = code_info.GetStackMapForNativePcOffset(offset, encoding);
1351      if (stack_map.IsValid()) {
1352        stack_map.Dump(
1353            os, code_info, encoding, oat_method.GetCodeOffset(), code_item->registers_size_);
1354      }
1355    }
1356  }
1357
1358  verifier::MethodVerifier* DumpVerifier(std::ostream& os, uint32_t dex_method_idx,
1359                                         const DexFile* dex_file,
1360                                         const DexFile::ClassDef& class_def,
1361                                         const DexFile::CodeItem* code_item,
1362                                         uint32_t method_access_flags) {
1363    if ((method_access_flags & kAccNative) == 0) {
1364      ScopedObjectAccess soa(Thread::Current());
1365      StackHandleScope<1> hs(soa.Self());
1366      Handle<mirror::DexCache> dex_cache(
1367          hs.NewHandle(Runtime::Current()->GetClassLinker()->FindDexCache(*dex_file)));
1368      DCHECK(options_.class_loader_ != nullptr);
1369      return verifier::MethodVerifier::VerifyMethodAndDump(
1370          soa.Self(), os, dex_method_idx, dex_file, dex_cache, *options_.class_loader_, &class_def,
1371          code_item, nullptr, method_access_flags);
1372    }
1373
1374    return nullptr;
1375  }
1376
1377  void DumpCode(std::ostream& os, verifier::MethodVerifier* verifier,
1378                const OatFile::OatMethod& oat_method, const DexFile::CodeItem* code_item,
1379                bool bad_input, size_t code_size) {
1380    const void* quick_code = oat_method.GetQuickCode();
1381
1382    if (code_size == 0) {
1383      code_size = oat_method.GetQuickCodeSize();
1384    }
1385    if (code_size == 0 || quick_code == nullptr) {
1386      os << "NO CODE!\n";
1387      return;
1388    } else {
1389      const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
1390      size_t offset = 0;
1391      while (offset < code_size) {
1392        if (!bad_input) {
1393          DumpInformationAtOffset(os, oat_method, code_item, offset, false);
1394        }
1395        offset += disassembler_->Dump(os, quick_native_pc + offset);
1396        if (!bad_input) {
1397          uint32_t dex_pc = DumpInformationAtOffset(os, oat_method, code_item, offset, true);
1398          if (dex_pc != DexFile::kDexNoIndex) {
1399            DumpGcMapAtNativePcOffset(os, oat_method, code_item, offset);
1400            if (verifier != nullptr) {
1401              DumpVRegsAtDexPc(os, verifier, oat_method, code_item, dex_pc);
1402            }
1403          }
1404        }
1405      }
1406    }
1407  }
1408
1409  const OatFile& oat_file_;
1410  const std::vector<const OatFile::OatDexFile*> oat_dex_files_;
1411  const OatDumperOptions& options_;
1412  uint32_t resolved_addr2instr_;
1413  InstructionSet instruction_set_;
1414  std::set<uintptr_t> offsets_;
1415  Disassembler* disassembler_;
1416};
1417
1418class ImageDumper {
1419 public:
1420  explicit ImageDumper(std::ostream* os, gc::space::ImageSpace& image_space,
1421                       const ImageHeader& image_header, OatDumperOptions* oat_dumper_options)
1422      : os_(os),
1423        image_space_(image_space),
1424        image_header_(image_header),
1425        oat_dumper_options_(oat_dumper_options) {}
1426
1427  bool Dump() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1428    std::ostream& os = *os_;
1429    os << "MAGIC: " << image_header_.GetMagic() << "\n\n";
1430
1431    os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n";
1432
1433    os << "IMAGE SIZE: " << image_header_.GetImageSize() << "\n\n";
1434
1435    for (size_t i = 0; i < ImageHeader::kSectionCount; ++i) {
1436      auto section = static_cast<ImageHeader::ImageSections>(i);
1437      os << "IMAGE SECTION " << section << ": " << image_header_.GetImageSection(section) << "\n\n";
1438    }
1439
1440    os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum());
1441
1442    os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n";
1443
1444    os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n";
1445
1446    os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n";
1447
1448    os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n";
1449
1450    os << "PATCH DELTA:" << image_header_.GetPatchDelta() << "\n\n";
1451
1452    os << "COMPILE PIC: " << (image_header_.CompilePic() ? "yes" : "no") << "\n\n";
1453
1454    {
1455      os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n";
1456      Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1457      std::ostream indent1_os(&indent1_filter);
1458      static_assert(arraysize(image_roots_descriptions_) ==
1459          static_cast<size_t>(ImageHeader::kImageRootsMax), "sizes must match");
1460      for (int i = 0; i < ImageHeader::kImageRootsMax; i++) {
1461        ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i);
1462        const char* image_root_description = image_roots_descriptions_[i];
1463        mirror::Object* image_root_object = image_header_.GetImageRoot(image_root);
1464        indent1_os << StringPrintf("%s: %p\n", image_root_description, image_root_object);
1465        if (image_root_object->IsObjectArray()) {
1466          Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count);
1467          std::ostream indent2_os(&indent2_filter);
1468          mirror::ObjectArray<mirror::Object>* image_root_object_array
1469              = image_root_object->AsObjectArray<mirror::Object>();
1470          for (int j = 0; j < image_root_object_array->GetLength(); j++) {
1471            mirror::Object* value = image_root_object_array->Get(j);
1472            size_t run = 0;
1473            for (int32_t k = j + 1; k < image_root_object_array->GetLength(); k++) {
1474              if (value == image_root_object_array->Get(k)) {
1475                run++;
1476              } else {
1477                break;
1478              }
1479            }
1480            if (run == 0) {
1481              indent2_os << StringPrintf("%d: ", j);
1482            } else {
1483              indent2_os << StringPrintf("%d to %zd: ", j, j + run);
1484              j = j + run;
1485            }
1486            if (value != nullptr) {
1487              PrettyObjectValue(indent2_os, value->GetClass(), value);
1488            } else {
1489              indent2_os << j << ": null\n";
1490            }
1491          }
1492        }
1493      }
1494
1495      os << "METHOD ROOTS\n";
1496      static_assert(arraysize(image_methods_descriptions_) ==
1497          static_cast<size_t>(ImageHeader::kImageMethodsCount), "sizes must match");
1498      for (int i = 0; i < ImageHeader::kImageMethodsCount; i++) {
1499        auto image_root = static_cast<ImageHeader::ImageMethod>(i);
1500        const char* description = image_methods_descriptions_[i];
1501        auto* image_method = image_header_.GetImageMethod(image_root);
1502        indent1_os << StringPrintf("%s: %p\n", description, image_method);
1503      }
1504    }
1505    os << "\n";
1506
1507    ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
1508    std::string image_filename = image_space_.GetImageFilename();
1509    std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename);
1510    os << "OAT LOCATION: " << oat_location;
1511    os << "\n";
1512    std::string error_msg;
1513    const OatFile* oat_file = class_linker->FindOpenedOatFileFromOatLocation(oat_location);
1514    if (oat_file == nullptr) {
1515      oat_file = OatFile::Open(oat_location, oat_location,
1516                               nullptr, nullptr, false, nullptr,
1517                               &error_msg);
1518      if (oat_file == nullptr) {
1519        os << "NOT FOUND: " << error_msg << "\n";
1520        return false;
1521      }
1522    }
1523    os << "\n";
1524
1525    stats_.oat_file_bytes = oat_file->Size();
1526
1527    oat_dumper_.reset(new OatDumper(*oat_file, *oat_dumper_options_));
1528
1529    for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
1530      CHECK(oat_dex_file != nullptr);
1531      stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(),
1532                                                         oat_dex_file->FileSize()));
1533    }
1534
1535    os << "OBJECTS:\n" << std::flush;
1536
1537    // Loop through all the image spaces and dump their objects.
1538    gc::Heap* heap = Runtime::Current()->GetHeap();
1539    const std::vector<gc::space::ContinuousSpace*>& spaces = heap->GetContinuousSpaces();
1540    Thread* self = Thread::Current();
1541    {
1542      {
1543        WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1544        heap->FlushAllocStack();
1545      }
1546      // Since FlushAllocStack() above resets the (active) allocation
1547      // stack. Need to revoke the thread-local allocation stacks that
1548      // point into it.
1549      {
1550        self->TransitionFromRunnableToSuspended(kNative);
1551        ThreadList* thread_list = Runtime::Current()->GetThreadList();
1552        thread_list->SuspendAll(__FUNCTION__);
1553        heap->RevokeAllThreadLocalAllocationStacks(self);
1554        thread_list->ResumeAll();
1555        self->TransitionFromSuspendedToRunnable();
1556      }
1557    }
1558    {
1559      std::ostream* saved_os = os_;
1560      Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1561      std::ostream indent_os(&indent_filter);
1562      os_ = &indent_os;
1563
1564      // Mark dex caches.
1565      dex_cache_arrays_.clear();
1566      {
1567        ReaderMutexLock mu(self, *class_linker->DexLock());
1568        for (size_t i = 0; i < class_linker->GetDexCacheCount(); ++i) {
1569          auto* dex_cache = class_linker->GetDexCache(i);
1570          dex_cache_arrays_.insert(dex_cache->GetResolvedFields());
1571          dex_cache_arrays_.insert(dex_cache->GetResolvedMethods());
1572        }
1573      }
1574      ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
1575      for (const auto& space : spaces) {
1576        if (space->IsImageSpace()) {
1577          auto* image_space = space->AsImageSpace();
1578          // Dump the normal objects before ArtMethods.
1579          image_space->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
1580          indent_os << "\n";
1581          // TODO: Dump fields.
1582          // Dump methods after.
1583          const auto& methods_section = image_header_.GetMethodsSection();
1584          const auto pointer_size =
1585              InstructionSetPointerSize(oat_dumper_->GetOatInstructionSet());
1586          const auto method_size = ArtMethod::ObjectSize(pointer_size);
1587          for (size_t pos = 0; pos < methods_section.Size(); pos += method_size) {
1588            auto* method = reinterpret_cast<ArtMethod*>(
1589                image_space->Begin() + pos + methods_section.Offset());
1590            indent_os << method << " " << " ArtMethod: " << PrettyMethod(method) << "\n";
1591            DumpMethod(method, this, indent_os);
1592            indent_os << "\n";
1593          }
1594        }
1595      }
1596      // Dump the large objects separately.
1597      heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(ImageDumper::Callback, this);
1598      indent_os << "\n";
1599      os_ = saved_os;
1600    }
1601    os << "STATS:\n" << std::flush;
1602    std::unique_ptr<File> file(OS::OpenFileForReading(image_filename.c_str()));
1603    if (file.get() == nullptr) {
1604      LOG(WARNING) << "Failed to find image in " << image_filename;
1605    }
1606    if (file.get() != nullptr) {
1607      stats_.file_bytes = file->GetLength();
1608    }
1609    size_t header_bytes = sizeof(ImageHeader);
1610    const auto& bitmap_section = image_header_.GetImageSection(ImageHeader::kSectionImageBitmap);
1611    const auto& field_section = image_header_.GetImageSection(ImageHeader::kSectionArtFields);
1612    const auto& method_section = image_header_.GetMethodsSection();
1613    const auto& intern_section = image_header_.GetImageSection(
1614        ImageHeader::kSectionInternedStrings);
1615    stats_.header_bytes = header_bytes;
1616    size_t alignment_bytes = RoundUp(header_bytes, kObjectAlignment) - header_bytes;
1617    stats_.alignment_bytes += alignment_bytes;
1618    stats_.alignment_bytes += bitmap_section.Offset() - image_header_.GetImageSize();
1619    stats_.bitmap_bytes += bitmap_section.Size();
1620    stats_.art_field_bytes += field_section.Size();
1621    stats_.art_method_bytes += method_section.Size();
1622    stats_.interned_strings_bytes += intern_section.Size();
1623    stats_.Dump(os);
1624    os << "\n";
1625
1626    os << std::flush;
1627
1628    return oat_dumper_->Dump(os);
1629  }
1630
1631 private:
1632  static void PrettyObjectValue(std::ostream& os, mirror::Class* type, mirror::Object* value)
1633      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1634    CHECK(type != nullptr);
1635    if (value == nullptr) {
1636      os << StringPrintf("null   %s\n", PrettyDescriptor(type).c_str());
1637    } else if (type->IsStringClass()) {
1638      mirror::String* string = value->AsString();
1639      os << StringPrintf("%p   String: %s\n", string,
1640                         PrintableString(string->ToModifiedUtf8().c_str()).c_str());
1641    } else if (type->IsClassClass()) {
1642      mirror::Class* klass = value->AsClass();
1643      os << StringPrintf("%p   Class: %s\n", klass, PrettyDescriptor(klass).c_str());
1644    } else {
1645      os << StringPrintf("%p   %s\n", value, PrettyDescriptor(type).c_str());
1646    }
1647  }
1648
1649  static void PrintField(std::ostream& os, ArtField* field, mirror::Object* obj)
1650      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1651    os << StringPrintf("%s: ", field->GetName());
1652    switch (field->GetTypeAsPrimitiveType()) {
1653      case Primitive::kPrimLong:
1654        os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj));
1655        break;
1656      case Primitive::kPrimDouble:
1657        os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj));
1658        break;
1659      case Primitive::kPrimFloat:
1660        os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj));
1661        break;
1662      case Primitive::kPrimInt:
1663        os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj));
1664        break;
1665      case Primitive::kPrimChar:
1666        os << StringPrintf("%u (0x%x)\n", field->GetChar(obj), field->GetChar(obj));
1667        break;
1668      case Primitive::kPrimShort:
1669        os << StringPrintf("%d (0x%x)\n", field->GetShort(obj), field->GetShort(obj));
1670        break;
1671      case Primitive::kPrimBoolean:
1672        os << StringPrintf("%s (0x%x)\n", field->GetBoolean(obj)? "true" : "false",
1673            field->GetBoolean(obj));
1674        break;
1675      case Primitive::kPrimByte:
1676        os << StringPrintf("%d (0x%x)\n", field->GetByte(obj), field->GetByte(obj));
1677        break;
1678      case Primitive::kPrimNot: {
1679        // Get the value, don't compute the type unless it is non-null as we don't want
1680        // to cause class loading.
1681        mirror::Object* value = field->GetObj(obj);
1682        if (value == nullptr) {
1683          os << StringPrintf("null   %s\n", PrettyDescriptor(field->GetTypeDescriptor()).c_str());
1684        } else {
1685          // Grab the field type without causing resolution.
1686          mirror::Class* field_type = field->GetType<false>();
1687          if (field_type != nullptr) {
1688            PrettyObjectValue(os, field_type, value);
1689          } else {
1690            os << StringPrintf("%p   %s\n", value,
1691                               PrettyDescriptor(field->GetTypeDescriptor()).c_str());
1692          }
1693        }
1694        break;
1695      }
1696      default:
1697        os << "unexpected field type: " << field->GetTypeDescriptor() << "\n";
1698        break;
1699    }
1700  }
1701
1702  static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass)
1703      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1704    mirror::Class* super = klass->GetSuperClass();
1705    if (super != nullptr) {
1706      DumpFields(os, obj, super);
1707    }
1708    ArtField* fields = klass->GetIFields();
1709    for (size_t i = 0, count = klass->NumInstanceFields(); i < count; i++) {
1710      PrintField(os, &fields[i], obj);
1711    }
1712  }
1713
1714  bool InDumpSpace(const mirror::Object* object) {
1715    return image_space_.Contains(object);
1716  }
1717
1718  const void* GetQuickOatCodeBegin(ArtMethod* m)
1719      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1720    const void* quick_code = m->GetEntryPointFromQuickCompiledCodePtrSize(
1721        InstructionSetPointerSize(oat_dumper_->GetOatInstructionSet()));
1722    if (Runtime::Current()->GetClassLinker()->IsQuickResolutionStub(quick_code)) {
1723      quick_code = oat_dumper_->GetQuickOatCode(m);
1724    }
1725    if (oat_dumper_->GetInstructionSet() == kThumb2) {
1726      quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1);
1727    }
1728    return quick_code;
1729  }
1730
1731  uint32_t GetQuickOatCodeSize(ArtMethod* m)
1732      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1733    const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m));
1734    if (oat_code_begin == nullptr) {
1735      return 0;
1736    }
1737    return oat_code_begin[-1];
1738  }
1739
1740  const void* GetQuickOatCodeEnd(ArtMethod* m)
1741      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1742    const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m));
1743    if (oat_code_begin == nullptr) {
1744      return nullptr;
1745    }
1746    return oat_code_begin + GetQuickOatCodeSize(m);
1747  }
1748
1749  static void Callback(mirror::Object* obj, void* arg) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1750    DCHECK(obj != nullptr);
1751    DCHECK(arg != nullptr);
1752    ImageDumper* state = reinterpret_cast<ImageDumper*>(arg);
1753    if (!state->InDumpSpace(obj)) {
1754      return;
1755    }
1756
1757    size_t object_bytes = obj->SizeOf();
1758    size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes;
1759    state->stats_.object_bytes += object_bytes;
1760    state->stats_.alignment_bytes += alignment_bytes;
1761
1762    std::ostream& os = *state->os_;
1763    mirror::Class* obj_class = obj->GetClass();
1764    if (obj_class->IsArrayClass()) {
1765      os << StringPrintf("%p: %s length:%d\n", obj, PrettyDescriptor(obj_class).c_str(),
1766                         obj->AsArray()->GetLength());
1767    } else if (obj->IsClass()) {
1768      mirror::Class* klass = obj->AsClass();
1769      os << StringPrintf("%p: java.lang.Class \"%s\" (", obj, PrettyDescriptor(klass).c_str())
1770         << klass->GetStatus() << ")\n";
1771    } else if (obj_class->IsStringClass()) {
1772      os << StringPrintf("%p: java.lang.String %s\n", obj,
1773                         PrintableString(obj->AsString()->ToModifiedUtf8().c_str()).c_str());
1774    } else {
1775      os << StringPrintf("%p: %s\n", obj, PrettyDescriptor(obj_class).c_str());
1776    }
1777    Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
1778    std::ostream indent_os(&indent_filter);
1779    DumpFields(indent_os, obj, obj_class);
1780    const auto image_pointer_size =
1781        InstructionSetPointerSize(state->oat_dumper_->GetOatInstructionSet());
1782    if (obj->IsObjectArray()) {
1783      auto* obj_array = obj->AsObjectArray<mirror::Object>();
1784      for (int32_t i = 0, length = obj_array->GetLength(); i < length; i++) {
1785        mirror::Object* value = obj_array->Get(i);
1786        size_t run = 0;
1787        for (int32_t j = i + 1; j < length; j++) {
1788          if (value == obj_array->Get(j)) {
1789            run++;
1790          } else {
1791            break;
1792          }
1793        }
1794        if (run == 0) {
1795          indent_os << StringPrintf("%d: ", i);
1796        } else {
1797          indent_os << StringPrintf("%d to %zd: ", i, i + run);
1798          i = i + run;
1799        }
1800        mirror::Class* value_class =
1801            (value == nullptr) ? obj_class->GetComponentType() : value->GetClass();
1802        PrettyObjectValue(indent_os, value_class, value);
1803      }
1804    } else if (obj->IsClass()) {
1805      mirror::Class* klass = obj->AsClass();
1806      ArtField* sfields = klass->GetSFields();
1807      const size_t num_fields = klass->NumStaticFields();
1808      if (num_fields != 0) {
1809        indent_os << "STATICS:\n";
1810        Indenter indent2_filter(indent_os.rdbuf(), kIndentChar, kIndentBy1Count);
1811        std::ostream indent2_os(&indent2_filter);
1812        for (size_t i = 0; i < num_fields; i++) {
1813          PrintField(indent2_os, &sfields[i], sfields[i].GetDeclaringClass());
1814        }
1815      }
1816    } else {
1817      auto it = state->dex_cache_arrays_.find(obj);
1818      if (it != state->dex_cache_arrays_.end()) {
1819        const auto& field_section = state->image_header_.GetImageSection(
1820            ImageHeader::kSectionArtFields);
1821        const auto& method_section = state->image_header_.GetMethodsSection();
1822        auto* arr = down_cast<mirror::PointerArray*>(obj);
1823        for (int32_t i = 0, length = arr->GetLength(); i < length; i++) {
1824          void* elem = arr->GetElementPtrSize<void*>(i, image_pointer_size);
1825          size_t run = 0;
1826          for (int32_t j = i + 1; j < length &&
1827              elem == arr->GetElementPtrSize<void*>(j, image_pointer_size); j++, run++) { }
1828          if (run == 0) {
1829            indent_os << StringPrintf("%d: ", i);
1830          } else {
1831            indent_os << StringPrintf("%d to %zd: ", i, i + run);
1832            i = i + run;
1833          }
1834          auto offset = reinterpret_cast<uint8_t*>(elem) - state->image_space_.Begin();
1835          std::string msg;
1836          if (field_section.Contains(offset)) {
1837            msg = PrettyField(reinterpret_cast<ArtField*>(elem));
1838          } else if (method_section.Contains(offset)) {
1839            msg = PrettyMethod(reinterpret_cast<ArtMethod*>(elem));
1840          } else {
1841            msg = "Unknown type";
1842          }
1843          indent_os << StringPrintf("%p   %s\n", elem, msg.c_str());
1844        }
1845      }
1846    }
1847    std::string temp;
1848    state->stats_.Update(obj_class->GetDescriptor(&temp), object_bytes);
1849  }
1850
1851  void DumpMethod(ArtMethod* method, ImageDumper* state, std::ostream& indent_os)
1852      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
1853    DCHECK(method != nullptr);
1854    const auto image_pointer_size =
1855        InstructionSetPointerSize(state->oat_dumper_->GetOatInstructionSet());
1856    if (method->IsNative()) {
1857      DCHECK(method->GetNativeGcMap(image_pointer_size) == nullptr) << PrettyMethod(method);
1858      DCHECK(method->GetMappingTable(image_pointer_size) == nullptr) << PrettyMethod(method);
1859      bool first_occurrence;
1860      const void* quick_oat_code = state->GetQuickOatCodeBegin(method);
1861      uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1862      state->ComputeOatSize(quick_oat_code, &first_occurrence);
1863      if (first_occurrence) {
1864        state->stats_.native_to_managed_code_bytes += quick_oat_code_size;
1865      }
1866      if (quick_oat_code != method->GetEntryPointFromQuickCompiledCodePtrSize(image_pointer_size)) {
1867        indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code);
1868      }
1869    } else if (method->IsAbstract() || method->IsCalleeSaveMethod() ||
1870      method->IsResolutionMethod() || method->IsImtConflictMethod() ||
1871      method->IsImtUnimplementedMethod() || method->IsClassInitializer()) {
1872      DCHECK(method->GetNativeGcMap(image_pointer_size) == nullptr) << PrettyMethod(method);
1873      DCHECK(method->GetMappingTable(image_pointer_size) == nullptr) << PrettyMethod(method);
1874    } else {
1875      const DexFile::CodeItem* code_item = method->GetCodeItem();
1876      size_t dex_instruction_bytes = code_item->insns_size_in_code_units_ * 2;
1877      state->stats_.dex_instruction_bytes += dex_instruction_bytes;
1878
1879      bool first_occurrence;
1880      size_t gc_map_bytes = state->ComputeOatSize(
1881          method->GetNativeGcMap(image_pointer_size), &first_occurrence);
1882      if (first_occurrence) {
1883        state->stats_.gc_map_bytes += gc_map_bytes;
1884      }
1885
1886      size_t pc_mapping_table_bytes = state->ComputeOatSize(
1887          method->GetMappingTable(image_pointer_size), &first_occurrence);
1888      if (first_occurrence) {
1889        state->stats_.pc_mapping_table_bytes += pc_mapping_table_bytes;
1890      }
1891
1892      size_t vmap_table_bytes = state->ComputeOatSize(
1893          method->GetVmapTable(image_pointer_size), &first_occurrence);
1894      if (first_occurrence) {
1895        state->stats_.vmap_table_bytes += vmap_table_bytes;
1896      }
1897
1898      const void* quick_oat_code_begin = state->GetQuickOatCodeBegin(method);
1899      const void* quick_oat_code_end = state->GetQuickOatCodeEnd(method);
1900      uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method);
1901      state->ComputeOatSize(quick_oat_code_begin, &first_occurrence);
1902      if (first_occurrence) {
1903        state->stats_.managed_code_bytes += quick_oat_code_size;
1904        if (method->IsConstructor()) {
1905          if (method->IsStatic()) {
1906            state->stats_.class_initializer_code_bytes += quick_oat_code_size;
1907          } else if (dex_instruction_bytes > kLargeConstructorDexBytes) {
1908            state->stats_.large_initializer_code_bytes += quick_oat_code_size;
1909          }
1910        } else if (dex_instruction_bytes > kLargeMethodDexBytes) {
1911          state->stats_.large_method_code_bytes += quick_oat_code_size;
1912        }
1913      }
1914      state->stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size;
1915
1916      indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end);
1917      indent_os << StringPrintf("SIZE: Dex Instructions=%zd GC=%zd Mapping=%zd\n",
1918      dex_instruction_bytes, gc_map_bytes, pc_mapping_table_bytes);
1919
1920      size_t total_size = dex_instruction_bytes + gc_map_bytes + pc_mapping_table_bytes +
1921          vmap_table_bytes + quick_oat_code_size + ArtMethod::ObjectSize(image_pointer_size);
1922
1923      double expansion =
1924      static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes);
1925      state->stats_.ComputeOutliers(total_size, expansion, method);
1926    }
1927  }
1928
1929  std::set<const void*> already_seen_;
1930  // Compute the size of the given data within the oat file and whether this is the first time
1931  // this data has been requested
1932  size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) {
1933    if (already_seen_.count(oat_data) == 0) {
1934      *first_occurrence = true;
1935      already_seen_.insert(oat_data);
1936    } else {
1937      *first_occurrence = false;
1938    }
1939    return oat_dumper_->ComputeSize(oat_data);
1940  }
1941
1942 public:
1943  struct Stats {
1944    size_t oat_file_bytes;
1945    size_t file_bytes;
1946
1947    size_t header_bytes;
1948    size_t object_bytes;
1949    size_t art_field_bytes;
1950    size_t art_method_bytes;
1951    size_t interned_strings_bytes;
1952    size_t bitmap_bytes;
1953    size_t alignment_bytes;
1954
1955    size_t managed_code_bytes;
1956    size_t managed_code_bytes_ignoring_deduplication;
1957    size_t managed_to_native_code_bytes;
1958    size_t native_to_managed_code_bytes;
1959    size_t class_initializer_code_bytes;
1960    size_t large_initializer_code_bytes;
1961    size_t large_method_code_bytes;
1962
1963    size_t gc_map_bytes;
1964    size_t pc_mapping_table_bytes;
1965    size_t vmap_table_bytes;
1966
1967    size_t dex_instruction_bytes;
1968
1969    std::vector<ArtMethod*> method_outlier;
1970    std::vector<size_t> method_outlier_size;
1971    std::vector<double> method_outlier_expansion;
1972    std::vector<std::pair<std::string, size_t>> oat_dex_file_sizes;
1973
1974    explicit Stats()
1975        : oat_file_bytes(0),
1976          file_bytes(0),
1977          header_bytes(0),
1978          object_bytes(0),
1979          art_field_bytes(0),
1980          art_method_bytes(0),
1981          interned_strings_bytes(0),
1982          bitmap_bytes(0),
1983          alignment_bytes(0),
1984          managed_code_bytes(0),
1985          managed_code_bytes_ignoring_deduplication(0),
1986          managed_to_native_code_bytes(0),
1987          native_to_managed_code_bytes(0),
1988          class_initializer_code_bytes(0),
1989          large_initializer_code_bytes(0),
1990          large_method_code_bytes(0),
1991          gc_map_bytes(0),
1992          pc_mapping_table_bytes(0),
1993          vmap_table_bytes(0),
1994          dex_instruction_bytes(0) {}
1995
1996    struct SizeAndCount {
1997      SizeAndCount(size_t bytes_in, size_t count_in) : bytes(bytes_in), count(count_in) {}
1998      size_t bytes;
1999      size_t count;
2000    };
2001    typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable;
2002    SizeAndCountTable sizes_and_counts;
2003
2004    void Update(const char* descriptor, size_t object_bytes_in) {
2005      SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor);
2006      if (it != sizes_and_counts.end()) {
2007        it->second.bytes += object_bytes_in;
2008        it->second.count += 1;
2009      } else {
2010        sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes_in, 1));
2011      }
2012    }
2013
2014    double PercentOfOatBytes(size_t size) {
2015      return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100;
2016    }
2017
2018    double PercentOfFileBytes(size_t size) {
2019      return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100;
2020    }
2021
2022    double PercentOfObjectBytes(size_t size) {
2023      return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100;
2024    }
2025
2026    void ComputeOutliers(size_t total_size, double expansion, ArtMethod* method) {
2027      method_outlier_size.push_back(total_size);
2028      method_outlier_expansion.push_back(expansion);
2029      method_outlier.push_back(method);
2030    }
2031
2032    void DumpOutliers(std::ostream& os)
2033        SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2034      size_t sum_of_sizes = 0;
2035      size_t sum_of_sizes_squared = 0;
2036      size_t sum_of_expansion = 0;
2037      size_t sum_of_expansion_squared = 0;
2038      size_t n = method_outlier_size.size();
2039      for (size_t i = 0; i < n; i++) {
2040        size_t cur_size = method_outlier_size[i];
2041        sum_of_sizes += cur_size;
2042        sum_of_sizes_squared += cur_size * cur_size;
2043        double cur_expansion = method_outlier_expansion[i];
2044        sum_of_expansion += cur_expansion;
2045        sum_of_expansion_squared += cur_expansion * cur_expansion;
2046      }
2047      size_t size_mean = sum_of_sizes / n;
2048      size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1);
2049      double expansion_mean = sum_of_expansion / n;
2050      double expansion_variance =
2051          (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1);
2052
2053      // Dump methods whose size is a certain number of standard deviations from the mean
2054      size_t dumped_values = 0;
2055      size_t skipped_values = 0;
2056      for (size_t i = 100; i > 0; i--) {  // i is the current number of standard deviations
2057        size_t cur_size_variance = i * i * size_variance;
2058        bool first = true;
2059        for (size_t j = 0; j < n; j++) {
2060          size_t cur_size = method_outlier_size[j];
2061          if (cur_size > size_mean) {
2062            size_t cur_var = cur_size - size_mean;
2063            cur_var = cur_var * cur_var;
2064            if (cur_var > cur_size_variance) {
2065              if (dumped_values > 20) {
2066                if (i == 1) {
2067                  skipped_values++;
2068                } else {
2069                  i = 2;  // jump to counting for 1 standard deviation
2070                  break;
2071                }
2072              } else {
2073                if (first) {
2074                  os << "\nBig methods (size > " << i << " standard deviations the norm):\n";
2075                  first = false;
2076                }
2077                os << PrettyMethod(method_outlier[j]) << " requires storage of "
2078                    << PrettySize(cur_size) << "\n";
2079                method_outlier_size[j] = 0;  // don't consider this method again
2080                dumped_values++;
2081              }
2082            }
2083          }
2084        }
2085      }
2086      if (skipped_values > 0) {
2087        os << "... skipped " << skipped_values
2088           << " methods with size > 1 standard deviation from the norm\n";
2089      }
2090      os << std::flush;
2091
2092      // Dump methods whose expansion is a certain number of standard deviations from the mean
2093      dumped_values = 0;
2094      skipped_values = 0;
2095      for (size_t i = 10; i > 0; i--) {  // i is the current number of standard deviations
2096        double cur_expansion_variance = i * i * expansion_variance;
2097        bool first = true;
2098        for (size_t j = 0; j < n; j++) {
2099          double cur_expansion = method_outlier_expansion[j];
2100          if (cur_expansion > expansion_mean) {
2101            size_t cur_var = cur_expansion - expansion_mean;
2102            cur_var = cur_var * cur_var;
2103            if (cur_var > cur_expansion_variance) {
2104              if (dumped_values > 20) {
2105                if (i == 1) {
2106                  skipped_values++;
2107                } else {
2108                  i = 2;  // jump to counting for 1 standard deviation
2109                  break;
2110                }
2111              } else {
2112                if (first) {
2113                  os << "\nLarge expansion methods (size > " << i
2114                      << " standard deviations the norm):\n";
2115                  first = false;
2116                }
2117                os << PrettyMethod(method_outlier[j]) << " expanded code by "
2118                   << cur_expansion << "\n";
2119                method_outlier_expansion[j] = 0.0;  // don't consider this method again
2120                dumped_values++;
2121              }
2122            }
2123          }
2124        }
2125      }
2126      if (skipped_values > 0) {
2127        os << "... skipped " << skipped_values
2128           << " methods with expansion > 1 standard deviation from the norm\n";
2129      }
2130      os << "\n" << std::flush;
2131    }
2132
2133    void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
2134      {
2135        os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n"
2136           << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n";
2137        Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count);
2138        std::ostream indent_os(&indent_filter);
2139        indent_os << StringPrintf("header_bytes          =  %8zd (%2.0f%% of art file bytes)\n"
2140                                  "object_bytes          =  %8zd (%2.0f%% of art file bytes)\n"
2141                                  "art_field_bytes       =  %8zd (%2.0f%% of art file bytes)\n"
2142                                  "art_method_bytes      =  %8zd (%2.0f%% of art file bytes)\n"
2143                                  "interned_string_bytes =  %8zd (%2.0f%% of art file bytes)\n"
2144                                  "bitmap_bytes          =  %8zd (%2.0f%% of art file bytes)\n"
2145                                  "alignment_bytes       =  %8zd (%2.0f%% of art file bytes)\n\n",
2146                                  header_bytes, PercentOfFileBytes(header_bytes),
2147                                  object_bytes, PercentOfFileBytes(object_bytes),
2148                                  art_field_bytes, PercentOfFileBytes(art_field_bytes),
2149                                  art_method_bytes, PercentOfFileBytes(art_method_bytes),
2150                                  interned_strings_bytes,
2151                                  PercentOfFileBytes(interned_strings_bytes),
2152                                  bitmap_bytes, PercentOfFileBytes(bitmap_bytes),
2153                                  alignment_bytes, PercentOfFileBytes(alignment_bytes))
2154            << std::flush;
2155        CHECK_EQ(file_bytes, header_bytes + object_bytes + art_field_bytes + art_method_bytes +
2156                 interned_strings_bytes + bitmap_bytes + alignment_bytes);
2157      }
2158
2159      os << "object_bytes breakdown:\n";
2160      size_t object_bytes_total = 0;
2161      for (const auto& sizes_and_count : sizes_and_counts) {
2162        const std::string& descriptor(sizes_and_count.first);
2163        double average = static_cast<double>(sizes_and_count.second.bytes) /
2164            static_cast<double>(sizes_and_count.second.count);
2165        double percent = PercentOfObjectBytes(sizes_and_count.second.bytes);
2166        os << StringPrintf("%32s %8zd bytes %6zd instances "
2167                           "(%4.0f bytes/instance) %2.0f%% of object_bytes\n",
2168                           descriptor.c_str(), sizes_and_count.second.bytes,
2169                           sizes_and_count.second.count, average, percent);
2170        object_bytes_total += sizes_and_count.second.bytes;
2171      }
2172      os << "\n" << std::flush;
2173      CHECK_EQ(object_bytes, object_bytes_total);
2174
2175      os << StringPrintf("oat_file_bytes               = %8zd\n"
2176                         "managed_code_bytes           = %8zd (%2.0f%% of oat file bytes)\n"
2177                         "managed_to_native_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2178                         "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n"
2179                         "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2180                         "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2181                         "large_method_code_bytes      = %8zd (%2.0f%% of oat file bytes)\n\n",
2182                         oat_file_bytes,
2183                         managed_code_bytes,
2184                         PercentOfOatBytes(managed_code_bytes),
2185                         managed_to_native_code_bytes,
2186                         PercentOfOatBytes(managed_to_native_code_bytes),
2187                         native_to_managed_code_bytes,
2188                         PercentOfOatBytes(native_to_managed_code_bytes),
2189                         class_initializer_code_bytes,
2190                         PercentOfOatBytes(class_initializer_code_bytes),
2191                         large_initializer_code_bytes,
2192                         PercentOfOatBytes(large_initializer_code_bytes),
2193                         large_method_code_bytes,
2194                         PercentOfOatBytes(large_method_code_bytes))
2195            << "DexFile sizes:\n";
2196      for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) {
2197        os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n",
2198                           oat_dex_file_size.first.c_str(), oat_dex_file_size.second,
2199                           PercentOfOatBytes(oat_dex_file_size.second));
2200      }
2201
2202      os << "\n" << StringPrintf("gc_map_bytes           = %7zd (%2.0f%% of oat file bytes)\n"
2203                                 "pc_mapping_table_bytes = %7zd (%2.0f%% of oat file bytes)\n"
2204                                 "vmap_table_bytes       = %7zd (%2.0f%% of oat file bytes)\n\n",
2205                                 gc_map_bytes, PercentOfOatBytes(gc_map_bytes),
2206                                 pc_mapping_table_bytes, PercentOfOatBytes(pc_mapping_table_bytes),
2207                                 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes))
2208         << std::flush;
2209
2210      os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes)
2211         << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n",
2212                         static_cast<double>(managed_code_bytes) /
2213                             static_cast<double>(dex_instruction_bytes),
2214                         static_cast<double>(managed_code_bytes_ignoring_deduplication) /
2215                             static_cast<double>(dex_instruction_bytes))
2216         << std::flush;
2217
2218      DumpOutliers(os);
2219    }
2220  } stats_;
2221
2222 private:
2223  enum {
2224    // Number of bytes for a constructor to be considered large. Based on the 1000 basic block
2225    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
2226    kLargeConstructorDexBytes = 4000,
2227    // Number of bytes for a method to be considered large. Based on the 4000 basic block
2228    // threshold, we assume 2 bytes per instruction and 2 instructions per block.
2229    kLargeMethodDexBytes = 16000
2230  };
2231  std::ostream* os_;
2232  gc::space::ImageSpace& image_space_;
2233  const ImageHeader& image_header_;
2234  std::unique_ptr<OatDumper> oat_dumper_;
2235  OatDumperOptions* oat_dumper_options_;
2236  std::set<mirror::Object*> dex_cache_arrays_;
2237
2238  DISALLOW_COPY_AND_ASSIGN(ImageDumper);
2239};
2240
2241static int DumpImage(Runtime* runtime, const char* image_location, OatDumperOptions* options,
2242                     std::ostream* os) {
2243  // Dumping the image, no explicit class loader.
2244  NullHandle<mirror::ClassLoader> null_class_loader;
2245  options->class_loader_ = &null_class_loader;
2246
2247  ScopedObjectAccess soa(Thread::Current());
2248  gc::Heap* heap = runtime->GetHeap();
2249  gc::space::ImageSpace* image_space = heap->GetImageSpace();
2250  CHECK(image_space != nullptr);
2251  const ImageHeader& image_header = image_space->GetImageHeader();
2252  if (!image_header.IsValid()) {
2253    fprintf(stderr, "Invalid image header %s\n", image_location);
2254    return EXIT_FAILURE;
2255  }
2256
2257  ImageDumper image_dumper(os, *image_space, image_header, options);
2258
2259  bool success = image_dumper.Dump();
2260  return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2261}
2262
2263static int DumpOatWithRuntime(Runtime* runtime, OatFile* oat_file, OatDumperOptions* options,
2264                              std::ostream* os) {
2265  CHECK(runtime != nullptr && oat_file != nullptr && options != nullptr);
2266
2267  Thread* self = Thread::Current();
2268  CHECK(self != nullptr);
2269  // Need well-known-classes.
2270  WellKnownClasses::Init(self->GetJniEnv());
2271
2272  // Need to register dex files to get a working dex cache.
2273  ScopedObjectAccess soa(self);
2274  ClassLinker* class_linker = runtime->GetClassLinker();
2275  class_linker->RegisterOatFile(oat_file);
2276  std::vector<std::unique_ptr<const DexFile>> dex_files;
2277  for (const OatFile::OatDexFile* odf : oat_file->GetOatDexFiles()) {
2278    std::string error_msg;
2279    std::unique_ptr<const DexFile> dex_file = odf->OpenDexFile(&error_msg);
2280    CHECK(dex_file != nullptr) << error_msg;
2281    class_linker->RegisterDexFile(*dex_file);
2282    dex_files.push_back(std::move(dex_file));
2283  }
2284
2285  // Need a class loader.
2286  // Fake that we're a compiler.
2287  std::vector<const DexFile*> class_path;
2288  for (auto& dex_file : dex_files) {
2289    class_path.push_back(dex_file.get());
2290  }
2291  jobject class_loader = class_linker->CreatePathClassLoader(self, class_path);
2292
2293  // Use the class loader while dumping.
2294  StackHandleScope<1> scope(self);
2295  Handle<mirror::ClassLoader> loader_handle = scope.NewHandle(
2296      soa.Decode<mirror::ClassLoader*>(class_loader));
2297  options->class_loader_ = &loader_handle;
2298
2299  OatDumper oat_dumper(*oat_file, *options);
2300  bool success = oat_dumper.Dump(*os);
2301  return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2302}
2303
2304static int DumpOatWithoutRuntime(OatFile* oat_file, OatDumperOptions* options, std::ostream* os) {
2305  CHECK(oat_file != nullptr && options != nullptr);
2306  // No image = no class loader.
2307  NullHandle<mirror::ClassLoader> null_class_loader;
2308  options->class_loader_ = &null_class_loader;
2309
2310  OatDumper oat_dumper(*oat_file, *options);
2311  bool success = oat_dumper.Dump(*os);
2312  return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2313}
2314
2315static int DumpOat(Runtime* runtime, const char* oat_filename, OatDumperOptions* options,
2316                   std::ostream* os) {
2317  std::string error_msg;
2318  OatFile* oat_file = OatFile::Open(oat_filename, oat_filename, nullptr, nullptr, false,
2319                                    nullptr, &error_msg);
2320  if (oat_file == nullptr) {
2321    fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
2322    return EXIT_FAILURE;
2323  }
2324
2325  if (runtime != nullptr) {
2326    return DumpOatWithRuntime(runtime, oat_file, options, os);
2327  } else {
2328    return DumpOatWithoutRuntime(oat_file, options, os);
2329  }
2330}
2331
2332static int SymbolizeOat(const char* oat_filename, std::string& output_name) {
2333  std::string error_msg;
2334  OatFile* oat_file = OatFile::Open(oat_filename, oat_filename, nullptr, nullptr, false,
2335                                    nullptr, &error_msg);
2336  if (oat_file == nullptr) {
2337    fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
2338    return EXIT_FAILURE;
2339  }
2340
2341  OatSymbolizer oat_symbolizer(oat_file, output_name);
2342  if (!oat_symbolizer.Symbolize()) {
2343    fprintf(stderr, "Failed to symbolize\n");
2344    return EXIT_FAILURE;
2345  }
2346
2347  return EXIT_SUCCESS;
2348}
2349
2350struct OatdumpArgs : public CmdlineArgs {
2351 protected:
2352  using Base = CmdlineArgs;
2353
2354  virtual ParseStatus ParseCustom(const StringPiece& option,
2355                                  std::string* error_msg) OVERRIDE {
2356    {
2357      ParseStatus base_parse = Base::ParseCustom(option, error_msg);
2358      if (base_parse != kParseUnknownArgument) {
2359        return base_parse;
2360      }
2361    }
2362
2363    if (option.starts_with("--oat-file=")) {
2364      oat_filename_ = option.substr(strlen("--oat-file=")).data();
2365    } else if (option.starts_with("--image=")) {
2366      image_location_ = option.substr(strlen("--image=")).data();
2367    } else if (option =="--dump:raw_mapping_table") {
2368      dump_raw_mapping_table_ = true;
2369    } else if (option == "--dump:raw_gc_map") {
2370      dump_raw_gc_map_ = true;
2371    } else if (option == "--no-dump:vmap") {
2372      dump_vmap_ = false;
2373    } else if (option =="--dump:code_info_stack_maps") {
2374      dump_code_info_stack_maps_ = true;
2375    } else if (option == "--no-disassemble") {
2376      disassemble_code_ = false;
2377    } else if (option.starts_with("--symbolize=")) {
2378      oat_filename_ = option.substr(strlen("--symbolize=")).data();
2379      symbolize_ = true;
2380    } else if (option.starts_with("--class-filter=")) {
2381      class_filter_ = option.substr(strlen("--class-filter=")).data();
2382    } else if (option.starts_with("--method-filter=")) {
2383      method_filter_ = option.substr(strlen("--method-filter=")).data();
2384    } else if (option.starts_with("--list-classes")) {
2385      list_classes_ = true;
2386    } else if (option.starts_with("--list-methods")) {
2387      list_methods_ = true;
2388    } else if (option.starts_with("--export-dex-to=")) {
2389      export_dex_location_ = option.substr(strlen("--export-dex-to=")).data();
2390    } else if (option.starts_with("--addr2instr=")) {
2391      if (!ParseUint(option.substr(strlen("--addr2instr=")).data(), &addr2instr_)) {
2392        *error_msg = "Address conversion failed";
2393        return kParseError;
2394      }
2395    } else {
2396      return kParseUnknownArgument;
2397    }
2398
2399    return kParseOk;
2400  }
2401
2402  virtual ParseStatus ParseChecks(std::string* error_msg) OVERRIDE {
2403    // Infer boot image location from the image location if possible.
2404    if (boot_image_location_ == nullptr) {
2405      boot_image_location_ = image_location_;
2406    }
2407
2408    // Perform the parent checks.
2409    ParseStatus parent_checks = Base::ParseChecks(error_msg);
2410    if (parent_checks != kParseOk) {
2411      return parent_checks;
2412    }
2413
2414    // Perform our own checks.
2415    if (image_location_ == nullptr && oat_filename_ == nullptr) {
2416      *error_msg = "Either --image or --oat-file must be specified";
2417      return kParseError;
2418    } else if (image_location_ != nullptr && oat_filename_ != nullptr) {
2419      *error_msg = "Either --image or --oat-file must be specified but not both";
2420      return kParseError;
2421    }
2422
2423    return kParseOk;
2424  }
2425
2426  virtual std::string GetUsage() const {
2427    std::string usage;
2428
2429    usage +=
2430        "Usage: oatdump [options] ...\n"
2431        "    Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art\n"
2432        "    Example: adb shell oatdump --image=/system/framework/boot.art\n"
2433        "\n"
2434        // Either oat-file or image is required.
2435        "  --oat-file=<file.oat>: specifies an input oat filename.\n"
2436        "      Example: --oat-file=/system/framework/boot.oat\n"
2437        "\n"
2438        "  --image=<file.art>: specifies an input image location.\n"
2439        "      Example: --image=/system/framework/boot.art\n"
2440        "\n";
2441
2442    usage += Base::GetUsage();
2443
2444    usage +=  // Optional.
2445        "  --dump:raw_mapping_table enables dumping of the mapping table.\n"
2446        "      Example: --dump:raw_mapping_table\n"
2447        "\n"
2448        "  --dump:raw_gc_map enables dumping of the GC map.\n"
2449        "      Example: --dump:raw_gc_map\n"
2450        "\n"
2451        "  --no-dump:vmap may be used to disable vmap dumping.\n"
2452        "      Example: --no-dump:vmap\n"
2453        "\n"
2454        "  --dump:code_info_stack_maps enables dumping of stack maps in CodeInfo sections.\n"
2455        "      Example: --dump:code_info_stack_maps\n"
2456        "\n"
2457        "  --no-disassemble may be used to disable disassembly.\n"
2458        "      Example: --no-disassemble\n"
2459        "\n"
2460        "  --list-classes may be used to list target file classes (can be used with filters).\n"
2461        "      Example: --list-classes\n"
2462        "      Example: --list-classes --class-filter=com.example.foo\n"
2463        "\n"
2464        "  --list-methods may be used to list target file methods (can be used with filters).\n"
2465        "      Example: --list-methods\n"
2466        "      Example: --list-methods --class-filter=com.example --method-filter=foo\n"
2467        "\n"
2468        "  --symbolize=<file.oat>: output a copy of file.oat with elf symbols included.\n"
2469        "      Example: --symbolize=/system/framework/boot.oat\n"
2470        "\n"
2471        "  --class-filter=<class name>: only dumps classes that contain the filter.\n"
2472        "      Example: --class-filter=com.example.foo\n"
2473        "\n"
2474        "  --method-filter=<method name>: only dumps methods that contain the filter.\n"
2475        "      Example: --method-filter=foo\n"
2476        "\n"
2477        "  --export-dex-to=<directory>: may be used to export oat embedded dex files.\n"
2478        "      Example: --export-dex-to=/data/local/tmp\n"
2479        "\n"
2480        "  --addr2instr=<address>: output matching method disassembled code from relative\n"
2481        "                          address (e.g. PC from crash dump)\n"
2482        "      Example: --addr2instr=0x00001a3b\n"
2483        "\n";
2484
2485    return usage;
2486  }
2487
2488 public:
2489  const char* oat_filename_ = nullptr;
2490  const char* class_filter_ = "";
2491  const char* method_filter_ = "";
2492  const char* image_location_ = nullptr;
2493  std::string elf_filename_prefix_;
2494  bool dump_raw_mapping_table_ = false;
2495  bool dump_raw_gc_map_ = false;
2496  bool dump_vmap_ = true;
2497  bool dump_code_info_stack_maps_ = false;
2498  bool disassemble_code_ = true;
2499  bool symbolize_ = false;
2500  bool list_classes_ = false;
2501  bool list_methods_ = false;
2502  uint32_t addr2instr_ = 0;
2503  const char* export_dex_location_ = nullptr;
2504};
2505
2506struct OatdumpMain : public CmdlineMain<OatdumpArgs> {
2507  virtual bool NeedsRuntime() OVERRIDE {
2508    CHECK(args_ != nullptr);
2509
2510    // If we are only doing the oat file, disable absolute_addresses. Keep them for image dumping.
2511    bool absolute_addresses = (args_->oat_filename_ == nullptr);
2512
2513    oat_dumper_options_ = std::unique_ptr<OatDumperOptions>(new OatDumperOptions(
2514        args_->dump_raw_mapping_table_,
2515        args_->dump_raw_gc_map_,
2516        args_->dump_vmap_,
2517        args_->dump_code_info_stack_maps_,
2518        args_->disassemble_code_,
2519        absolute_addresses,
2520        args_->class_filter_,
2521        args_->method_filter_,
2522        args_->list_classes_,
2523        args_->list_methods_,
2524        args_->export_dex_location_,
2525        args_->addr2instr_));
2526
2527    return (args_->boot_image_location_ != nullptr || args_->image_location_ != nullptr) &&
2528          !args_->symbolize_;
2529  }
2530
2531  virtual bool ExecuteWithoutRuntime() OVERRIDE {
2532    CHECK(args_ != nullptr);
2533    CHECK(args_->oat_filename_ != nullptr);
2534
2535    MemMap::Init();
2536
2537    if (args_->symbolize_) {
2538      return SymbolizeOat(args_->oat_filename_, args_->output_name_) == EXIT_SUCCESS;
2539    } else {
2540      return DumpOat(nullptr,
2541                     args_->oat_filename_,
2542                     oat_dumper_options_.get(),
2543                     args_->os_) == EXIT_SUCCESS;
2544    }
2545  }
2546
2547  virtual bool ExecuteWithRuntime(Runtime* runtime) {
2548    CHECK(args_ != nullptr);
2549
2550    if (args_->oat_filename_ != nullptr) {
2551      return DumpOat(runtime,
2552                     args_->oat_filename_,
2553                     oat_dumper_options_.get(),
2554                     args_->os_) == EXIT_SUCCESS;
2555    }
2556
2557    return DumpImage(runtime, args_->image_location_, oat_dumper_options_.get(), args_->os_)
2558      == EXIT_SUCCESS;
2559  }
2560
2561  std::unique_ptr<OatDumperOptions> oat_dumper_options_;
2562};
2563
2564}  // namespace art
2565
2566int main(int argc, char** argv) {
2567  art::OatdumpMain main;
2568  return main.Main(argc, argv);
2569}
2570