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