blob: 89826c6863fc5c9b28a4d71a50438892a395c30d [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
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 */
Brian Carlstrom78128a62011-09-15 17:21:19 -070016
17#include <stdio.h>
18#include <stdlib.h>
19
Brian Carlstrom27ec9612011-09-19 20:20:38 -070020#include <fstream>
David Srbecky86decb62018-06-05 06:41:10 +010021#include <iomanip>
Brian Carlstrom27ec9612011-09-19 20:20:38 -070022#include <iostream>
Igor Murashkin37743352014-11-13 14:38:00 -080023#include <map>
24#include <set>
Brian Carlstrom78128a62011-09-15 17:21:19 -070025#include <string>
Andreas Gampe54fc26c2014-09-04 21:47:42 -070026#include <unordered_map>
Andreas Gampe9fded872016-09-25 16:08:35 -070027#include <unordered_set>
Brian Carlstrom78128a62011-09-15 17:21:19 -070028#include <vector>
29
Andreas Gampe221d9812018-01-22 17:48:56 -080030#include "android-base/logging.h"
Andreas Gampef9411702018-09-06 17:16:57 -070031#include "android-base/parseint.h"
Andreas Gampe46ee31b2016-12-14 10:11:49 -080032#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080033#include "android-base/strings.h"
34
Ian Rogersd582fa42014-11-05 23:46:43 -080035#include "arch/instruction_set_features.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070036#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070037#include "art_method-inl.h"
Vladimir Markof3c52b42017-11-17 17:32:12 +000038#include "base/bit_utils_iterator.h"
David Sehr9c4a0152018-04-05 12:23:54 -070039#include "base/indenter.h"
David Sehrc431b9d2018-03-02 12:01:51 -080040#include "base/os.h"
David Sehr67bf42e2018-02-26 16:43:04 -080041#include "base/safe_map.h"
David Srbecky86decb62018-06-05 06:41:10 +010042#include "base/stats.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000043#include "base/stl_util.h"
Elliott Hughes76160052012-12-12 16:31:20 -080044#include "base/unix_file/fd_file.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080045#include "class_linker-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070046#include "class_linker.h"
Vladimir Markoa8bba7d2018-05-30 15:18:48 +010047#include "class_root.h"
Vladimir Markod8dbc8d2017-09-20 13:37:47 +010048#include "compiled_method.h"
David Srbecky32210b92017-12-04 14:39:21 +000049#include "debug/debug_info.h"
David Srbecky5d950762016-03-07 20:47:29 +000050#include "debug/elf_debug_writer.h"
51#include "debug/method_debug_info.h"
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +030052#include "dex/art_dex_file_loader.h"
Mathieu Chartier3d092992018-05-24 13:36:23 -070053#include "dex/class_accessor-inl.h"
David Sehr9e734c72018-01-04 17:56:19 -080054#include "dex/code_item_accessors-inl.h"
David Sehrb2ec9f52018-02-21 13:20:31 -080055#include "dex/descriptors_names.h"
David Sehr9e734c72018-01-04 17:56:19 -080056#include "dex/dex_file-inl.h"
57#include "dex/dex_instruction-inl.h"
David Sehr312f3b22018-03-19 08:39:26 -070058#include "dex/string_reference.h"
David Sehr9c4a0152018-04-05 12:23:54 -070059#include "dex/type_lookup_table.h"
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +030060#include "dexlayout.h"
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080061#include "disassembler.h"
Andreas Gampe0c183382017-07-13 22:26:24 -070062#include "gc/accounting/space_bitmap-inl.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070063#include "gc/space/image_space.h"
64#include "gc/space/large_object_space.h"
65#include "gc/space/space-inl.h"
Mathieu Chartier4a26f172016-01-26 14:26:18 -080066#include "image-inl.h"
Andreas Gampe9fded872016-09-25 16:08:35 -070067#include "imtable-inl.h"
Igor Murashkin86083f72017-10-27 10:59:04 -070068#include "subtype_check.h"
Vladimir Markof3c52b42017-11-17 17:32:12 +000069#include "index_bss_mapping.h"
Andreas Gampeebfc1ac2016-09-29 19:50:27 -070070#include "interpreter/unstarted_runtime.h"
Vladimir Marko131980f2015-12-03 18:29:23 +000071#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000072#include "linker/elf_builder.h"
Vladimir Marko131980f2015-12-03 18:29:23 +000073#include "linker/file_output_stream.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080074#include "mirror/array-inl.h"
75#include "mirror/class-inl.h"
Vladimir Marko05792b92015-08-03 11:56:49 +010076#include "mirror/dex_cache-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080077#include "mirror/object-inl.h"
78#include "mirror/object_array-inl.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080079#include "oat.h"
Vladimir Marko8a630572014-04-09 18:45:35 +010080#include "oat_file-inl.h"
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070081#include "oat_file_manager.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070082#include "scoped_thread_state_change-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070083#include "stack.h"
Mathieu Chartierdc00f182016-07-14 10:10:44 -070084#include "stack_map.h"
Mathieu Chartierc22c59e2014-02-24 15:16:06 -080085#include "thread_list.h"
Nicolas Geoffray4acefd32016-10-24 13:14:58 +010086#include "vdex_file.h"
Ian Rogers2bcb4a42012-11-08 10:39:18 -080087#include "verifier/method_verifier.h"
Nicolas Geoffraye70dd562016-10-30 21:03:35 +000088#include "verifier/verifier_deps.h"
Andreas Gampe00b25f32014-09-17 21:49:05 -070089#include "well_known_classes.h"
Brian Carlstrom78128a62011-09-15 17:21:19 -070090
Igor Murashkin37743352014-11-13 14:38:00 -080091#include <sys/stat.h>
92#include "cmdline.h"
Brian Carlstrom78128a62011-09-15 17:21:19 -070093
Igor Murashkin37743352014-11-13 14:38:00 -080094namespace art {
Brian Carlstrom78128a62011-09-15 17:21:19 -070095
Andreas Gampe46ee31b2016-12-14 10:11:49 -080096using android::base::StringPrintf;
97
Mathieu Chartiere401d142015-04-22 13:56:20 -070098const char* image_methods_descriptions_[] = {
Ian Rogers19846512012-02-24 11:42:47 -080099 "kResolutionMethod",
Jeff Hao88474b42013-10-23 16:24:40 -0700100 "kImtConflictMethod",
Mathieu Chartier2d2621a2014-10-23 16:48:06 -0700101 "kImtUnimplementedMethod",
Vladimir Markofd36f1f2016-08-03 18:49:58 +0100102 "kSaveAllCalleeSavesMethod",
103 "kSaveRefsOnlyMethod",
104 "kSaveRefsAndArgsMethod",
Vladimir Marko952dbb12016-07-28 12:01:51 +0100105 "kSaveEverythingMethod",
Mingyao Yang0a87a652017-04-12 13:43:15 -0700106 "kSaveEverythingMethodForClinit",
107 "kSaveEverythingMethodForSuspendCheck",
Mathieu Chartiere401d142015-04-22 13:56:20 -0700108};
109
110const char* image_roots_descriptions_[] = {
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700111 "kDexCaches",
Brian Carlstrom34f426c2011-10-04 12:58:02 -0700112 "kClassRoots",
Vladimir Markoc13fbd82018-06-04 16:16:28 +0100113 "kOomeWhenThrowingException",
114 "kOomeWhenThrowingOome",
115 "kOomeWhenHandlingStackOverflow",
116 "kNoClassDefFoundError",
Alex Light885f0c12019-01-09 13:48:55 -0800117 "kSpecialRoots",
Brian Carlstrom78128a62011-09-15 17:21:19 -0700118};
119
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700120// Map is so that we don't allocate multiple dex files for the same OatDexFile.
Andreas Gampeb40d3612018-06-26 15:49:42 -0700121static std::map<const OatDexFile*, std::unique_ptr<const DexFile>> opened_dex_files;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700122
Andreas Gampeb40d3612018-06-26 15:49:42 -0700123const DexFile* OpenDexFile(const OatDexFile* oat_dex_file, std::string* error_msg) {
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700124 DCHECK(oat_dex_file != nullptr);
125 auto it = opened_dex_files.find(oat_dex_file);
126 if (it != opened_dex_files.end()) {
127 return it->second.get();
128 }
129 const DexFile* ret = oat_dex_file->OpenDexFile(error_msg).release();
130 opened_dex_files.emplace(oat_dex_file, std::unique_ptr<const DexFile>(ret));
131 return ret;
132}
133
Andreas Gampe2d8614b2016-03-07 16:31:34 -0800134template <typename ElfTypes>
Roland Levillainbbc6e7e2018-08-24 16:58:47 +0100135class OatSymbolizer final {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700136 public:
David Srbecky2fdd03c2016-03-10 15:32:37 +0000137 OatSymbolizer(const OatFile* oat_file, const std::string& output_name, bool no_bits) :
138 oat_file_(oat_file),
139 builder_(nullptr),
140 output_name_(output_name.empty() ? "symbolized.oat" : output_name),
141 no_bits_(no_bits) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700142 }
143
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700144 bool Symbolize() {
David Srbecky6d8c8f02015-10-26 10:57:09 +0000145 const InstructionSet isa = oat_file_->GetOatHeader().GetInstructionSet();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800146 std::unique_ptr<const InstructionSetFeatures> features = InstructionSetFeatures::FromBitmap(
David Srbecky5d811202016-03-08 13:21:22 +0000147 isa, oat_file_->GetOatHeader().GetInstructionSetFeaturesBitmap());
David Srbecky6d8c8f02015-10-26 10:57:09 +0000148
Andreas Gampe08c277c2017-04-26 22:22:15 -0700149 std::unique_ptr<File> elf_file(OS::CreateEmptyFile(output_name_.c_str()));
150 if (elf_file == nullptr) {
151 return false;
152 }
Vladimir Marko74527972016-11-29 15:57:32 +0000153 std::unique_ptr<linker::BufferedOutputStream> output_stream =
154 std::make_unique<linker::BufferedOutputStream>(
155 std::make_unique<linker::FileOutputStream>(elf_file.get()));
156 builder_.reset(new linker::ElfBuilder<ElfTypes>(isa, features.get(), output_stream.get()));
David Srbecky6d8c8f02015-10-26 10:57:09 +0000157
158 builder_->Start();
159
160 auto* rodata = builder_->GetRoData();
161 auto* text = builder_->GetText();
David Srbecky6d8c8f02015-10-26 10:57:09 +0000162
David Srbecky6d8c8f02015-10-26 10:57:09 +0000163 const uint8_t* rodata_begin = oat_file_->Begin();
164 const size_t rodata_size = oat_file_->GetOatHeader().GetExecutableOffset();
David Srbeckye155f4b2017-12-06 15:18:38 +0000165 if (!no_bits_) {
David Srbecky2fdd03c2016-03-10 15:32:37 +0000166 rodata->Start();
167 rodata->WriteFully(rodata_begin, rodata_size);
168 rodata->End();
169 }
David Srbecky6d8c8f02015-10-26 10:57:09 +0000170
David Srbecky6d8c8f02015-10-26 10:57:09 +0000171 const uint8_t* text_begin = oat_file_->Begin() + rodata_size;
172 const size_t text_size = oat_file_->End() - text_begin;
David Srbeckye155f4b2017-12-06 15:18:38 +0000173 if (!no_bits_) {
David Srbecky2fdd03c2016-03-10 15:32:37 +0000174 text->Start();
175 text->WriteFully(text_begin, text_size);
176 text->End();
177 }
David Srbecky6d8c8f02015-10-26 10:57:09 +0000178
Vladimir Marko33bff252017-11-01 14:35:42 +0000179 if (isa == InstructionSet::kMips || isa == InstructionSet::kMips64) {
Douglas Leung316a2182015-09-17 15:26:25 -0700180 builder_->WriteMIPSabiflagsSection();
181 }
Vladimir Markoaad75c62016-10-03 08:46:48 +0000182 builder_->PrepareDynamicSection(elf_file->GetPath(),
183 rodata_size,
184 text_size,
Vladimir Markob066d432018-01-03 13:14:37 +0000185 oat_file_->DataBimgRelRoSize(),
Vladimir Markoaad75c62016-10-03 08:46:48 +0000186 oat_file_->BssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +0100187 oat_file_->BssMethodsOffset(),
David Srbeckyec2cdf42017-12-08 16:21:25 +0000188 oat_file_->BssRootsOffset(),
189 oat_file_->VdexSize());
Vladimir Marko944da602016-02-19 12:27:55 +0000190 builder_->WriteDynamicSection();
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700191
Vladimir Marko1b404a82017-09-01 13:35:26 +0100192 const OatHeader& oat_header = oat_file_->GetOatHeader();
193 #define DO_TRAMPOLINE(fn_name) \
194 if (oat_header.Get ## fn_name ## Offset() != 0) { \
195 debug::MethodDebugInfo info = {}; \
David Srbeckyc684f332018-01-19 17:38:06 +0000196 info.custom_name = #fn_name; \
Vladimir Marko1b404a82017-09-01 13:35:26 +0100197 info.isa = oat_header.GetInstructionSet(); \
198 info.is_code_address_text_relative = true; \
199 size_t code_offset = oat_header.Get ## fn_name ## Offset(); \
200 code_offset -= CompiledCode::CodeDelta(oat_header.GetInstructionSet()); \
201 info.code_address = code_offset - oat_header.GetExecutableOffset(); \
202 info.code_size = 0; /* The symbol lasts until the next symbol. */ \
203 method_debug_infos_.push_back(std::move(info)); \
204 }
205 DO_TRAMPOLINE(InterpreterToInterpreterBridge)
206 DO_TRAMPOLINE(InterpreterToCompiledCodeBridge)
207 DO_TRAMPOLINE(JniDlsymLookup);
208 DO_TRAMPOLINE(QuickGenericJniTrampoline);
209 DO_TRAMPOLINE(QuickImtConflictTrampoline);
210 DO_TRAMPOLINE(QuickResolutionTrampoline);
211 DO_TRAMPOLINE(QuickToInterpreterBridge);
212 #undef DO_TRAMPOLINE
213
David Srbecky5d950762016-03-07 20:47:29 +0000214 Walk();
Vladimir Marko1b404a82017-09-01 13:35:26 +0100215
216 // TODO: Try to symbolize link-time thunks?
217 // This would require disassembling all methods to find branches outside the method code.
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700218
David Srbecky32210b92017-12-04 14:39:21 +0000219 // TODO: Add symbols for dex bytecode in the .dex section.
220
221 debug::DebugInfo debug_info{};
222 debug_info.compiled_methods = ArrayRef<const debug::MethodDebugInfo>(method_debug_infos_);
223
David Srbecky5d950762016-03-07 20:47:29 +0000224 debug::WriteDebugInfo(builder_.get(),
David Srbecky32210b92017-12-04 14:39:21 +0000225 debug_info,
David Srbecky5d950762016-03-07 20:47:29 +0000226 dwarf::DW_DEBUG_FRAME_FORMAT,
Andreas Gampe9b031f72018-10-04 11:03:34 -0700227 /* write_oat_patches= */ true);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700228
David Srbecky6d8c8f02015-10-26 10:57:09 +0000229 builder_->End();
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700230
Andreas Gampe08c277c2017-04-26 22:22:15 -0700231 bool ret_value = builder_->Good();
232
233 builder_.reset();
234 output_stream.reset();
235
236 if (elf_file->FlushCloseOrErase() != 0) {
237 return false;
238 }
239 elf_file.reset();
240
241 return ret_value;
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700242 }
243
David Srbecky5d950762016-03-07 20:47:29 +0000244 void Walk() {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700245 std::vector<const OatDexFile*> oat_dex_files = oat_file_->GetOatDexFiles();
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700246 for (size_t i = 0; i < oat_dex_files.size(); i++) {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700247 const OatDexFile* oat_dex_file = oat_dex_files[i];
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700248 CHECK(oat_dex_file != nullptr);
David Srbecky5d950762016-03-07 20:47:29 +0000249 WalkOatDexFile(oat_dex_file);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700250 }
251 }
252
Andreas Gampeb40d3612018-06-26 15:49:42 -0700253 void WalkOatDexFile(const OatDexFile* oat_dex_file) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700254 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700255 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
256 if (dex_file == nullptr) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700257 return;
258 }
259 for (size_t class_def_index = 0;
260 class_def_index < dex_file->NumClassDefs();
261 class_def_index++) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700262 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
263 OatClassType type = oat_class.GetType();
264 switch (type) {
265 case kOatClassAllCompiled:
266 case kOatClassSomeCompiled:
David Srbecky5d950762016-03-07 20:47:29 +0000267 WalkOatClass(oat_class, *dex_file, class_def_index);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700268 break;
269
270 case kOatClassNoneCompiled:
271 case kOatClassMax:
272 // Ignore.
273 break;
274 }
275 }
276 }
277
David Srbecky5d950762016-03-07 20:47:29 +0000278 void WalkOatClass(const OatFile::OatClass& oat_class,
279 const DexFile& dex_file,
280 uint32_t class_def_index) {
Mathieu Chartier18e26872018-06-04 17:19:02 -0700281 ClassAccessor accessor(dex_file, class_def_index);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700282 // Note: even if this is an interface or a native class, we still have to walk it, as there
283 // might be a static initializer.
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700284 uint32_t class_method_idx = 0;
Mathieu Chartier3d092992018-05-24 13:36:23 -0700285 for (const ClassAccessor::Method& method : accessor.GetMethods()) {
David Srbecky5d950762016-03-07 20:47:29 +0000286 WalkOatMethod(oat_class.GetOatMethod(class_method_idx++),
287 dex_file,
288 class_def_index,
Mathieu Chartier3d092992018-05-24 13:36:23 -0700289 method.GetIndex(),
290 method.GetCodeItem(),
291 method.GetAccessFlags());
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700292 }
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700293 }
294
David Srbecky5d950762016-03-07 20:47:29 +0000295 void WalkOatMethod(const OatFile::OatMethod& oat_method,
296 const DexFile& dex_file,
297 uint32_t class_def_index,
298 uint32_t dex_method_index,
Andreas Gampe3f1dcd32018-12-28 09:39:56 -0800299 const dex::CodeItem* code_item,
David Srbecky5d950762016-03-07 20:47:29 +0000300 uint32_t method_access_flags) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700301 if ((method_access_flags & kAccAbstract) != 0) {
302 // Abstract method, no code.
303 return;
304 }
David Srbecky5d950762016-03-07 20:47:29 +0000305 const OatHeader& oat_header = oat_file_->GetOatHeader();
306 const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader();
307 if (method_header == nullptr || method_header->GetCodeSize() == 0) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700308 // No code.
309 return;
310 }
311
David Srbeckya1b4c5f2016-03-31 18:17:59 +0100312 uint32_t entry_point = oat_method.GetCodeOffset() - oat_header.GetExecutableOffset();
313 // Clear Thumb2 bit.
314 const void* code_address = EntryPointToCodePointer(reinterpret_cast<void*>(entry_point));
315
Vladimir Marko1b404a82017-09-01 13:35:26 +0100316 debug::MethodDebugInfo info = {};
David Srbeckyc684f332018-01-19 17:38:06 +0000317 DCHECK(info.custom_name.empty());
David Srbecky5d950762016-03-07 20:47:29 +0000318 info.dex_file = &dex_file;
319 info.class_def_index = class_def_index;
320 info.dex_method_index = dex_method_index;
321 info.access_flags = method_access_flags;
322 info.code_item = code_item;
323 info.isa = oat_header.GetInstructionSet();
324 info.deduped = !seen_offsets_.insert(oat_method.GetCodeOffset()).second;
325 info.is_native_debuggable = oat_header.IsNativeDebuggable();
326 info.is_optimized = method_header->IsOptimized();
327 info.is_code_address_text_relative = true;
David Srbeckya1b4c5f2016-03-31 18:17:59 +0100328 info.code_address = reinterpret_cast<uintptr_t>(code_address);
David Srbecky5d950762016-03-07 20:47:29 +0000329 info.code_size = method_header->GetCodeSize();
330 info.frame_size_in_bytes = method_header->GetFrameSizeInBytes();
331 info.code_info = info.is_optimized ? method_header->GetOptimizedCodeInfoPtr() : nullptr;
332 info.cfi = ArrayRef<uint8_t>();
333 method_debug_infos_.push_back(info);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700334 }
335
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700336 private:
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700337 const OatFile* oat_file_;
Vladimir Marko74527972016-11-29 15:57:32 +0000338 std::unique_ptr<linker::ElfBuilder<ElfTypes>> builder_;
David Srbecky5d950762016-03-07 20:47:29 +0000339 std::vector<debug::MethodDebugInfo> method_debug_infos_;
340 std::unordered_set<uint32_t> seen_offsets_;
Ian Rogers0279ebb2014-10-08 17:27:48 -0700341 const std::string output_name_;
David Srbecky2fdd03c2016-03-10 15:32:37 +0000342 bool no_bits_;
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700343};
344
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700345class OatDumperOptions {
346 public:
Vladimir Marko9d07e3d2016-03-31 12:02:28 +0100347 OatDumperOptions(bool dump_vmap,
Roland Levillainf2650d12015-05-28 14:53:28 +0100348 bool dump_code_info_stack_maps,
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700349 bool disassemble_code,
Andreas Gampe00b25f32014-09-17 21:49:05 -0700350 bool absolute_addresses,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800351 const char* class_filter,
352 const char* method_filter,
353 bool list_classes,
354 bool list_methods,
David Brazdilc03d7b62016-03-02 12:18:03 +0000355 bool dump_header_only,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800356 const char* export_dex_location,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -0800357 const char* app_image,
358 const char* app_oat,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800359 uint32_t addr2instr)
Vladimir Marko9d07e3d2016-03-31 12:02:28 +0100360 : dump_vmap_(dump_vmap),
Roland Levillainf2650d12015-05-28 14:53:28 +0100361 dump_code_info_stack_maps_(dump_code_info_stack_maps),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700362 disassemble_code_(disassemble_code),
Andreas Gampe00b25f32014-09-17 21:49:05 -0700363 absolute_addresses_(absolute_addresses),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800364 class_filter_(class_filter),
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +0000365 method_filter_(method_filter),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800366 list_classes_(list_classes),
367 list_methods_(list_methods),
David Brazdilc03d7b62016-03-02 12:18:03 +0000368 dump_header_only_(dump_header_only),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800369 export_dex_location_(export_dex_location),
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -0800370 app_image_(app_image),
371 app_oat_(app_oat),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800372 addr2instr_(addr2instr),
Igor Murashkin37743352014-11-13 14:38:00 -0800373 class_loader_(nullptr) {}
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700374
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700375 const bool dump_vmap_;
Roland Levillainf2650d12015-05-28 14:53:28 +0100376 const bool dump_code_info_stack_maps_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700377 const bool disassemble_code_;
378 const bool absolute_addresses_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800379 const char* const class_filter_;
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +0000380 const char* const method_filter_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800381 const bool list_classes_;
382 const bool list_methods_;
David Brazdilc03d7b62016-03-02 12:18:03 +0000383 const bool dump_header_only_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800384 const char* const export_dex_location_;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -0800385 const char* const app_image_;
386 const char* const app_oat_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800387 uint32_t addr2instr_;
Andreas Gampe00b25f32014-09-17 21:49:05 -0700388 Handle<mirror::ClassLoader>* class_loader_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700389};
390
Elliott Hughese3c845c2012-02-28 17:23:01 -0800391class OatDumper {
Brian Carlstromaded5f72011-10-07 17:15:04 -0700392 public:
Roland Levillain3887c462015-08-12 18:15:42 +0100393 OatDumper(const OatFile& oat_file, const OatDumperOptions& options)
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000394 : oat_file_(oat_file),
Elliott Hughesa72ec822012-03-05 17:12:22 -0800395 oat_dex_files_(oat_file.GetOatDexFiles()),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700396 options_(options),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800397 resolved_addr2instr_(0),
Mathieu Chartiera7dd0382014-11-20 17:08:58 -0800398 instruction_set_(oat_file_.GetOatHeader().GetInstructionSet()),
399 disassembler_(Disassembler::Create(instruction_set_,
Andreas Gampe372f3a32016-08-19 10:49:06 -0700400 new DisassemblerOptions(
401 options_.absolute_addresses_,
402 oat_file.Begin(),
403 oat_file.End(),
Andreas Gampe9b031f72018-10-04 11:03:34 -0700404 /* can_read_literals_= */ true,
Andreas Gampe372f3a32016-08-19 10:49:06 -0700405 Is64BitInstructionSet(instruction_set_)
406 ? &Thread::DumpThreadOffset<PointerSize::k64>
407 : &Thread::DumpThreadOffset<PointerSize::k32>))) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800408 CHECK(options_.class_loader_ != nullptr);
409 CHECK(options_.class_filter_ != nullptr);
410 CHECK(options_.method_filter_ != nullptr);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800411 AddAllOffsets();
412 }
413
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700414 ~OatDumper() {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700415 delete disassembler_;
416 }
417
Mathieu Chartiera7dd0382014-11-20 17:08:58 -0800418 InstructionSet GetInstructionSet() {
419 return instruction_set_;
420 }
421
Andreas Gampec55bb392018-09-21 00:02:02 +0000422 using DexFileUniqV = std::vector<std::unique_ptr<const DexFile>>;
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300423
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700424 bool Dump(std::ostream& os) {
425 bool success = true;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800426 const OatHeader& oat_header = oat_file_.GetOatHeader();
Brian Carlstromaded5f72011-10-07 17:15:04 -0700427
428 os << "MAGIC:\n";
429 os << oat_header.GetMagic() << "\n\n";
430
Jeff Hao4b07a6e2016-01-15 12:50:44 -0800431 os << "LOCATION:\n";
432 os << oat_file_.GetLocation() << "\n\n";
433
Brian Carlstromaded5f72011-10-07 17:15:04 -0700434 os << "CHECKSUM:\n";
Elliott Hughesed2adb62012-02-29 14:41:01 -0800435 os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum());
Brian Carlstromaded5f72011-10-07 17:15:04 -0700436
Elliott Hughesa72ec822012-03-05 17:12:22 -0800437 os << "INSTRUCTION SET:\n";
438 os << oat_header.GetInstructionSet() << "\n\n";
439
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700440 {
441 std::unique_ptr<const InstructionSetFeatures> features(
442 InstructionSetFeatures::FromBitmap(oat_header.GetInstructionSet(),
443 oat_header.GetInstructionSetFeaturesBitmap()));
444 os << "INSTRUCTION SET FEATURES:\n";
445 os << features->GetFeatureString() << "\n\n";
446 }
Dave Allison70202782013-10-22 17:52:19 -0700447
Brian Carlstromaded5f72011-10-07 17:15:04 -0700448 os << "DEX FILE COUNT:\n";
449 os << oat_header.GetDexFileCount() << "\n\n";
450
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800451#define DUMP_OAT_HEADER_OFFSET(label, offset) \
452 os << label " OFFSET:\n"; \
453 os << StringPrintf("0x%08x", oat_header.offset()); \
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800454 if (oat_header.offset() != 0 && options_.absolute_addresses_) { \
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800455 os << StringPrintf(" (%p)", oat_file_.Begin() + oat_header.offset()); \
456 } \
457 os << StringPrintf("\n\n");
458
459 DUMP_OAT_HEADER_OFFSET("EXECUTABLE", GetExecutableOffset);
460 DUMP_OAT_HEADER_OFFSET("INTERPRETER TO INTERPRETER BRIDGE",
461 GetInterpreterToInterpreterBridgeOffset);
462 DUMP_OAT_HEADER_OFFSET("INTERPRETER TO COMPILED CODE BRIDGE",
463 GetInterpreterToCompiledCodeBridgeOffset);
464 DUMP_OAT_HEADER_OFFSET("JNI DLSYM LOOKUP",
465 GetJniDlsymLookupOffset);
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800466 DUMP_OAT_HEADER_OFFSET("QUICK GENERIC JNI TRAMPOLINE",
467 GetQuickGenericJniTrampolineOffset);
468 DUMP_OAT_HEADER_OFFSET("QUICK IMT CONFLICT TRAMPOLINE",
469 GetQuickImtConflictTrampolineOffset);
470 DUMP_OAT_HEADER_OFFSET("QUICK RESOLUTION TRAMPOLINE",
471 GetQuickResolutionTrampolineOffset);
472 DUMP_OAT_HEADER_OFFSET("QUICK TO INTERPRETER BRIDGE",
473 GetQuickToInterpreterBridgeOffset);
474#undef DUMP_OAT_HEADER_OFFSET
Brian Carlstromaded5f72011-10-07 17:15:04 -0700475
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700476 // Print the key-value store.
477 {
478 os << "KEY VALUE STORE:\n";
479 size_t index = 0;
480 const char* key;
481 const char* value;
482 while (oat_header.GetStoreKeyValuePairByIndex(index, &key, &value)) {
483 os << key << " = " << value << "\n";
484 index++;
485 }
486 os << "\n";
487 }
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700488
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800489 if (options_.absolute_addresses_) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700490 os << "BEGIN:\n";
491 os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -0700492
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700493 os << "END:\n";
494 os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n";
495 }
496
497 os << "SIZE:\n";
498 os << oat_file_.Size() << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -0700499
500 os << std::flush;
501
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800502 // If set, adjust relative address to be searched
503 if (options_.addr2instr_ != 0) {
504 resolved_addr2instr_ = options_.addr2instr_ + oat_header.GetExecutableOffset();
505 os << "SEARCH ADDRESS (executable offset + input):\n";
506 os << StringPrintf("0x%08x\n\n", resolved_addr2instr_);
507 }
508
Vladimir Marko812fb4d2018-03-14 13:07:21 +0000509 // Dump .data.bimg.rel.ro entries.
510 DumpDataBimgRelRoEntries(os);
511
512 // Dump .bss summary, individual entries are dumped per dex file.
513 os << ".bss: ";
514 if (oat_file_.GetBssMethods().empty() && oat_file_.GetBssGcRoots().empty()) {
515 os << "empty.\n\n";
516 } else {
517 os << oat_file_.GetBssMethods().size() << " methods, ";
518 os << oat_file_.GetBssGcRoots().size() << " GC roots.\n\n";
519 }
520
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700521 // Dumping the dex file overview is compact enough to do even if header only.
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700522 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700523 const OatDexFile* oat_dex_file = oat_dex_files_[i];
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700524 CHECK(oat_dex_file != nullptr);
525 std::string error_msg;
526 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
527 if (dex_file == nullptr) {
528 os << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation() << "': "
529 << error_msg;
530 continue;
531 }
Mathieu Chartierba4c1182018-05-24 14:05:55 -0700532
Mathieu Chartier120aa282017-08-05 16:03:03 -0700533 const DexLayoutSections* const layout_sections = oat_dex_file->GetDexLayoutSections();
534 if (layout_sections != nullptr) {
535 os << "Layout data\n";
536 os << *layout_sections;
537 os << "\n";
538 }
539
Vladimir Markobacb8e42018-06-13 14:45:30 +0100540 if (!options_.dump_header_only_) {
541 // Dump .bss entries.
542 DumpBssEntries(
543 os,
544 "ArtMethod",
545 oat_dex_file->GetMethodBssMapping(),
546 dex_file->NumMethodIds(),
547 static_cast<size_t>(GetInstructionSetPointerSize(instruction_set_)),
548 [=](uint32_t index) { return dex_file->PrettyMethod(index); });
549 DumpBssEntries(
550 os,
551 "Class",
552 oat_dex_file->GetTypeBssMapping(),
553 dex_file->NumTypeIds(),
554 sizeof(GcRoot<mirror::Class>),
555 [=](uint32_t index) { return dex_file->PrettyType(dex::TypeIndex(index)); });
556 DumpBssEntries(
557 os,
558 "String",
559 oat_dex_file->GetStringBssMapping(),
560 dex_file->NumStringIds(),
561 sizeof(GcRoot<mirror::Class>),
562 [=](uint32_t index) { return dex_file->StringDataByIdx(dex::StringIndex(index)); });
563 }
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700564 }
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700565
David Brazdilc03d7b62016-03-02 12:18:03 +0000566 if (!options_.dump_header_only_) {
Nicolas Geoffraye70dd562016-10-30 21:03:35 +0000567 VariableIndentationOutputStream vios(&os);
Nicolas Geoffray3a293552018-03-02 10:52:16 +0000568 VdexFile::VerifierDepsHeader vdex_header = oat_file_.GetVdexFile()->GetVerifierDepsHeader();
Nicolas Geoffraye70dd562016-10-30 21:03:35 +0000569 if (vdex_header.IsValid()) {
570 std::string error_msg;
571 std::vector<const DexFile*> dex_files;
572 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
573 const DexFile* dex_file = OpenDexFile(oat_dex_files_[i], &error_msg);
574 if (dex_file == nullptr) {
575 os << "Error opening dex file: " << error_msg << std::endl;
576 return false;
577 }
578 dex_files.push_back(dex_file);
579 }
580 verifier::VerifierDeps deps(dex_files, oat_file_.GetVdexFile()->GetVerifierDepsData());
581 deps.Dump(&vios);
582 } else {
583 os << "UNRECOGNIZED vdex file, magic "
584 << vdex_header.GetMagic()
Nicolas Geoffray3a293552018-03-02 10:52:16 +0000585 << ", verifier deps version "
586 << vdex_header.GetVerifierDepsVersion()
587 << ", dex section version "
588 << vdex_header.GetDexSectionVersion()
Nicolas Geoffraye70dd562016-10-30 21:03:35 +0000589 << "\n";
590 }
David Brazdilc03d7b62016-03-02 12:18:03 +0000591 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700592 const OatDexFile* oat_dex_file = oat_dex_files_[i];
David Brazdilc03d7b62016-03-02 12:18:03 +0000593 CHECK(oat_dex_file != nullptr);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300594 if (!DumpOatDexFile(os, *oat_dex_file)) {
595 success = false;
596 }
597 }
598 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800599
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300600 if (options_.export_dex_location_) {
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000601 std::string error_msg;
602 std::string vdex_filename = GetVdexFilename(oat_file_.GetLocation());
603 if (!OS::FileExists(vdex_filename.c_str())) {
604 os << "File " << vdex_filename.c_str() << " does not exist\n";
605 return false;
606 }
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300607
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000608 DexFileUniqV vdex_dex_files;
609 std::unique_ptr<const VdexFile> vdex_file = OpenVdexUnquicken(vdex_filename,
610 &vdex_dex_files,
611 &error_msg);
612 if (vdex_file.get() == nullptr) {
613 os << "Failed to open vdex file: " << error_msg << "\n";
614 return false;
615 }
616 if (oat_dex_files_.size() != vdex_dex_files.size()) {
617 os << "Dex files number in Vdex file does not match Dex files number in Oat file: "
618 << vdex_dex_files.size() << " vs " << oat_dex_files_.size() << '\n';
619 return false;
620 }
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300621
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000622 size_t i = 0;
623 for (const auto& vdex_dex_file : vdex_dex_files) {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700624 const OatDexFile* oat_dex_file = oat_dex_files_[i];
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000625 CHECK(oat_dex_file != nullptr);
626 CHECK(vdex_dex_file != nullptr);
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300627
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300628 // If a CompactDex file is detected within a Vdex container, DexLayout is used to convert
629 // back to a StandardDex file. Since the converted DexFile will most likely not reproduce
630 // the original input Dex file, the `update_checksum_` option is used to recompute the
631 // checksum. If the vdex container does not contain cdex resources (`used_dexlayout` is
632 // false), ExportDexFile() enforces a reproducible checksum verification.
633 if (vdex_dex_file->IsCompactDexFile()) {
634 Options options;
635 options.compact_dex_level_ = CompactDexLevel::kCompactDexLevelNone;
636 options.update_checksum_ = true;
Andreas Gampe9b031f72018-10-04 11:03:34 -0700637 DexLayout dex_layout(options, /*info=*/ nullptr, /*out_file=*/ nullptr, /*header=*/ nullptr);
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300638 std::unique_ptr<art::DexContainer> dex_container;
639 bool result = dex_layout.ProcessDexFile(vdex_dex_file->GetLocation().c_str(),
640 vdex_dex_file.get(),
641 i,
642 &dex_container,
643 &error_msg);
644 if (!result) {
645 os << "DexLayout failed to process Dex file: " + error_msg;
646 success = false;
647 break;
648 }
649 DexContainer::Section* main_section = dex_container->GetMainSection();
650 CHECK_EQ(dex_container->GetDataSection()->Size(), 0u);
651
652 const ArtDexFileLoader dex_file_loader;
653 std::unique_ptr<const DexFile> dex(dex_file_loader.Open(
654 main_section->Begin(),
655 main_section->Size(),
656 vdex_dex_file->GetLocation(),
657 vdex_file->GetLocationChecksum(i),
Andreas Gampe9b031f72018-10-04 11:03:34 -0700658 /*oat_dex_file=*/ nullptr,
659 /*verify=*/ false,
660 /*verify_checksum=*/ true,
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300661 &error_msg));
662 if (dex == nullptr) {
663 os << "Failed to load DexFile from layout container: " + error_msg;
664 success = false;
665 break;
666 }
667 if (dex->IsCompactDexFile()) {
668 os <<"CompactDex conversion to StandardDex failed";
669 success = false;
670 break;
671 }
672
Andreas Gampe9b031f72018-10-04 11:03:34 -0700673 if (!ExportDexFile(os, *oat_dex_file, dex.get(), /*used_dexlayout=*/ true)) {
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300674 success = false;
675 break;
676 }
677 } else {
Andreas Gampe9b031f72018-10-04 11:03:34 -0700678 if (!ExportDexFile(os, *oat_dex_file, vdex_dex_file.get(), /*used_dexlayout=*/ false)) {
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300679 success = false;
680 break;
681 }
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300682 }
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000683 i++;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700684 }
Brian Carlstromaded5f72011-10-07 17:15:04 -0700685 }
David Brazdilc03d7b62016-03-02 12:18:03 +0000686
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800687 {
688 os << "OAT FILE STATS:\n";
689 VariableIndentationOutputStream vios(&os);
David Srbecky86decb62018-06-05 06:41:10 +0100690 stats_.AddBytes(oat_file_.Size());
691 DumpStats(vios, "OatFile", stats_, stats_.Value());
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800692 }
693
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700694 os << std::flush;
695 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700696 }
697
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800698 size_t ComputeSize(const void* oat_data) {
Ian Rogers13735952014-10-08 12:43:28 -0700699 if (reinterpret_cast<const uint8_t*>(oat_data) < oat_file_.Begin() ||
700 reinterpret_cast<const uint8_t*>(oat_data) > oat_file_.End()) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800701 return 0; // Address not in oat file
702 }
Ian Rogersef7d42f2014-01-06 12:55:46 -0800703 uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) -
704 reinterpret_cast<uintptr_t>(oat_file_.Begin());
705 auto it = offsets_.upper_bound(begin_offset);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800706 CHECK(it != offsets_.end());
Ian Rogersef7d42f2014-01-06 12:55:46 -0800707 uintptr_t end_offset = *it;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800708 return end_offset - begin_offset;
709 }
710
Mathieu Chartiera7dd0382014-11-20 17:08:58 -0800711 InstructionSet GetOatInstructionSet() {
Brian Carlstromf8bbb842012-03-14 03:01:42 -0700712 return oat_file_.GetOatHeader().GetInstructionSet();
713 }
714
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700715 const void* GetQuickOatCode(ArtMethod* m) REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800716 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700717 const OatDexFile* oat_dex_file = oat_dex_files_[i];
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700718 CHECK(oat_dex_file != nullptr);
719 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700720 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
721 if (dex_file == nullptr) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700722 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
723 << "': " << error_msg;
724 } else {
Mathieu Chartiere7c9a8c2014-11-06 16:35:45 -0800725 const char* descriptor = m->GetDeclaringClassDescriptor();
Andreas Gampe3f1dcd32018-12-28 09:39:56 -0800726 const dex::ClassDef* class_def =
David Sehr9aa352e2016-09-15 18:13:52 -0700727 OatDexFile::FindClassDef(*dex_file, descriptor, ComputeModifiedUtf8Hash(descriptor));
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700728 if (class_def != nullptr) {
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700729 uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100730 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800731 size_t method_index = m->GetMethodIndex();
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100732 return oat_class.GetOatMethod(method_index).GetQuickCode();
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800733 }
734 }
735 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700736 return nullptr;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800737 }
738
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300739 // Returns nullptr and updates error_msg if the Vdex file cannot be opened, otherwise all Dex
740 // files are fully unquickened and stored in dex_files
741 std::unique_ptr<const VdexFile> OpenVdexUnquicken(const std::string& vdex_filename,
742 /* out */ DexFileUniqV* dex_files,
743 /* out */ std::string* error_msg) {
744 std::unique_ptr<const File> file(OS::OpenFileForReading(vdex_filename.c_str()));
745 if (file == nullptr) {
746 *error_msg = "Could not open file " + vdex_filename + " for reading.";
747 return nullptr;
748 }
749
750 int64_t vdex_length = file->GetLength();
751 if (vdex_length == -1) {
752 *error_msg = "Could not read the length of file " + vdex_filename;
753 return nullptr;
754 }
755
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100756 MemMap mmap = MemMap::MapFile(
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300757 file->GetLength(),
758 PROT_READ | PROT_WRITE,
759 MAP_PRIVATE,
760 file->Fd(),
Andreas Gampe9b031f72018-10-04 11:03:34 -0700761 /* start offset= */ 0,
762 /* low_4gb= */ false,
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300763 vdex_filename.c_str(),
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100764 error_msg);
765 if (!mmap.IsValid()) {
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300766 *error_msg = "Failed to mmap file " + vdex_filename + ": " + *error_msg;
767 return nullptr;
768 }
769
Vladimir Markoc34bebf2018-08-16 16:12:49 +0100770 std::unique_ptr<VdexFile> vdex_file(new VdexFile(std::move(mmap)));
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300771 if (!vdex_file->IsValid()) {
772 *error_msg = "Vdex file is not valid";
773 return nullptr;
774 }
775
776 DexFileUniqV tmp_dex_files;
777 if (!vdex_file->OpenAllDexFiles(&tmp_dex_files, error_msg)) {
778 *error_msg = "Failed to open Dex files from Vdex: " + *error_msg;
779 return nullptr;
780 }
781
782 vdex_file->Unquicken(MakeNonOwningPointerVector(tmp_dex_files),
Andreas Gampe9b031f72018-10-04 11:03:34 -0700783 /* decompile_return_instruction= */ true);
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300784
785 *dex_files = std::move(tmp_dex_files);
786 return vdex_file;
787 }
788
David Srbecky86decb62018-06-05 06:41:10 +0100789 bool AddStatsObject(const void* address) {
790 return seen_stats_objects_.insert(address).second; // Inserted new entry.
791 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800792
David Srbecky86decb62018-06-05 06:41:10 +0100793 void DumpStats(VariableIndentationOutputStream& os,
794 const std::string& name,
795 const Stats& stats,
796 double total) {
797 if (std::fabs(stats.Value()) > 0 || !stats.Children().empty()) {
798 double percent = 100.0 * stats.Value() / total;
799 os.Stream()
800 << std::setw(40 - os.GetIndentation()) << std::left << name << std::right << " "
801 << std::setw(8) << stats.Count() << " "
802 << std::setw(12) << std::fixed << std::setprecision(3) << stats.Value() / KB << "KB "
803 << std::setw(8) << std::fixed << std::setprecision(1) << percent << "%\n";
804
805 // Sort all children by largest value first, than by name.
806 std::map<std::pair<double, std::string>, const Stats&> sorted_children;
807 for (const auto& it : stats.Children()) {
808 sorted_children.emplace(std::make_pair(-it.second.Value(), it.first), it.second);
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800809 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800810
David Srbecky86decb62018-06-05 06:41:10 +0100811 // Add "other" row to represent any amount not account for by the children.
812 Stats other;
813 other.AddBytes(stats.Value() - stats.SumChildrenValues(), stats.Count());
814 if (std::fabs(other.Value()) > 0 && !stats.Children().empty()) {
815 sorted_children.emplace(std::make_pair(-other.Value(), "(other)"), other);
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800816 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800817
David Srbecky86decb62018-06-05 06:41:10 +0100818 // Print the data.
819 ScopedIndentation indent1(&os);
820 for (const auto& it : sorted_children) {
821 DumpStats(os, it.first.second, it.second, total);
822 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800823 }
David Srbecky86decb62018-06-05 06:41:10 +0100824 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800825
Brian Carlstromaded5f72011-10-07 17:15:04 -0700826 private:
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800827 void AddAllOffsets() {
Elliott Hughese3c845c2012-02-28 17:23:01 -0800828 // We don't know the length of the code for each method, but we need to know where to stop
829 // when disassembling. What we do know is that a region of code will be followed by some other
830 // region, so if we keep a sorted sequence of the start of each region, we can infer the length
831 // of a piece of code by using upper_bound to find the start of the next region.
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800832 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
Andreas Gampeb40d3612018-06-26 15:49:42 -0700833 const OatDexFile* oat_dex_file = oat_dex_files_[i];
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700834 CHECK(oat_dex_file != nullptr);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700835 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700836 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
837 if (dex_file == nullptr) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700838 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
839 << "': " << error_msg;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800840 continue;
Elliott Hughese3c845c2012-02-28 17:23:01 -0800841 }
Ian Rogersef7d42f2014-01-06 12:55:46 -0800842 offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader()));
Mathieu Chartier3d092992018-05-24 13:36:23 -0700843 for (ClassAccessor accessor : dex_file->GetClasses()) {
Mathieu Chartier18e26872018-06-04 17:19:02 -0700844 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(accessor.GetClassDefIndex());
Mathieu Chartier3d092992018-05-24 13:36:23 -0700845 for (uint32_t class_method_index = 0;
846 class_method_index < accessor.NumMethods();
847 ++class_method_index) {
848 AddOffsets(oat_class.GetOatMethod(class_method_index));
Elliott Hughese3c845c2012-02-28 17:23:01 -0800849 }
850 }
851 }
852
853 // If the last thing in the file is code for a method, there won't be an offset for the "next"
854 // thing. Instead of having a special case in the upper_bound code, let's just add an entry
855 // for the end of the file.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800856 offsets_.insert(oat_file_.Size());
Elliott Hughese3c845c2012-02-28 17:23:01 -0800857 }
858
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700859 static uint32_t AlignCodeOffset(uint32_t maybe_thumb_offset) {
860 return maybe_thumb_offset & ~0x1; // TODO: Make this Thumb2 specific.
861 }
862
Elliott Hughese3c845c2012-02-28 17:23:01 -0800863 void AddOffsets(const OatFile::OatMethod& oat_method) {
Brian Carlstrom95ba0dc2012-03-05 22:06:14 -0800864 uint32_t code_offset = oat_method.GetCodeOffset();
Vladimir Marko33bff252017-11-01 14:35:42 +0000865 if (oat_file_.GetOatHeader().GetInstructionSet() == InstructionSet::kThumb2) {
Brian Carlstrom95ba0dc2012-03-05 22:06:14 -0800866 code_offset &= ~0x1;
867 }
868 offsets_.insert(code_offset);
Elliott Hughese3c845c2012-02-28 17:23:01 -0800869 offsets_.insert(oat_method.GetVmapTableOffset());
Elliott Hughese3c845c2012-02-28 17:23:01 -0800870 }
871
Andreas Gampeb40d3612018-06-26 15:49:42 -0700872 bool DumpOatDexFile(std::ostream& os, const OatDexFile& oat_dex_file) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700873 bool success = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800874 bool stop_analysis = false;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700875 os << "OatDexFile:\n";
Brian Carlstroma004aa92012-02-08 18:05:09 -0800876 os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str());
Elliott Hughesed2adb62012-02-29 14:41:01 -0800877 os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum());
Mathieu Chartier590fee92013-09-13 13:46:47 -0700878
Andreas Gampe2ba88952016-04-29 17:52:07 -0700879 const uint8_t* const oat_file_begin = oat_dex_file.GetOatFile()->Begin();
Nicolas Geoffrayf3075272018-01-08 12:41:19 +0000880 if (oat_dex_file.GetOatFile()->ContainsDexCode()) {
881 const uint8_t* const vdex_file_begin = oat_dex_file.GetOatFile()->DexBegin();
David Brazdil7b49e6c2016-09-01 11:06:18 +0100882
Nicolas Geoffrayf3075272018-01-08 12:41:19 +0000883 // Print data range of the dex file embedded inside the corresponding vdex file.
884 const uint8_t* const dex_file_pointer = oat_dex_file.GetDexFilePointer();
885 uint32_t dex_offset = dchecked_integral_cast<uint32_t>(dex_file_pointer - vdex_file_begin);
886 os << StringPrintf(
887 "dex-file: 0x%08x..0x%08x\n",
888 dex_offset,
889 dchecked_integral_cast<uint32_t>(dex_offset + oat_dex_file.FileSize() - 1));
890 } else {
891 os << StringPrintf("dex-file not in VDEX file\n");
892 }
Mathieu Chartier590fee92013-09-13 13:46:47 -0700893
Andreas Gampe2ba88952016-04-29 17:52:07 -0700894 // Create the dex file early. A lot of print-out things depend on it.
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700895 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700896 const DexFile* const dex_file = OpenDexFile(&oat_dex_file, &error_msg);
897 if (dex_file == nullptr) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700898 os << "NOT FOUND: " << error_msg << "\n\n";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700899 os << std::flush;
900 return false;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700901 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +0100902
Andreas Gampe2ba88952016-04-29 17:52:07 -0700903 // Print lookup table, if it exists.
904 if (oat_dex_file.GetLookupTableData() != nullptr) {
905 uint32_t table_offset = dchecked_integral_cast<uint32_t>(
906 oat_dex_file.GetLookupTableData() - oat_file_begin);
David Sehr9aa352e2016-09-15 18:13:52 -0700907 uint32_t table_size = TypeLookupTable::RawDataLength(dex_file->NumClassDefs());
Andreas Gampe2ba88952016-04-29 17:52:07 -0700908 os << StringPrintf("type-table: 0x%08x..0x%08x\n",
909 table_offset,
910 table_offset + table_size - 1);
911 }
912
Vladimir Marko8f1e08a2015-06-26 12:06:30 +0100913 VariableIndentationOutputStream vios(&os);
914 ScopedIndentation indent1(&vios);
Mathieu Chartier98dad402018-06-04 18:00:12 -0700915 for (ClassAccessor accessor : dex_file->GetClasses()) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800916 // TODO: Support regex
Mathieu Chartier98dad402018-06-04 18:00:12 -0700917 const char* descriptor = accessor.GetDescriptor();
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800918 if (DescriptorToDot(descriptor).find(options_.class_filter_) == std::string::npos) {
919 continue;
920 }
921
Mathieu Chartier98dad402018-06-04 18:00:12 -0700922 const uint16_t class_def_index = accessor.GetClassDefIndex();
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700923 uint32_t oat_class_offset = oat_dex_file.GetOatClassOffset(class_def_index);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100924 const OatFile::OatClass oat_class = oat_dex_file.GetOatClass(class_def_index);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700925 os << StringPrintf("%zd: %s (offset=0x%08x) (type_idx=%d)",
Mathieu Chartier98dad402018-06-04 18:00:12 -0700926 static_cast<ssize_t>(class_def_index),
927 descriptor,
928 oat_class_offset,
929 accessor.GetClassIdx().index_)
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100930 << " (" << oat_class.GetStatus() << ")"
931 << " (" << oat_class.GetType() << ")\n";
932 // TODO: include bitmap here if type is kOatClassSomeCompiled?
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700933 if (options_.list_classes_) {
934 continue;
935 }
Mathieu Chartier98dad402018-06-04 18:00:12 -0700936 if (!DumpOatClass(&vios, oat_class, *dex_file, accessor, &stop_analysis)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700937 success = false;
938 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800939 if (stop_analysis) {
940 os << std::flush;
941 return success;
942 }
Brian Carlstromaded5f72011-10-07 17:15:04 -0700943 }
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700944 os << "\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -0700945 os << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700946 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700947 }
948
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300949 // Backwards compatible Dex file export. If dex_file is nullptr (valid Vdex file not present) the
950 // Dex resource is extracted from the oat_dex_file and its checksum is repaired since it's not
951 // unquickened. Otherwise the dex_file has been fully unquickened and is expected to verify the
952 // original checksum.
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300953 bool ExportDexFile(std::ostream& os,
954 const OatDexFile& oat_dex_file,
955 const DexFile* dex_file,
956 bool used_dexlayout) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800957 std::string error_msg;
958 std::string dex_file_location = oat_dex_file.GetDexFileLocation();
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300959
960 // If dex_file (from unquicken or dexlayout) is not available, the output DexFile size is the
961 // same as the one extracted from the Oat container (pre-oreo)
962 size_t fsize = dex_file == nullptr ? oat_dex_file.FileSize() : dex_file->Size();
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800963
964 // Some quick checks just in case
965 if (fsize == 0 || fsize < sizeof(DexFile::Header)) {
966 os << "Invalid dex file\n";
967 return false;
968 }
969
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300970 if (dex_file == nullptr) {
971 // Exported bytecode is quickened (dex-to-dex transformations present)
972 dex_file = OpenDexFile(&oat_dex_file, &error_msg);
973 if (dex_file == nullptr) {
974 os << "Failed to open dex file '" << dex_file_location << "': " << error_msg;
975 return false;
976 }
977
978 // Recompute checksum
979 reinterpret_cast<DexFile::Header*>(const_cast<uint8_t*>(dex_file->Begin()))->checksum_ =
980 dex_file->CalculateChecksum();
981 } else {
Anestis Bechtsoudis8583bec2018-09-08 22:32:29 +0300982 // If dexlayout was used to convert CompactDex back to StandardDex, checksum will be updated
983 // due to `update_checksum_` option, otherwise we expect a reproducible checksum.
984 if (!used_dexlayout) {
985 // Vdex unquicken output should match original input bytecode
986 uint32_t orig_checksum =
987 reinterpret_cast<DexFile::Header*>(const_cast<uint8_t*>(dex_file->Begin()))->checksum_;
988 if (orig_checksum != dex_file->CalculateChecksum()) {
989 os << "Unexpected checksum from unquicken dex file '" << dex_file_location << "'\n";
990 return false;
991 }
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300992 }
993 }
994
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800995 // Verify output directory exists
996 if (!OS::DirectoryExists(options_.export_dex_location_)) {
997 // TODO: Extend OS::DirectoryExists if symlink support is required
998 os << options_.export_dex_location_ << " output directory not found or symlink\n";
999 return false;
1000 }
1001
1002 // Beautify path names
1003 if (dex_file_location.size() > PATH_MAX || dex_file_location.size() <= 0) {
1004 return false;
1005 }
1006
1007 std::string dex_orig_name;
1008 size_t dex_orig_pos = dex_file_location.rfind('/');
1009 if (dex_orig_pos == std::string::npos)
1010 dex_orig_name = dex_file_location;
1011 else
1012 dex_orig_name = dex_file_location.substr(dex_orig_pos + 1);
1013
1014 // A more elegant approach to efficiently name user installed apps is welcome
Andreas Gampef812d8c2017-02-17 10:19:44 -08001015 if (dex_orig_name.size() == 8 &&
1016 dex_orig_name.compare("base.apk") == 0 &&
1017 dex_orig_pos != std::string::npos) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001018 dex_file_location.erase(dex_orig_pos, strlen("base.apk") + 1);
1019 size_t apk_orig_pos = dex_file_location.rfind('/');
1020 if (apk_orig_pos != std::string::npos) {
1021 dex_orig_name = dex_file_location.substr(++apk_orig_pos);
1022 }
1023 }
1024
1025 std::string out_dex_path(options_.export_dex_location_);
1026 if (out_dex_path.back() != '/') {
1027 out_dex_path.append("/");
1028 }
1029 out_dex_path.append(dex_orig_name);
1030 out_dex_path.append("_export.dex");
1031 if (out_dex_path.length() > PATH_MAX) {
1032 return false;
1033 }
1034
1035 std::unique_ptr<File> file(OS::CreateEmptyFile(out_dex_path.c_str()));
1036 if (file.get() == nullptr) {
1037 os << "Failed to open output dex file " << out_dex_path;
1038 return false;
1039 }
1040
Mathieu Chartier567dc6f2018-04-05 16:37:14 -07001041 bool success = file->WriteFully(dex_file->Begin(), fsize);
Mathieu Chartierc3a22aa2018-01-19 18:58:34 -08001042 if (!success) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001043 os << "Failed to write dex file";
1044 file->Erase();
1045 return false;
1046 }
1047
1048 if (file->FlushCloseOrErase() != 0) {
1049 os << "Flush and close failed";
1050 return false;
1051 }
1052
1053 os << StringPrintf("Dex file exported at %s (%zd bytes)\n", out_dex_path.c_str(), fsize);
1054 os << std::flush;
1055
1056 return true;
1057 }
1058
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001059 bool DumpOatClass(VariableIndentationOutputStream* vios,
Mathieu Chartier98dad402018-06-04 18:00:12 -07001060 const OatFile::OatClass& oat_class,
1061 const DexFile& dex_file,
1062 const ClassAccessor& class_accessor,
1063 bool* stop_analysis) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001064 bool success = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001065 bool addr_found = false;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001066 uint32_t class_method_index = 0;
Mathieu Chartier98dad402018-06-04 18:00:12 -07001067 for (const ClassAccessor::Method& method : class_accessor.GetMethods()) {
1068 if (!DumpOatMethod(vios,
1069 dex_file.GetClassDef(class_accessor.GetClassDefIndex()),
1070 class_method_index,
1071 oat_class,
1072 dex_file,
1073 method.GetIndex(),
1074 method.GetCodeItem(),
David Brazdil20c765f2018-10-27 21:45:15 +00001075 method.GetAccessFlags(),
Mathieu Chartier98dad402018-06-04 18:00:12 -07001076 &addr_found)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001077 success = false;
1078 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001079 if (addr_found) {
1080 *stop_analysis = true;
1081 return success;
1082 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001083 class_method_index++;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001084 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001085 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001086 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001087 }
Elliott Hughese3c845c2012-02-28 17:23:01 -08001088
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001089 static constexpr uint32_t kPrologueBytes = 16;
1090
1091 // When this was picked, the largest arm method was 55,256 bytes and arm64 was 50,412 bytes.
1092 static constexpr uint32_t kMaxCodeSize = 100 * 1000;
1093
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001094 bool DumpOatMethod(VariableIndentationOutputStream* vios,
Andreas Gampe3f1dcd32018-12-28 09:39:56 -08001095 const dex::ClassDef& class_def,
Ian Rogers8b2c0b92013-09-19 02:56:49 -07001096 uint32_t class_method_index,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001097 const OatFile::OatClass& oat_class,
1098 const DexFile& dex_file,
1099 uint32_t dex_method_idx,
Andreas Gampe3f1dcd32018-12-28 09:39:56 -08001100 const dex::CodeItem* code_item,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001101 uint32_t method_access_flags,
1102 bool* addr_found) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001103 bool success = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001104
Mathieu Chartier698ebbc2018-01-05 11:00:42 -08001105 CodeItemDataAccessor code_item_accessor(dex_file, code_item);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001106
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001107 // TODO: Support regex
1108 std::string method_name = dex_file.GetMethodName(dex_file.GetMethodId(dex_method_idx));
1109 if (method_name.find(options_.method_filter_) == std::string::npos) {
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +00001110 return success;
1111 }
1112
David Sehr709b0702016-10-13 09:12:37 -07001113 std::string pretty_method = dex_file.PrettyMethod(dex_method_idx, true);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001114 vios->Stream() << StringPrintf("%d: %s (dex_method_idx=%d)\n",
1115 class_method_index, pretty_method.c_str(),
1116 dex_method_idx);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001117 if (options_.list_methods_) {
1118 return success;
1119 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001120
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001121 uint32_t oat_method_offsets_offset = oat_class.GetOatMethodOffsetsOffset(class_method_index);
1122 const OatMethodOffsets* oat_method_offsets = oat_class.GetOatMethodOffsets(class_method_index);
1123 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_index);
1124 uint32_t code_offset = oat_method.GetCodeOffset();
1125 uint32_t code_size = oat_method.GetQuickCodeSize();
1126 if (resolved_addr2instr_ != 0) {
1127 if (resolved_addr2instr_ > code_offset + code_size) {
1128 return success;
1129 } else {
1130 *addr_found = true; // stop analyzing file at next iteration
1131 }
1132 }
1133
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001134 // Everything below is indented at least once.
1135 ScopedIndentation indent1(vios);
1136
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001137 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001138 vios->Stream() << "DEX CODE:\n";
1139 ScopedIndentation indent2(vios);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001140 if (code_item_accessor.HasCodeItem()) {
1141 for (const DexInstructionPcPair& inst : code_item_accessor) {
1142 vios->Stream() << StringPrintf("0x%04x: ", inst.DexPc()) << inst->DumpHexLE(5)
1143 << StringPrintf("\t| %s\n", inst->DumpString(&dex_file).c_str());
1144 }
1145 }
Ian Rogersb23a7722012-10-09 16:54:26 -07001146 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001147
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001148 std::unique_ptr<StackHandleScope<1>> hs;
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001149 std::unique_ptr<verifier::MethodVerifier> verifier;
1150 if (Runtime::Current() != nullptr) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001151 // We need to have the handle scope stay live until after the verifier since the verifier has
1152 // a handle to the dex cache from hs.
1153 hs.reset(new StackHandleScope<1>(Thread::Current()));
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001154 vios->Stream() << "VERIFIER TYPE ANALYSIS:\n";
1155 ScopedIndentation indent2(vios);
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001156 verifier.reset(DumpVerifier(vios, hs.get(),
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001157 dex_method_idx, &dex_file, class_def, code_item,
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001158 method_access_flags));
Ian Rogersb23a7722012-10-09 16:54:26 -07001159 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001160 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001161 vios->Stream() << "OatMethodOffsets ";
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001162 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001163 vios->Stream() << StringPrintf("%p ", oat_method_offsets);
Nicolas Geoffray39468442014-09-02 15:17:15 +01001164 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001165 vios->Stream() << StringPrintf("(offset=0x%08x)\n", oat_method_offsets_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001166 if (oat_method_offsets_offset > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001167 vios->Stream() << StringPrintf(
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001168 "WARNING: oat method offsets offset 0x%08x is past end of file 0x%08zx.\n",
1169 oat_method_offsets_offset, oat_file_.Size());
1170 // If we can't read OatMethodOffsets, the rest of the data is dangerous to read.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001171 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001172 return false;
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001173 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001174
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001175 ScopedIndentation indent2(vios);
1176 vios->Stream() << StringPrintf("code_offset: 0x%08x ", code_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001177 uint32_t aligned_code_begin = AlignCodeOffset(oat_method.GetCodeOffset());
1178 if (aligned_code_begin > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001179 vios->Stream() << StringPrintf("WARNING: "
1180 "code offset 0x%08x is past end of file 0x%08zx.\n",
1181 aligned_code_begin, oat_file_.Size());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001182 success = false;
1183 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001184 vios->Stream() << "\n";
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001185 }
1186 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001187 vios->Stream() << "OatQuickMethodHeader ";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001188 uint32_t method_header_offset = oat_method.GetOatQuickMethodHeaderOffset();
1189 const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader();
David Srbecky86decb62018-06-05 06:41:10 +01001190 if (AddStatsObject(method_header)) {
1191 stats_.Child("QuickMethodHeader")->AddBytes(sizeof(*method_header));
1192 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001193 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001194 vios->Stream() << StringPrintf("%p ", method_header);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001195 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001196 vios->Stream() << StringPrintf("(offset=0x%08x)\n", method_header_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001197 if (method_header_offset > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001198 vios->Stream() << StringPrintf(
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001199 "WARNING: oat quick method header offset 0x%08x is past end of file 0x%08zx.\n",
1200 method_header_offset, oat_file_.Size());
1201 // If we can't read the OatQuickMethodHeader, the rest of the data is dangerous to read.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001202 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001203 return false;
1204 }
1205
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001206 ScopedIndentation indent2(vios);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001207 vios->Stream() << "vmap_table: ";
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001208 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001209 vios->Stream() << StringPrintf("%p ", oat_method.GetVmapTable());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001210 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001211 uint32_t vmap_table_offset = method_header ==
1212 nullptr ? 0 : method_header->GetVmapTableOffset();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001213 vios->Stream() << StringPrintf("(offset=0x%08x)\n", vmap_table_offset);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001214
1215 size_t vmap_table_offset_limit =
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001216 IsMethodGeneratedByDexToDexCompiler(oat_method, code_item_accessor)
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001217 ? oat_file_.GetVdexFile()->Size()
1218 : method_header->GetCode() - oat_file_.Begin();
1219 if (vmap_table_offset >= vmap_table_offset_limit) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001220 vios->Stream() << StringPrintf("WARNING: "
1221 "vmap table offset 0x%08x is past end of file 0x%08zx. "
1222 "vmap table offset was loaded from offset 0x%08x.\n",
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001223 vmap_table_offset,
1224 vmap_table_offset_limit,
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001225 oat_method.GetVmapTableOffsetOffset());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001226 success = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001227 } else if (options_.dump_vmap_) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001228 DumpVmapData(vios, oat_method, code_item_accessor);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001229 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001230 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001231 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001232 vios->Stream() << "QuickMethodFrameInfo\n";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001233
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001234 ScopedIndentation indent2(vios);
1235 vios->Stream()
1236 << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes());
1237 vios->Stream() << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask());
1238 DumpSpillMask(vios->Stream(), oat_method.GetCoreSpillMask(), false);
1239 vios->Stream() << "\n";
1240 vios->Stream() << StringPrintf("fp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask());
1241 DumpSpillMask(vios->Stream(), oat_method.GetFpSpillMask(), true);
1242 vios->Stream() << "\n";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001243 }
1244 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001245 // Based on spill masks from QuickMethodFrameInfo so placed
1246 // after it is dumped, but useful for understanding quick
1247 // code, so dumped here.
1248 ScopedIndentation indent2(vios);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001249 DumpVregLocations(vios->Stream(), oat_method, code_item_accessor);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001250 }
1251 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001252 vios->Stream() << "CODE: ";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001253 uint32_t code_size_offset = oat_method.GetQuickCodeSizeOffset();
1254 if (code_size_offset > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001255 ScopedIndentation indent2(vios);
1256 vios->Stream() << StringPrintf("WARNING: "
1257 "code size offset 0x%08x is past end of file 0x%08zx.",
1258 code_size_offset, oat_file_.Size());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001259 success = false;
1260 } else {
1261 const void* code = oat_method.GetQuickCode();
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001262 uint32_t aligned_code_begin = AlignCodeOffset(code_offset);
1263 uint64_t aligned_code_end = aligned_code_begin + code_size;
David Srbecky86decb62018-06-05 06:41:10 +01001264 if (AddStatsObject(code)) {
1265 stats_.Child("Code")->AddBytes(code_size);
1266 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001267
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001268 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001269 vios->Stream() << StringPrintf("%p ", code);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001270 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001271 vios->Stream() << StringPrintf("(code_offset=0x%08x size_offset=0x%08x size=%u)%s\n",
1272 code_offset,
1273 code_size_offset,
1274 code_size,
1275 code != nullptr ? "..." : "");
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001276
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001277 ScopedIndentation indent2(vios);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001278 if (aligned_code_begin > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001279 vios->Stream() << StringPrintf("WARNING: "
1280 "start of code at 0x%08x is past end of file 0x%08zx.",
1281 aligned_code_begin, oat_file_.Size());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001282 success = false;
1283 } else if (aligned_code_end > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001284 vios->Stream() << StringPrintf(
1285 "WARNING: "
1286 "end of code at 0x%08" PRIx64 " is past end of file 0x%08zx. "
1287 "code size is 0x%08x loaded from offset 0x%08x.\n",
1288 aligned_code_end, oat_file_.Size(),
1289 code_size, code_size_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001290 success = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001291 if (options_.disassemble_code_) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001292 if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001293 DumpCode(vios, oat_method, code_item_accessor, true, kPrologueBytes);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001294 }
1295 }
1296 } else if (code_size > kMaxCodeSize) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001297 vios->Stream() << StringPrintf(
1298 "WARNING: "
1299 "code size %d is bigger than max expected threshold of %d. "
1300 "code size is 0x%08x loaded from offset 0x%08x.\n",
1301 code_size, kMaxCodeSize,
1302 code_size, code_size_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001303 success = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001304 if (options_.disassemble_code_) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001305 if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001306 DumpCode(vios, oat_method, code_item_accessor, true, kPrologueBytes);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001307 }
1308 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001309 } else if (options_.disassemble_code_) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001310 DumpCode(vios, oat_method, code_item_accessor, !success, 0);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001311 }
1312 }
1313 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001314 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001315 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001316 }
Elliott Hughese3c845c2012-02-28 17:23:01 -08001317
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001318 void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) {
1319 if (spill_mask == 0) {
1320 return;
1321 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001322 os << "(";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001323 for (size_t i = 0; i < 32; i++) {
1324 if ((spill_mask & (1 << i)) != 0) {
1325 if (is_float) {
1326 os << "fr" << i;
1327 } else {
1328 os << "r" << i;
1329 }
1330 spill_mask ^= 1 << i; // clear bit
1331 if (spill_mask != 0) {
1332 os << ", ";
1333 } else {
1334 break;
1335 }
1336 }
1337 }
1338 os << ")";
1339 }
1340
Roland Levillain442b46a2015-02-18 16:54:21 +00001341 // Display data stored at the the vmap offset of an oat method.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001342 void DumpVmapData(VariableIndentationOutputStream* vios,
Roland Levillain442b46a2015-02-18 16:54:21 +00001343 const OatFile::OatMethod& oat_method,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001344 const CodeItemDataAccessor& code_item_accessor) {
1345 if (IsMethodGeneratedByOptimizingCompiler(oat_method, code_item_accessor)) {
Roland Levillainf2650d12015-05-28 14:53:28 +01001346 // The optimizing compiler outputs its CodeInfo data in the vmap table.
David Srbecky6ee06e92018-07-25 21:45:54 +01001347 const uint8_t* raw_code_info = oat_method.GetVmapTable();
Roland Levillain442b46a2015-02-18 16:54:21 +00001348 if (raw_code_info != nullptr) {
1349 CodeInfo code_info(raw_code_info);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001350 DCHECK(code_item_accessor.HasCodeItem());
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001351 ScopedIndentation indent1(vios);
David Srbecky8cd54542018-07-15 23:58:44 +01001352 DumpCodeInfo(vios, code_info, oat_method);
Roland Levillain442b46a2015-02-18 16:54:21 +00001353 }
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001354 } else if (IsMethodGeneratedByDexToDexCompiler(oat_method, code_item_accessor)) {
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001355 // We don't encode the size in the table, so just emit that we have quickened
1356 // information.
1357 ScopedIndentation indent(vios);
1358 vios->Stream() << "quickened data\n";
Roland Levillain442b46a2015-02-18 16:54:21 +00001359 } else {
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01001360 // Otherwise, there is nothing to display.
Nicolas Geoffray20d3eae2014-09-17 11:27:23 +01001361 }
Roland Levillain442b46a2015-02-18 16:54:21 +00001362 }
1363
1364 // Display a CodeInfo object emitted by the optimizing compiler.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001365 void DumpCodeInfo(VariableIndentationOutputStream* vios,
Roland Levillain442b46a2015-02-18 16:54:21 +00001366 const CodeInfo& code_info,
David Srbecky8cd54542018-07-15 23:58:44 +01001367 const OatFile::OatMethod& oat_method) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001368 code_info.Dump(vios,
Roland Levillainf2650d12015-05-28 14:53:28 +01001369 oat_method.GetCodeOffset(),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001370 options_.dump_code_info_stack_maps_,
David Srbecky8cd54542018-07-15 23:58:44 +01001371 instruction_set_);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001372 }
1373
Andreas Gampe36a296f2017-06-13 14:11:11 -07001374 static int GetOutVROffset(uint16_t out_num, InstructionSet isa) {
1375 // According to stack model, the first out is above the Method referernce.
1376 return static_cast<size_t>(InstructionSetPointerSize(isa)) + out_num * sizeof(uint32_t);
1377 }
1378
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001379 static uint32_t GetVRegOffsetFromQuickCode(const CodeItemDataAccessor& code_item_accessor,
Andreas Gampe36a296f2017-06-13 14:11:11 -07001380 uint32_t core_spills,
1381 uint32_t fp_spills,
1382 size_t frame_size,
1383 int reg,
1384 InstructionSet isa) {
1385 PointerSize pointer_size = InstructionSetPointerSize(isa);
1386 if (kIsDebugBuild) {
1387 auto* runtime = Runtime::Current();
1388 if (runtime != nullptr) {
1389 CHECK_EQ(runtime->GetClassLinker()->GetImagePointerSize(), pointer_size);
1390 }
1391 }
1392 DCHECK_ALIGNED(frame_size, kStackAlignment);
1393 DCHECK_NE(reg, -1);
1394 int spill_size = POPCOUNT(core_spills) * GetBytesPerGprSpillLocation(isa)
1395 + POPCOUNT(fp_spills) * GetBytesPerFprSpillLocation(isa)
1396 + sizeof(uint32_t); // Filler.
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001397 int num_regs = code_item_accessor.RegistersSize() - code_item_accessor.InsSize();
1398 int temp_threshold = code_item_accessor.RegistersSize();
Andreas Gampe36a296f2017-06-13 14:11:11 -07001399 const int max_num_special_temps = 1;
1400 if (reg == temp_threshold) {
1401 // The current method pointer corresponds to special location on stack.
1402 return 0;
1403 } else if (reg >= temp_threshold + max_num_special_temps) {
1404 /*
1405 * Special temporaries may have custom locations and the logic above deals with that.
1406 * However, non-special temporaries are placed relative to the outs.
1407 */
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001408 int temps_start = code_item_accessor.OutsSize() * sizeof(uint32_t)
Andreas Gampe36a296f2017-06-13 14:11:11 -07001409 + static_cast<size_t>(pointer_size) /* art method */;
1410 int relative_offset = (reg - (temp_threshold + max_num_special_temps)) * sizeof(uint32_t);
1411 return temps_start + relative_offset;
1412 } else if (reg < num_regs) {
1413 int locals_start = frame_size - spill_size - num_regs * sizeof(uint32_t);
1414 return locals_start + (reg * sizeof(uint32_t));
1415 } else {
1416 // Handle ins.
1417 return frame_size + ((reg - num_regs) * sizeof(uint32_t))
1418 + static_cast<size_t>(pointer_size) /* art method */;
1419 }
1420 }
1421
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001422 void DumpVregLocations(std::ostream& os, const OatFile::OatMethod& oat_method,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001423 const CodeItemDataAccessor& code_item_accessor) {
1424 if (code_item_accessor.HasCodeItem()) {
1425 size_t num_locals_ins = code_item_accessor.RegistersSize();
1426 size_t num_ins = code_item_accessor.InsSize();
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001427 size_t num_locals = num_locals_ins - num_ins;
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001428 size_t num_outs = code_item_accessor.OutsSize();
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001429
1430 os << "vr_stack_locations:";
1431 for (size_t reg = 0; reg <= num_locals_ins; reg++) {
1432 // For readability, delimit the different kinds of VRs.
1433 if (reg == num_locals_ins) {
1434 os << "\n\tmethod*:";
1435 } else if (reg == num_locals && num_ins > 0) {
1436 os << "\n\tins:";
1437 } else if (reg == 0 && num_locals > 0) {
1438 os << "\n\tlocals:";
1439 }
1440
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001441 uint32_t offset = GetVRegOffsetFromQuickCode(code_item_accessor,
Andreas Gampe36a296f2017-06-13 14:11:11 -07001442 oat_method.GetCoreSpillMask(),
1443 oat_method.GetFpSpillMask(),
1444 oat_method.GetFrameSizeInBytes(),
1445 reg,
1446 GetInstructionSet());
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001447 os << " v" << reg << "[sp + #" << offset << "]";
1448 }
1449
1450 for (size_t out_reg = 0; out_reg < num_outs; out_reg++) {
1451 if (out_reg == 0) {
1452 os << "\n\touts:";
1453 }
1454
Andreas Gampe36a296f2017-06-13 14:11:11 -07001455 uint32_t offset = GetOutVROffset(out_reg, GetInstructionSet());
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001456 os << " v" << out_reg << "[sp + #" << offset << "]";
1457 }
1458
1459 os << "\n";
1460 }
1461 }
1462
Roland Levillainf2650d12015-05-28 14:53:28 +01001463 // Has `oat_method` -- corresponding to the Dex `code_item` -- been compiled by
1464 // the optimizing compiler?
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001465 static bool IsMethodGeneratedByOptimizingCompiler(
1466 const OatFile::OatMethod& oat_method,
1467 const CodeItemDataAccessor& code_item_accessor) {
Roland Levillainf2650d12015-05-28 14:53:28 +01001468 // If the native GC map is null and the Dex `code_item` is not
1469 // null, then this method has been compiled with the optimizing
1470 // compiler.
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001471 return oat_method.GetQuickCode() != nullptr &&
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01001472 oat_method.GetVmapTable() != nullptr &&
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001473 code_item_accessor.HasCodeItem();
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001474 }
1475
1476 // Has `oat_method` -- corresponding to the Dex `code_item` -- been compiled by
1477 // the dextodex compiler?
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001478 static bool IsMethodGeneratedByDexToDexCompiler(
1479 const OatFile::OatMethod& oat_method,
1480 const CodeItemDataAccessor& code_item_accessor) {
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001481 // If the quick code is null, the Dex `code_item` is not
1482 // null, and the vmap table is not null, then this method has been compiled
1483 // with the dextodex compiler.
1484 return oat_method.GetQuickCode() == nullptr &&
1485 oat_method.GetVmapTable() != nullptr &&
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001486 code_item_accessor.HasCodeItem();
Roland Levillainf2650d12015-05-28 14:53:28 +01001487 }
1488
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001489 verifier::MethodVerifier* DumpVerifier(VariableIndentationOutputStream* vios,
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001490 StackHandleScope<1>* hs,
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001491 uint32_t dex_method_idx,
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001492 const DexFile* dex_file,
Andreas Gampe3f1dcd32018-12-28 09:39:56 -08001493 const dex::ClassDef& class_def,
1494 const dex::CodeItem* code_item,
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001495 uint32_t method_access_flags) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001496 if ((method_access_flags & kAccNative) == 0) {
1497 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierd57d4542015-10-14 10:55:30 -07001498 Runtime* const runtime = Runtime::Current();
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001499 DCHECK(options_.class_loader_ != nullptr);
Vladimir Marko421087b2018-02-27 11:00:17 +00001500 Handle<mirror::DexCache> dex_cache = hs->NewHandle(
1501 runtime->GetClassLinker()->RegisterDexFile(*dex_file, options_.class_loader_->Get()));
1502 CHECK(dex_cache != nullptr);
Nicolas Geoffrayb041a402017-11-13 15:16:22 +00001503 ArtMethod* method = runtime->GetClassLinker()->ResolveMethodWithoutInvokeType(
1504 dex_method_idx, dex_cache, *options_.class_loader_);
Andreas Gampe03da7842018-04-12 11:12:52 -07001505 if (method == nullptr) {
1506 soa.Self()->ClearException();
1507 return nullptr;
1508 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001509 return verifier::MethodVerifier::VerifyMethodAndDump(
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001510 soa.Self(), vios, dex_method_idx, dex_file, dex_cache, *options_.class_loader_,
Andreas Gampe9b031f72018-10-04 11:03:34 -07001511 class_def, code_item, method, method_access_flags, /* api_level= */ 0);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001512 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001513
1514 return nullptr;
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001515 }
1516
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001517 // The StackMapsHelper provides the stack maps in the native PC order.
1518 // For identical native PCs, the order from the CodeInfo is preserved.
1519 class StackMapsHelper {
1520 public:
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001521 explicit StackMapsHelper(const uint8_t* raw_code_info, InstructionSet instruction_set)
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001522 : code_info_(raw_code_info),
David Srbecky052f8ca2018-04-26 15:42:54 +01001523 number_of_stack_maps_(code_info_.GetNumberOfStackMaps()),
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001524 indexes_(),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001525 offset_(static_cast<uint32_t>(-1)),
1526 stack_map_index_(0u),
1527 instruction_set_(instruction_set) {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001528 if (number_of_stack_maps_ != 0u) {
1529 // Check if native PCs are ordered.
1530 bool ordered = true;
David Srbecky052f8ca2018-04-26 15:42:54 +01001531 StackMap last = code_info_.GetStackMapAt(0u);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001532 for (size_t i = 1; i != number_of_stack_maps_; ++i) {
David Srbecky052f8ca2018-04-26 15:42:54 +01001533 StackMap current = code_info_.GetStackMapAt(i);
1534 if (last.GetNativePcOffset(instruction_set) >
1535 current.GetNativePcOffset(instruction_set)) {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001536 ordered = false;
1537 break;
1538 }
1539 last = current;
1540 }
1541 if (!ordered) {
1542 // Create indirection indexes for access in native PC order. We do not optimize
1543 // for the fact that there can currently be only two separately ordered ranges,
1544 // namely normal stack maps and catch-point stack maps.
1545 indexes_.resize(number_of_stack_maps_);
1546 std::iota(indexes_.begin(), indexes_.end(), 0u);
1547 std::sort(indexes_.begin(),
1548 indexes_.end(),
1549 [this](size_t lhs, size_t rhs) {
David Srbecky052f8ca2018-04-26 15:42:54 +01001550 StackMap left = code_info_.GetStackMapAt(lhs);
1551 uint32_t left_pc = left.GetNativePcOffset(instruction_set_);
1552 StackMap right = code_info_.GetStackMapAt(rhs);
1553 uint32_t right_pc = right.GetNativePcOffset(instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001554 // If the PCs are the same, compare indexes to preserve the original order.
1555 return (left_pc < right_pc) || (left_pc == right_pc && lhs < rhs);
1556 });
1557 }
David Srbecky052f8ca2018-04-26 15:42:54 +01001558 offset_ = GetStackMapAt(0).GetNativePcOffset(instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001559 }
1560 }
1561
1562 const CodeInfo& GetCodeInfo() const {
1563 return code_info_;
1564 }
1565
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001566 uint32_t GetOffset() const {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001567 return offset_;
1568 }
1569
1570 StackMap GetStackMap() const {
1571 return GetStackMapAt(stack_map_index_);
1572 }
1573
1574 void Next() {
1575 ++stack_map_index_;
1576 offset_ = (stack_map_index_ == number_of_stack_maps_)
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001577 ? static_cast<uint32_t>(-1)
David Srbecky052f8ca2018-04-26 15:42:54 +01001578 : GetStackMapAt(stack_map_index_).GetNativePcOffset(instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001579 }
1580
1581 private:
1582 StackMap GetStackMapAt(size_t i) const {
1583 if (!indexes_.empty()) {
1584 i = indexes_[i];
1585 }
1586 DCHECK_LT(i, number_of_stack_maps_);
David Srbecky052f8ca2018-04-26 15:42:54 +01001587 return code_info_.GetStackMapAt(i);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001588 }
1589
1590 const CodeInfo code_info_;
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001591 const size_t number_of_stack_maps_;
1592 dchecked_vector<size_t> indexes_; // Used if stack map native PCs are not ordered.
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001593 uint32_t offset_;
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001594 size_t stack_map_index_;
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001595 const InstructionSet instruction_set_;
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001596 };
1597
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001598 void DumpCode(VariableIndentationOutputStream* vios,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001599 const OatFile::OatMethod& oat_method,
1600 const CodeItemDataAccessor& code_item_accessor,
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001601 bool bad_input, size_t code_size) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001602 const void* quick_code = oat_method.GetQuickCode();
1603
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001604 if (code_size == 0) {
1605 code_size = oat_method.GetQuickCodeSize();
1606 }
Elliott Hughes956af0f2014-12-11 14:34:28 -08001607 if (code_size == 0 || quick_code == nullptr) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001608 vios->Stream() << "NO CODE!\n";
Ian Rogersb23a7722012-10-09 16:54:26 -07001609 return;
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001610 } else if (!bad_input && IsMethodGeneratedByOptimizingCompiler(oat_method,
1611 code_item_accessor)) {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001612 // The optimizing compiler outputs its CodeInfo data in the vmap table.
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001613 StackMapsHelper helper(oat_method.GetVmapTable(), instruction_set_);
David Srbecky86decb62018-06-05 06:41:10 +01001614 if (AddStatsObject(oat_method.GetVmapTable())) {
David Srbecky42deda82018-08-10 11:23:27 +01001615 helper.GetCodeInfo().CollectSizeStats(oat_method.GetVmapTable(), &stats_);
David Srbecky86decb62018-06-05 06:41:10 +01001616 }
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001617 const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
1618 size_t offset = 0;
1619 while (offset < code_size) {
1620 offset += disassembler_->Dump(vios->Stream(), quick_native_pc + offset);
1621 if (offset == helper.GetOffset()) {
1622 ScopedIndentation indent1(vios);
1623 StackMap stack_map = helper.GetStackMap();
1624 DCHECK(stack_map.IsValid());
1625 stack_map.Dump(vios,
1626 helper.GetCodeInfo(),
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001627 oat_method.GetCodeOffset(),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001628 instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001629 do {
1630 helper.Next();
1631 // There may be multiple stack maps at a given PC. We display only the first one.
1632 } while (offset == helper.GetOffset());
1633 }
1634 DCHECK_LT(offset, helper.GetOffset());
1635 }
Elliott Hughes956af0f2014-12-11 14:34:28 -08001636 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001637 const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
1638 size_t offset = 0;
1639 while (offset < code_size) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001640 offset += disassembler_->Dump(vios->Stream(), quick_native_pc + offset);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001641 }
Ian Rogersb23a7722012-10-09 16:54:26 -07001642 }
1643 }
1644
Vladimir Marko812fb4d2018-03-14 13:07:21 +00001645 void DumpDataBimgRelRoEntries(std::ostream& os) {
1646 os << ".data.bimg.rel.ro: ";
1647 if (oat_file_.GetBootImageRelocations().empty()) {
1648 os << "empty.\n\n";
1649 return;
1650 }
1651
1652 os << oat_file_.GetBootImageRelocations().size() << " entries.\n";
1653 Runtime* runtime = Runtime::Current();
1654 if (runtime != nullptr && !runtime->GetHeap()->GetBootImageSpaces().empty()) {
1655 const std::vector<gc::space::ImageSpace*>& boot_image_spaces =
1656 runtime->GetHeap()->GetBootImageSpaces();
1657 ScopedObjectAccess soa(Thread::Current());
1658 for (const uint32_t& object_offset : oat_file_.GetBootImageRelocations()) {
1659 uint32_t entry_index = &object_offset - oat_file_.GetBootImageRelocations().data();
1660 uint32_t entry_offset = entry_index * sizeof(oat_file_.GetBootImageRelocations()[0]);
1661 os << StringPrintf(" 0x%x: 0x%08x", entry_offset, object_offset);
1662 uint8_t* object = boot_image_spaces[0]->Begin() + object_offset;
1663 bool found = false;
1664 for (gc::space::ImageSpace* space : boot_image_spaces) {
1665 uint64_t local_offset = object - space->Begin();
1666 if (local_offset < space->GetImageHeader().GetImageSize()) {
1667 if (space->GetImageHeader().GetObjectsSection().Contains(local_offset)) {
1668 ObjPtr<mirror::Object> o = reinterpret_cast<mirror::Object*>(object);
1669 if (o->IsString()) {
1670 os << " String: " << o->AsString()->ToModifiedUtf8();
1671 } else if (o->IsClass()) {
1672 os << " Class: " << o->AsClass()->PrettyDescriptor();
1673 } else {
1674 os << StringPrintf(" 0x%08x %s",
1675 object_offset,
1676 o->GetClass()->PrettyDescriptor().c_str());
1677 }
1678 } else if (space->GetImageHeader().GetMethodsSection().Contains(local_offset)) {
1679 ArtMethod* m = reinterpret_cast<ArtMethod*>(object);
1680 os << " ArtMethod: " << m->PrettyMethod();
1681 } else {
1682 os << StringPrintf(" 0x%08x <unexpected section in %s>",
1683 object_offset,
1684 space->GetImageFilename().c_str());
1685 }
1686 found = true;
1687 break;
1688 }
1689 }
1690 if (!found) {
1691 os << StringPrintf(" 0x%08x <outside boot image spaces>", object_offset);
1692 }
1693 os << "\n";
1694 }
1695 } else {
1696 for (const uint32_t& object_offset : oat_file_.GetBootImageRelocations()) {
1697 uint32_t entry_index = &object_offset - oat_file_.GetBootImageRelocations().data();
1698 uint32_t entry_offset = entry_index * sizeof(oat_file_.GetBootImageRelocations()[0]);
1699 os << StringPrintf(" 0x%x: 0x%08x\n", entry_offset, object_offset);
1700 }
1701 }
1702 os << "\n";
1703 }
1704
Vladimir Markof3c52b42017-11-17 17:32:12 +00001705 template <typename NameGetter>
1706 void DumpBssEntries(std::ostream& os,
1707 const char* slot_type,
1708 const IndexBssMapping* mapping,
1709 uint32_t number_of_indexes,
1710 size_t slot_size,
1711 NameGetter name) {
1712 os << ".bss mapping for " << slot_type << ": ";
1713 if (mapping == nullptr) {
1714 os << "empty.\n";
1715 return;
1716 }
1717 size_t index_bits = IndexBssMappingEntry::IndexBits(number_of_indexes);
1718 size_t num_valid_indexes = 0u;
1719 for (const IndexBssMappingEntry& entry : *mapping) {
1720 num_valid_indexes += 1u + POPCOUNT(entry.GetMask(index_bits));
1721 }
1722 os << mapping->size() << " entries for " << num_valid_indexes << " valid indexes.\n";
1723 os << std::hex;
1724 for (const IndexBssMappingEntry& entry : *mapping) {
1725 uint32_t index = entry.GetIndex(index_bits);
1726 uint32_t mask = entry.GetMask(index_bits);
1727 size_t bss_offset = entry.bss_offset - POPCOUNT(mask) * slot_size;
1728 for (uint32_t n : LowToHighBits(mask)) {
1729 size_t current_index = index - (32u - index_bits) + n;
1730 os << " 0x" << bss_offset << ": " << slot_type << ": " << name(current_index) << "\n";
1731 bss_offset += slot_size;
1732 }
1733 DCHECK_EQ(bss_offset, entry.bss_offset);
1734 os << " 0x" << bss_offset << ": " << slot_type << ": " << name(index) << "\n";
1735 }
1736 os << std::dec;
1737 }
1738
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001739 const OatFile& oat_file_;
Andreas Gampeb40d3612018-06-26 15:49:42 -07001740 const std::vector<const OatDexFile*> oat_dex_files_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001741 const OatDumperOptions& options_;
1742 uint32_t resolved_addr2instr_;
Andreas Gampe372f3a32016-08-19 10:49:06 -07001743 const InstructionSet instruction_set_;
Ian Rogersef7d42f2014-01-06 12:55:46 -08001744 std::set<uintptr_t> offsets_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001745 Disassembler* disassembler_;
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001746 Stats stats_;
David Srbecky86decb62018-06-05 06:41:10 +01001747 std::unordered_set<const void*> seen_stats_objects_;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001748};
1749
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001750class ImageDumper {
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001751 public:
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001752 ImageDumper(std::ostream* os,
1753 gc::space::ImageSpace& image_space,
1754 const ImageHeader& image_header,
1755 OatDumperOptions* oat_dumper_options)
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001756 : os_(os),
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001757 vios_(os),
1758 indent1_(&vios_),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001759 image_space_(image_space),
1760 image_header_(image_header),
1761 oat_dumper_options_(oat_dumper_options) {}
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001762
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001763 bool Dump() REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001764 std::ostream& os = *os_;
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001765 std::ostream& indent_os = vios_.Stream();
1766
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001767 os << "MAGIC: " << image_header_.GetMagic() << "\n\n";
Brian Carlstrome24fa612011-09-29 00:53:55 -07001768
Jeff Haodcdc85b2015-12-04 14:06:18 -08001769 os << "IMAGE LOCATION: " << image_space_.GetImageLocation() << "\n\n";
1770
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001771 os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n";
1772 os << "IMAGE SIZE: " << image_header_.GetImageSize() << "\n";
1773 os << "IMAGE CHECKSUM: " << std::hex << image_header_.GetImageChecksum() << std::dec << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -07001774
Vladimir Markoc10a0c62018-11-16 11:39:22 +00001775 os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum()) << "\n";
1776 os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n";
1777 os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n";
1778 os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n";
1779 os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n";
1780
1781 os << "BOOT IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetBootImageBegin())
1782 << "\n";
Vladimir Marko0c78ef72018-11-21 14:09:35 +00001783 os << "BOOT IMAGE SIZE: " << image_header_.GetBootImageSize() << "\n\n";
Mathieu Chartiere401d142015-04-22 13:56:20 -07001784
1785 for (size_t i = 0; i < ImageHeader::kSectionCount; ++i) {
1786 auto section = static_cast<ImageHeader::ImageSections>(i);
1787 os << "IMAGE SECTION " << section << ": " << image_header_.GetImageSection(section) << "\n\n";
1788 }
Mathieu Chartier31e89252013-08-28 11:29:12 -07001789
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001790 {
Vladimir Markoc13fbd82018-06-04 16:16:28 +01001791 os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots().Ptr()) << "\n";
Mathieu Chartiere401d142015-04-22 13:56:20 -07001792 static_assert(arraysize(image_roots_descriptions_) ==
1793 static_cast<size_t>(ImageHeader::kImageRootsMax), "sizes must match");
Vladimir Markoeca3eda2016-11-09 16:26:44 +00001794 DCHECK_LE(image_header_.GetImageRoots()->GetLength(), ImageHeader::kImageRootsMax);
1795 for (int32_t i = 0, size = image_header_.GetImageRoots()->GetLength(); i != size; ++i) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001796 ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i);
1797 const char* image_root_description = image_roots_descriptions_[i];
Vladimir Markoc13fbd82018-06-04 16:16:28 +01001798 ObjPtr<mirror::Object> image_root_object = image_header_.GetImageRoot(image_root);
1799 indent_os << StringPrintf("%s: %p\n", image_root_description, image_root_object.Ptr());
Vladimir Markoeca3eda2016-11-09 16:26:44 +00001800 if (image_root_object != nullptr && image_root_object->IsObjectArray()) {
Vladimir Markoc13fbd82018-06-04 16:16:28 +01001801 ObjPtr<mirror::ObjectArray<mirror::Object>> image_root_object_array
Ian Rogersfa824272013-11-05 16:12:57 -08001802 = image_root_object->AsObjectArray<mirror::Object>();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001803 ScopedIndentation indent2(&vios_);
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001804 for (int j = 0; j < image_root_object_array->GetLength(); j++) {
1805 mirror::Object* value = image_root_object_array->Get(j);
Ian Rogersfa824272013-11-05 16:12:57 -08001806 size_t run = 0;
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001807 for (int32_t k = j + 1; k < image_root_object_array->GetLength(); k++) {
1808 if (value == image_root_object_array->Get(k)) {
Ian Rogersfa824272013-11-05 16:12:57 -08001809 run++;
1810 } else {
1811 break;
1812 }
1813 }
1814 if (run == 0) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001815 indent_os << StringPrintf("%d: ", j);
Ian Rogersfa824272013-11-05 16:12:57 -08001816 } else {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001817 indent_os << StringPrintf("%d to %zd: ", j, j + run);
Andreas Gampe277ccbd2014-11-03 21:36:10 -08001818 j = j + run;
Ian Rogersfa824272013-11-05 16:12:57 -08001819 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001820 if (value != nullptr) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001821 PrettyObjectValue(indent_os, value->GetClass(), value);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001822 } else {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001823 indent_os << j << ": null\n";
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001824 }
Ian Rogersd5b32602012-02-26 16:40:04 -08001825 }
Brian Carlstrom34f426c2011-10-04 12:58:02 -07001826 }
1827 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001828 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001829
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001830 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001831 os << "METHOD ROOTS\n";
1832 static_assert(arraysize(image_methods_descriptions_) ==
1833 static_cast<size_t>(ImageHeader::kImageMethodsCount), "sizes must match");
1834 for (int i = 0; i < ImageHeader::kImageMethodsCount; i++) {
1835 auto image_root = static_cast<ImageHeader::ImageMethod>(i);
1836 const char* description = image_methods_descriptions_[i];
1837 auto* image_method = image_header_.GetImageMethod(image_root);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001838 indent_os << StringPrintf("%s: %p\n", description, image_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001839 }
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001840 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001841 os << "\n";
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001842
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -07001843 Runtime* const runtime = Runtime::Current();
1844 ClassLinker* class_linker = runtime->GetClassLinker();
Brian Carlstrom2ec65202014-03-03 15:16:37 -08001845 std::string image_filename = image_space_.GetImageFilename();
1846 std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001847 os << "OAT LOCATION: " << oat_location;
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001848 os << "\n";
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001849 std::string error_msg;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001850 const OatFile* oat_file = image_space_.GetOatFile();
Alex Lighta59dd802014-07-02 16:28:08 -07001851 if (oat_file == nullptr) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001852 oat_file = runtime->GetOatFileManager().FindOpenedOatFileFromOatLocation(oat_location);
1853 }
1854 if (oat_file == nullptr) {
Vladimir Markof4efa9e2018-10-17 14:12:45 +01001855 oat_file = OatFile::Open(/*zip_fd=*/ -1,
Nicolas Geoffray30025092018-04-19 14:43:29 +01001856 oat_location,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001857 oat_location,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01001858 /*executable=*/ false,
1859 /*low_4gb=*/ false,
1860 /*abs_dex_location=*/ nullptr,
1861 /*reservation=*/ nullptr,
Igor Murashkinb1d8c312015-08-04 11:18:43 -07001862 &error_msg);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001863 }
1864 if (oat_file == nullptr) {
1865 os << "OAT FILE NOT FOUND: " << error_msg << "\n";
1866 return EXIT_FAILURE;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001867 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001868 os << "\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -07001869
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001870 stats_.oat_file_bytes = oat_file->Size();
1871
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001872 oat_dumper_.reset(new OatDumper(*oat_file, *oat_dumper_options_));
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001873
Andreas Gampeb40d3612018-06-26 15:49:42 -07001874 for (const OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001875 CHECK(oat_dex_file != nullptr);
Mathieu Chartier02e25112013-08-14 16:14:24 -07001876 stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(),
1877 oat_dex_file->FileSize()));
Ian Rogers05f28c62012-10-23 18:12:13 -07001878 }
1879
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001880 os << "OBJECTS:\n" << std::flush;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07001881
Jeff Haodcdc85b2015-12-04 14:06:18 -08001882 // Loop through the image space and dump its objects.
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -07001883 gc::Heap* heap = runtime->GetHeap();
Ian Rogers50b35e22012-10-04 10:09:15 -07001884 Thread* self = Thread::Current();
Mathieu Chartier357e9be2012-08-01 11:00:14 -07001885 {
Mathieu Chartierc22c59e2014-02-24 15:16:06 -08001886 {
1887 WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
1888 heap->FlushAllocStack();
1889 }
Hiroshi Yamauchi90d70682014-02-20 16:17:30 -08001890 // Since FlushAllocStack() above resets the (active) allocation
1891 // stack. Need to revoke the thread-local allocation stacks that
1892 // point into it.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001893 ScopedThreadSuspension sts(self, kNative);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07001894 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07001895 heap->RevokeAllThreadLocalAllocationStacks(self);
Mathieu Chartier357e9be2012-08-01 11:00:14 -07001896 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001897 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07001898 // Mark dex caches.
Vladimir Marko05792b92015-08-03 11:56:49 +01001899 dex_caches_.clear();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001900 {
Andreas Gampecc1b5352016-12-01 16:58:38 -08001901 ReaderMutexLock mu(self, *Locks::dex_lock_);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08001902 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07001903 ObjPtr<mirror::DexCache> dex_cache =
1904 ObjPtr<mirror::DexCache>::DownCast(self->DecodeJObject(data.weak_root));
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001905 if (dex_cache != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07001906 dex_caches_.insert(dex_cache.Ptr());
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001907 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07001908 }
1909 }
Andreas Gampe0c183382017-07-13 22:26:24 -07001910 auto dump_visitor = [&](mirror::Object* obj) REQUIRES_SHARED(Locks::mutator_lock_) {
1911 DumpObject(obj);
1912 };
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001913 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001914 // Dump the normal objects before ArtMethods.
Andreas Gampe0c183382017-07-13 22:26:24 -07001915 image_space_.GetLiveBitmap()->Walk(dump_visitor);
Jeff Haodcdc85b2015-12-04 14:06:18 -08001916 indent_os << "\n";
1917 // TODO: Dump fields.
1918 // Dump methods after.
Jeff Haodcdc85b2015-12-04 14:06:18 -08001919 DumpArtMethodVisitor visitor(this);
Mathieu Chartiere42888f2016-04-14 10:49:19 -07001920 image_header_.VisitPackedArtMethods(&visitor,
1921 image_space_.Begin(),
1922 image_header_.GetPointerSize());
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001923 // Dump the large objects separately.
Andreas Gampe0c183382017-07-13 22:26:24 -07001924 heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(dump_visitor);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001925 indent_os << "\n";
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07001926 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001927 os << "STATS:\n" << std::flush;
Ian Rogers700a4022014-05-19 16:49:03 -07001928 std::unique_ptr<File> file(OS::OpenFileForReading(image_filename.c_str()));
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001929 size_t data_size = image_header_.GetDataSize(); // stored size in file.
1930 if (file == nullptr) {
Brian Carlstrom2ec65202014-03-03 15:16:37 -08001931 LOG(WARNING) << "Failed to find image in " << image_filename;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001932 } else {
Brian Carlstrom2ec65202014-03-03 15:16:37 -08001933 stats_.file_bytes = file->GetLength();
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001934 // If the image is compressed, adjust to decompressed size.
1935 size_t uncompressed_size = image_header_.GetImageSize() - sizeof(ImageHeader);
Mathieu Chartier1a842962018-11-13 15:09:51 -08001936 if (image_header_.HasCompressedBlock()) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001937 DCHECK_EQ(uncompressed_size, data_size) << "Sizes should match for uncompressed image";
1938 }
1939 stats_.file_bytes += uncompressed_size - data_size;
Brian Carlstrom6f277752013-09-30 17:56:45 -07001940 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001941 size_t header_bytes = sizeof(ImageHeader);
Vladimir Markocd87c3e2017-09-05 13:11:57 +01001942 const auto& object_section = image_header_.GetObjectsSection();
1943 const auto& field_section = image_header_.GetFieldsSection();
Mathieu Chartiere401d142015-04-22 13:56:20 -07001944 const auto& method_section = image_header_.GetMethodsSection();
Vladimir Markocd87c3e2017-09-05 13:11:57 +01001945 const auto& dex_cache_arrays_section = image_header_.GetDexCacheArraysSection();
1946 const auto& intern_section = image_header_.GetInternedStringsSection();
1947 const auto& class_table_section = image_header_.GetClassTableSection();
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07001948 const auto& sro_section = image_header_.GetImageStringReferenceOffsetsSection();
1949 const auto& metadata_section = image_header_.GetMetadataSection();
Vladimir Markocd87c3e2017-09-05 13:11:57 +01001950 const auto& bitmap_section = image_header_.GetImageBitmapSection();
Andreas Gampeace0dc12016-01-20 13:33:13 -08001951
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001952 stats_.header_bytes = header_bytes;
Andreas Gampeace0dc12016-01-20 13:33:13 -08001953
1954 // Objects are kObjectAlignment-aligned.
1955 // CHECK_EQ(RoundUp(header_bytes, kObjectAlignment), object_section.Offset());
1956 if (object_section.Offset() > header_bytes) {
1957 stats_.alignment_bytes += object_section.Offset() - header_bytes;
1958 }
1959
1960 // Field section is 4-byte aligned.
1961 constexpr size_t kFieldSectionAlignment = 4U;
1962 uint32_t end_objects = object_section.Offset() + object_section.Size();
1963 CHECK_EQ(RoundUp(end_objects, kFieldSectionAlignment), field_section.Offset());
1964 stats_.alignment_bytes += field_section.Offset() - end_objects;
1965
1966 // Method section is 4/8 byte aligned depending on target. Just check for 4-byte alignment.
1967 uint32_t end_fields = field_section.Offset() + field_section.Size();
1968 CHECK_ALIGNED(method_section.Offset(), 4);
1969 stats_.alignment_bytes += method_section.Offset() - end_fields;
1970
1971 // Dex cache arrays section is aligned depending on the target. Just check for 4-byte alignment.
1972 uint32_t end_methods = method_section.Offset() + method_section.Size();
1973 CHECK_ALIGNED(dex_cache_arrays_section.Offset(), 4);
1974 stats_.alignment_bytes += dex_cache_arrays_section.Offset() - end_methods;
1975
1976 // Intern table is 8-byte aligned.
1977 uint32_t end_caches = dex_cache_arrays_section.Offset() + dex_cache_arrays_section.Size();
Vladimir Markoe47f60c2018-02-21 13:43:28 +00001978 CHECK_EQ(RoundUp(end_caches, 8U), intern_section.Offset());
Andreas Gampeace0dc12016-01-20 13:33:13 -08001979 stats_.alignment_bytes += intern_section.Offset() - end_caches;
1980
1981 // Add space between intern table and class table.
1982 uint32_t end_intern = intern_section.Offset() + intern_section.Size();
1983 stats_.alignment_bytes += class_table_section.Offset() - end_intern;
1984
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001985 // Add space between end of image data and bitmap. Expect the bitmap to be page-aligned.
1986 const size_t bitmap_offset = sizeof(ImageHeader) + data_size;
Andreas Gampeace0dc12016-01-20 13:33:13 -08001987 CHECK_ALIGNED(bitmap_section.Offset(), kPageSize);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001988 stats_.alignment_bytes += RoundUp(bitmap_offset, kPageSize) - bitmap_offset;
Andreas Gampeace0dc12016-01-20 13:33:13 -08001989
Mathieu Chartiere401d142015-04-22 13:56:20 -07001990 stats_.bitmap_bytes += bitmap_section.Size();
1991 stats_.art_field_bytes += field_section.Size();
Vladimir Markocf36d492015-08-12 19:27:26 +01001992 stats_.art_method_bytes += method_section.Size();
Vladimir Marko05792b92015-08-03 11:56:49 +01001993 stats_.dex_cache_arrays_bytes += dex_cache_arrays_section.Size();
Mathieu Chartierd39645e2015-06-09 17:50:29 -07001994 stats_.interned_strings_bytes += intern_section.Size();
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08001995 stats_.class_table_bytes += class_table_section.Size();
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07001996 stats_.sro_offset_bytes += sro_section.Size();
1997 stats_.metadata_bytes += metadata_section.Size();
1998
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001999 stats_.Dump(os, indent_os);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002000 os << "\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002001
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002002 os << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002003
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07002004 return oat_dumper_->Dump(os);
Brian Carlstrom78128a62011-09-15 17:21:19 -07002005 }
2006
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002007 private:
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002008 class DumpArtMethodVisitor : public ArtMethodVisitor {
2009 public:
2010 explicit DumpArtMethodVisitor(ImageDumper* image_dumper) : image_dumper_(image_dumper) {}
2011
Roland Levillainf73caca2018-08-24 17:19:07 +01002012 void Visit(ArtMethod* method) override REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002013 std::ostream& indent_os = image_dumper_->vios_.Stream();
David Sehr709b0702016-10-13 09:12:37 -07002014 indent_os << method << " " << " ArtMethod: " << ArtMethod::PrettyMethod(method) << "\n";
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002015 image_dumper_->DumpMethod(method, indent_os);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002016 indent_os << "\n";
2017 }
2018
2019 private:
2020 ImageDumper* const image_dumper_;
2021 };
2022
Mathieu Chartier3398c782016-09-30 10:27:43 -07002023 static void PrettyObjectValue(std::ostream& os,
2024 ObjPtr<mirror::Class> type,
2025 ObjPtr<mirror::Object> value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002026 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002027 CHECK(type != nullptr);
2028 if (value == nullptr) {
David Sehr709b0702016-10-13 09:12:37 -07002029 os << StringPrintf("null %s\n", type->PrettyDescriptor().c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002030 } else if (type->IsStringClass()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002031 mirror::String* string = value->AsString();
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002032 os << StringPrintf("%p String: %s\n", string,
Ian Rogers68b56852014-08-29 20:19:11 -07002033 PrintableString(string->ToModifiedUtf8().c_str()).c_str());
Ian Rogers64b6d142012-10-29 16:34:15 -07002034 } else if (type->IsClassClass()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002035 mirror::Class* klass = value->AsClass();
David Sehr709b0702016-10-13 09:12:37 -07002036 os << StringPrintf("%p Class: %s\n", klass, mirror::Class::PrettyDescriptor(klass).c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002037 } else {
David Sehr709b0702016-10-13 09:12:37 -07002038 os << StringPrintf("%p %s\n", value.Ptr(), type->PrettyDescriptor().c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002039 }
2040 }
2041
Mathieu Chartier3398c782016-09-30 10:27:43 -07002042 static void PrintField(std::ostream& os, ArtField* field, ObjPtr<mirror::Object> obj)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002043 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07002044 os << StringPrintf("%s: ", field->GetName());
Ian Rogers08f1f502014-12-02 15:04:37 -08002045 switch (field->GetTypeAsPrimitiveType()) {
2046 case Primitive::kPrimLong:
Ian Rogersef7d42f2014-01-06 12:55:46 -08002047 os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002048 break;
2049 case Primitive::kPrimDouble:
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002050 os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002051 break;
2052 case Primitive::kPrimFloat:
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002053 os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002054 break;
2055 case Primitive::kPrimInt:
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002056 os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002057 break;
2058 case Primitive::kPrimChar:
Fred Shih37f05ef2014-07-16 18:38:08 -07002059 os << StringPrintf("%u (0x%x)\n", field->GetChar(obj), field->GetChar(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002060 break;
2061 case Primitive::kPrimShort:
Fred Shih37f05ef2014-07-16 18:38:08 -07002062 os << StringPrintf("%d (0x%x)\n", field->GetShort(obj), field->GetShort(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002063 break;
2064 case Primitive::kPrimBoolean:
Roland Levillain5e8d5f02016-10-18 18:03:43 +01002065 os << StringPrintf("%s (0x%x)\n", field->GetBoolean(obj) ? "true" : "false",
Fred Shih37f05ef2014-07-16 18:38:08 -07002066 field->GetBoolean(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002067 break;
2068 case Primitive::kPrimByte:
Fred Shih37f05ef2014-07-16 18:38:08 -07002069 os << StringPrintf("%d (0x%x)\n", field->GetByte(obj), field->GetByte(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002070 break;
2071 case Primitive::kPrimNot: {
2072 // Get the value, don't compute the type unless it is non-null as we don't want
2073 // to cause class loading.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002074 ObjPtr<mirror::Object> value = field->GetObj(obj);
Ian Rogers08f1f502014-12-02 15:04:37 -08002075 if (value == nullptr) {
2076 os << StringPrintf("null %s\n", PrettyDescriptor(field->GetTypeDescriptor()).c_str());
Ian Rogers50239c72013-06-17 14:53:22 -07002077 } else {
Ian Rogers08f1f502014-12-02 15:04:37 -08002078 // Grab the field type without causing resolution.
Vladimir Marko208f6702017-12-08 12:00:50 +00002079 ObjPtr<mirror::Class> field_type = field->LookupResolvedType();
Ian Rogers08f1f502014-12-02 15:04:37 -08002080 if (field_type != nullptr) {
2081 PrettyObjectValue(os, field_type, value);
2082 } else {
Mathieu Chartier3398c782016-09-30 10:27:43 -07002083 os << StringPrintf("%p %s\n",
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07002084 value.Ptr(),
Ian Rogers08f1f502014-12-02 15:04:37 -08002085 PrettyDescriptor(field->GetTypeDescriptor()).c_str());
2086 }
Ian Rogers50239c72013-06-17 14:53:22 -07002087 }
Ian Rogers08f1f502014-12-02 15:04:37 -08002088 break;
Ian Rogers48efc2b2012-08-27 17:20:31 -07002089 }
Ian Rogers08f1f502014-12-02 15:04:37 -08002090 default:
2091 os << "unexpected field type: " << field->GetTypeDescriptor() << "\n";
2092 break;
Ian Rogersd5b32602012-02-26 16:40:04 -08002093 }
2094 }
2095
Andreas Gampe98104992018-10-16 12:49:47 -07002096 static void DumpFields(std::ostream& os, mirror::Object* obj, ObjPtr<mirror::Class> klass)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002097 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe98104992018-10-16 12:49:47 -07002098 ObjPtr<mirror::Class> super = klass->GetSuperClass();
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002099 if (super != nullptr) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002100 DumpFields(os, obj, super);
Ian Rogersd5b32602012-02-26 16:40:04 -08002101 }
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002102 for (ArtField& field : klass->GetIFields()) {
2103 PrintField(os, &field, obj);
Ian Rogersd5b32602012-02-26 16:40:04 -08002104 }
2105 }
2106
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002107 bool InDumpSpace(const mirror::Object* object) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002108 return image_space_.Contains(object);
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002109 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002110
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002111 const void* GetQuickOatCodeBegin(ArtMethod* m) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiera7dd0382014-11-20 17:08:58 -08002112 const void* quick_code = m->GetEntryPointFromQuickCompiledCodePtrSize(
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002113 image_header_.GetPointerSize());
Ian Rogers6f3dbba2014-10-14 17:41:57 -07002114 if (Runtime::Current()->GetClassLinker()->IsQuickResolutionStub(quick_code)) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002115 quick_code = oat_dumper_->GetQuickOatCode(m);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002116 }
Vladimir Marko33bff252017-11-01 14:35:42 +00002117 if (oat_dumper_->GetInstructionSet() == InstructionSet::kThumb2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002118 quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1);
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002119 }
Ian Rogersef7d42f2014-01-06 12:55:46 -08002120 return quick_code;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002121 }
2122
Mathieu Chartiere401d142015-04-22 13:56:20 -07002123 uint32_t GetQuickOatCodeSize(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002124 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002125 const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m));
2126 if (oat_code_begin == nullptr) {
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002127 return 0;
2128 }
2129 return oat_code_begin[-1];
2130 }
2131
Mathieu Chartiere401d142015-04-22 13:56:20 -07002132 const void* GetQuickOatCodeEnd(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002133 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002134 const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m));
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002135 if (oat_code_begin == nullptr) {
2136 return nullptr;
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002137 }
Ian Rogersef7d42f2014-01-06 12:55:46 -08002138 return oat_code_begin + GetQuickOatCodeSize(m);
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002139 }
2140
Andreas Gampe0c183382017-07-13 22:26:24 -07002141 void DumpObject(mirror::Object* obj) REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002142 DCHECK(obj != nullptr);
Andreas Gampe0c183382017-07-13 22:26:24 -07002143 if (!InDumpSpace(obj)) {
Brian Carlstrom78128a62011-09-15 17:21:19 -07002144 return;
2145 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002146
2147 size_t object_bytes = obj->SizeOf();
2148 size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes;
Andreas Gampe0c183382017-07-13 22:26:24 -07002149 stats_.object_bytes += object_bytes;
2150 stats_.alignment_bytes += alignment_bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002151
Andreas Gampe0c183382017-07-13 22:26:24 -07002152 std::ostream& os = vios_.Stream();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002153
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002154 mirror::Class* obj_class = obj->GetClass();
Ian Rogersd5b32602012-02-26 16:40:04 -08002155 if (obj_class->IsArrayClass()) {
David Sehr709b0702016-10-13 09:12:37 -07002156 os << StringPrintf("%p: %s length:%d\n", obj, obj_class->PrettyDescriptor().c_str(),
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002157 obj->AsArray()->GetLength());
Ian Rogersd5b32602012-02-26 16:40:04 -08002158 } else if (obj->IsClass()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002159 mirror::Class* klass = obj->AsClass();
David Sehr709b0702016-10-13 09:12:37 -07002160 os << StringPrintf("%p: java.lang.Class \"%s\" (", obj,
2161 mirror::Class::PrettyDescriptor(klass).c_str())
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002162 << klass->GetStatus() << ")\n";
Ian Rogersd5b32602012-02-26 16:40:04 -08002163 } else if (obj_class->IsStringClass()) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002164 os << StringPrintf("%p: java.lang.String %s\n", obj,
Ian Rogers68b56852014-08-29 20:19:11 -07002165 PrintableString(obj->AsString()->ToModifiedUtf8().c_str()).c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002166 } else {
David Sehr709b0702016-10-13 09:12:37 -07002167 os << StringPrintf("%p: %s\n", obj, obj_class->PrettyDescriptor().c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002168 }
Andreas Gampe0c183382017-07-13 22:26:24 -07002169 ScopedIndentation indent1(&vios_);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002170 DumpFields(os, obj, obj_class);
Andreas Gampe0c183382017-07-13 22:26:24 -07002171 const PointerSize image_pointer_size = image_header_.GetPointerSize();
Ian Rogersd5b32602012-02-26 16:40:04 -08002172 if (obj->IsObjectArray()) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002173 auto* obj_array = obj->AsObjectArray<mirror::Object>();
2174 for (int32_t i = 0, length = obj_array->GetLength(); i < length; i++) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002175 mirror::Object* value = obj_array->Get(i);
Ian Rogersd5b32602012-02-26 16:40:04 -08002176 size_t run = 0;
2177 for (int32_t j = i + 1; j < length; j++) {
2178 if (value == obj_array->Get(j)) {
2179 run++;
2180 } else {
2181 break;
2182 }
2183 }
2184 if (run == 0) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002185 os << StringPrintf("%d: ", i);
Ian Rogersd5b32602012-02-26 16:40:04 -08002186 } else {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002187 os << StringPrintf("%d to %zd: ", i, i + run);
Ian Rogersd5b32602012-02-26 16:40:04 -08002188 i = i + run;
2189 }
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002190 mirror::Class* value_class =
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002191 (value == nullptr) ? obj_class->GetComponentType() : value->GetClass();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002192 PrettyObjectValue(os, value_class, value);
Ian Rogersd5b32602012-02-26 16:40:04 -08002193 }
2194 } else if (obj->IsClass()) {
Vladimir Marko38b8b252018-01-02 19:07:06 +00002195 ObjPtr<mirror::Class> klass = obj->AsClass();
Igor Murashkin86083f72017-10-27 10:59:04 -07002196
Vladimir Marko305c38b2018-02-14 11:50:07 +00002197 if (kBitstringSubtypeCheckEnabled) {
2198 os << "SUBTYPE_CHECK_BITS: ";
2199 SubtypeCheck<ObjPtr<mirror::Class>>::Dump(klass, os);
2200 os << "\n";
2201 }
Igor Murashkin86083f72017-10-27 10:59:04 -07002202
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002203 if (klass->NumStaticFields() != 0) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002204 os << "STATICS:\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002205 ScopedIndentation indent2(&vios_);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002206 for (ArtField& field : klass->GetSFields()) {
2207 PrintField(os, &field, field.GetDeclaringClass());
Ian Rogersd5b32602012-02-26 16:40:04 -08002208 }
2209 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002210 } else {
Andreas Gampe0c183382017-07-13 22:26:24 -07002211 auto it = dex_caches_.find(obj);
2212 if (it != dex_caches_.end()) {
Vladimir Marko05792b92015-08-03 11:56:49 +01002213 auto* dex_cache = down_cast<mirror::DexCache*>(obj);
Vladimir Markocd87c3e2017-09-05 13:11:57 +01002214 const auto& field_section = image_header_.GetFieldsSection();
Andreas Gampe0c183382017-07-13 22:26:24 -07002215 const auto& method_section = image_header_.GetMethodsSection();
Vladimir Marko05792b92015-08-03 11:56:49 +01002216 size_t num_methods = dex_cache->NumResolvedMethods();
2217 if (num_methods != 0u) {
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002218 os << "Methods (size=" << num_methods << "):\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002219 ScopedIndentation indent2(&vios_);
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002220 mirror::MethodDexCacheType* resolved_methods = dex_cache->GetResolvedMethods();
Vladimir Marko05792b92015-08-03 11:56:49 +01002221 for (size_t i = 0, length = dex_cache->NumResolvedMethods(); i < length; ++i) {
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002222 ArtMethod* elem = mirror::DexCache::GetNativePairPtrSize(
2223 resolved_methods, i, image_pointer_size).object;
Vladimir Marko05792b92015-08-03 11:56:49 +01002224 size_t run = 0;
2225 for (size_t j = i + 1;
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002226 j != length &&
2227 elem == mirror::DexCache::GetNativePairPtrSize(
2228 resolved_methods, j, image_pointer_size).object;
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002229 ++j) {
2230 ++run;
2231 }
Vladimir Marko05792b92015-08-03 11:56:49 +01002232 if (run == 0) {
2233 os << StringPrintf("%zd: ", i);
2234 } else {
2235 os << StringPrintf("%zd to %zd: ", i, i + run);
2236 i = i + run;
2237 }
2238 std::string msg;
2239 if (elem == nullptr) {
2240 msg = "null";
2241 } else if (method_section.Contains(
Andreas Gampe0c183382017-07-13 22:26:24 -07002242 reinterpret_cast<uint8_t*>(elem) - image_space_.Begin())) {
David Sehr709b0702016-10-13 09:12:37 -07002243 msg = reinterpret_cast<ArtMethod*>(elem)->PrettyMethod();
Vladimir Marko05792b92015-08-03 11:56:49 +01002244 } else {
2245 msg = "<not in method section>";
2246 }
2247 os << StringPrintf("%p %s\n", elem, msg.c_str());
Ian Rogers0d2d3782012-04-10 11:09:18 -07002248 }
Vladimir Marko05792b92015-08-03 11:56:49 +01002249 }
2250 size_t num_fields = dex_cache->NumResolvedFields();
2251 if (num_fields != 0u) {
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002252 os << "Fields (size=" << num_fields << "):\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002253 ScopedIndentation indent2(&vios_);
Vladimir Marko05792b92015-08-03 11:56:49 +01002254 auto* resolved_fields = dex_cache->GetResolvedFields();
2255 for (size_t i = 0, length = dex_cache->NumResolvedFields(); i < length; ++i) {
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002256 ArtField* elem = mirror::DexCache::GetNativePairPtrSize(
Vladimir Markof44d36c2017-03-14 14:18:46 +00002257 resolved_fields, i, image_pointer_size).object;
Vladimir Marko05792b92015-08-03 11:56:49 +01002258 size_t run = 0;
2259 for (size_t j = i + 1;
Vladimir Markof44d36c2017-03-14 14:18:46 +00002260 j != length &&
2261 elem == mirror::DexCache::GetNativePairPtrSize(
2262 resolved_fields, j, image_pointer_size).object;
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002263 ++j) {
2264 ++run;
2265 }
Vladimir Marko05792b92015-08-03 11:56:49 +01002266 if (run == 0) {
2267 os << StringPrintf("%zd: ", i);
2268 } else {
2269 os << StringPrintf("%zd to %zd: ", i, i + run);
2270 i = i + run;
2271 }
2272 std::string msg;
2273 if (elem == nullptr) {
2274 msg = "null";
2275 } else if (field_section.Contains(
Andreas Gampe0c183382017-07-13 22:26:24 -07002276 reinterpret_cast<uint8_t*>(elem) - image_space_.Begin())) {
David Sehr709b0702016-10-13 09:12:37 -07002277 msg = reinterpret_cast<ArtField*>(elem)->PrettyField();
Vladimir Marko05792b92015-08-03 11:56:49 +01002278 } else {
2279 msg = "<not in field section>";
2280 }
2281 os << StringPrintf("%p %s\n", elem, msg.c_str());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002282 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002283 }
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002284 size_t num_types = dex_cache->NumResolvedTypes();
2285 if (num_types != 0u) {
2286 os << "Types (size=" << num_types << "):\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002287 ScopedIndentation indent2(&vios_);
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002288 auto* resolved_types = dex_cache->GetResolvedTypes();
2289 for (size_t i = 0; i < num_types; ++i) {
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002290 auto pair = resolved_types[i].load(std::memory_order_relaxed);
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002291 size_t run = 0;
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002292 for (size_t j = i + 1; j != num_types; ++j) {
2293 auto other_pair = resolved_types[j].load(std::memory_order_relaxed);
2294 if (pair.index != other_pair.index ||
2295 pair.object.Read() != other_pair.object.Read()) {
2296 break;
2297 }
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002298 ++run;
2299 }
2300 if (run == 0) {
2301 os << StringPrintf("%zd: ", i);
2302 } else {
2303 os << StringPrintf("%zd to %zd: ", i, i + run);
2304 i = i + run;
2305 }
2306 std::string msg;
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002307 auto* elem = pair.object.Read();
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002308 if (elem == nullptr) {
2309 msg = "null";
2310 } else {
David Sehr709b0702016-10-13 09:12:37 -07002311 msg = elem->PrettyClass();
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002312 }
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002313 os << StringPrintf("%p %u %s\n", elem, pair.index, msg.c_str());
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002314 }
2315 }
Brian Carlstrom78128a62011-09-15 17:21:19 -07002316 }
2317 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07002318 std::string temp;
Andreas Gampe0c183382017-07-13 22:26:24 -07002319 stats_.Update(obj_class->GetDescriptor(&temp), object_bytes);
Brian Carlstrom78128a62011-09-15 17:21:19 -07002320 }
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002321
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002322 void DumpMethod(ArtMethod* method, std::ostream& indent_os)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002323 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002324 DCHECK(method != nullptr);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002325 const void* quick_oat_code_begin = GetQuickOatCodeBegin(method);
2326 const void* quick_oat_code_end = GetQuickOatCodeEnd(method);
Andreas Gampe542451c2016-07-26 09:02:02 -07002327 const PointerSize pointer_size = image_header_.GetPointerSize();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002328 OatQuickMethodHeader* method_header = reinterpret_cast<OatQuickMethodHeader*>(
2329 reinterpret_cast<uintptr_t>(quick_oat_code_begin) - sizeof(OatQuickMethodHeader));
Mathieu Chartiere401d142015-04-22 13:56:20 -07002330 if (method->IsNative()) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002331 bool first_occurrence;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002332 uint32_t quick_oat_code_size = GetQuickOatCodeSize(method);
2333 ComputeOatSize(quick_oat_code_begin, &first_occurrence);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002334 if (first_occurrence) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002335 stats_.native_to_managed_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002336 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002337 if (quick_oat_code_begin != method->GetEntryPointFromQuickCompiledCodePtrSize(
2338 image_header_.GetPointerSize())) {
Nicolas Geoffray6bc43742015-10-12 18:11:10 +01002339 indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code_begin);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002340 }
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002341 } else if (method->IsAbstract() || method->IsClassInitializer()) {
Nicolas Geoffray796d6302016-03-13 22:22:31 +00002342 // Don't print information for these.
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002343 } else if (method->IsRuntimeMethod()) {
2344 ImtConflictTable* table = method->GetImtConflictTable(image_header_.GetPointerSize());
2345 if (table != nullptr) {
2346 indent_os << "IMT conflict table " << table << " method: ";
2347 for (size_t i = 0, count = table->NumEntries(pointer_size); i < count; ++i) {
David Sehr709b0702016-10-13 09:12:37 -07002348 indent_os << ArtMethod::PrettyMethod(table->GetImplementationMethod(i, pointer_size))
2349 << " ";
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002350 }
2351 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002352 } else {
David Sehr0225f8e2018-01-31 08:52:24 +00002353 CodeItemDataAccessor code_item_accessor(method->DexInstructionData());
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08002354 size_t dex_instruction_bytes = code_item_accessor.InsnsSizeInCodeUnits() * 2;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002355 stats_.dex_instruction_bytes += dex_instruction_bytes;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002356
2357 bool first_occurrence;
Roland Levillain6d7f1792015-07-02 10:59:15 +01002358 size_t vmap_table_bytes = 0u;
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002359 if (!method_header->IsOptimized()) {
Roland Levillain6d7f1792015-07-02 10:59:15 +01002360 // Method compiled with the optimizing compiler have no vmap table.
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002361 vmap_table_bytes = ComputeOatSize(method_header->GetVmapTable(), &first_occurrence);
Roland Levillain6d7f1792015-07-02 10:59:15 +01002362 if (first_occurrence) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002363 stats_.vmap_table_bytes += vmap_table_bytes;
Roland Levillain6d7f1792015-07-02 10:59:15 +01002364 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002365 }
2366
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002367 uint32_t quick_oat_code_size = GetQuickOatCodeSize(method);
2368 ComputeOatSize(quick_oat_code_begin, &first_occurrence);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002369 if (first_occurrence) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002370 stats_.managed_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002371 if (method->IsConstructor()) {
2372 if (method->IsStatic()) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002373 stats_.class_initializer_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002374 } else if (dex_instruction_bytes > kLargeConstructorDexBytes) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002375 stats_.large_initializer_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002376 }
2377 } else if (dex_instruction_bytes > kLargeMethodDexBytes) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002378 stats_.large_method_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002379 }
2380 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002381 stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002382
Igor Murashkin7617abd2015-07-10 18:27:47 -07002383 uint32_t method_access_flags = method->GetAccessFlags();
2384
Mathieu Chartiere401d142015-04-22 13:56:20 -07002385 indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002386 indent_os << StringPrintf("SIZE: Dex Instructions=%zd StackMaps=%zd AccessFlags=0x%x\n",
2387 dex_instruction_bytes,
2388 vmap_table_bytes,
Igor Murashkin7617abd2015-07-10 18:27:47 -07002389 method_access_flags);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002390
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002391 size_t total_size = dex_instruction_bytes +
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002392 vmap_table_bytes + quick_oat_code_size + ArtMethod::Size(image_header_.GetPointerSize());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002393
2394 double expansion =
2395 static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002396 stats_.ComputeOutliers(total_size, expansion, method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002397 }
2398 }
2399
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002400 std::set<const void*> already_seen_;
2401 // Compute the size of the given data within the oat file and whether this is the first time
2402 // this data has been requested
Elliott Hughesa0e18062012-04-13 15:59:59 -07002403 size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002404 if (already_seen_.count(oat_data) == 0) {
Elliott Hughesa0e18062012-04-13 15:59:59 -07002405 *first_occurrence = true;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002406 already_seen_.insert(oat_data);
2407 } else {
Elliott Hughesa0e18062012-04-13 15:59:59 -07002408 *first_occurrence = false;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002409 }
2410 return oat_dumper_->ComputeSize(oat_data);
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002411 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002412
2413 public:
2414 struct Stats {
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002415 size_t oat_file_bytes = 0u;
2416 size_t file_bytes = 0u;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002417
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002418 size_t header_bytes = 0u;
2419 size_t object_bytes = 0u;
2420 size_t art_field_bytes = 0u;
2421 size_t art_method_bytes = 0u;
2422 size_t dex_cache_arrays_bytes = 0u;
2423 size_t interned_strings_bytes = 0u;
2424 size_t class_table_bytes = 0u;
2425 size_t sro_offset_bytes = 0u;
2426 size_t metadata_bytes = 0u;
2427 size_t bitmap_bytes = 0u;
2428 size_t alignment_bytes = 0u;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002429
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002430 size_t managed_code_bytes = 0u;
2431 size_t managed_code_bytes_ignoring_deduplication = 0u;
2432 size_t native_to_managed_code_bytes = 0u;
2433 size_t class_initializer_code_bytes = 0u;
2434 size_t large_initializer_code_bytes = 0u;
2435 size_t large_method_code_bytes = 0u;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002436
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002437 size_t vmap_table_bytes = 0u;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002438
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002439 size_t dex_instruction_bytes = 0u;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002440
Mathieu Chartiere401d142015-04-22 13:56:20 -07002441 std::vector<ArtMethod*> method_outlier;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002442 std::vector<size_t> method_outlier_size;
2443 std::vector<double> method_outlier_expansion;
Ian Rogers700a4022014-05-19 16:49:03 -07002444 std::vector<std::pair<std::string, size_t>> oat_dex_file_sizes;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002445
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002446 Stats() {}
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002447
Elliott Hughesa0e18062012-04-13 15:59:59 -07002448 struct SizeAndCount {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002449 SizeAndCount(size_t bytes_in, size_t count_in) : bytes(bytes_in), count(count_in) {}
Elliott Hughesa0e18062012-04-13 15:59:59 -07002450 size_t bytes;
2451 size_t count;
2452 };
Andreas Gampec55bb392018-09-21 00:02:02 +00002453 using SizeAndCountTable = SafeMap<std::string, SizeAndCount>;
Elliott Hughesa0e18062012-04-13 15:59:59 -07002454 SizeAndCountTable sizes_and_counts;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002455
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002456 void Update(const char* descriptor, size_t object_bytes_in) {
Elliott Hughesa0e18062012-04-13 15:59:59 -07002457 SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor);
2458 if (it != sizes_and_counts.end()) {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002459 it->second.bytes += object_bytes_in;
Elliott Hughesa0e18062012-04-13 15:59:59 -07002460 it->second.count += 1;
2461 } else {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002462 sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes_in, 1));
Elliott Hughesa0e18062012-04-13 15:59:59 -07002463 }
2464 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002465
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002466 double PercentOfOatBytes(size_t size) {
2467 return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100;
2468 }
2469
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002470 double PercentOfFileBytes(size_t size) {
2471 return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100;
2472 }
2473
2474 double PercentOfObjectBytes(size_t size) {
2475 return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100;
2476 }
2477
Mathieu Chartiere401d142015-04-22 13:56:20 -07002478 void ComputeOutliers(size_t total_size, double expansion, ArtMethod* method) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002479 method_outlier_size.push_back(total_size);
2480 method_outlier_expansion.push_back(expansion);
2481 method_outlier.push_back(method);
2482 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002483
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002484 void DumpOutliers(std::ostream& os)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002485 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002486 size_t sum_of_sizes = 0;
2487 size_t sum_of_sizes_squared = 0;
2488 size_t sum_of_expansion = 0;
2489 size_t sum_of_expansion_squared = 0;
2490 size_t n = method_outlier_size.size();
Mathieu Chartier1ebf8d32016-06-09 11:51:27 -07002491 if (n <= 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002492 return;
2493 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002494 for (size_t i = 0; i < n; i++) {
2495 size_t cur_size = method_outlier_size[i];
2496 sum_of_sizes += cur_size;
2497 sum_of_sizes_squared += cur_size * cur_size;
2498 double cur_expansion = method_outlier_expansion[i];
2499 sum_of_expansion += cur_expansion;
2500 sum_of_expansion_squared += cur_expansion * cur_expansion;
2501 }
2502 size_t size_mean = sum_of_sizes / n;
2503 size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1);
2504 double expansion_mean = sum_of_expansion / n;
2505 double expansion_variance =
2506 (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1);
2507
2508 // Dump methods whose size is a certain number of standard deviations from the mean
2509 size_t dumped_values = 0;
2510 size_t skipped_values = 0;
2511 for (size_t i = 100; i > 0; i--) { // i is the current number of standard deviations
2512 size_t cur_size_variance = i * i * size_variance;
2513 bool first = true;
2514 for (size_t j = 0; j < n; j++) {
2515 size_t cur_size = method_outlier_size[j];
2516 if (cur_size > size_mean) {
2517 size_t cur_var = cur_size - size_mean;
2518 cur_var = cur_var * cur_var;
2519 if (cur_var > cur_size_variance) {
2520 if (dumped_values > 20) {
2521 if (i == 1) {
2522 skipped_values++;
2523 } else {
2524 i = 2; // jump to counting for 1 standard deviation
2525 break;
2526 }
2527 } else {
2528 if (first) {
Elliott Hughesc073b072012-05-24 19:29:17 -07002529 os << "\nBig methods (size > " << i << " standard deviations the norm):\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002530 first = false;
2531 }
David Sehr709b0702016-10-13 09:12:37 -07002532 os << ArtMethod::PrettyMethod(method_outlier[j]) << " requires storage of "
Elliott Hughesc073b072012-05-24 19:29:17 -07002533 << PrettySize(cur_size) << "\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002534 method_outlier_size[j] = 0; // don't consider this method again
2535 dumped_values++;
2536 }
2537 }
2538 }
2539 }
2540 }
2541 if (skipped_values > 0) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002542 os << "... skipped " << skipped_values
Elliott Hughesc073b072012-05-24 19:29:17 -07002543 << " methods with size > 1 standard deviation from the norm\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002544 }
Elliott Hughesc073b072012-05-24 19:29:17 -07002545 os << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002546
2547 // Dump methods whose expansion is a certain number of standard deviations from the mean
2548 dumped_values = 0;
2549 skipped_values = 0;
2550 for (size_t i = 10; i > 0; i--) { // i is the current number of standard deviations
2551 double cur_expansion_variance = i * i * expansion_variance;
2552 bool first = true;
2553 for (size_t j = 0; j < n; j++) {
2554 double cur_expansion = method_outlier_expansion[j];
2555 if (cur_expansion > expansion_mean) {
2556 size_t cur_var = cur_expansion - expansion_mean;
2557 cur_var = cur_var * cur_var;
2558 if (cur_var > cur_expansion_variance) {
2559 if (dumped_values > 20) {
2560 if (i == 1) {
2561 skipped_values++;
2562 } else {
2563 i = 2; // jump to counting for 1 standard deviation
2564 break;
2565 }
2566 } else {
2567 if (first) {
2568 os << "\nLarge expansion methods (size > " << i
Elliott Hughesc073b072012-05-24 19:29:17 -07002569 << " standard deviations the norm):\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002570 first = false;
2571 }
David Sehr709b0702016-10-13 09:12:37 -07002572 os << ArtMethod::PrettyMethod(method_outlier[j]) << " expanded code by "
Elliott Hughesc073b072012-05-24 19:29:17 -07002573 << cur_expansion << "\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002574 method_outlier_expansion[j] = 0.0; // don't consider this method again
2575 dumped_values++;
2576 }
2577 }
2578 }
2579 }
2580 }
2581 if (skipped_values > 0) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002582 os << "... skipped " << skipped_values
Elliott Hughesc073b072012-05-24 19:29:17 -07002583 << " methods with expansion > 1 standard deviation from the norm\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002584 }
Elliott Hughesc073b072012-05-24 19:29:17 -07002585 os << "\n" << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002586 }
2587
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002588 void Dump(std::ostream& os, std::ostream& indent_os)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002589 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002590 {
2591 os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n"
2592 << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n";
Vladimir Marko05792b92015-08-03 11:56:49 +01002593 indent_os << StringPrintf("header_bytes = %8zd (%2.0f%% of art file bytes)\n"
2594 "object_bytes = %8zd (%2.0f%% of art file bytes)\n"
2595 "art_field_bytes = %8zd (%2.0f%% of art file bytes)\n"
2596 "art_method_bytes = %8zd (%2.0f%% of art file bytes)\n"
2597 "dex_cache_arrays_bytes = %8zd (%2.0f%% of art file bytes)\n"
2598 "interned_string_bytes = %8zd (%2.0f%% of art file bytes)\n"
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002599 "class_table_bytes = %8zd (%2.0f%% of art file bytes)\n"
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002600 "sro_bytes = %8zd (%2.0f%% of art file bytes)\n"
2601 "metadata_bytes = %8zd (%2.0f%% of art file bytes)\n"
Vladimir Marko05792b92015-08-03 11:56:49 +01002602 "bitmap_bytes = %8zd (%2.0f%% of art file bytes)\n"
2603 "alignment_bytes = %8zd (%2.0f%% of art file bytes)\n\n",
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002604 header_bytes, PercentOfFileBytes(header_bytes),
2605 object_bytes, PercentOfFileBytes(object_bytes),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002606 art_field_bytes, PercentOfFileBytes(art_field_bytes),
2607 art_method_bytes, PercentOfFileBytes(art_method_bytes),
Vladimir Marko05792b92015-08-03 11:56:49 +01002608 dex_cache_arrays_bytes,
2609 PercentOfFileBytes(dex_cache_arrays_bytes),
Mathieu Chartierd39645e2015-06-09 17:50:29 -07002610 interned_strings_bytes,
2611 PercentOfFileBytes(interned_strings_bytes),
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002612 class_table_bytes, PercentOfFileBytes(class_table_bytes),
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002613 sro_offset_bytes, PercentOfFileBytes(sro_offset_bytes),
2614 metadata_bytes, PercentOfFileBytes(metadata_bytes),
Mathieu Chartier32327092013-08-30 14:04:08 -07002615 bitmap_bytes, PercentOfFileBytes(bitmap_bytes),
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002616 alignment_bytes, PercentOfFileBytes(alignment_bytes))
2617 << std::flush;
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002618 CHECK_EQ(file_bytes,
2619 header_bytes + object_bytes + art_field_bytes + art_method_bytes +
2620 dex_cache_arrays_bytes + interned_strings_bytes + class_table_bytes +
Mathieu Chartier1ca718e2018-10-23 12:55:34 -07002621 sro_offset_bytes + metadata_bytes + bitmap_bytes + alignment_bytes);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002622 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002623
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002624 os << "object_bytes breakdown:\n";
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002625 size_t object_bytes_total = 0;
Mathieu Chartier02e25112013-08-14 16:14:24 -07002626 for (const auto& sizes_and_count : sizes_and_counts) {
2627 const std::string& descriptor(sizes_and_count.first);
2628 double average = static_cast<double>(sizes_and_count.second.bytes) /
2629 static_cast<double>(sizes_and_count.second.count);
2630 double percent = PercentOfObjectBytes(sizes_and_count.second.bytes);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002631 os << StringPrintf("%32s %8zd bytes %6zd instances "
Elliott Hughesa0e18062012-04-13 15:59:59 -07002632 "(%4.0f bytes/instance) %2.0f%% of object_bytes\n",
Mathieu Chartier02e25112013-08-14 16:14:24 -07002633 descriptor.c_str(), sizes_and_count.second.bytes,
2634 sizes_and_count.second.count, average, percent);
2635 object_bytes_total += sizes_and_count.second.bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002636 }
Elliott Hughesc073b072012-05-24 19:29:17 -07002637 os << "\n" << std::flush;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002638 CHECK_EQ(object_bytes, object_bytes_total);
2639
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002640 os << StringPrintf("oat_file_bytes = %8zd\n"
2641 "managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002642 "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n"
2643 "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2644 "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2645 "large_method_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n",
Ian Rogers05f28c62012-10-23 18:12:13 -07002646 oat_file_bytes,
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002647 managed_code_bytes,
2648 PercentOfOatBytes(managed_code_bytes),
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002649 native_to_managed_code_bytes,
2650 PercentOfOatBytes(native_to_managed_code_bytes),
2651 class_initializer_code_bytes,
2652 PercentOfOatBytes(class_initializer_code_bytes),
2653 large_initializer_code_bytes,
2654 PercentOfOatBytes(large_initializer_code_bytes),
2655 large_method_code_bytes,
2656 PercentOfOatBytes(large_method_code_bytes))
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002657 << "DexFile sizes:\n";
Mathieu Chartier02e25112013-08-14 16:14:24 -07002658 for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002659 os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n",
Mathieu Chartier02e25112013-08-14 16:14:24 -07002660 oat_dex_file_size.first.c_str(), oat_dex_file_size.second,
2661 PercentOfOatBytes(oat_dex_file_size.second));
Ian Rogers05f28c62012-10-23 18:12:13 -07002662 }
2663
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002664 os << "\n" << StringPrintf("vmap_table_bytes = %7zd (%2.0f%% of oat file bytes)\n\n",
Ian Rogers05f28c62012-10-23 18:12:13 -07002665 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes))
Elliott Hughesc073b072012-05-24 19:29:17 -07002666 << std::flush;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002667
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002668 os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes)
2669 << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n",
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002670 static_cast<double>(managed_code_bytes) /
2671 static_cast<double>(dex_instruction_bytes),
Elliott Hughesc073b072012-05-24 19:29:17 -07002672 static_cast<double>(managed_code_bytes_ignoring_deduplication) /
Elliott Hughescf44e6f2012-05-24 19:42:18 -07002673 static_cast<double>(dex_instruction_bytes))
Elliott Hughesc073b072012-05-24 19:29:17 -07002674 << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002675
2676 DumpOutliers(os);
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002677 }
2678 } stats_;
2679
2680 private:
Ian Rogers0d2d3782012-04-10 11:09:18 -07002681 enum {
2682 // Number of bytes for a constructor to be considered large. Based on the 1000 basic block
2683 // threshold, we assume 2 bytes per instruction and 2 instructions per block.
2684 kLargeConstructorDexBytes = 4000,
2685 // Number of bytes for a method to be considered large. Based on the 4000 basic block
2686 // threshold, we assume 2 bytes per instruction and 2 instructions per block.
2687 kLargeMethodDexBytes = 16000
2688 };
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002689
2690 // For performance, use the *os_ directly for anything that doesn't need indentation
2691 // and prepare an indentation stream with default indentation 1.
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002692 std::ostream* os_;
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002693 VariableIndentationOutputStream vios_;
2694 ScopedIndentation indent1_;
2695
Ian Rogers1d54e732013-05-02 21:10:01 -07002696 gc::space::ImageSpace& image_space_;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002697 const ImageHeader& image_header_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07002698 std::unique_ptr<OatDumper> oat_dumper_;
Andreas Gampedf2bb1f2015-05-04 18:25:23 -07002699 OatDumperOptions* oat_dumper_options_;
Vladimir Marko05792b92015-08-03 11:56:49 +01002700 std::set<mirror::Object*> dex_caches_;
Elliott Hughesd1bb4f62011-09-23 14:09:45 -07002701
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002702 DISALLOW_COPY_AND_ASSIGN(ImageDumper);
Brian Carlstrom78128a62011-09-15 17:21:19 -07002703};
2704
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002705static int DumpImage(gc::space::ImageSpace* image_space,
2706 OatDumperOptions* options,
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002707 std::ostream* os) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002708 const ImageHeader& image_header = image_space->GetImageHeader();
2709 if (!image_header.IsValid()) {
Andreas Gampe221d9812018-01-22 17:48:56 -08002710 LOG(ERROR) << "Invalid image header " << image_space->GetImageLocation();
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002711 return EXIT_FAILURE;
2712 }
2713 ImageDumper image_dumper(os, *image_space, image_header, options);
2714 if (!image_dumper.Dump()) {
2715 return EXIT_FAILURE;
2716 }
2717 return EXIT_SUCCESS;
2718}
2719
2720static int DumpImages(Runtime* runtime, OatDumperOptions* options, std::ostream* os) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002721 // Dumping the image, no explicit class loader.
Mathieu Chartier9865bde2015-12-21 09:58:16 -08002722 ScopedNullHandle<mirror::ClassLoader> null_class_loader;
Andreas Gampe00b25f32014-09-17 21:49:05 -07002723 options->class_loader_ = &null_class_loader;
2724
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002725 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002726 if (options->app_image_ != nullptr) {
2727 if (options->app_oat_ == nullptr) {
2728 LOG(ERROR) << "Can not dump app image without app oat file";
Jeff Haodcdc85b2015-12-04 14:06:18 -08002729 return EXIT_FAILURE;
2730 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002731 // We can't know if the app image is 32 bits yet, but it contains pointers into the oat file.
2732 // We need to map the oat file in the low 4gb or else the fixup wont be able to fit oat file
2733 // pointers into 32 bit pointer sized ArtMethods.
2734 std::string error_msg;
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002735 std::unique_ptr<OatFile> oat_file(OatFile::Open(/*zip_fd=*/ -1,
Nicolas Geoffray30025092018-04-19 14:43:29 +01002736 options->app_oat_,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002737 options->app_oat_,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002738 /*executable=*/ false,
2739 /*low_4gb=*/ true,
2740 /*abs_dex_location=*/ nullptr,
2741 /*reservation=*/ nullptr,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002742 &error_msg));
2743 if (oat_file == nullptr) {
2744 LOG(ERROR) << "Failed to open oat file " << options->app_oat_ << " with error " << error_msg;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002745 return EXIT_FAILURE;
2746 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002747 std::unique_ptr<gc::space::ImageSpace> space(
2748 gc::space::ImageSpace::CreateFromAppImage(options->app_image_, oat_file.get(), &error_msg));
2749 if (space == nullptr) {
2750 LOG(ERROR) << "Failed to open app image " << options->app_image_ << " with error "
2751 << error_msg;
2752 }
2753 // Open dex files for the image.
2754 std::vector<std::unique_ptr<const DexFile>> dex_files;
2755 if (!runtime->GetClassLinker()->OpenImageDexFiles(space.get(), &dex_files, &error_msg)) {
2756 LOG(ERROR) << "Failed to open app image dex files " << options->app_image_ << " with error "
2757 << error_msg;
2758 }
2759 // Dump the actual image.
2760 int result = DumpImage(space.get(), options, os);
2761 if (result != EXIT_SUCCESS) {
2762 return result;
2763 }
2764 // Fall through to dump the boot images.
2765 }
2766
2767 gc::Heap* heap = runtime->GetHeap();
2768 CHECK(heap->HasBootImageSpace()) << "No image spaces";
2769 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
2770 int result = DumpImage(image_space, options, os);
2771 if (result != EXIT_SUCCESS) {
2772 return result;
2773 }
Brian Carlstrom78128a62011-09-15 17:21:19 -07002774 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002775 return EXIT_SUCCESS;
Brian Carlstrom78128a62011-09-15 17:21:19 -07002776}
2777
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002778static jobject InstallOatFile(Runtime* runtime,
2779 std::unique_ptr<OatFile> oat_file,
2780 std::vector<const DexFile*>* class_path)
2781 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002782 Thread* self = Thread::Current();
2783 CHECK(self != nullptr);
2784 // Need well-known-classes.
2785 WellKnownClasses::Init(self->GetJniEnv());
2786
Vladimir Marko421087b2018-02-27 11:00:17 +00002787 // Open dex files.
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002788 OatFile* oat_file_ptr = oat_file.get();
Andreas Gampe00b25f32014-09-17 21:49:05 -07002789 ClassLinker* class_linker = runtime->GetClassLinker();
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002790 runtime->GetOatFileManager().RegisterOatFile(std::move(oat_file));
Andreas Gampeb40d3612018-06-26 15:49:42 -07002791 for (const OatDexFile* odf : oat_file_ptr->GetOatDexFiles()) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002792 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -07002793 const DexFile* const dex_file = OpenDexFile(odf, &error_msg);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002794 CHECK(dex_file != nullptr) << error_msg;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002795 class_path->push_back(dex_file);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002796 }
2797
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002798 // Need a class loader. Fake that we're a compiler.
2799 // Note: this will run initializers through the unstarted runtime, so make sure it's
2800 // initialized.
2801 interpreter::UnstartedRuntime::Initialize();
2802
2803 jobject class_loader = class_linker->CreatePathClassLoader(self, *class_path);
2804
Vladimir Marko421087b2018-02-27 11:00:17 +00002805 // Need to register dex files to get a working dex cache.
2806 for (const DexFile* dex_file : *class_path) {
2807 ObjPtr<mirror::DexCache> dex_cache = class_linker->RegisterDexFile(
2808 *dex_file, self->DecodeJObject(class_loader)->AsClassLoader());
2809 CHECK(dex_cache != nullptr);
2810 }
2811
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002812 return class_loader;
2813}
2814
2815static int DumpOatWithRuntime(Runtime* runtime,
2816 std::unique_ptr<OatFile> oat_file,
2817 OatDumperOptions* options,
2818 std::ostream* os) {
2819 CHECK(runtime != nullptr && oat_file != nullptr && options != nullptr);
2820 ScopedObjectAccess soa(Thread::Current());
2821
2822 OatFile* oat_file_ptr = oat_file.get();
2823 std::vector<const DexFile*> class_path;
2824 jobject class_loader = InstallOatFile(runtime, std::move(oat_file), &class_path);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002825
2826 // Use the class loader while dumping.
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002827 StackHandleScope<1> scope(soa.Self());
Andreas Gampe00b25f32014-09-17 21:49:05 -07002828 Handle<mirror::ClassLoader> loader_handle = scope.NewHandle(
Mathieu Chartier0795f232016-09-27 18:43:30 -07002829 soa.Decode<mirror::ClassLoader>(class_loader));
Andreas Gampe00b25f32014-09-17 21:49:05 -07002830 options->class_loader_ = &loader_handle;
2831
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002832 OatDumper oat_dumper(*oat_file_ptr, *options);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002833 bool success = oat_dumper.Dump(*os);
2834 return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2835}
2836
2837static int DumpOatWithoutRuntime(OatFile* oat_file, OatDumperOptions* options, std::ostream* os) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08002838 CHECK(oat_file != nullptr && options != nullptr);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002839 // No image = no class loader.
Mathieu Chartier9865bde2015-12-21 09:58:16 -08002840 ScopedNullHandle<mirror::ClassLoader> null_class_loader;
Andreas Gampe00b25f32014-09-17 21:49:05 -07002841 options->class_loader_ = &null_class_loader;
2842
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08002843 OatDumper oat_dumper(*oat_file, *options);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002844 bool success = oat_dumper.Dump(*os);
2845 return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
2846}
2847
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002848static int DumpOat(Runtime* runtime,
2849 const char* oat_filename,
2850 const char* dex_filename,
2851 OatDumperOptions* options,
Andreas Gampe00b25f32014-09-17 21:49:05 -07002852 std::ostream* os) {
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002853 if (dex_filename == nullptr) {
2854 LOG(WARNING) << "No dex filename provided, "
2855 << "oatdump might fail if the oat file does not contain the dex code.";
2856 }
Andreas Gampe00b25f32014-09-17 21:49:05 -07002857 std::string error_msg;
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002858 std::unique_ptr<OatFile> oat_file(OatFile::Open(/*zip_fd=*/ -1,
Nicolas Geoffray30025092018-04-19 14:43:29 +01002859 oat_filename,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002860 oat_filename,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002861 /*executable=*/ false,
2862 /*low_4gb=*/ false,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002863 dex_filename,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002864 /*reservation=*/ nullptr,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002865 &error_msg));
Andreas Gampe00b25f32014-09-17 21:49:05 -07002866 if (oat_file == nullptr) {
Andreas Gampe221d9812018-01-22 17:48:56 -08002867 LOG(ERROR) << "Failed to open oat file from '" << oat_filename << "': " << error_msg;
Andreas Gampe00b25f32014-09-17 21:49:05 -07002868 return EXIT_FAILURE;
2869 }
2870
2871 if (runtime != nullptr) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002872 return DumpOatWithRuntime(runtime, std::move(oat_file), options, os);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002873 } else {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002874 return DumpOatWithoutRuntime(oat_file.get(), options, os);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002875 }
2876}
2877
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002878static int SymbolizeOat(const char* oat_filename,
2879 const char* dex_filename,
2880 std::string& output_name,
2881 bool no_bits) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002882 std::string error_msg;
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002883 std::unique_ptr<OatFile> oat_file(OatFile::Open(/*zip_fd=*/ -1,
Nicolas Geoffray30025092018-04-19 14:43:29 +01002884 oat_filename,
Andreas Gampe08c277c2017-04-26 22:22:15 -07002885 oat_filename,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002886 /*executable=*/ false,
2887 /*low_4gb=*/ false,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002888 dex_filename,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002889 /*reservation=*/ nullptr,
Andreas Gampe08c277c2017-04-26 22:22:15 -07002890 &error_msg));
Andreas Gampe00b25f32014-09-17 21:49:05 -07002891 if (oat_file == nullptr) {
Andreas Gampe221d9812018-01-22 17:48:56 -08002892 LOG(ERROR) << "Failed to open oat file from '" << oat_filename << "': " << error_msg;
Andreas Gampe00b25f32014-09-17 21:49:05 -07002893 return EXIT_FAILURE;
2894 }
2895
Andreas Gampe2d8614b2016-03-07 16:31:34 -08002896 bool result;
2897 // Try to produce an ELF file of the same type. This is finicky, as we have used 32-bit ELF
2898 // files for 64-bit code in the past.
2899 if (Is64BitInstructionSet(oat_file->GetOatHeader().GetInstructionSet())) {
Andreas Gampe08c277c2017-04-26 22:22:15 -07002900 OatSymbolizer<ElfTypes64> oat_symbolizer(oat_file.get(), output_name, no_bits);
Andreas Gampe2d8614b2016-03-07 16:31:34 -08002901 result = oat_symbolizer.Symbolize();
2902 } else {
Andreas Gampe08c277c2017-04-26 22:22:15 -07002903 OatSymbolizer<ElfTypes32> oat_symbolizer(oat_file.get(), output_name, no_bits);
Andreas Gampe2d8614b2016-03-07 16:31:34 -08002904 result = oat_symbolizer.Symbolize();
2905 }
2906 if (!result) {
Andreas Gampe221d9812018-01-22 17:48:56 -08002907 LOG(ERROR) << "Failed to symbolize";
Andreas Gampe00b25f32014-09-17 21:49:05 -07002908 return EXIT_FAILURE;
2909 }
2910
2911 return EXIT_SUCCESS;
2912}
2913
Andreas Gampe9fded872016-09-25 16:08:35 -07002914class IMTDumper {
2915 public:
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002916 static bool Dump(Runtime* runtime,
2917 const std::string& imt_file,
2918 bool dump_imt_stats,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002919 const char* oat_filename,
2920 const char* dex_filename) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002921 Thread* self = Thread::Current();
2922
2923 ScopedObjectAccess soa(self);
2924 StackHandleScope<1> scope(self);
2925 MutableHandle<mirror::ClassLoader> class_loader = scope.NewHandle<mirror::ClassLoader>(nullptr);
2926 std::vector<const DexFile*> class_path;
2927
2928 if (oat_filename != nullptr) {
2929 std::string error_msg;
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002930 std::unique_ptr<OatFile> oat_file(OatFile::Open(/*zip_fd=*/ -1,
Nicolas Geoffray30025092018-04-19 14:43:29 +01002931 oat_filename,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002932 oat_filename,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002933 /*executable=*/ false,
Andreas Gampe9b031f72018-10-04 11:03:34 -07002934 /*low_4gb=*/false,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00002935 dex_filename,
Vladimir Markof4efa9e2018-10-17 14:12:45 +01002936 /*reservation=*/ nullptr,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002937 &error_msg));
2938 if (oat_file == nullptr) {
Andreas Gampe221d9812018-01-22 17:48:56 -08002939 LOG(ERROR) << "Failed to open oat file from '" << oat_filename << "': " << error_msg;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002940 return false;
2941 }
2942
2943 class_loader.Assign(soa.Decode<mirror::ClassLoader>(
2944 InstallOatFile(runtime, std::move(oat_file), &class_path)));
2945 } else {
2946 class_loader.Assign(nullptr); // Boot classloader. Just here for explicit documentation.
2947 class_path = runtime->GetClassLinker()->GetBootClassPath();
2948 }
2949
2950 if (!imt_file.empty()) {
2951 return DumpImt(runtime, imt_file, class_loader);
2952 }
2953
2954 if (dump_imt_stats) {
2955 return DumpImtStats(runtime, class_path, class_loader);
2956 }
2957
2958 LOG(FATAL) << "Should not reach here";
2959 UNREACHABLE();
2960 }
2961
2962 private:
2963 static bool DumpImt(Runtime* runtime,
2964 const std::string& imt_file,
2965 Handle<mirror::ClassLoader> h_class_loader)
2966 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe9fded872016-09-25 16:08:35 -07002967 std::vector<std::string> lines = ReadCommentedInputFromFile(imt_file);
2968 std::unordered_set<std::string> prepared;
2969
2970 for (const std::string& line : lines) {
2971 // A line should be either a class descriptor, in which case we will dump the complete IMT,
2972 // or a class descriptor and an interface method, in which case we will lookup the method,
2973 // determine its IMT slot, and check the class' IMT.
2974 size_t first_space = line.find(' ');
2975 if (first_space == std::string::npos) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002976 DumpIMTForClass(runtime, line, h_class_loader, &prepared);
Andreas Gampe9fded872016-09-25 16:08:35 -07002977 } else {
2978 DumpIMTForMethod(runtime,
2979 line.substr(0, first_space),
2980 line.substr(first_space + 1, std::string::npos),
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002981 h_class_loader,
Andreas Gampe9fded872016-09-25 16:08:35 -07002982 &prepared);
2983 }
2984 std::cerr << std::endl;
2985 }
2986
2987 return true;
2988 }
2989
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002990 static bool DumpImtStats(Runtime* runtime,
2991 const std::vector<const DexFile*>& dex_files,
2992 Handle<mirror::ClassLoader> h_class_loader)
2993 REQUIRES_SHARED(Locks::mutator_lock_) {
2994 size_t without_imt = 0;
2995 size_t with_imt = 0;
Andreas Gampe9fded872016-09-25 16:08:35 -07002996 std::map<size_t, size_t> histogram;
2997
2998 ClassLinker* class_linker = runtime->GetClassLinker();
2999 const PointerSize pointer_size = class_linker->GetImagePointerSize();
3000 std::unordered_set<std::string> prepared;
3001
3002 Thread* self = Thread::Current();
Andreas Gampe9fded872016-09-25 16:08:35 -07003003 StackHandleScope<1> scope(self);
3004 MutableHandle<mirror::Class> h_klass(scope.NewHandle<mirror::Class>(nullptr));
3005
3006 for (const DexFile* dex_file : dex_files) {
3007 for (uint32_t class_def_index = 0;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003008 class_def_index != dex_file->NumClassDefs();
3009 ++class_def_index) {
Andreas Gampe3f1dcd32018-12-28 09:39:56 -08003010 const dex::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
Andreas Gampe9fded872016-09-25 16:08:35 -07003011 const char* descriptor = dex_file->GetClassDescriptor(class_def);
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003012 h_klass.Assign(class_linker->FindClass(self, descriptor, h_class_loader));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003013 if (h_klass == nullptr) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003014 std::cerr << "Warning: could not load " << descriptor << std::endl;
3015 continue;
3016 }
3017
3018 if (HasNoIMT(runtime, h_klass, pointer_size, &prepared)) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003019 without_imt++;
Andreas Gampe9fded872016-09-25 16:08:35 -07003020 continue;
3021 }
3022
3023 ImTable* im_table = PrepareAndGetImTable(runtime, h_klass, pointer_size, &prepared);
3024 if (im_table == nullptr) {
3025 // Should not happen, but accept.
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003026 without_imt++;
Andreas Gampe9fded872016-09-25 16:08:35 -07003027 continue;
3028 }
3029
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003030 with_imt++;
Andreas Gampe9fded872016-09-25 16:08:35 -07003031 for (size_t imt_index = 0; imt_index != ImTable::kSize; ++imt_index) {
3032 ArtMethod* ptr = im_table->Get(imt_index, pointer_size);
3033 if (ptr->IsRuntimeMethod()) {
3034 if (ptr->IsImtUnimplementedMethod()) {
3035 histogram[0]++;
3036 } else {
3037 ImtConflictTable* current_table = ptr->GetImtConflictTable(pointer_size);
3038 histogram[current_table->NumEntries(pointer_size)]++;
3039 }
3040 } else {
3041 histogram[1]++;
3042 }
3043 }
3044 }
3045 }
3046
3047 std::cerr << "IMT stats:"
3048 << std::endl << std::endl;
3049
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003050 std::cerr << " " << with_imt << " classes with IMT."
Andreas Gampe9fded872016-09-25 16:08:35 -07003051 << std::endl << std::endl;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003052 std::cerr << " " << without_imt << " classes without IMT (or copy from Object)."
Andreas Gampe9fded872016-09-25 16:08:35 -07003053 << std::endl << std::endl;
3054
3055 double sum_one = 0;
3056 size_t count_one = 0;
3057
3058 std::cerr << " " << "IMT histogram" << std::endl;
3059 for (auto& bucket : histogram) {
3060 std::cerr << " " << bucket.first << " " << bucket.second << std::endl;
3061 if (bucket.first > 0) {
3062 sum_one += bucket.second * bucket.first;
3063 count_one += bucket.second;
3064 }
3065 }
3066
3067 double count_zero = count_one + histogram[0];
3068 std::cerr << " Stats:" << std::endl;
3069 std::cerr << " Average depth (including empty): " << (sum_one / count_zero) << std::endl;
3070 std::cerr << " Average depth (excluding empty): " << (sum_one / count_one) << std::endl;
3071
3072 return true;
3073 }
3074
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003075 // Return whether the given class has no IMT (or the one shared with java.lang.Object).
Andreas Gampe9fded872016-09-25 16:08:35 -07003076 static bool HasNoIMT(Runtime* runtime,
3077 Handle<mirror::Class> klass,
3078 const PointerSize pointer_size,
3079 std::unordered_set<std::string>* prepared)
3080 REQUIRES_SHARED(Locks::mutator_lock_) {
3081 if (klass->IsObjectClass() || !klass->ShouldHaveImt()) {
3082 return true;
3083 }
3084
3085 if (klass->GetImt(pointer_size) == nullptr) {
3086 PrepareClass(runtime, klass, prepared);
3087 }
3088
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003089 ObjPtr<mirror::Class> object_class = GetClassRoot<mirror::Object>();
Andreas Gampe9fded872016-09-25 16:08:35 -07003090 DCHECK(object_class->IsObjectClass());
3091
3092 bool result = klass->GetImt(pointer_size) == object_class->GetImt(pointer_size);
3093
Mathieu Chartier6beced42016-11-15 15:51:31 -08003094 if (klass->GetIfTable()->Count() == 0) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003095 DCHECK(result);
3096 }
3097
3098 return result;
3099 }
3100
3101 static void PrintTable(ImtConflictTable* table, PointerSize pointer_size)
3102 REQUIRES_SHARED(Locks::mutator_lock_) {
3103 if (table == nullptr) {
3104 std::cerr << " <No IMT?>" << std::endl;
3105 return;
3106 }
3107 size_t table_index = 0;
3108 for (;;) {
3109 ArtMethod* ptr = table->GetInterfaceMethod(table_index, pointer_size);
3110 if (ptr == nullptr) {
3111 return;
3112 }
3113 table_index++;
David Sehr709b0702016-10-13 09:12:37 -07003114 std::cerr << " " << ptr->PrettyMethod(true) << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003115 }
3116 }
3117
3118 static ImTable* PrepareAndGetImTable(Runtime* runtime,
3119 Thread* self,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003120 Handle<mirror::ClassLoader> h_loader,
Andreas Gampe9fded872016-09-25 16:08:35 -07003121 const std::string& class_name,
3122 const PointerSize pointer_size,
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003123 /*out*/ ObjPtr<mirror::Class>* klass_out,
3124 /*inout*/ std::unordered_set<std::string>* prepared)
Andreas Gampe9fded872016-09-25 16:08:35 -07003125 REQUIRES_SHARED(Locks::mutator_lock_) {
3126 if (class_name.empty()) {
3127 return nullptr;
3128 }
3129
3130 std::string descriptor;
3131 if (class_name[0] == 'L') {
3132 descriptor = class_name;
3133 } else {
3134 descriptor = DotToDescriptor(class_name.c_str());
3135 }
3136
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003137 ObjPtr<mirror::Class> klass =
3138 runtime->GetClassLinker()->FindClass(self, descriptor.c_str(), h_loader);
Andreas Gampe9fded872016-09-25 16:08:35 -07003139
3140 if (klass == nullptr) {
3141 self->ClearException();
3142 std::cerr << "Did not find " << class_name << std::endl;
3143 *klass_out = nullptr;
3144 return nullptr;
3145 }
3146
3147 StackHandleScope<1> scope(Thread::Current());
3148 Handle<mirror::Class> h_klass = scope.NewHandle<mirror::Class>(klass);
3149
3150 ImTable* ret = PrepareAndGetImTable(runtime, h_klass, pointer_size, prepared);
3151 *klass_out = h_klass.Get();
3152 return ret;
3153 }
3154
3155 static ImTable* PrepareAndGetImTable(Runtime* runtime,
3156 Handle<mirror::Class> h_klass,
3157 const PointerSize pointer_size,
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003158 /*inout*/ std::unordered_set<std::string>* prepared)
Andreas Gampe9fded872016-09-25 16:08:35 -07003159 REQUIRES_SHARED(Locks::mutator_lock_) {
3160 PrepareClass(runtime, h_klass, prepared);
3161 return h_klass->GetImt(pointer_size);
3162 }
3163
3164 static void DumpIMTForClass(Runtime* runtime,
3165 const std::string& class_name,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003166 Handle<mirror::ClassLoader> h_loader,
3167 std::unordered_set<std::string>* prepared)
3168 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003169 const PointerSize pointer_size = runtime->GetClassLinker()->GetImagePointerSize();
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003170 ObjPtr<mirror::Class> klass;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003171 ImTable* imt = PrepareAndGetImTable(runtime,
3172 Thread::Current(),
3173 h_loader,
3174 class_name,
3175 pointer_size,
3176 &klass,
3177 prepared);
Andreas Gampe9fded872016-09-25 16:08:35 -07003178 if (imt == nullptr) {
3179 return;
3180 }
3181
3182 std::cerr << class_name << std::endl << " IMT:" << std::endl;
3183 for (size_t index = 0; index < ImTable::kSize; ++index) {
3184 std::cerr << " " << index << ":" << std::endl;
3185 ArtMethod* ptr = imt->Get(index, pointer_size);
3186 if (ptr->IsRuntimeMethod()) {
3187 if (ptr->IsImtUnimplementedMethod()) {
3188 std::cerr << " <empty>" << std::endl;
3189 } else {
3190 ImtConflictTable* current_table = ptr->GetImtConflictTable(pointer_size);
3191 PrintTable(current_table, pointer_size);
3192 }
3193 } else {
David Sehr709b0702016-10-13 09:12:37 -07003194 std::cerr << " " << ptr->PrettyMethod(true) << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003195 }
3196 }
3197
3198 std::cerr << " Interfaces:" << std::endl;
3199 // Run through iftable, find methods that slot here, see if they fit.
3200 mirror::IfTable* if_table = klass->GetIfTable();
Mathieu Chartier6beced42016-11-15 15:51:31 -08003201 for (size_t i = 0, num_interfaces = klass->GetIfTableCount(); i < num_interfaces; ++i) {
3202 mirror::Class* iface = if_table->GetInterface(i);
3203 std::string iface_name;
3204 std::cerr << " " << iface->GetDescriptor(&iface_name) << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003205
Mathieu Chartier6beced42016-11-15 15:51:31 -08003206 for (ArtMethod& iface_method : iface->GetVirtualMethods(pointer_size)) {
3207 uint32_t class_hash, name_hash, signature_hash;
3208 ImTable::GetImtHashComponents(&iface_method, &class_hash, &name_hash, &signature_hash);
3209 uint32_t imt_slot = ImTable::GetImtIndex(&iface_method);
3210 std::cerr << " " << iface_method.PrettyMethod(true)
3211 << " slot=" << imt_slot
3212 << std::hex
3213 << " class_hash=0x" << class_hash
3214 << " name_hash=0x" << name_hash
3215 << " signature_hash=0x" << signature_hash
3216 << std::dec
3217 << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003218 }
3219 }
3220 }
3221
3222 static void DumpIMTForMethod(Runtime* runtime,
3223 const std::string& class_name,
3224 const std::string& method,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003225 Handle<mirror::ClassLoader> h_loader,
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003226 /*inout*/ std::unordered_set<std::string>* prepared)
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003227 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003228 const PointerSize pointer_size = runtime->GetClassLinker()->GetImagePointerSize();
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003229 ObjPtr<mirror::Class> klass;
Andreas Gampe9fded872016-09-25 16:08:35 -07003230 ImTable* imt = PrepareAndGetImTable(runtime,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003231 Thread::Current(),
3232 h_loader,
Andreas Gampe9fded872016-09-25 16:08:35 -07003233 class_name,
3234 pointer_size,
3235 &klass,
3236 prepared);
3237 if (imt == nullptr) {
3238 return;
3239 }
3240
3241 std::cerr << class_name << " <" << method << ">" << std::endl;
3242 for (size_t index = 0; index < ImTable::kSize; ++index) {
3243 ArtMethod* ptr = imt->Get(index, pointer_size);
3244 if (ptr->IsRuntimeMethod()) {
3245 if (ptr->IsImtUnimplementedMethod()) {
3246 continue;
3247 }
3248
3249 ImtConflictTable* current_table = ptr->GetImtConflictTable(pointer_size);
3250 if (current_table == nullptr) {
3251 continue;
3252 }
3253
3254 size_t table_index = 0;
3255 for (;;) {
3256 ArtMethod* ptr2 = current_table->GetInterfaceMethod(table_index, pointer_size);
3257 if (ptr2 == nullptr) {
3258 break;
3259 }
3260 table_index++;
3261
David Sehr709b0702016-10-13 09:12:37 -07003262 std::string p_name = ptr2->PrettyMethod(true);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003263 if (android::base::StartsWith(p_name, method.c_str())) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003264 std::cerr << " Slot "
3265 << index
3266 << " ("
3267 << current_table->NumEntries(pointer_size)
3268 << ")"
3269 << std::endl;
3270 PrintTable(current_table, pointer_size);
3271 return;
3272 }
3273 }
3274 } else {
David Sehr709b0702016-10-13 09:12:37 -07003275 std::string p_name = ptr->PrettyMethod(true);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003276 if (android::base::StartsWith(p_name, method.c_str())) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003277 std::cerr << " Slot " << index << " (1)" << std::endl;
3278 std::cerr << " " << p_name << std::endl;
3279 } else {
3280 // Run through iftable, find methods that slot here, see if they fit.
3281 mirror::IfTable* if_table = klass->GetIfTable();
Mathieu Chartier6beced42016-11-15 15:51:31 -08003282 for (size_t i = 0, num_interfaces = klass->GetIfTableCount(); i < num_interfaces; ++i) {
3283 mirror::Class* iface = if_table->GetInterface(i);
3284 size_t num_methods = iface->NumDeclaredVirtualMethods();
3285 if (num_methods > 0) {
3286 for (ArtMethod& iface_method : iface->GetMethods(pointer_size)) {
3287 if (ImTable::GetImtIndex(&iface_method) == index) {
3288 std::string i_name = iface_method.PrettyMethod(true);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003289 if (android::base::StartsWith(i_name, method.c_str())) {
Mathieu Chartier6beced42016-11-15 15:51:31 -08003290 std::cerr << " Slot " << index << " (1)" << std::endl;
3291 std::cerr << " " << p_name << " (" << i_name << ")" << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003292 }
3293 }
3294 }
3295 }
3296 }
3297 }
3298 }
3299 }
3300 }
3301
3302 // Read lines from the given stream, dropping comments and empty lines
3303 static std::vector<std::string> ReadCommentedInputStream(std::istream& in_stream) {
3304 std::vector<std::string> output;
3305 while (in_stream.good()) {
3306 std::string dot;
3307 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003308 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003309 continue;
3310 }
3311 output.push_back(dot);
3312 }
3313 return output;
3314 }
3315
3316 // Read lines from the given file, dropping comments and empty lines.
3317 static std::vector<std::string> ReadCommentedInputFromFile(const std::string& input_filename) {
3318 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
3319 if (input_file.get() == nullptr) {
3320 LOG(ERROR) << "Failed to open input file " << input_filename;
3321 return std::vector<std::string>();
3322 }
3323 std::vector<std::string> result = ReadCommentedInputStream(*input_file);
3324 input_file->close();
3325 return result;
3326 }
3327
3328 // Prepare a class, i.e., ensure it has a filled IMT. Will do so recursively for superclasses,
3329 // and note in the given set that the work was done.
3330 static void PrepareClass(Runtime* runtime,
3331 Handle<mirror::Class> h_klass,
Vladimir Markoa8bba7d2018-05-30 15:18:48 +01003332 /*inout*/ std::unordered_set<std::string>* done)
Andreas Gampe9fded872016-09-25 16:08:35 -07003333 REQUIRES_SHARED(Locks::mutator_lock_) {
3334 if (!h_klass->ShouldHaveImt()) {
3335 return;
3336 }
3337
3338 std::string name;
3339 name = h_klass->GetDescriptor(&name);
3340
3341 if (done->find(name) != done->end()) {
3342 return;
3343 }
3344 done->insert(name);
3345
3346 if (h_klass->HasSuperClass()) {
3347 StackHandleScope<1> h(Thread::Current());
3348 PrepareClass(runtime, h.NewHandle<mirror::Class>(h_klass->GetSuperClass()), done);
3349 }
3350
3351 if (!h_klass->IsTemp()) {
3352 runtime->GetClassLinker()->FillIMTAndConflictTables(h_klass.Get());
3353 }
3354 }
3355};
3356
Igor Murashkin37743352014-11-13 14:38:00 -08003357struct OatdumpArgs : public CmdlineArgs {
3358 protected:
3359 using Base = CmdlineArgs;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003360
Roland Levillainf73caca2018-08-24 17:19:07 +01003361 ParseStatus ParseCustom(const StringPiece& option, std::string* error_msg) override {
Igor Murashkin37743352014-11-13 14:38:00 -08003362 {
3363 ParseStatus base_parse = Base::ParseCustom(option, error_msg);
3364 if (base_parse != kParseUnknownArgument) {
3365 return base_parse;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003366 }
3367 }
3368
Igor Murashkin37743352014-11-13 14:38:00 -08003369 if (option.starts_with("--oat-file=")) {
3370 oat_filename_ = option.substr(strlen("--oat-file=")).data();
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00003371 } else if (option.starts_with("--dex-file=")) {
3372 dex_filename_ = option.substr(strlen("--dex-file=")).data();
Igor Murashkin37743352014-11-13 14:38:00 -08003373 } else if (option.starts_with("--image=")) {
3374 image_location_ = option.substr(strlen("--image=")).data();
Igor Murashkin37743352014-11-13 14:38:00 -08003375 } else if (option == "--no-dump:vmap") {
3376 dump_vmap_ = false;
Roland Levillainf2650d12015-05-28 14:53:28 +01003377 } else if (option =="--dump:code_info_stack_maps") {
3378 dump_code_info_stack_maps_ = true;
Igor Murashkin37743352014-11-13 14:38:00 -08003379 } else if (option == "--no-disassemble") {
3380 disassemble_code_ = false;
David Brazdilc03d7b62016-03-02 12:18:03 +00003381 } else if (option =="--header-only") {
3382 dump_header_only_ = true;
Igor Murashkin37743352014-11-13 14:38:00 -08003383 } else if (option.starts_with("--symbolize=")) {
3384 oat_filename_ = option.substr(strlen("--symbolize=")).data();
3385 symbolize_ = true;
David Srbecky2fdd03c2016-03-10 15:32:37 +00003386 } else if (option.starts_with("--only-keep-debug")) {
3387 only_keep_debug_ = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003388 } else if (option.starts_with("--class-filter=")) {
3389 class_filter_ = option.substr(strlen("--class-filter=")).data();
Igor Murashkin37743352014-11-13 14:38:00 -08003390 } else if (option.starts_with("--method-filter=")) {
3391 method_filter_ = option.substr(strlen("--method-filter=")).data();
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003392 } else if (option.starts_with("--list-classes")) {
3393 list_classes_ = true;
3394 } else if (option.starts_with("--list-methods")) {
3395 list_methods_ = true;
3396 } else if (option.starts_with("--export-dex-to=")) {
3397 export_dex_location_ = option.substr(strlen("--export-dex-to=")).data();
3398 } else if (option.starts_with("--addr2instr=")) {
Andreas Gampef9411702018-09-06 17:16:57 -07003399 if (!android::base::ParseUint(option.substr(strlen("--addr2instr=")).data(), &addr2instr_)) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003400 *error_msg = "Address conversion failed";
3401 return kParseError;
3402 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003403 } else if (option.starts_with("--app-image=")) {
3404 app_image_ = option.substr(strlen("--app-image=")).data();
3405 } else if (option.starts_with("--app-oat=")) {
3406 app_oat_ = option.substr(strlen("--app-oat=")).data();
Andreas Gampe9fded872016-09-25 16:08:35 -07003407 } else if (option.starts_with("--dump-imt=")) {
3408 imt_dump_ = option.substr(strlen("--dump-imt=")).data();
3409 } else if (option == "--dump-imt-stats") {
3410 imt_stat_dump_ = true;
Igor Murashkin37743352014-11-13 14:38:00 -08003411 } else {
3412 return kParseUnknownArgument;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003413 }
3414
Igor Murashkin37743352014-11-13 14:38:00 -08003415 return kParseOk;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003416 }
3417
Roland Levillainf73caca2018-08-24 17:19:07 +01003418 ParseStatus ParseChecks(std::string* error_msg) override {
Igor Murashkin37743352014-11-13 14:38:00 -08003419 // Infer boot image location from the image location if possible.
3420 if (boot_image_location_ == nullptr) {
3421 boot_image_location_ = image_location_;
3422 }
3423
3424 // Perform the parent checks.
3425 ParseStatus parent_checks = Base::ParseChecks(error_msg);
3426 if (parent_checks != kParseOk) {
3427 return parent_checks;
3428 }
3429
3430 // Perform our own checks.
3431 if (image_location_ == nullptr && oat_filename_ == nullptr) {
3432 *error_msg = "Either --image or --oat-file must be specified";
3433 return kParseError;
3434 } else if (image_location_ != nullptr && oat_filename_ != nullptr) {
3435 *error_msg = "Either --image or --oat-file must be specified but not both";
3436 return kParseError;
3437 }
3438
3439 return kParseOk;
3440 }
3441
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003442 std::string GetUsage() const override {
Igor Murashkin37743352014-11-13 14:38:00 -08003443 std::string usage;
3444
3445 usage +=
3446 "Usage: oatdump [options] ...\n"
3447 " Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art\n"
3448 " Example: adb shell oatdump --image=/system/framework/boot.art\n"
3449 "\n"
3450 // Either oat-file or image is required.
3451 " --oat-file=<file.oat>: specifies an input oat filename.\n"
3452 " Example: --oat-file=/system/framework/boot.oat\n"
3453 "\n"
3454 " --image=<file.art>: specifies an input image location.\n"
3455 " Example: --image=/system/framework/boot.art\n"
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003456 "\n"
3457 " --app-image=<file.art>: specifies an input app image. Must also have a specified\n"
Roland Levillain4f1c9e62017-06-28 16:44:30 +01003458 " boot image (with --image) and app oat file (with --app-oat).\n"
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003459 " Example: --app-image=app.art\n"
3460 "\n"
3461 " --app-oat=<file.odex>: specifies an input app oat.\n"
3462 " Example: --app-oat=app.odex\n"
Igor Murashkin37743352014-11-13 14:38:00 -08003463 "\n";
3464
3465 usage += Base::GetUsage();
3466
3467 usage += // Optional.
Igor Murashkin37743352014-11-13 14:38:00 -08003468 " --no-dump:vmap may be used to disable vmap dumping.\n"
3469 " Example: --no-dump:vmap\n"
3470 "\n"
Roland Levillainf2650d12015-05-28 14:53:28 +01003471 " --dump:code_info_stack_maps enables dumping of stack maps in CodeInfo sections.\n"
3472 " Example: --dump:code_info_stack_maps\n"
3473 "\n"
Igor Murashkin37743352014-11-13 14:38:00 -08003474 " --no-disassemble may be used to disable disassembly.\n"
3475 " Example: --no-disassemble\n"
3476 "\n"
David Brazdilc03d7b62016-03-02 12:18:03 +00003477 " --header-only may be used to print only the oat header.\n"
3478 " Example: --header-only\n"
3479 "\n"
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003480 " --list-classes may be used to list target file classes (can be used with filters).\n"
3481 " Example: --list-classes\n"
3482 " Example: --list-classes --class-filter=com.example.foo\n"
3483 "\n"
3484 " --list-methods may be used to list target file methods (can be used with filters).\n"
3485 " Example: --list-methods\n"
3486 " Example: --list-methods --class-filter=com.example --method-filter=foo\n"
3487 "\n"
3488 " --symbolize=<file.oat>: output a copy of file.oat with elf symbols included.\n"
3489 " Example: --symbolize=/system/framework/boot.oat\n"
3490 "\n"
David Srbecky2fdd03c2016-03-10 15:32:37 +00003491 " --only-keep-debug<file.oat>: Modifies the behaviour of --symbolize so that\n"
3492 " .rodata and .text sections are omitted in the output file to save space.\n"
3493 " Example: --symbolize=/system/framework/boot.oat --only-keep-debug\n"
3494 "\n"
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003495 " --class-filter=<class name>: only dumps classes that contain the filter.\n"
3496 " Example: --class-filter=com.example.foo\n"
3497 "\n"
Igor Murashkin37743352014-11-13 14:38:00 -08003498 " --method-filter=<method name>: only dumps methods that contain the filter.\n"
3499 " Example: --method-filter=foo\n"
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003500 "\n"
3501 " --export-dex-to=<directory>: may be used to export oat embedded dex files.\n"
3502 " Example: --export-dex-to=/data/local/tmp\n"
3503 "\n"
3504 " --addr2instr=<address>: output matching method disassembled code from relative\n"
3505 " address (e.g. PC from crash dump)\n"
3506 " Example: --addr2instr=0x00001a3b\n"
Andreas Gampe9fded872016-09-25 16:08:35 -07003507 "\n"
3508 " --dump-imt=<file.txt>: output IMT collisions (if any) for the given receiver\n"
3509 " types and interface methods in the given file. The file\n"
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003510 " is read line-wise, where each line should either be a class\n"
Andreas Gampe9fded872016-09-25 16:08:35 -07003511 " name or descriptor, or a class name/descriptor and a prefix\n"
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003512 " of a complete method name (separated by a whitespace).\n"
Andreas Gampe9fded872016-09-25 16:08:35 -07003513 " Example: --dump-imt=imt.txt\n"
3514 "\n"
3515 " --dump-imt-stats: output IMT statistics for the given boot image\n"
3516 " Example: --dump-imt-stats"
Igor Murashkin37743352014-11-13 14:38:00 -08003517 "\n";
3518
3519 return usage;
3520 }
3521
3522 public:
Andreas Gampe00b25f32014-09-17 21:49:05 -07003523 const char* oat_filename_ = nullptr;
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00003524 const char* dex_filename_ = nullptr;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003525 const char* class_filter_ = "";
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +00003526 const char* method_filter_ = "";
Andreas Gampe00b25f32014-09-17 21:49:05 -07003527 const char* image_location_ = nullptr;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003528 std::string elf_filename_prefix_;
Andreas Gampe9fded872016-09-25 16:08:35 -07003529 std::string imt_dump_;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003530 bool dump_vmap_ = true;
Roland Levillainf2650d12015-05-28 14:53:28 +01003531 bool dump_code_info_stack_maps_ = false;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003532 bool disassemble_code_ = true;
3533 bool symbolize_ = false;
David Srbecky2fdd03c2016-03-10 15:32:37 +00003534 bool only_keep_debug_ = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003535 bool list_classes_ = false;
3536 bool list_methods_ = false;
David Brazdilc03d7b62016-03-02 12:18:03 +00003537 bool dump_header_only_ = false;
Andreas Gampe9fded872016-09-25 16:08:35 -07003538 bool imt_stat_dump_ = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003539 uint32_t addr2instr_ = 0;
3540 const char* export_dex_location_ = nullptr;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003541 const char* app_image_ = nullptr;
3542 const char* app_oat_ = nullptr;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003543};
3544
Igor Murashkin37743352014-11-13 14:38:00 -08003545struct OatdumpMain : public CmdlineMain<OatdumpArgs> {
Roland Levillainf73caca2018-08-24 17:19:07 +01003546 bool NeedsRuntime() override {
Igor Murashkin37743352014-11-13 14:38:00 -08003547 CHECK(args_ != nullptr);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003548
Igor Murashkin37743352014-11-13 14:38:00 -08003549 // If we are only doing the oat file, disable absolute_addresses. Keep them for image dumping.
3550 bool absolute_addresses = (args_->oat_filename_ == nullptr);
3551
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003552 oat_dumper_options_.reset(new OatDumperOptions(
Igor Murashkin37743352014-11-13 14:38:00 -08003553 args_->dump_vmap_,
Roland Levillainf2650d12015-05-28 14:53:28 +01003554 args_->dump_code_info_stack_maps_,
Igor Murashkin37743352014-11-13 14:38:00 -08003555 args_->disassemble_code_,
3556 absolute_addresses,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003557 args_->class_filter_,
3558 args_->method_filter_,
3559 args_->list_classes_,
3560 args_->list_methods_,
David Brazdilc03d7b62016-03-02 12:18:03 +00003561 args_->dump_header_only_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003562 args_->export_dex_location_,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003563 args_->app_image_,
3564 args_->app_oat_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003565 args_->addr2instr_));
Igor Murashkin37743352014-11-13 14:38:00 -08003566
Andreas Gampe9fded872016-09-25 16:08:35 -07003567 return (args_->boot_image_location_ != nullptr ||
3568 args_->image_location_ != nullptr ||
3569 !args_->imt_dump_.empty()) &&
Igor Murashkin37743352014-11-13 14:38:00 -08003570 !args_->symbolize_;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003571 }
3572
Roland Levillainf73caca2018-08-24 17:19:07 +01003573 bool ExecuteWithoutRuntime() override {
Igor Murashkin37743352014-11-13 14:38:00 -08003574 CHECK(args_ != nullptr);
Andreas Gampec24f3992014-12-17 20:40:11 -08003575 CHECK(args_->oat_filename_ != nullptr);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003576
Mathieu Chartierd424d082014-10-15 10:31:46 -07003577 MemMap::Init();
Igor Murashkin37743352014-11-13 14:38:00 -08003578
Andreas Gampec24f3992014-12-17 20:40:11 -08003579 if (args_->symbolize_) {
David Srbecky2fdd03c2016-03-10 15:32:37 +00003580 // ELF has special kind of section called SHT_NOBITS which allows us to create
3581 // sections which exist but their data is omitted from the ELF file to save space.
3582 // This is what "strip --only-keep-debug" does when it creates separate ELF file
3583 // with only debug data. We use it in similar way to exclude .rodata and .text.
3584 bool no_bits = args_->only_keep_debug_;
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00003585 return SymbolizeOat(args_->oat_filename_, args_->dex_filename_, args_->output_name_, no_bits)
3586 == EXIT_SUCCESS;
Andreas Gampec24f3992014-12-17 20:40:11 -08003587 } else {
3588 return DumpOat(nullptr,
3589 args_->oat_filename_,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00003590 args_->dex_filename_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003591 oat_dumper_options_.get(),
Andreas Gampec24f3992014-12-17 20:40:11 -08003592 args_->os_) == EXIT_SUCCESS;
3593 }
Andreas Gampe00b25f32014-09-17 21:49:05 -07003594 }
3595
Andreas Gampefa6a1b02018-09-07 08:11:55 -07003596 bool ExecuteWithRuntime(Runtime* runtime) override {
Igor Murashkin37743352014-11-13 14:38:00 -08003597 CHECK(args_ != nullptr);
3598
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003599 if (!args_->imt_dump_.empty() || args_->imt_stat_dump_) {
3600 return IMTDumper::Dump(runtime,
3601 args_->imt_dump_,
3602 args_->imt_stat_dump_,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00003603 args_->oat_filename_,
3604 args_->dex_filename_);
Andreas Gampe9fded872016-09-25 16:08:35 -07003605 }
3606
Igor Murashkin37743352014-11-13 14:38:00 -08003607 if (args_->oat_filename_ != nullptr) {
3608 return DumpOat(runtime,
3609 args_->oat_filename_,
Nicolas Geoffrayf3075272018-01-08 12:41:19 +00003610 args_->dex_filename_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003611 oat_dumper_options_.get(),
Igor Murashkin37743352014-11-13 14:38:00 -08003612 args_->os_) == EXIT_SUCCESS;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003613 }
Igor Murashkin37743352014-11-13 14:38:00 -08003614
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003615 return DumpImages(runtime, oat_dumper_options_.get(), args_->os_) == EXIT_SUCCESS;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003616 }
3617
Igor Murashkin37743352014-11-13 14:38:00 -08003618 std::unique_ptr<OatDumperOptions> oat_dumper_options_;
3619};
Andreas Gampe00b25f32014-09-17 21:49:05 -07003620
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003621} // namespace art
Brian Carlstrom78128a62011-09-15 17:21:19 -07003622
3623int main(int argc, char** argv) {
Andreas Gampe221d9812018-01-22 17:48:56 -08003624 // Output all logging to stderr.
3625 android::base::SetLogger(android::base::StderrLogger);
3626
Igor Murashkin37743352014-11-13 14:38:00 -08003627 art::OatdumpMain main;
3628 return main.Main(argc, argv);
Brian Carlstrom78128a62011-09-15 17:21:19 -07003629}