blob: 2c15087612cbaca75b18ad8826f21e9a8b0cb468 [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>
21#include <iostream>
Igor Murashkin37743352014-11-13 14:38:00 -080022#include <map>
23#include <set>
Brian Carlstrom78128a62011-09-15 17:21:19 -070024#include <string>
Andreas Gampe54fc26c2014-09-04 21:47:42 -070025#include <unordered_map>
Andreas Gampe9fded872016-09-25 16:08:35 -070026#include <unordered_set>
Brian Carlstrom78128a62011-09-15 17:21:19 -070027#include <vector>
28
Andreas Gampe46ee31b2016-12-14 10:11:49 -080029#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080030#include "android-base/strings.h"
31
Ian Rogersd582fa42014-11-05 23:46:43 -080032#include "arch/instruction_set_features.h"
Mathieu Chartierc7853442015-03-27 14:35:38 -070033#include "art_field-inl.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070034#include "art_method-inl.h"
Vladimir Markof3c52b42017-11-17 17:32:12 +000035#include "base/bit_utils_iterator.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000036#include "base/stl_util.h"
Elliott Hughes76160052012-12-12 16:31:20 -080037#include "base/unix_file/fd_file.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080038#include "class_linker-inl.h"
Steven Morelande431e272017-07-18 16:53:49 -070039#include "class_linker.h"
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -080040#include "code_item_accessors-inl.h"
Vladimir Markod8dbc8d2017-09-20 13:37:47 +010041#include "compiled_method.h"
David Srbecky5d950762016-03-07 20:47:29 +000042#include "debug/elf_debug_writer.h"
43#include "debug/method_debug_info.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070044#include "dex_file-inl.h"
Christina Wadsworthbc233ac2016-06-20 15:01:32 -070045#include "dex_instruction-inl.h"
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080046#include "disassembler.h"
Andreas Gampe0c183382017-07-13 22:26:24 -070047#include "gc/accounting/space_bitmap-inl.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070048#include "gc/space/image_space.h"
49#include "gc/space/large_object_space.h"
50#include "gc/space/space-inl.h"
Mathieu Chartier4a26f172016-01-26 14:26:18 -080051#include "image-inl.h"
Andreas Gampe9fded872016-09-25 16:08:35 -070052#include "imtable-inl.h"
Ian Rogers2bcb4a42012-11-08 10:39:18 -080053#include "indenter.h"
Igor Murashkin86083f72017-10-27 10:59:04 -070054#include "subtype_check.h"
Vladimir Markof3c52b42017-11-17 17:32:12 +000055#include "index_bss_mapping.h"
Andreas Gampeebfc1ac2016-09-29 19:50:27 -070056#include "interpreter/unstarted_runtime.h"
Vladimir Marko131980f2015-12-03 18:29:23 +000057#include "linker/buffered_output_stream.h"
Vladimir Marko74527972016-11-29 15:57:32 +000058#include "linker/elf_builder.h"
Vladimir Marko131980f2015-12-03 18:29:23 +000059#include "linker/file_output_stream.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080060#include "mirror/array-inl.h"
61#include "mirror/class-inl.h"
Vladimir Marko05792b92015-08-03 11:56:49 +010062#include "mirror/dex_cache-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080063#include "mirror/object-inl.h"
64#include "mirror/object_array-inl.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080065#include "oat.h"
Vladimir Marko8a630572014-04-09 18:45:35 +010066#include "oat_file-inl.h"
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -070067#include "oat_file_manager.h"
Elliott Hughese5448b52012-01-18 16:44:06 -080068#include "os.h"
Elliott Hughesa0e18062012-04-13 15:59:59 -070069#include "safe_map.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070070#include "scoped_thread_state_change-inl.h"
Andreas Gampe513061a2017-06-01 09:17:34 -070071#include "stack.h"
Mathieu Chartierdc00f182016-07-14 10:10:44 -070072#include "stack_map.h"
73#include "string_reference.h"
Mathieu Chartierc22c59e2014-02-24 15:16:06 -080074#include "thread_list.h"
Andreas Gampe2ba88952016-04-29 17:52:07 -070075#include "type_lookup_table.h"
Nicolas Geoffray4acefd32016-10-24 13:14:58 +010076#include "vdex_file.h"
Ian Rogers2bcb4a42012-11-08 10:39:18 -080077#include "verifier/method_verifier.h"
Nicolas Geoffraye70dd562016-10-30 21:03:35 +000078#include "verifier/verifier_deps.h"
Andreas Gampe00b25f32014-09-17 21:49:05 -070079#include "well_known_classes.h"
Brian Carlstrom78128a62011-09-15 17:21:19 -070080
Igor Murashkin37743352014-11-13 14:38:00 -080081#include <sys/stat.h>
82#include "cmdline.h"
Brian Carlstrom78128a62011-09-15 17:21:19 -070083
Igor Murashkin37743352014-11-13 14:38:00 -080084namespace art {
Brian Carlstrom78128a62011-09-15 17:21:19 -070085
Andreas Gampe46ee31b2016-12-14 10:11:49 -080086using android::base::StringPrintf;
87
Mathieu Chartiere401d142015-04-22 13:56:20 -070088const char* image_methods_descriptions_[] = {
Ian Rogers19846512012-02-24 11:42:47 -080089 "kResolutionMethod",
Jeff Hao88474b42013-10-23 16:24:40 -070090 "kImtConflictMethod",
Mathieu Chartier2d2621a2014-10-23 16:48:06 -070091 "kImtUnimplementedMethod",
Vladimir Markofd36f1f2016-08-03 18:49:58 +010092 "kSaveAllCalleeSavesMethod",
93 "kSaveRefsOnlyMethod",
94 "kSaveRefsAndArgsMethod",
Vladimir Marko952dbb12016-07-28 12:01:51 +010095 "kSaveEverythingMethod",
Mingyao Yang0a87a652017-04-12 13:43:15 -070096 "kSaveEverythingMethodForClinit",
97 "kSaveEverythingMethodForSuspendCheck",
Mathieu Chartiere401d142015-04-22 13:56:20 -070098};
99
100const char* image_roots_descriptions_[] = {
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700101 "kDexCaches",
Brian Carlstrom34f426c2011-10-04 12:58:02 -0700102 "kClassRoots",
Vladimir Markoeca3eda2016-11-09 16:26:44 +0000103 "kClassLoader",
Brian Carlstrom78128a62011-09-15 17:21:19 -0700104};
105
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700106// Map is so that we don't allocate multiple dex files for the same OatDexFile.
107static std::map<const OatFile::OatDexFile*,
108 std::unique_ptr<const DexFile>> opened_dex_files;
109
110const DexFile* OpenDexFile(const OatFile::OatDexFile* oat_dex_file, std::string* error_msg) {
111 DCHECK(oat_dex_file != nullptr);
112 auto it = opened_dex_files.find(oat_dex_file);
113 if (it != opened_dex_files.end()) {
114 return it->second.get();
115 }
116 const DexFile* ret = oat_dex_file->OpenDexFile(error_msg).release();
117 opened_dex_files.emplace(oat_dex_file, std::unique_ptr<const DexFile>(ret));
118 return ret;
119}
120
Andreas Gampe2d8614b2016-03-07 16:31:34 -0800121template <typename ElfTypes>
David Srbeckybc90fd02015-04-22 19:40:27 +0100122class OatSymbolizer FINAL {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700123 public:
David Srbecky2fdd03c2016-03-10 15:32:37 +0000124 OatSymbolizer(const OatFile* oat_file, const std::string& output_name, bool no_bits) :
125 oat_file_(oat_file),
126 builder_(nullptr),
127 output_name_(output_name.empty() ? "symbolized.oat" : output_name),
128 no_bits_(no_bits) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700129 }
130
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700131 bool Symbolize() {
David Srbecky6d8c8f02015-10-26 10:57:09 +0000132 const InstructionSet isa = oat_file_->GetOatHeader().GetInstructionSet();
Andreas Gampe0415b4e2015-01-06 15:17:07 -0800133 std::unique_ptr<const InstructionSetFeatures> features = InstructionSetFeatures::FromBitmap(
David Srbecky5d811202016-03-08 13:21:22 +0000134 isa, oat_file_->GetOatHeader().GetInstructionSetFeaturesBitmap());
David Srbecky6d8c8f02015-10-26 10:57:09 +0000135
Andreas Gampe08c277c2017-04-26 22:22:15 -0700136 std::unique_ptr<File> elf_file(OS::CreateEmptyFile(output_name_.c_str()));
137 if (elf_file == nullptr) {
138 return false;
139 }
Vladimir Marko74527972016-11-29 15:57:32 +0000140 std::unique_ptr<linker::BufferedOutputStream> output_stream =
141 std::make_unique<linker::BufferedOutputStream>(
142 std::make_unique<linker::FileOutputStream>(elf_file.get()));
143 builder_.reset(new linker::ElfBuilder<ElfTypes>(isa, features.get(), output_stream.get()));
David Srbecky6d8c8f02015-10-26 10:57:09 +0000144
145 builder_->Start();
146
147 auto* rodata = builder_->GetRoData();
148 auto* text = builder_->GetText();
149 auto* bss = builder_->GetBss();
David Srbecky6d8c8f02015-10-26 10:57:09 +0000150
David Srbecky6d8c8f02015-10-26 10:57:09 +0000151 const uint8_t* rodata_begin = oat_file_->Begin();
152 const size_t rodata_size = oat_file_->GetOatHeader().GetExecutableOffset();
David Srbecky2fdd03c2016-03-10 15:32:37 +0000153 if (no_bits_) {
154 rodata->WriteNoBitsSection(rodata_size);
155 } else {
156 rodata->Start();
157 rodata->WriteFully(rodata_begin, rodata_size);
158 rodata->End();
159 }
David Srbecky6d8c8f02015-10-26 10:57:09 +0000160
David Srbecky6d8c8f02015-10-26 10:57:09 +0000161 const uint8_t* text_begin = oat_file_->Begin() + rodata_size;
162 const size_t text_size = oat_file_->End() - text_begin;
David Srbecky2fdd03c2016-03-10 15:32:37 +0000163 if (no_bits_) {
164 text->WriteNoBitsSection(text_size);
165 } else {
166 text->Start();
167 text->WriteFully(text_begin, text_size);
168 text->End();
169 }
David Srbecky6d8c8f02015-10-26 10:57:09 +0000170
171 if (oat_file_->BssSize() != 0) {
David Srbecky5b1c2ca2016-01-25 17:32:41 +0000172 bss->WriteNoBitsSection(oat_file_->BssSize());
David Srbecky6d8c8f02015-10-26 10:57:09 +0000173 }
174
Vladimir Marko33bff252017-11-01 14:35:42 +0000175 if (isa == InstructionSet::kMips || isa == InstructionSet::kMips64) {
Douglas Leung316a2182015-09-17 15:26:25 -0700176 builder_->WriteMIPSabiflagsSection();
177 }
Vladimir Markoaad75c62016-10-03 08:46:48 +0000178 builder_->PrepareDynamicSection(elf_file->GetPath(),
179 rodata_size,
180 text_size,
181 oat_file_->BssSize(),
Vladimir Marko0eb882b2017-05-15 13:39:18 +0100182 oat_file_->BssMethodsOffset(),
Vladimir Markoaad75c62016-10-03 08:46:48 +0000183 oat_file_->BssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +0000184 builder_->WriteDynamicSection();
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700185
Vladimir Marko1b404a82017-09-01 13:35:26 +0100186 const OatHeader& oat_header = oat_file_->GetOatHeader();
187 #define DO_TRAMPOLINE(fn_name) \
188 if (oat_header.Get ## fn_name ## Offset() != 0) { \
189 debug::MethodDebugInfo info = {}; \
190 info.trampoline_name = #fn_name; \
191 info.isa = oat_header.GetInstructionSet(); \
192 info.is_code_address_text_relative = true; \
193 size_t code_offset = oat_header.Get ## fn_name ## Offset(); \
194 code_offset -= CompiledCode::CodeDelta(oat_header.GetInstructionSet()); \
195 info.code_address = code_offset - oat_header.GetExecutableOffset(); \
196 info.code_size = 0; /* The symbol lasts until the next symbol. */ \
197 method_debug_infos_.push_back(std::move(info)); \
198 }
199 DO_TRAMPOLINE(InterpreterToInterpreterBridge)
200 DO_TRAMPOLINE(InterpreterToCompiledCodeBridge)
201 DO_TRAMPOLINE(JniDlsymLookup);
202 DO_TRAMPOLINE(QuickGenericJniTrampoline);
203 DO_TRAMPOLINE(QuickImtConflictTrampoline);
204 DO_TRAMPOLINE(QuickResolutionTrampoline);
205 DO_TRAMPOLINE(QuickToInterpreterBridge);
206 #undef DO_TRAMPOLINE
207
David Srbecky5d950762016-03-07 20:47:29 +0000208 Walk();
Vladimir Marko1b404a82017-09-01 13:35:26 +0100209
210 // TODO: Try to symbolize link-time thunks?
211 // This would require disassembling all methods to find branches outside the method code.
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700212
David Srbecky5d950762016-03-07 20:47:29 +0000213 debug::WriteDebugInfo(builder_.get(),
214 ArrayRef<const debug::MethodDebugInfo>(method_debug_infos_),
215 dwarf::DW_DEBUG_FRAME_FORMAT,
216 true /* write_oat_patches */);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700217
David Srbecky6d8c8f02015-10-26 10:57:09 +0000218 builder_->End();
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700219
Andreas Gampe08c277c2017-04-26 22:22:15 -0700220 bool ret_value = builder_->Good();
221
222 builder_.reset();
223 output_stream.reset();
224
225 if (elf_file->FlushCloseOrErase() != 0) {
226 return false;
227 }
228 elf_file.reset();
229
230 return ret_value;
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700231 }
232
David Srbecky5d950762016-03-07 20:47:29 +0000233 void Walk() {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700234 std::vector<const OatFile::OatDexFile*> oat_dex_files = oat_file_->GetOatDexFiles();
235 for (size_t i = 0; i < oat_dex_files.size(); i++) {
236 const OatFile::OatDexFile* oat_dex_file = oat_dex_files[i];
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700237 CHECK(oat_dex_file != nullptr);
David Srbecky5d950762016-03-07 20:47:29 +0000238 WalkOatDexFile(oat_dex_file);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700239 }
240 }
241
David Srbecky5d950762016-03-07 20:47:29 +0000242 void WalkOatDexFile(const OatFile::OatDexFile* oat_dex_file) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700243 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700244 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
245 if (dex_file == nullptr) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700246 return;
247 }
248 for (size_t class_def_index = 0;
249 class_def_index < dex_file->NumClassDefs();
250 class_def_index++) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700251 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
252 OatClassType type = oat_class.GetType();
253 switch (type) {
254 case kOatClassAllCompiled:
255 case kOatClassSomeCompiled:
David Srbecky5d950762016-03-07 20:47:29 +0000256 WalkOatClass(oat_class, *dex_file, class_def_index);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700257 break;
258
259 case kOatClassNoneCompiled:
260 case kOatClassMax:
261 // Ignore.
262 break;
263 }
264 }
265 }
266
David Srbecky5d950762016-03-07 20:47:29 +0000267 void WalkOatClass(const OatFile::OatClass& oat_class,
268 const DexFile& dex_file,
269 uint32_t class_def_index) {
270 const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
Ian Rogers13735952014-10-08 12:43:28 -0700271 const uint8_t* class_data = dex_file.GetClassData(class_def);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700272 if (class_data == nullptr) { // empty class such as a marker interface?
273 return;
274 }
275 // Note: even if this is an interface or a native class, we still have to walk it, as there
276 // might be a static initializer.
277 ClassDataItemIterator it(dex_file, class_data);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700278 uint32_t class_method_idx = 0;
Mathieu Chartiere17cf242017-06-19 11:05:51 -0700279 it.SkipAllFields();
Mathieu Chartierb7c273c2017-11-10 18:07:56 -0800280 for (; it.HasNextMethod(); it.Next()) {
David Srbecky5d950762016-03-07 20:47:29 +0000281 WalkOatMethod(oat_class.GetOatMethod(class_method_idx++),
282 dex_file,
283 class_def_index,
284 it.GetMemberIndex(),
285 it.GetMethodCodeItem(),
286 it.GetMethodAccessFlags());
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700287 }
288 DCHECK(!it.HasNext());
289 }
290
David Srbecky5d950762016-03-07 20:47:29 +0000291 void WalkOatMethod(const OatFile::OatMethod& oat_method,
292 const DexFile& dex_file,
293 uint32_t class_def_index,
294 uint32_t dex_method_index,
295 const DexFile::CodeItem* code_item,
296 uint32_t method_access_flags) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700297 if ((method_access_flags & kAccAbstract) != 0) {
298 // Abstract method, no code.
299 return;
300 }
David Srbecky5d950762016-03-07 20:47:29 +0000301 const OatHeader& oat_header = oat_file_->GetOatHeader();
302 const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader();
303 if (method_header == nullptr || method_header->GetCodeSize() == 0) {
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700304 // No code.
305 return;
306 }
307
David Srbeckya1b4c5f2016-03-31 18:17:59 +0100308 uint32_t entry_point = oat_method.GetCodeOffset() - oat_header.GetExecutableOffset();
309 // Clear Thumb2 bit.
310 const void* code_address = EntryPointToCodePointer(reinterpret_cast<void*>(entry_point));
311
Vladimir Marko1b404a82017-09-01 13:35:26 +0100312 debug::MethodDebugInfo info = {};
313 DCHECK(info.trampoline_name.empty());
David Srbecky5d950762016-03-07 20:47:29 +0000314 info.dex_file = &dex_file;
315 info.class_def_index = class_def_index;
316 info.dex_method_index = dex_method_index;
317 info.access_flags = method_access_flags;
318 info.code_item = code_item;
319 info.isa = oat_header.GetInstructionSet();
320 info.deduped = !seen_offsets_.insert(oat_method.GetCodeOffset()).second;
321 info.is_native_debuggable = oat_header.IsNativeDebuggable();
322 info.is_optimized = method_header->IsOptimized();
323 info.is_code_address_text_relative = true;
David Srbeckya1b4c5f2016-03-31 18:17:59 +0100324 info.code_address = reinterpret_cast<uintptr_t>(code_address);
David Srbecky5d950762016-03-07 20:47:29 +0000325 info.code_size = method_header->GetCodeSize();
326 info.frame_size_in_bytes = method_header->GetFrameSizeInBytes();
327 info.code_info = info.is_optimized ? method_header->GetOptimizedCodeInfoPtr() : nullptr;
328 info.cfi = ArrayRef<uint8_t>();
329 method_debug_infos_.push_back(info);
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700330 }
331
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700332 private:
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700333 const OatFile* oat_file_;
Vladimir Marko74527972016-11-29 15:57:32 +0000334 std::unique_ptr<linker::ElfBuilder<ElfTypes>> builder_;
David Srbecky5d950762016-03-07 20:47:29 +0000335 std::vector<debug::MethodDebugInfo> method_debug_infos_;
336 std::unordered_set<uint32_t> seen_offsets_;
Ian Rogers0279ebb2014-10-08 17:27:48 -0700337 const std::string output_name_;
David Srbecky2fdd03c2016-03-10 15:32:37 +0000338 bool no_bits_;
Andreas Gampe54fc26c2014-09-04 21:47:42 -0700339};
340
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700341class OatDumperOptions {
342 public:
Vladimir Marko9d07e3d2016-03-31 12:02:28 +0100343 OatDumperOptions(bool dump_vmap,
Roland Levillainf2650d12015-05-28 14:53:28 +0100344 bool dump_code_info_stack_maps,
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700345 bool disassemble_code,
Andreas Gampe00b25f32014-09-17 21:49:05 -0700346 bool absolute_addresses,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800347 const char* class_filter,
348 const char* method_filter,
349 bool list_classes,
350 bool list_methods,
David Brazdilc03d7b62016-03-02 12:18:03 +0000351 bool dump_header_only,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800352 const char* export_dex_location,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -0800353 const char* app_image,
354 const char* app_oat,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800355 uint32_t addr2instr)
Vladimir Marko9d07e3d2016-03-31 12:02:28 +0100356 : dump_vmap_(dump_vmap),
Roland Levillainf2650d12015-05-28 14:53:28 +0100357 dump_code_info_stack_maps_(dump_code_info_stack_maps),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700358 disassemble_code_(disassemble_code),
Andreas Gampe00b25f32014-09-17 21:49:05 -0700359 absolute_addresses_(absolute_addresses),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800360 class_filter_(class_filter),
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +0000361 method_filter_(method_filter),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800362 list_classes_(list_classes),
363 list_methods_(list_methods),
David Brazdilc03d7b62016-03-02 12:18:03 +0000364 dump_header_only_(dump_header_only),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800365 export_dex_location_(export_dex_location),
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -0800366 app_image_(app_image),
367 app_oat_(app_oat),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800368 addr2instr_(addr2instr),
Igor Murashkin37743352014-11-13 14:38:00 -0800369 class_loader_(nullptr) {}
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700370
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700371 const bool dump_vmap_;
Roland Levillainf2650d12015-05-28 14:53:28 +0100372 const bool dump_code_info_stack_maps_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700373 const bool disassemble_code_;
374 const bool absolute_addresses_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800375 const char* const class_filter_;
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +0000376 const char* const method_filter_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800377 const bool list_classes_;
378 const bool list_methods_;
David Brazdilc03d7b62016-03-02 12:18:03 +0000379 const bool dump_header_only_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800380 const char* const export_dex_location_;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -0800381 const char* const app_image_;
382 const char* const app_oat_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800383 uint32_t addr2instr_;
Andreas Gampe00b25f32014-09-17 21:49:05 -0700384 Handle<mirror::ClassLoader>* class_loader_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700385};
386
Elliott Hughese3c845c2012-02-28 17:23:01 -0800387class OatDumper {
Brian Carlstromaded5f72011-10-07 17:15:04 -0700388 public:
Roland Levillain3887c462015-08-12 18:15:42 +0100389 OatDumper(const OatFile& oat_file, const OatDumperOptions& options)
Nicolas Geoffray9583fbc2014-02-28 15:21:07 +0000390 : oat_file_(oat_file),
Elliott Hughesa72ec822012-03-05 17:12:22 -0800391 oat_dex_files_(oat_file.GetOatDexFiles()),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700392 options_(options),
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800393 resolved_addr2instr_(0),
Mathieu Chartiera7dd0382014-11-20 17:08:58 -0800394 instruction_set_(oat_file_.GetOatHeader().GetInstructionSet()),
395 disassembler_(Disassembler::Create(instruction_set_,
Andreas Gampe372f3a32016-08-19 10:49:06 -0700396 new DisassemblerOptions(
397 options_.absolute_addresses_,
398 oat_file.Begin(),
399 oat_file.End(),
400 true /* can_read_literals_ */,
401 Is64BitInstructionSet(instruction_set_)
402 ? &Thread::DumpThreadOffset<PointerSize::k64>
403 : &Thread::DumpThreadOffset<PointerSize::k32>))) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800404 CHECK(options_.class_loader_ != nullptr);
405 CHECK(options_.class_filter_ != nullptr);
406 CHECK(options_.method_filter_ != nullptr);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800407 AddAllOffsets();
408 }
409
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700410 ~OatDumper() {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700411 delete disassembler_;
412 }
413
Mathieu Chartiera7dd0382014-11-20 17:08:58 -0800414 InstructionSet GetInstructionSet() {
415 return instruction_set_;
416 }
417
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300418 typedef std::vector<std::unique_ptr<const DexFile>> DexFileUniqV;
419
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700420 bool Dump(std::ostream& os) {
421 bool success = true;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800422 const OatHeader& oat_header = oat_file_.GetOatHeader();
Brian Carlstromaded5f72011-10-07 17:15:04 -0700423
424 os << "MAGIC:\n";
425 os << oat_header.GetMagic() << "\n\n";
426
Jeff Hao4b07a6e2016-01-15 12:50:44 -0800427 os << "LOCATION:\n";
428 os << oat_file_.GetLocation() << "\n\n";
429
Brian Carlstromaded5f72011-10-07 17:15:04 -0700430 os << "CHECKSUM:\n";
Elliott Hughesed2adb62012-02-29 14:41:01 -0800431 os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum());
Brian Carlstromaded5f72011-10-07 17:15:04 -0700432
Elliott Hughesa72ec822012-03-05 17:12:22 -0800433 os << "INSTRUCTION SET:\n";
434 os << oat_header.GetInstructionSet() << "\n\n";
435
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700436 {
437 std::unique_ptr<const InstructionSetFeatures> features(
438 InstructionSetFeatures::FromBitmap(oat_header.GetInstructionSet(),
439 oat_header.GetInstructionSetFeaturesBitmap()));
440 os << "INSTRUCTION SET FEATURES:\n";
441 os << features->GetFeatureString() << "\n\n";
442 }
Dave Allison70202782013-10-22 17:52:19 -0700443
Brian Carlstromaded5f72011-10-07 17:15:04 -0700444 os << "DEX FILE COUNT:\n";
445 os << oat_header.GetDexFileCount() << "\n\n";
446
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800447#define DUMP_OAT_HEADER_OFFSET(label, offset) \
448 os << label " OFFSET:\n"; \
449 os << StringPrintf("0x%08x", oat_header.offset()); \
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800450 if (oat_header.offset() != 0 && options_.absolute_addresses_) { \
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800451 os << StringPrintf(" (%p)", oat_file_.Begin() + oat_header.offset()); \
452 } \
453 os << StringPrintf("\n\n");
454
455 DUMP_OAT_HEADER_OFFSET("EXECUTABLE", GetExecutableOffset);
456 DUMP_OAT_HEADER_OFFSET("INTERPRETER TO INTERPRETER BRIDGE",
457 GetInterpreterToInterpreterBridgeOffset);
458 DUMP_OAT_HEADER_OFFSET("INTERPRETER TO COMPILED CODE BRIDGE",
459 GetInterpreterToCompiledCodeBridgeOffset);
460 DUMP_OAT_HEADER_OFFSET("JNI DLSYM LOOKUP",
461 GetJniDlsymLookupOffset);
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800462 DUMP_OAT_HEADER_OFFSET("QUICK GENERIC JNI TRAMPOLINE",
463 GetQuickGenericJniTrampolineOffset);
464 DUMP_OAT_HEADER_OFFSET("QUICK IMT CONFLICT TRAMPOLINE",
465 GetQuickImtConflictTrampolineOffset);
466 DUMP_OAT_HEADER_OFFSET("QUICK RESOLUTION TRAMPOLINE",
467 GetQuickResolutionTrampolineOffset);
468 DUMP_OAT_HEADER_OFFSET("QUICK TO INTERPRETER BRIDGE",
469 GetQuickToInterpreterBridgeOffset);
470#undef DUMP_OAT_HEADER_OFFSET
Brian Carlstromaded5f72011-10-07 17:15:04 -0700471
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700472 os << "IMAGE PATCH DELTA:\n";
473 os << StringPrintf("%d (0x%08x)\n\n",
474 oat_header.GetImagePatchDelta(),
475 oat_header.GetImagePatchDelta());
Alex Lighta59dd802014-07-02 16:28:08 -0700476
Brian Carlstrom28db0122012-10-18 16:20:41 -0700477 os << "IMAGE FILE LOCATION OAT CHECKSUM:\n";
478 os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatChecksum());
479
480 os << "IMAGE FILE LOCATION OAT BEGIN:\n";
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800481 os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatDataBegin());
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700482
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700483 // Print the key-value store.
484 {
485 os << "KEY VALUE STORE:\n";
486 size_t index = 0;
487 const char* key;
488 const char* value;
489 while (oat_header.GetStoreKeyValuePairByIndex(index, &key, &value)) {
490 os << key << " = " << value << "\n";
491 index++;
492 }
493 os << "\n";
494 }
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700495
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800496 if (options_.absolute_addresses_) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700497 os << "BEGIN:\n";
498 os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -0700499
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700500 os << "END:\n";
501 os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n";
502 }
503
504 os << "SIZE:\n";
505 os << oat_file_.Size() << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -0700506
507 os << std::flush;
508
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -0800509 // If set, adjust relative address to be searched
510 if (options_.addr2instr_ != 0) {
511 resolved_addr2instr_ = options_.addr2instr_ + oat_header.GetExecutableOffset();
512 os << "SEARCH ADDRESS (executable offset + input):\n";
513 os << StringPrintf("0x%08x\n\n", resolved_addr2instr_);
514 }
515
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700516 // Dumping the dex file overview is compact enough to do even if header only.
517 DexFileData cumulative;
518 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
519 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
520 CHECK(oat_dex_file != nullptr);
521 std::string error_msg;
522 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
523 if (dex_file == nullptr) {
524 os << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation() << "': "
525 << error_msg;
526 continue;
527 }
528 DexFileData data(*dex_file);
529 os << "Dex file data for " << dex_file->GetLocation() << "\n";
530 data.Dump(os);
531 os << "\n";
Mathieu Chartier120aa282017-08-05 16:03:03 -0700532 const DexLayoutSections* const layout_sections = oat_dex_file->GetDexLayoutSections();
533 if (layout_sections != nullptr) {
534 os << "Layout data\n";
535 os << *layout_sections;
536 os << "\n";
537 }
538
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700539 cumulative.Add(data);
Vladimir Markof3c52b42017-11-17 17:32:12 +0000540
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)); });
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700563 }
564 os << "Cumulative dex file data\n";
565 cumulative.Dump(os);
566 os << "\n";
567
David Brazdilc03d7b62016-03-02 12:18:03 +0000568 if (!options_.dump_header_only_) {
Nicolas Geoffraye70dd562016-10-30 21:03:35 +0000569 VariableIndentationOutputStream vios(&os);
570 VdexFile::Header vdex_header = oat_file_.GetVdexFile()->GetHeader();
571 if (vdex_header.IsValid()) {
572 std::string error_msg;
573 std::vector<const DexFile*> dex_files;
574 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
575 const DexFile* dex_file = OpenDexFile(oat_dex_files_[i], &error_msg);
576 if (dex_file == nullptr) {
577 os << "Error opening dex file: " << error_msg << std::endl;
578 return false;
579 }
580 dex_files.push_back(dex_file);
581 }
582 verifier::VerifierDeps deps(dex_files, oat_file_.GetVdexFile()->GetVerifierDepsData());
583 deps.Dump(&vios);
584 } else {
585 os << "UNRECOGNIZED vdex file, magic "
586 << vdex_header.GetMagic()
587 << ", version "
588 << vdex_header.GetVersion()
589 << "\n";
590 }
David Brazdilc03d7b62016-03-02 12:18:03 +0000591 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
592 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
593 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) {
624 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
625 CHECK(oat_dex_file != nullptr);
626 CHECK(vdex_dex_file != nullptr);
627 if (!ExportDexFile(os, *oat_dex_file, vdex_dex_file.get())) {
628 success = false;
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300629 }
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000630 i++;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700631 }
Brian Carlstromaded5f72011-10-07 17:15:04 -0700632 }
David Brazdilc03d7b62016-03-02 12:18:03 +0000633
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800634 {
635 os << "OAT FILE STATS:\n";
636 VariableIndentationOutputStream vios(&os);
637 stats_.Dump(vios);
638 }
639
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700640 os << std::flush;
641 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700642 }
643
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800644 size_t ComputeSize(const void* oat_data) {
Ian Rogers13735952014-10-08 12:43:28 -0700645 if (reinterpret_cast<const uint8_t*>(oat_data) < oat_file_.Begin() ||
646 reinterpret_cast<const uint8_t*>(oat_data) > oat_file_.End()) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800647 return 0; // Address not in oat file
648 }
Ian Rogersef7d42f2014-01-06 12:55:46 -0800649 uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) -
650 reinterpret_cast<uintptr_t>(oat_file_.Begin());
651 auto it = offsets_.upper_bound(begin_offset);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800652 CHECK(it != offsets_.end());
Ian Rogersef7d42f2014-01-06 12:55:46 -0800653 uintptr_t end_offset = *it;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800654 return end_offset - begin_offset;
655 }
656
Mathieu Chartiera7dd0382014-11-20 17:08:58 -0800657 InstructionSet GetOatInstructionSet() {
Brian Carlstromf8bbb842012-03-14 03:01:42 -0700658 return oat_file_.GetOatHeader().GetInstructionSet();
659 }
660
Andreas Gampebdf7f1c2016-08-30 16:38:47 -0700661 const void* GetQuickOatCode(ArtMethod* m) REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800662 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
663 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700664 CHECK(oat_dex_file != nullptr);
665 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700666 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
667 if (dex_file == nullptr) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700668 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
669 << "': " << error_msg;
670 } else {
Mathieu Chartiere7c9a8c2014-11-06 16:35:45 -0800671 const char* descriptor = m->GetDeclaringClassDescriptor();
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700672 const DexFile::ClassDef* class_def =
David Sehr9aa352e2016-09-15 18:13:52 -0700673 OatDexFile::FindClassDef(*dex_file, descriptor, ComputeModifiedUtf8Hash(descriptor));
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700674 if (class_def != nullptr) {
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700675 uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100676 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800677 size_t method_index = m->GetMethodIndex();
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100678 return oat_class.GetOatMethod(method_index).GetQuickCode();
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800679 }
680 }
681 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700682 return nullptr;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800683 }
684
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +0300685 // Returns nullptr and updates error_msg if the Vdex file cannot be opened, otherwise all Dex
686 // files are fully unquickened and stored in dex_files
687 std::unique_ptr<const VdexFile> OpenVdexUnquicken(const std::string& vdex_filename,
688 /* out */ DexFileUniqV* dex_files,
689 /* out */ std::string* error_msg) {
690 std::unique_ptr<const File> file(OS::OpenFileForReading(vdex_filename.c_str()));
691 if (file == nullptr) {
692 *error_msg = "Could not open file " + vdex_filename + " for reading.";
693 return nullptr;
694 }
695
696 int64_t vdex_length = file->GetLength();
697 if (vdex_length == -1) {
698 *error_msg = "Could not read the length of file " + vdex_filename;
699 return nullptr;
700 }
701
702 std::unique_ptr<MemMap> mmap(MemMap::MapFile(
703 file->GetLength(),
704 PROT_READ | PROT_WRITE,
705 MAP_PRIVATE,
706 file->Fd(),
707 /* start offset */ 0,
708 /* low_4gb */ false,
709 vdex_filename.c_str(),
710 error_msg));
711 if (mmap == nullptr) {
712 *error_msg = "Failed to mmap file " + vdex_filename + ": " + *error_msg;
713 return nullptr;
714 }
715
716 std::unique_ptr<VdexFile> vdex_file(new VdexFile(mmap.release()));
717 if (!vdex_file->IsValid()) {
718 *error_msg = "Vdex file is not valid";
719 return nullptr;
720 }
721
722 DexFileUniqV tmp_dex_files;
723 if (!vdex_file->OpenAllDexFiles(&tmp_dex_files, error_msg)) {
724 *error_msg = "Failed to open Dex files from Vdex: " + *error_msg;
725 return nullptr;
726 }
727
728 vdex_file->Unquicken(MakeNonOwningPointerVector(tmp_dex_files),
729 vdex_file->GetQuickeningInfo(),
730 /* decompile_return_instruction */ true);
731
732 *dex_files = std::move(tmp_dex_files);
733 return vdex_file;
734 }
735
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800736 struct Stats {
737 enum ByteKind {
738 kByteKindCode,
739 kByteKindQuickMethodHeader,
740 kByteKindCodeInfoLocationCatalog,
741 kByteKindCodeInfoDexRegisterMap,
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800742 kByteKindCodeInfoEncoding,
Mathieu Chartierd776ff02017-01-17 09:32:18 -0800743 kByteKindCodeInfoInvokeInfo,
David Srbecky45aa5982016-03-18 02:15:09 +0000744 kByteKindCodeInfoStackMasks,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800745 kByteKindCodeInfoRegisterMasks,
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800746 kByteKindStackMapNativePc,
747 kByteKindStackMapDexPc,
748 kByteKindStackMapDexRegisterMap,
Mathieu Chartier1e083792017-02-08 13:30:04 -0800749 kByteKindStackMapInlineInfoIndex,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800750 kByteKindStackMapRegisterMaskIndex,
David Srbecky45aa5982016-03-18 02:15:09 +0000751 kByteKindStackMapStackMaskIndex,
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700752 kByteKindInlineInfoMethodIndexIdx,
Mathieu Chartier1e083792017-02-08 13:30:04 -0800753 kByteKindInlineInfoDexPc,
754 kByteKindInlineInfoExtraData,
755 kByteKindInlineInfoDexRegisterMap,
756 kByteKindInlineInfoIsLast,
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800757 kByteKindCount,
Mathieu Chartier1e083792017-02-08 13:30:04 -0800758 // Special ranges for std::accumulate convenience.
759 kByteKindStackMapFirst = kByteKindStackMapNativePc,
David Srbecky45aa5982016-03-18 02:15:09 +0000760 kByteKindStackMapLast = kByteKindStackMapStackMaskIndex,
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700761 kByteKindInlineInfoFirst = kByteKindInlineInfoMethodIndexIdx,
Mathieu Chartier1e083792017-02-08 13:30:04 -0800762 kByteKindInlineInfoLast = kByteKindInlineInfoIsLast,
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800763 };
764 int64_t bits[kByteKindCount] = {};
765 // Since code has deduplication, seen tracks already seen pointers to avoid double counting
766 // deduplicated code and tables.
767 std::unordered_set<const void*> seen;
768
769 // Returns true if it was newly added.
770 bool AddBitsIfUnique(ByteKind kind, int64_t count, const void* address) {
771 if (seen.insert(address).second == true) {
772 // True means the address was not already in the set.
773 AddBits(kind, count);
774 return true;
775 }
776 return false;
777 }
778
779 void AddBits(ByteKind kind, int64_t count) {
780 bits[kind] += count;
781 }
782
783 void Dump(VariableIndentationOutputStream& os) {
784 const int64_t sum = std::accumulate(bits, bits + kByteKindCount, 0u);
785 os.Stream() << "Dumping cumulative use of " << sum / kBitsPerByte << " accounted bytes\n";
786 if (sum > 0) {
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800787 Dump(os, "Code ", bits[kByteKindCode], sum);
788 Dump(os, "QuickMethodHeader ", bits[kByteKindQuickMethodHeader], sum);
789 Dump(os, "CodeInfoEncoding ", bits[kByteKindCodeInfoEncoding], sum);
790 Dump(os, "CodeInfoLocationCatalog ", bits[kByteKindCodeInfoLocationCatalog], sum);
791 Dump(os, "CodeInfoDexRegisterMap ", bits[kByteKindCodeInfoDexRegisterMap], sum);
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800792 Dump(os, "CodeInfoStackMasks ", bits[kByteKindCodeInfoStackMasks], sum);
793 Dump(os, "CodeInfoRegisterMasks ", bits[kByteKindCodeInfoRegisterMasks], sum);
Mathieu Chartierd776ff02017-01-17 09:32:18 -0800794 Dump(os, "CodeInfoInvokeInfo ", bits[kByteKindCodeInfoInvokeInfo], sum);
Mathieu Chartier1e083792017-02-08 13:30:04 -0800795 // Stack map section.
796 const int64_t stack_map_bits = std::accumulate(bits + kByteKindStackMapFirst,
797 bits + kByteKindStackMapLast + 1,
798 0u);
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800799 Dump(os, "CodeInfoStackMap ", stack_map_bits, sum);
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800800 {
801 ScopedIndentation indent1(&os);
802 Dump(os,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800803 "StackMapNativePc ",
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800804 bits[kByteKindStackMapNativePc],
805 stack_map_bits,
806 "stack map");
807 Dump(os,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800808 "StackMapDexPcEncoding ",
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800809 bits[kByteKindStackMapDexPc],
810 stack_map_bits,
811 "stack map");
812 Dump(os,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800813 "StackMapDexRegisterMap ",
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800814 bits[kByteKindStackMapDexRegisterMap],
815 stack_map_bits,
816 "stack map");
817 Dump(os,
Mathieu Chartier697dc662017-02-08 16:56:48 -0800818 "StackMapInlineInfoIndex ",
Mathieu Chartier1e083792017-02-08 13:30:04 -0800819 bits[kByteKindStackMapInlineInfoIndex],
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800820 stack_map_bits,
821 "stack map");
822 Dump(os,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800823 "StackMapRegisterMaskIndex ",
824 bits[kByteKindStackMapRegisterMaskIndex],
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800825 stack_map_bits,
826 "stack map");
827 Dump(os,
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800828 "StackMapStackMaskIndex ",
David Srbecky45aa5982016-03-18 02:15:09 +0000829 bits[kByteKindStackMapStackMaskIndex],
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800830 stack_map_bits,
831 "stack map");
832 }
Mathieu Chartier1e083792017-02-08 13:30:04 -0800833 // Inline info section.
834 const int64_t inline_info_bits = std::accumulate(bits + kByteKindInlineInfoFirst,
835 bits + kByteKindInlineInfoLast + 1,
836 0u);
837 Dump(os, "CodeInfoInlineInfo ", inline_info_bits, sum);
838 {
839 ScopedIndentation indent1(&os);
840 Dump(os,
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700841 "InlineInfoMethodIndexIdx ",
842 bits[kByteKindInlineInfoMethodIndexIdx],
Mathieu Chartier1e083792017-02-08 13:30:04 -0800843 inline_info_bits,
844 "inline info");
845 Dump(os,
846 "InlineInfoDexPc ",
847 bits[kByteKindStackMapDexPc],
848 inline_info_bits,
849 "inline info");
850 Dump(os,
851 "InlineInfoExtraData ",
852 bits[kByteKindInlineInfoExtraData],
853 inline_info_bits,
854 "inline info");
855 Dump(os,
856 "InlineInfoDexRegisterMap ",
857 bits[kByteKindInlineInfoDexRegisterMap],
858 inline_info_bits,
859 "inline info");
860 Dump(os,
861 "InlineInfoIsLast ",
862 bits[kByteKindInlineInfoIsLast],
863 inline_info_bits,
864 "inline info");
865 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -0800866 }
867 os.Stream() << "\n" << std::flush;
868 }
869
870 private:
871 void Dump(VariableIndentationOutputStream& os,
872 const char* name,
873 int64_t size,
874 int64_t total,
875 const char* sum_of = "total") {
876 const double percent = (static_cast<double>(size) / static_cast<double>(total)) * 100;
877 os.Stream() << StringPrintf("%s = %8" PRId64 " (%2.0f%% of %s)\n",
878 name,
879 size / kBitsPerByte,
880 percent,
881 sum_of);
882 }
883 };
884
Brian Carlstromaded5f72011-10-07 17:15:04 -0700885 private:
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800886 void AddAllOffsets() {
Elliott Hughese3c845c2012-02-28 17:23:01 -0800887 // We don't know the length of the code for each method, but we need to know where to stop
888 // when disassembling. What we do know is that a region of code will be followed by some other
889 // region, so if we keep a sorted sequence of the start of each region, we can infer the length
890 // of a piece of code by using upper_bound to find the start of the next region.
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800891 for (size_t i = 0; i < oat_dex_files_.size(); i++) {
892 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i];
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700893 CHECK(oat_dex_file != nullptr);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700894 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -0700895 const DexFile* const dex_file = OpenDexFile(oat_dex_file, &error_msg);
896 if (dex_file == nullptr) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700897 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation()
898 << "': " << error_msg;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -0800899 continue;
Elliott Hughese3c845c2012-02-28 17:23:01 -0800900 }
Ian Rogersef7d42f2014-01-06 12:55:46 -0800901 offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader()));
Brian Carlstrom2ec65202014-03-03 15:16:37 -0800902 for (size_t class_def_index = 0;
903 class_def_index < dex_file->NumClassDefs();
904 class_def_index++) {
Elliott Hughese3c845c2012-02-28 17:23:01 -0800905 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100906 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index);
Ian Rogers13735952014-10-08 12:43:28 -0700907 const uint8_t* class_data = dex_file->GetClassData(class_def);
Andreas Gampe2ed8def2014-08-28 14:41:02 -0700908 if (class_data != nullptr) {
Elliott Hughese3c845c2012-02-28 17:23:01 -0800909 ClassDataItemIterator it(*dex_file, class_data);
Mathieu Chartiere17cf242017-06-19 11:05:51 -0700910 it.SkipAllFields();
Elliott Hughese3c845c2012-02-28 17:23:01 -0800911 uint32_t class_method_index = 0;
Mathieu Chartierb7c273c2017-11-10 18:07:56 -0800912 while (it.HasNextMethod()) {
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100913 AddOffsets(oat_class.GetOatMethod(class_method_index++));
Elliott Hughese3c845c2012-02-28 17:23:01 -0800914 it.Next();
915 }
916 }
917 }
918 }
919
920 // If the last thing in the file is code for a method, there won't be an offset for the "next"
921 // thing. Instead of having a special case in the upper_bound code, let's just add an entry
922 // for the end of the file.
Ian Rogersef7d42f2014-01-06 12:55:46 -0800923 offsets_.insert(oat_file_.Size());
Elliott Hughese3c845c2012-02-28 17:23:01 -0800924 }
925
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700926 static uint32_t AlignCodeOffset(uint32_t maybe_thumb_offset) {
927 return maybe_thumb_offset & ~0x1; // TODO: Make this Thumb2 specific.
928 }
929
Elliott Hughese3c845c2012-02-28 17:23:01 -0800930 void AddOffsets(const OatFile::OatMethod& oat_method) {
Brian Carlstrom95ba0dc2012-03-05 22:06:14 -0800931 uint32_t code_offset = oat_method.GetCodeOffset();
Vladimir Marko33bff252017-11-01 14:35:42 +0000932 if (oat_file_.GetOatHeader().GetInstructionSet() == InstructionSet::kThumb2) {
Brian Carlstrom95ba0dc2012-03-05 22:06:14 -0800933 code_offset &= ~0x1;
934 }
935 offsets_.insert(code_offset);
Elliott Hughese3c845c2012-02-28 17:23:01 -0800936 offsets_.insert(oat_method.GetVmapTableOffset());
Elliott Hughese3c845c2012-02-28 17:23:01 -0800937 }
938
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700939 // Dex file data, may be for multiple different dex files.
940 class DexFileData {
941 public:
942 DexFileData() {}
943
944 explicit DexFileData(const DexFile& dex_file)
945 : num_string_ids_(dex_file.NumStringIds()),
946 num_method_ids_(dex_file.NumMethodIds()),
947 num_field_ids_(dex_file.NumFieldIds()),
948 num_type_ids_(dex_file.NumTypeIds()),
949 num_class_defs_(dex_file.NumClassDefs()) {
950 for (size_t class_def_index = 0; class_def_index < num_class_defs_; ++class_def_index) {
951 const DexFile::ClassDef& class_def = dex_file.GetClassDef(class_def_index);
952 WalkClass(dex_file, class_def);
953 }
954 }
955
956 void Add(const DexFileData& other) {
957 AddAll(unique_string_ids_from_code_, other.unique_string_ids_from_code_);
958 num_string_ids_from_code_ += other.num_string_ids_from_code_;
959 AddAll(dex_code_item_ptrs_, other.dex_code_item_ptrs_);
960 dex_code_bytes_ += other.dex_code_bytes_;
961 num_string_ids_ += other.num_string_ids_;
962 num_method_ids_ += other.num_method_ids_;
963 num_field_ids_ += other.num_field_ids_;
964 num_type_ids_ += other.num_type_ids_;
965 num_class_defs_ += other.num_class_defs_;
966 }
967
968 void Dump(std::ostream& os) {
969 os << "Num string ids: " << num_string_ids_ << "\n";
970 os << "Num method ids: " << num_method_ids_ << "\n";
971 os << "Num field ids: " << num_field_ids_ << "\n";
972 os << "Num type ids: " << num_type_ids_ << "\n";
973 os << "Num class defs: " << num_class_defs_ << "\n";
974 os << "Unique strings loaded from dex code: " << unique_string_ids_from_code_.size() << "\n";
975 os << "Total strings loaded from dex code: " << num_string_ids_from_code_ << "\n";
976 os << "Number of unique dex code items: " << dex_code_item_ptrs_.size() << "\n";
977 os << "Total number of dex code bytes: " << dex_code_bytes_ << "\n";
978 }
979
Igor Murashkin2ffb7032017-11-08 13:35:21 -0800980 private:
Andreas Gampe9186ced2016-12-12 14:28:21 -0800981 // All of the elements from one container to another.
982 template <typename Dest, typename Src>
983 static void AddAll(Dest& dest, const Src& src) {
984 dest.insert(src.begin(), src.end());
985 }
986
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700987 void WalkClass(const DexFile& dex_file, const DexFile::ClassDef& class_def) {
988 const uint8_t* class_data = dex_file.GetClassData(class_def);
989 if (class_data == nullptr) { // empty class such as a marker interface?
990 return;
991 }
992 ClassDataItemIterator it(dex_file, class_data);
Mathieu Chartiere17cf242017-06-19 11:05:51 -0700993 it.SkipAllFields();
Mathieu Chartierb7c273c2017-11-10 18:07:56 -0800994 while (it.HasNextMethod()) {
Mathieu Chartierdc00f182016-07-14 10:10:44 -0700995 WalkCodeItem(dex_file, it.GetMethodCodeItem());
996 it.Next();
997 }
998 DCHECK(!it.HasNext());
999 }
1000
1001 void WalkCodeItem(const DexFile& dex_file, const DexFile::CodeItem* code_item) {
1002 if (code_item == nullptr) {
1003 return;
1004 }
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001005 CodeItemInstructionAccessor instructions(&dex_file, code_item);
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001006
1007 // If we inserted a new dex code item pointer, add to total code bytes.
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001008 const uint16_t* code_ptr = instructions.Insns();
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001009 if (dex_code_item_ptrs_.insert(code_ptr).second) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001010 dex_code_bytes_ += instructions.InsnsSizeInCodeUnits() * sizeof(code_ptr[0]);
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001011 }
1012
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001013 for (const DexInstructionPcPair& inst : instructions) {
Mathieu Chartier2b2bef22017-10-26 17:10:19 -07001014 switch (inst->Opcode()) {
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001015 case Instruction::CONST_STRING: {
Mathieu Chartier2b2bef22017-10-26 17:10:19 -07001016 const dex::StringIndex string_index(inst->VRegB_21c());
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001017 unique_string_ids_from_code_.insert(StringReference(&dex_file, string_index));
1018 ++num_string_ids_from_code_;
1019 break;
1020 }
1021 case Instruction::CONST_STRING_JUMBO: {
Mathieu Chartier2b2bef22017-10-26 17:10:19 -07001022 const dex::StringIndex string_index(inst->VRegB_31c());
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001023 unique_string_ids_from_code_.insert(StringReference(&dex_file, string_index));
1024 ++num_string_ids_from_code_;
1025 break;
1026 }
1027 default:
1028 break;
1029 }
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001030 }
1031 }
1032
1033 // Unique string ids loaded from dex code.
Mathieu Chartierfc8b4222017-09-17 13:44:24 -07001034 std::set<StringReference> unique_string_ids_from_code_;
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001035
1036 // Total string ids loaded from dex code.
1037 size_t num_string_ids_from_code_ = 0;
1038
1039 // Unique code pointers.
1040 std::set<const void*> dex_code_item_ptrs_;
1041
1042 // Total "unique" dex code bytes.
1043 size_t dex_code_bytes_ = 0;
1044
1045 // Other dex ids.
1046 size_t num_string_ids_ = 0;
1047 size_t num_method_ids_ = 0;
1048 size_t num_field_ids_ = 0;
1049 size_t num_type_ids_ = 0;
1050 size_t num_class_defs_ = 0;
1051 };
1052
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001053 bool DumpOatDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) {
1054 bool success = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001055 bool stop_analysis = false;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001056 os << "OatDexFile:\n";
Brian Carlstroma004aa92012-02-08 18:05:09 -08001057 os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str());
Elliott Hughesed2adb62012-02-29 14:41:01 -08001058 os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum());
Mathieu Chartier590fee92013-09-13 13:46:47 -07001059
Andreas Gampe2ba88952016-04-29 17:52:07 -07001060 const uint8_t* const oat_file_begin = oat_dex_file.GetOatFile()->Begin();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001061 const uint8_t* const vdex_file_begin = oat_dex_file.GetOatFile()->DexBegin();
1062
1063 // Print data range of the dex file embedded inside the corresponding vdex file.
Andreas Gampe2ba88952016-04-29 17:52:07 -07001064 const uint8_t* const dex_file_pointer = oat_dex_file.GetDexFilePointer();
David Brazdil7b49e6c2016-09-01 11:06:18 +01001065 uint32_t dex_offset = dchecked_integral_cast<uint32_t>(dex_file_pointer - vdex_file_begin);
Andreas Gampe2ba88952016-04-29 17:52:07 -07001066 os << StringPrintf("dex-file: 0x%08x..0x%08x\n",
1067 dex_offset,
1068 dchecked_integral_cast<uint32_t>(dex_offset + oat_dex_file.FileSize() - 1));
Mathieu Chartier590fee92013-09-13 13:46:47 -07001069
Andreas Gampe2ba88952016-04-29 17:52:07 -07001070 // Create the dex file early. A lot of print-out things depend on it.
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001071 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -07001072 const DexFile* const dex_file = OpenDexFile(&oat_dex_file, &error_msg);
1073 if (dex_file == nullptr) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -07001074 os << "NOT FOUND: " << error_msg << "\n\n";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001075 os << std::flush;
1076 return false;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001077 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001078
Andreas Gampe2ba88952016-04-29 17:52:07 -07001079 // Print lookup table, if it exists.
1080 if (oat_dex_file.GetLookupTableData() != nullptr) {
1081 uint32_t table_offset = dchecked_integral_cast<uint32_t>(
1082 oat_dex_file.GetLookupTableData() - oat_file_begin);
David Sehr9aa352e2016-09-15 18:13:52 -07001083 uint32_t table_size = TypeLookupTable::RawDataLength(dex_file->NumClassDefs());
Andreas Gampe2ba88952016-04-29 17:52:07 -07001084 os << StringPrintf("type-table: 0x%08x..0x%08x\n",
1085 table_offset,
1086 table_offset + table_size - 1);
1087 }
1088
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001089 VariableIndentationOutputStream vios(&os);
1090 ScopedIndentation indent1(&vios);
Brian Carlstrom2ec65202014-03-03 15:16:37 -08001091 for (size_t class_def_index = 0;
1092 class_def_index < dex_file->NumClassDefs();
1093 class_def_index++) {
Brian Carlstromaded5f72011-10-07 17:15:04 -07001094 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
1095 const char* descriptor = dex_file->GetClassDescriptor(class_def);
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001096
1097 // TODO: Support regex
1098 if (DescriptorToDot(descriptor).find(options_.class_filter_) == std::string::npos) {
1099 continue;
1100 }
1101
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001102 uint32_t oat_class_offset = oat_dex_file.GetOatClassOffset(class_def_index);
Vladimir Markod3c5beb2014-04-11 16:32:51 +01001103 const OatFile::OatClass oat_class = oat_dex_file.GetOatClass(class_def_index);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001104 os << StringPrintf("%zd: %s (offset=0x%08x) (type_idx=%d)",
Andreas Gampea5b09a62016-11-17 15:21:22 -08001105 class_def_index, descriptor, oat_class_offset, class_def.class_idx_.index_)
Vladimir Markod3c5beb2014-04-11 16:32:51 +01001106 << " (" << oat_class.GetStatus() << ")"
1107 << " (" << oat_class.GetType() << ")\n";
1108 // TODO: include bitmap here if type is kOatClassSomeCompiled?
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001109 if (options_.list_classes_) {
1110 continue;
1111 }
1112 if (!DumpOatClass(&vios, oat_class, *dex_file, class_def, &stop_analysis)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001113 success = false;
1114 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001115 if (stop_analysis) {
1116 os << std::flush;
1117 return success;
1118 }
Brian Carlstromaded5f72011-10-07 17:15:04 -07001119 }
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001120 os << "\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -07001121 os << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001122 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001123 }
1124
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001125 // Backwards compatible Dex file export. If dex_file is nullptr (valid Vdex file not present) the
1126 // Dex resource is extracted from the oat_dex_file and its checksum is repaired since it's not
1127 // unquickened. Otherwise the dex_file has been fully unquickened and is expected to verify the
1128 // original checksum.
1129 bool ExportDexFile(std::ostream& os,
1130 const OatFile::OatDexFile& oat_dex_file,
1131 const DexFile* dex_file) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001132 std::string error_msg;
1133 std::string dex_file_location = oat_dex_file.GetDexFileLocation();
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001134 size_t fsize = oat_dex_file.FileSize();
1135
1136 // Some quick checks just in case
1137 if (fsize == 0 || fsize < sizeof(DexFile::Header)) {
1138 os << "Invalid dex file\n";
1139 return false;
1140 }
1141
Anestis Bechtsoudisa1f56a82017-10-08 23:37:10 +03001142 if (dex_file == nullptr) {
1143 // Exported bytecode is quickened (dex-to-dex transformations present)
1144 dex_file = OpenDexFile(&oat_dex_file, &error_msg);
1145 if (dex_file == nullptr) {
1146 os << "Failed to open dex file '" << dex_file_location << "': " << error_msg;
1147 return false;
1148 }
1149
1150 // Recompute checksum
1151 reinterpret_cast<DexFile::Header*>(const_cast<uint8_t*>(dex_file->Begin()))->checksum_ =
1152 dex_file->CalculateChecksum();
1153 } else {
1154 // Vdex unquicken output should match original input bytecode
1155 uint32_t orig_checksum =
1156 reinterpret_cast<DexFile::Header*>(const_cast<uint8_t*>(dex_file->Begin()))->checksum_;
1157 if (orig_checksum != dex_file->CalculateChecksum()) {
1158 os << "Unexpected checksum from unquicken dex file '" << dex_file_location << "'\n";
1159 return false;
1160 }
1161 }
1162
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001163 // Verify output directory exists
1164 if (!OS::DirectoryExists(options_.export_dex_location_)) {
1165 // TODO: Extend OS::DirectoryExists if symlink support is required
1166 os << options_.export_dex_location_ << " output directory not found or symlink\n";
1167 return false;
1168 }
1169
1170 // Beautify path names
1171 if (dex_file_location.size() > PATH_MAX || dex_file_location.size() <= 0) {
1172 return false;
1173 }
1174
1175 std::string dex_orig_name;
1176 size_t dex_orig_pos = dex_file_location.rfind('/');
1177 if (dex_orig_pos == std::string::npos)
1178 dex_orig_name = dex_file_location;
1179 else
1180 dex_orig_name = dex_file_location.substr(dex_orig_pos + 1);
1181
1182 // A more elegant approach to efficiently name user installed apps is welcome
Andreas Gampef812d8c2017-02-17 10:19:44 -08001183 if (dex_orig_name.size() == 8 &&
1184 dex_orig_name.compare("base.apk") == 0 &&
1185 dex_orig_pos != std::string::npos) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001186 dex_file_location.erase(dex_orig_pos, strlen("base.apk") + 1);
1187 size_t apk_orig_pos = dex_file_location.rfind('/');
1188 if (apk_orig_pos != std::string::npos) {
1189 dex_orig_name = dex_file_location.substr(++apk_orig_pos);
1190 }
1191 }
1192
1193 std::string out_dex_path(options_.export_dex_location_);
1194 if (out_dex_path.back() != '/') {
1195 out_dex_path.append("/");
1196 }
1197 out_dex_path.append(dex_orig_name);
1198 out_dex_path.append("_export.dex");
1199 if (out_dex_path.length() > PATH_MAX) {
1200 return false;
1201 }
1202
1203 std::unique_ptr<File> file(OS::CreateEmptyFile(out_dex_path.c_str()));
1204 if (file.get() == nullptr) {
1205 os << "Failed to open output dex file " << out_dex_path;
1206 return false;
1207 }
1208
1209 if (!file->WriteFully(dex_file->Begin(), fsize)) {
1210 os << "Failed to write dex file";
1211 file->Erase();
1212 return false;
1213 }
1214
1215 if (file->FlushCloseOrErase() != 0) {
1216 os << "Flush and close failed";
1217 return false;
1218 }
1219
1220 os << StringPrintf("Dex file exported at %s (%zd bytes)\n", out_dex_path.c_str(), fsize);
1221 os << std::flush;
1222
1223 return true;
1224 }
1225
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001226 bool DumpOatClass(VariableIndentationOutputStream* vios,
1227 const OatFile::OatClass& oat_class, const DexFile& dex_file,
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001228 const DexFile::ClassDef& class_def, bool* stop_analysis) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001229 bool success = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001230 bool addr_found = false;
Ian Rogers13735952014-10-08 12:43:28 -07001231 const uint8_t* class_data = dex_file.GetClassData(class_def);
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001232 if (class_data == nullptr) { // empty class such as a marker interface?
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001233 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001234 return success;
Elliott Hughese3c845c2012-02-28 17:23:01 -08001235 }
1236 ClassDataItemIterator it(dex_file, class_data);
Mathieu Chartiere17cf242017-06-19 11:05:51 -07001237 it.SkipAllFields();
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001238 uint32_t class_method_index = 0;
Mathieu Chartierb7c273c2017-11-10 18:07:56 -08001239 while (it.HasNextMethod()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001240 if (!DumpOatMethod(vios, class_def, class_method_index, oat_class, dex_file,
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001241 it.GetMemberIndex(), it.GetMethodCodeItem(),
Mathieu Chartierdc00f182016-07-14 10:10:44 -07001242 it.GetRawMemberAccessFlags(), &addr_found)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001243 success = false;
1244 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001245 if (addr_found) {
1246 *stop_analysis = true;
1247 return success;
1248 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001249 class_method_index++;
Ian Rogers0571d352011-11-03 19:51:38 -07001250 it.Next();
Brian Carlstromaded5f72011-10-07 17:15:04 -07001251 }
Ian Rogers0571d352011-11-03 19:51:38 -07001252 DCHECK(!it.HasNext());
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001253 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001254 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001255 }
Elliott Hughese3c845c2012-02-28 17:23:01 -08001256
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001257 static constexpr uint32_t kPrologueBytes = 16;
1258
1259 // When this was picked, the largest arm method was 55,256 bytes and arm64 was 50,412 bytes.
1260 static constexpr uint32_t kMaxCodeSize = 100 * 1000;
1261
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001262 bool DumpOatMethod(VariableIndentationOutputStream* vios,
1263 const DexFile::ClassDef& class_def,
Ian Rogers8b2c0b92013-09-19 02:56:49 -07001264 uint32_t class_method_index,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001265 const OatFile::OatClass& oat_class,
1266 const DexFile& dex_file,
1267 uint32_t dex_method_idx,
1268 const DexFile::CodeItem* code_item,
1269 uint32_t method_access_flags,
1270 bool* addr_found) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001271 bool success = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001272
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001273 CodeItemDataAccessor code_item_accessor(CodeItemDataAccessor::CreateNullable(&dex_file,
1274 code_item));
1275
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001276 // TODO: Support regex
1277 std::string method_name = dex_file.GetMethodName(dex_file.GetMethodId(dex_method_idx));
1278 if (method_name.find(options_.method_filter_) == std::string::npos) {
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +00001279 return success;
1280 }
1281
David Sehr709b0702016-10-13 09:12:37 -07001282 std::string pretty_method = dex_file.PrettyMethod(dex_method_idx, true);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001283 vios->Stream() << StringPrintf("%d: %s (dex_method_idx=%d)\n",
1284 class_method_index, pretty_method.c_str(),
1285 dex_method_idx);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001286 if (options_.list_methods_) {
1287 return success;
1288 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001289
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001290 uint32_t oat_method_offsets_offset = oat_class.GetOatMethodOffsetsOffset(class_method_index);
1291 const OatMethodOffsets* oat_method_offsets = oat_class.GetOatMethodOffsets(class_method_index);
1292 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_index);
1293 uint32_t code_offset = oat_method.GetCodeOffset();
1294 uint32_t code_size = oat_method.GetQuickCodeSize();
1295 if (resolved_addr2instr_ != 0) {
1296 if (resolved_addr2instr_ > code_offset + code_size) {
1297 return success;
1298 } else {
1299 *addr_found = true; // stop analyzing file at next iteration
1300 }
1301 }
1302
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001303 // Everything below is indented at least once.
1304 ScopedIndentation indent1(vios);
1305
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001306 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001307 vios->Stream() << "DEX CODE:\n";
1308 ScopedIndentation indent2(vios);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001309 if (code_item_accessor.HasCodeItem()) {
1310 for (const DexInstructionPcPair& inst : code_item_accessor) {
1311 vios->Stream() << StringPrintf("0x%04x: ", inst.DexPc()) << inst->DumpHexLE(5)
1312 << StringPrintf("\t| %s\n", inst->DumpString(&dex_file).c_str());
1313 }
1314 }
Ian Rogersb23a7722012-10-09 16:54:26 -07001315 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001316
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001317 std::unique_ptr<StackHandleScope<1>> hs;
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001318 std::unique_ptr<verifier::MethodVerifier> verifier;
1319 if (Runtime::Current() != nullptr) {
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001320 // We need to have the handle scope stay live until after the verifier since the verifier has
1321 // a handle to the dex cache from hs.
1322 hs.reset(new StackHandleScope<1>(Thread::Current()));
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001323 vios->Stream() << "VERIFIER TYPE ANALYSIS:\n";
1324 ScopedIndentation indent2(vios);
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001325 verifier.reset(DumpVerifier(vios, hs.get(),
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001326 dex_method_idx, &dex_file, class_def, code_item,
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001327 method_access_flags));
Ian Rogersb23a7722012-10-09 16:54:26 -07001328 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001329 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001330 vios->Stream() << "OatMethodOffsets ";
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001331 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001332 vios->Stream() << StringPrintf("%p ", oat_method_offsets);
Nicolas Geoffray39468442014-09-02 15:17:15 +01001333 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001334 vios->Stream() << StringPrintf("(offset=0x%08x)\n", oat_method_offsets_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001335 if (oat_method_offsets_offset > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001336 vios->Stream() << StringPrintf(
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001337 "WARNING: oat method offsets offset 0x%08x is past end of file 0x%08zx.\n",
1338 oat_method_offsets_offset, oat_file_.Size());
1339 // If we can't read OatMethodOffsets, the rest of the data is dangerous to read.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001340 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001341 return false;
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001342 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001343
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001344 ScopedIndentation indent2(vios);
1345 vios->Stream() << StringPrintf("code_offset: 0x%08x ", code_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001346 uint32_t aligned_code_begin = AlignCodeOffset(oat_method.GetCodeOffset());
1347 if (aligned_code_begin > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001348 vios->Stream() << StringPrintf("WARNING: "
1349 "code offset 0x%08x is past end of file 0x%08zx.\n",
1350 aligned_code_begin, oat_file_.Size());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001351 success = false;
1352 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001353 vios->Stream() << "\n";
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001354 }
1355 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001356 vios->Stream() << "OatQuickMethodHeader ";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001357 uint32_t method_header_offset = oat_method.GetOatQuickMethodHeaderOffset();
1358 const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader();
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001359 stats_.AddBitsIfUnique(Stats::kByteKindQuickMethodHeader,
1360 sizeof(*method_header) * kBitsPerByte,
1361 method_header);
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001362 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001363 vios->Stream() << StringPrintf("%p ", method_header);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001364 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001365 vios->Stream() << StringPrintf("(offset=0x%08x)\n", method_header_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001366 if (method_header_offset > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001367 vios->Stream() << StringPrintf(
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001368 "WARNING: oat quick method header offset 0x%08x is past end of file 0x%08zx.\n",
1369 method_header_offset, oat_file_.Size());
1370 // If we can't read the OatQuickMethodHeader, the rest of the data is dangerous to read.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001371 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001372 return false;
1373 }
1374
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001375 ScopedIndentation indent2(vios);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001376 vios->Stream() << "vmap_table: ";
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001377 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001378 vios->Stream() << StringPrintf("%p ", oat_method.GetVmapTable());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001379 }
Mingyao Yang063fc772016-08-02 11:02:54 -07001380 uint32_t vmap_table_offset = method_header ==
1381 nullptr ? 0 : method_header->GetVmapTableOffset();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001382 vios->Stream() << StringPrintf("(offset=0x%08x)\n", vmap_table_offset);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001383
1384 size_t vmap_table_offset_limit =
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +00001385 IsMethodGeneratedByDexToDexCompiler(oat_method, code_item_accessor)
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001386 ? oat_file_.GetVdexFile()->Size()
1387 : method_header->GetCode() - oat_file_.Begin();
1388 if (vmap_table_offset >= vmap_table_offset_limit) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001389 vios->Stream() << StringPrintf("WARNING: "
1390 "vmap table offset 0x%08x is past end of file 0x%08zx. "
1391 "vmap table offset was loaded from offset 0x%08x.\n",
Nicolas Geoffray4acefd32016-10-24 13:14:58 +01001392 vmap_table_offset,
1393 vmap_table_offset_limit,
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001394 oat_method.GetVmapTableOffsetOffset());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001395 success = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001396 } else if (options_.dump_vmap_) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001397 DumpVmapData(vios, oat_method, code_item_accessor);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001398 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001399 }
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001400 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001401 vios->Stream() << "QuickMethodFrameInfo\n";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001402
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001403 ScopedIndentation indent2(vios);
1404 vios->Stream()
1405 << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes());
1406 vios->Stream() << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask());
1407 DumpSpillMask(vios->Stream(), oat_method.GetCoreSpillMask(), false);
1408 vios->Stream() << "\n";
1409 vios->Stream() << StringPrintf("fp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask());
1410 DumpSpillMask(vios->Stream(), oat_method.GetFpSpillMask(), true);
1411 vios->Stream() << "\n";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001412 }
1413 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001414 // Based on spill masks from QuickMethodFrameInfo so placed
1415 // after it is dumped, but useful for understanding quick
1416 // code, so dumped here.
1417 ScopedIndentation indent2(vios);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001418 DumpVregLocations(vios->Stream(), oat_method, code_item_accessor);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001419 }
1420 {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001421 vios->Stream() << "CODE: ";
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001422 uint32_t code_size_offset = oat_method.GetQuickCodeSizeOffset();
1423 if (code_size_offset > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001424 ScopedIndentation indent2(vios);
1425 vios->Stream() << StringPrintf("WARNING: "
1426 "code size offset 0x%08x is past end of file 0x%08zx.",
1427 code_size_offset, oat_file_.Size());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001428 success = false;
1429 } else {
1430 const void* code = oat_method.GetQuickCode();
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001431 uint32_t aligned_code_begin = AlignCodeOffset(code_offset);
1432 uint64_t aligned_code_end = aligned_code_begin + code_size;
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001433 stats_.AddBitsIfUnique(Stats::kByteKindCode, code_size * kBitsPerByte, code);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001434
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001435 if (options_.absolute_addresses_) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001436 vios->Stream() << StringPrintf("%p ", code);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001437 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001438 vios->Stream() << StringPrintf("(code_offset=0x%08x size_offset=0x%08x size=%u)%s\n",
1439 code_offset,
1440 code_size_offset,
1441 code_size,
1442 code != nullptr ? "..." : "");
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001443
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001444 ScopedIndentation indent2(vios);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001445 if (aligned_code_begin > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001446 vios->Stream() << StringPrintf("WARNING: "
1447 "start of code at 0x%08x is past end of file 0x%08zx.",
1448 aligned_code_begin, oat_file_.Size());
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001449 success = false;
1450 } else if (aligned_code_end > oat_file_.Size()) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001451 vios->Stream() << StringPrintf(
1452 "WARNING: "
1453 "end of code at 0x%08" PRIx64 " is past end of file 0x%08zx. "
1454 "code size is 0x%08x loaded from offset 0x%08x.\n",
1455 aligned_code_end, oat_file_.Size(),
1456 code_size, code_size_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001457 success = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001458 if (options_.disassemble_code_) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001459 if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001460 DumpCode(vios, oat_method, code_item_accessor, true, kPrologueBytes);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001461 }
1462 }
1463 } else if (code_size > kMaxCodeSize) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001464 vios->Stream() << StringPrintf(
1465 "WARNING: "
1466 "code size %d is bigger than max expected threshold of %d. "
1467 "code size is 0x%08x loaded from offset 0x%08x.\n",
1468 code_size, kMaxCodeSize,
1469 code_size, code_size_offset);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001470 success = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001471 if (options_.disassemble_code_) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001472 if (code_size_offset + kPrologueBytes <= oat_file_.Size()) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001473 DumpCode(vios, oat_method, code_item_accessor, true, kPrologueBytes);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001474 }
1475 }
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001476 } else if (options_.disassemble_code_) {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001477 DumpCode(vios, oat_method, code_item_accessor, !success, 0);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001478 }
1479 }
1480 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001481 vios->Stream() << std::flush;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001482 return success;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001483 }
Elliott Hughese3c845c2012-02-28 17:23:01 -08001484
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001485 void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) {
1486 if (spill_mask == 0) {
1487 return;
1488 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001489 os << "(";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001490 for (size_t i = 0; i < 32; i++) {
1491 if ((spill_mask & (1 << i)) != 0) {
1492 if (is_float) {
1493 os << "fr" << i;
1494 } else {
1495 os << "r" << i;
1496 }
1497 spill_mask ^= 1 << i; // clear bit
1498 if (spill_mask != 0) {
1499 os << ", ";
1500 } else {
1501 break;
1502 }
1503 }
1504 }
1505 os << ")";
1506 }
1507
Roland Levillain442b46a2015-02-18 16:54:21 +00001508 // Display data stored at the the vmap offset of an oat method.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001509 void DumpVmapData(VariableIndentationOutputStream* vios,
Roland Levillain442b46a2015-02-18 16:54:21 +00001510 const OatFile::OatMethod& oat_method,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001511 const CodeItemDataAccessor& code_item_accessor) {
1512 if (IsMethodGeneratedByOptimizingCompiler(oat_method, code_item_accessor)) {
Roland Levillainf2650d12015-05-28 14:53:28 +01001513 // The optimizing compiler outputs its CodeInfo data in the vmap table.
Roland Levillain442b46a2015-02-18 16:54:21 +00001514 const void* raw_code_info = oat_method.GetVmapTable();
1515 if (raw_code_info != nullptr) {
1516 CodeInfo code_info(raw_code_info);
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001517 DCHECK(code_item_accessor.HasCodeItem());
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001518 ScopedIndentation indent1(vios);
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -07001519 MethodInfo method_info = oat_method.GetOatQuickMethodHeader()->GetOptimizedMethodInfo();
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001520 DumpCodeInfo(vios, code_info, oat_method, code_item_accessor, method_info);
Roland Levillain442b46a2015-02-18 16:54:21 +00001521 }
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001522 } else if (IsMethodGeneratedByDexToDexCompiler(oat_method, code_item_accessor)) {
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001523 // We don't encode the size in the table, so just emit that we have quickened
1524 // information.
1525 ScopedIndentation indent(vios);
1526 vios->Stream() << "quickened data\n";
Roland Levillain442b46a2015-02-18 16:54:21 +00001527 } else {
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01001528 // Otherwise, there is nothing to display.
Nicolas Geoffray20d3eae2014-09-17 11:27:23 +01001529 }
Roland Levillain442b46a2015-02-18 16:54:21 +00001530 }
1531
1532 // Display a CodeInfo object emitted by the optimizing compiler.
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001533 void DumpCodeInfo(VariableIndentationOutputStream* vios,
Roland Levillain442b46a2015-02-18 16:54:21 +00001534 const CodeInfo& code_info,
Roland Levillainf2650d12015-05-28 14:53:28 +01001535 const OatFile::OatMethod& oat_method,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001536 const CodeItemDataAccessor& code_item_accessor,
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -07001537 const MethodInfo& method_info) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001538 code_info.Dump(vios,
Roland Levillainf2650d12015-05-28 14:53:28 +01001539 oat_method.GetCodeOffset(),
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001540 code_item_accessor.RegistersSize(),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001541 options_.dump_code_info_stack_maps_,
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -07001542 instruction_set_,
1543 method_info);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001544 }
1545
Andreas Gampe36a296f2017-06-13 14:11:11 -07001546 static int GetOutVROffset(uint16_t out_num, InstructionSet isa) {
1547 // According to stack model, the first out is above the Method referernce.
1548 return static_cast<size_t>(InstructionSetPointerSize(isa)) + out_num * sizeof(uint32_t);
1549 }
1550
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001551 static uint32_t GetVRegOffsetFromQuickCode(const CodeItemDataAccessor& code_item_accessor,
Andreas Gampe36a296f2017-06-13 14:11:11 -07001552 uint32_t core_spills,
1553 uint32_t fp_spills,
1554 size_t frame_size,
1555 int reg,
1556 InstructionSet isa) {
1557 PointerSize pointer_size = InstructionSetPointerSize(isa);
1558 if (kIsDebugBuild) {
1559 auto* runtime = Runtime::Current();
1560 if (runtime != nullptr) {
1561 CHECK_EQ(runtime->GetClassLinker()->GetImagePointerSize(), pointer_size);
1562 }
1563 }
1564 DCHECK_ALIGNED(frame_size, kStackAlignment);
1565 DCHECK_NE(reg, -1);
1566 int spill_size = POPCOUNT(core_spills) * GetBytesPerGprSpillLocation(isa)
1567 + POPCOUNT(fp_spills) * GetBytesPerFprSpillLocation(isa)
1568 + sizeof(uint32_t); // Filler.
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001569 int num_regs = code_item_accessor.RegistersSize() - code_item_accessor.InsSize();
1570 int temp_threshold = code_item_accessor.RegistersSize();
Andreas Gampe36a296f2017-06-13 14:11:11 -07001571 const int max_num_special_temps = 1;
1572 if (reg == temp_threshold) {
1573 // The current method pointer corresponds to special location on stack.
1574 return 0;
1575 } else if (reg >= temp_threshold + max_num_special_temps) {
1576 /*
1577 * Special temporaries may have custom locations and the logic above deals with that.
1578 * However, non-special temporaries are placed relative to the outs.
1579 */
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001580 int temps_start = code_item_accessor.OutsSize() * sizeof(uint32_t)
Andreas Gampe36a296f2017-06-13 14:11:11 -07001581 + static_cast<size_t>(pointer_size) /* art method */;
1582 int relative_offset = (reg - (temp_threshold + max_num_special_temps)) * sizeof(uint32_t);
1583 return temps_start + relative_offset;
1584 } else if (reg < num_regs) {
1585 int locals_start = frame_size - spill_size - num_regs * sizeof(uint32_t);
1586 return locals_start + (reg * sizeof(uint32_t));
1587 } else {
1588 // Handle ins.
1589 return frame_size + ((reg - num_regs) * sizeof(uint32_t))
1590 + static_cast<size_t>(pointer_size) /* art method */;
1591 }
1592 }
1593
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001594 void DumpVregLocations(std::ostream& os, const OatFile::OatMethod& oat_method,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001595 const CodeItemDataAccessor& code_item_accessor) {
1596 if (code_item_accessor.HasCodeItem()) {
1597 size_t num_locals_ins = code_item_accessor.RegistersSize();
1598 size_t num_ins = code_item_accessor.InsSize();
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001599 size_t num_locals = num_locals_ins - num_ins;
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001600 size_t num_outs = code_item_accessor.OutsSize();
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001601
1602 os << "vr_stack_locations:";
1603 for (size_t reg = 0; reg <= num_locals_ins; reg++) {
1604 // For readability, delimit the different kinds of VRs.
1605 if (reg == num_locals_ins) {
1606 os << "\n\tmethod*:";
1607 } else if (reg == num_locals && num_ins > 0) {
1608 os << "\n\tins:";
1609 } else if (reg == 0 && num_locals > 0) {
1610 os << "\n\tlocals:";
1611 }
1612
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001613 uint32_t offset = GetVRegOffsetFromQuickCode(code_item_accessor,
Andreas Gampe36a296f2017-06-13 14:11:11 -07001614 oat_method.GetCoreSpillMask(),
1615 oat_method.GetFpSpillMask(),
1616 oat_method.GetFrameSizeInBytes(),
1617 reg,
1618 GetInstructionSet());
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001619 os << " v" << reg << "[sp + #" << offset << "]";
1620 }
1621
1622 for (size_t out_reg = 0; out_reg < num_outs; out_reg++) {
1623 if (out_reg == 0) {
1624 os << "\n\touts:";
1625 }
1626
Andreas Gampe36a296f2017-06-13 14:11:11 -07001627 uint32_t offset = GetOutVROffset(out_reg, GetInstructionSet());
Razvan A Lupusorufaf9f0d2014-08-29 17:56:46 -07001628 os << " v" << out_reg << "[sp + #" << offset << "]";
1629 }
1630
1631 os << "\n";
1632 }
1633 }
1634
Roland Levillainf2650d12015-05-28 14:53:28 +01001635 // Has `oat_method` -- corresponding to the Dex `code_item` -- been compiled by
1636 // the optimizing compiler?
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001637 static bool IsMethodGeneratedByOptimizingCompiler(
1638 const OatFile::OatMethod& oat_method,
1639 const CodeItemDataAccessor& code_item_accessor) {
Roland Levillainf2650d12015-05-28 14:53:28 +01001640 // If the native GC map is null and the Dex `code_item` is not
1641 // null, then this method has been compiled with the optimizing
1642 // compiler.
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001643 return oat_method.GetQuickCode() != nullptr &&
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01001644 oat_method.GetVmapTable() != nullptr &&
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001645 code_item_accessor.HasCodeItem();
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001646 }
1647
1648 // Has `oat_method` -- corresponding to the Dex `code_item` -- been compiled by
1649 // the dextodex compiler?
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001650 static bool IsMethodGeneratedByDexToDexCompiler(
1651 const OatFile::OatMethod& oat_method,
1652 const CodeItemDataAccessor& code_item_accessor) {
Nicolas Geoffray0a5cd122015-07-16 14:15:05 +01001653 // If the quick code is null, the Dex `code_item` is not
1654 // null, and the vmap table is not null, then this method has been compiled
1655 // with the dextodex compiler.
1656 return oat_method.GetQuickCode() == nullptr &&
1657 oat_method.GetVmapTable() != nullptr &&
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001658 code_item_accessor.HasCodeItem();
Roland Levillainf2650d12015-05-28 14:53:28 +01001659 }
1660
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001661 verifier::MethodVerifier* DumpVerifier(VariableIndentationOutputStream* vios,
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07001662 StackHandleScope<1>* hs,
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001663 uint32_t dex_method_idx,
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001664 const DexFile* dex_file,
1665 const DexFile::ClassDef& class_def,
1666 const DexFile::CodeItem* code_item,
1667 uint32_t method_access_flags) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001668 if ((method_access_flags & kAccNative) == 0) {
1669 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartierd57d4542015-10-14 10:55:30 -07001670 Runtime* const runtime = Runtime::Current();
Mathieu Chartiereb8167a2014-05-07 15:43:14 -07001671 Handle<mirror::DexCache> dex_cache(
Mathieu Chartierf284d442016-06-02 11:48:30 -07001672 hs->NewHandle(runtime->GetClassLinker()->RegisterDexFile(*dex_file, nullptr)));
Andreas Gampefa4333d2017-02-14 11:10:34 -08001673 CHECK(dex_cache != nullptr);
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001674 DCHECK(options_.class_loader_ != nullptr);
Mathieu Chartiere401d142015-04-22 13:56:20 -07001675 return verifier::MethodVerifier::VerifyMethodAndDump(
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001676 soa.Self(), vios, dex_method_idx, dex_file, dex_cache, *options_.class_loader_,
David Brazdil15fc7292016-09-02 14:13:18 +01001677 class_def, code_item, nullptr, method_access_flags);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001678 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -07001679
1680 return nullptr;
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001681 }
1682
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001683 // The StackMapsHelper provides the stack maps in the native PC order.
1684 // For identical native PCs, the order from the CodeInfo is preserved.
1685 class StackMapsHelper {
1686 public:
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001687 explicit StackMapsHelper(const uint8_t* raw_code_info, InstructionSet instruction_set)
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001688 : code_info_(raw_code_info),
1689 encoding_(code_info_.ExtractEncoding()),
1690 number_of_stack_maps_(code_info_.GetNumberOfStackMaps(encoding_)),
1691 indexes_(),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001692 offset_(static_cast<uint32_t>(-1)),
1693 stack_map_index_(0u),
1694 instruction_set_(instruction_set) {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001695 if (number_of_stack_maps_ != 0u) {
1696 // Check if native PCs are ordered.
1697 bool ordered = true;
1698 StackMap last = code_info_.GetStackMapAt(0u, encoding_);
1699 for (size_t i = 1; i != number_of_stack_maps_; ++i) {
1700 StackMap current = code_info_.GetStackMapAt(i, encoding_);
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001701 if (last.GetNativePcOffset(encoding_.stack_map.encoding, instruction_set) >
1702 current.GetNativePcOffset(encoding_.stack_map.encoding, instruction_set)) {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001703 ordered = false;
1704 break;
1705 }
1706 last = current;
1707 }
1708 if (!ordered) {
1709 // Create indirection indexes for access in native PC order. We do not optimize
1710 // for the fact that there can currently be only two separately ordered ranges,
1711 // namely normal stack maps and catch-point stack maps.
1712 indexes_.resize(number_of_stack_maps_);
1713 std::iota(indexes_.begin(), indexes_.end(), 0u);
1714 std::sort(indexes_.begin(),
1715 indexes_.end(),
1716 [this](size_t lhs, size_t rhs) {
1717 StackMap left = code_info_.GetStackMapAt(lhs, encoding_);
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001718 uint32_t left_pc = left.GetNativePcOffset(encoding_.stack_map.encoding,
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001719 instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001720 StackMap right = code_info_.GetStackMapAt(rhs, encoding_);
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001721 uint32_t right_pc = right.GetNativePcOffset(encoding_.stack_map.encoding,
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001722 instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001723 // If the PCs are the same, compare indexes to preserve the original order.
1724 return (left_pc < right_pc) || (left_pc == right_pc && lhs < rhs);
1725 });
1726 }
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001727 offset_ = GetStackMapAt(0).GetNativePcOffset(encoding_.stack_map.encoding,
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001728 instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001729 }
1730 }
1731
1732 const CodeInfo& GetCodeInfo() const {
1733 return code_info_;
1734 }
1735
1736 const CodeInfoEncoding& GetEncoding() const {
1737 return encoding_;
1738 }
1739
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001740 uint32_t GetOffset() const {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001741 return offset_;
1742 }
1743
1744 StackMap GetStackMap() const {
1745 return GetStackMapAt(stack_map_index_);
1746 }
1747
1748 void Next() {
1749 ++stack_map_index_;
1750 offset_ = (stack_map_index_ == number_of_stack_maps_)
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001751 ? static_cast<uint32_t>(-1)
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001752 : GetStackMapAt(stack_map_index_).GetNativePcOffset(encoding_.stack_map.encoding,
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001753 instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001754 }
1755
1756 private:
1757 StackMap GetStackMapAt(size_t i) const {
1758 if (!indexes_.empty()) {
1759 i = indexes_[i];
1760 }
1761 DCHECK_LT(i, number_of_stack_maps_);
1762 return code_info_.GetStackMapAt(i, encoding_);
1763 }
1764
1765 const CodeInfo code_info_;
1766 const CodeInfoEncoding encoding_;
1767 const size_t number_of_stack_maps_;
1768 dchecked_vector<size_t> indexes_; // Used if stack map native PCs are not ordered.
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001769 uint32_t offset_;
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001770 size_t stack_map_index_;
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001771 const InstructionSet instruction_set_;
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001772 };
1773
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001774 void DumpCode(VariableIndentationOutputStream* vios,
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001775 const OatFile::OatMethod& oat_method,
1776 const CodeItemDataAccessor& code_item_accessor,
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001777 bool bad_input, size_t code_size) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001778 const void* quick_code = oat_method.GetQuickCode();
1779
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001780 if (code_size == 0) {
1781 code_size = oat_method.GetQuickCodeSize();
1782 }
Elliott Hughes956af0f2014-12-11 14:34:28 -08001783 if (code_size == 0 || quick_code == nullptr) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001784 vios->Stream() << "NO CODE!\n";
Ian Rogersb23a7722012-10-09 16:54:26 -07001785 return;
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001786 } else if (!bad_input && IsMethodGeneratedByOptimizingCompiler(oat_method,
1787 code_item_accessor)) {
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001788 // The optimizing compiler outputs its CodeInfo data in the vmap table.
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001789 StackMapsHelper helper(oat_method.GetVmapTable(), instruction_set_);
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -07001790 MethodInfo method_info(oat_method.GetOatQuickMethodHeader()->GetOptimizedMethodInfo());
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001791 {
1792 CodeInfoEncoding encoding(helper.GetEncoding());
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001793 StackMapEncoding stack_map_encoding(encoding.stack_map.encoding);
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001794 const size_t num_stack_maps = encoding.stack_map.num_entries;
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001795 if (stats_.AddBitsIfUnique(Stats::kByteKindCodeInfoEncoding,
Mathieu Chartierd776ff02017-01-17 09:32:18 -08001796 encoding.HeaderSize() * kBitsPerByte,
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001797 oat_method.GetVmapTable())) {
Mathieu Chartier1e083792017-02-08 13:30:04 -08001798 // Stack maps
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001799 stats_.AddBits(
1800 Stats::kByteKindStackMapNativePc,
1801 stack_map_encoding.GetNativePcEncoding().BitSize() * num_stack_maps);
1802 stats_.AddBits(
1803 Stats::kByteKindStackMapDexPc,
1804 stack_map_encoding.GetDexPcEncoding().BitSize() * num_stack_maps);
1805 stats_.AddBits(
1806 Stats::kByteKindStackMapDexRegisterMap,
1807 stack_map_encoding.GetDexRegisterMapEncoding().BitSize() * num_stack_maps);
1808 stats_.AddBits(
Mathieu Chartier1e083792017-02-08 13:30:04 -08001809 Stats::kByteKindStackMapInlineInfoIndex,
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001810 stack_map_encoding.GetInlineInfoEncoding().BitSize() * num_stack_maps);
1811 stats_.AddBits(
Mathieu Chartier1a20b682017-01-31 14:25:16 -08001812 Stats::kByteKindStackMapRegisterMaskIndex,
1813 stack_map_encoding.GetRegisterMaskIndexEncoding().BitSize() * num_stack_maps);
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001814 stats_.AddBits(
David Srbecky45aa5982016-03-18 02:15:09 +00001815 Stats::kByteKindStackMapStackMaskIndex,
1816 stack_map_encoding.GetStackMaskIndexEncoding().BitSize() * num_stack_maps);
Mathieu Chartier1e083792017-02-08 13:30:04 -08001817
1818 // Stack masks
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001819 stats_.AddBits(
David Srbecky45aa5982016-03-18 02:15:09 +00001820 Stats::kByteKindCodeInfoStackMasks,
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001821 encoding.stack_mask.encoding.BitSize() * encoding.stack_mask.num_entries);
Mathieu Chartier1e083792017-02-08 13:30:04 -08001822
1823 // Register masks
Mathieu Chartier1a20b682017-01-31 14:25:16 -08001824 stats_.AddBits(
1825 Stats::kByteKindCodeInfoRegisterMasks,
Mathieu Chartier575d3e62017-02-06 11:00:40 -08001826 encoding.register_mask.encoding.BitSize() * encoding.register_mask.num_entries);
Mathieu Chartier1e083792017-02-08 13:30:04 -08001827
Mathieu Chartierd776ff02017-01-17 09:32:18 -08001828 // Invoke infos
1829 if (encoding.invoke_info.num_entries > 0u) {
1830 stats_.AddBits(
1831 Stats::kByteKindCodeInfoInvokeInfo,
1832 encoding.invoke_info.encoding.BitSize() * encoding.invoke_info.num_entries);
1833 }
1834
Mathieu Chartier1e083792017-02-08 13:30:04 -08001835 // Location catalog
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001836 const size_t location_catalog_bytes =
1837 helper.GetCodeInfo().GetDexRegisterLocationCatalogSize(encoding);
1838 stats_.AddBits(Stats::kByteKindCodeInfoLocationCatalog,
1839 kBitsPerByte * location_catalog_bytes);
Mathieu Chartier1e083792017-02-08 13:30:04 -08001840 // Dex register bytes.
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001841 const size_t dex_register_bytes =
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001842 helper.GetCodeInfo().GetDexRegisterMapsSize(encoding,
1843 code_item_accessor.RegistersSize());
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001844 stats_.AddBits(
1845 Stats::kByteKindCodeInfoDexRegisterMap,
1846 kBitsPerByte * dex_register_bytes);
Mathieu Chartier1e083792017-02-08 13:30:04 -08001847
1848 // Inline infos.
1849 const size_t num_inline_infos = encoding.inline_info.num_entries;
1850 if (num_inline_infos > 0u) {
1851 stats_.AddBits(
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -07001852 Stats::kByteKindInlineInfoMethodIndexIdx,
1853 encoding.inline_info.encoding.GetMethodIndexIdxEncoding().BitSize() *
1854 num_inline_infos);
Mathieu Chartier1e083792017-02-08 13:30:04 -08001855 stats_.AddBits(
1856 Stats::kByteKindInlineInfoDexPc,
1857 encoding.inline_info.encoding.GetDexPcEncoding().BitSize() * num_inline_infos);
1858 stats_.AddBits(
1859 Stats::kByteKindInlineInfoExtraData,
1860 encoding.inline_info.encoding.GetExtraDataEncoding().BitSize() * num_inline_infos);
1861 stats_.AddBits(
1862 Stats::kByteKindInlineInfoDexRegisterMap,
1863 encoding.inline_info.encoding.GetDexRegisterMapEncoding().BitSize() *
1864 num_inline_infos);
1865 stats_.AddBits(Stats::kByteKindInlineInfoIsLast, num_inline_infos);
1866 }
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001867 }
1868 }
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001869 const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
1870 size_t offset = 0;
1871 while (offset < code_size) {
1872 offset += disassembler_->Dump(vios->Stream(), quick_native_pc + offset);
1873 if (offset == helper.GetOffset()) {
1874 ScopedIndentation indent1(vios);
1875 StackMap stack_map = helper.GetStackMap();
1876 DCHECK(stack_map.IsValid());
1877 stack_map.Dump(vios,
1878 helper.GetCodeInfo(),
1879 helper.GetEncoding(),
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -07001880 method_info,
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001881 oat_method.GetCodeOffset(),
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08001882 code_item_accessor.RegistersSize(),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -08001883 instruction_set_);
Vladimir Markoadbf93e2016-04-08 11:18:25 +01001884 do {
1885 helper.Next();
1886 // There may be multiple stack maps at a given PC. We display only the first one.
1887 } while (offset == helper.GetOffset());
1888 }
1889 DCHECK_LT(offset, helper.GetOffset());
1890 }
Elliott Hughes956af0f2014-12-11 14:34:28 -08001891 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -08001892 const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code);
1893 size_t offset = 0;
1894 while (offset < code_size) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001895 offset += disassembler_->Dump(vios->Stream(), quick_native_pc + offset);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001896 }
Ian Rogersb23a7722012-10-09 16:54:26 -07001897 }
1898 }
1899
Vladimir Markof3c52b42017-11-17 17:32:12 +00001900 template <typename NameGetter>
1901 void DumpBssEntries(std::ostream& os,
1902 const char* slot_type,
1903 const IndexBssMapping* mapping,
1904 uint32_t number_of_indexes,
1905 size_t slot_size,
1906 NameGetter name) {
1907 os << ".bss mapping for " << slot_type << ": ";
1908 if (mapping == nullptr) {
1909 os << "empty.\n";
1910 return;
1911 }
1912 size_t index_bits = IndexBssMappingEntry::IndexBits(number_of_indexes);
1913 size_t num_valid_indexes = 0u;
1914 for (const IndexBssMappingEntry& entry : *mapping) {
1915 num_valid_indexes += 1u + POPCOUNT(entry.GetMask(index_bits));
1916 }
1917 os << mapping->size() << " entries for " << num_valid_indexes << " valid indexes.\n";
1918 os << std::hex;
1919 for (const IndexBssMappingEntry& entry : *mapping) {
1920 uint32_t index = entry.GetIndex(index_bits);
1921 uint32_t mask = entry.GetMask(index_bits);
1922 size_t bss_offset = entry.bss_offset - POPCOUNT(mask) * slot_size;
1923 for (uint32_t n : LowToHighBits(mask)) {
1924 size_t current_index = index - (32u - index_bits) + n;
1925 os << " 0x" << bss_offset << ": " << slot_type << ": " << name(current_index) << "\n";
1926 bss_offset += slot_size;
1927 }
1928 DCHECK_EQ(bss_offset, entry.bss_offset);
1929 os << " 0x" << bss_offset << ": " << slot_type << ": " << name(index) << "\n";
1930 }
1931 os << std::dec;
1932 }
1933
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001934 const OatFile& oat_file_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001935 const std::vector<const OatFile::OatDexFile*> oat_dex_files_;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08001936 const OatDumperOptions& options_;
1937 uint32_t resolved_addr2instr_;
Andreas Gampe372f3a32016-08-19 10:49:06 -07001938 const InstructionSet instruction_set_;
Ian Rogersef7d42f2014-01-06 12:55:46 -08001939 std::set<uintptr_t> offsets_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001940 Disassembler* disassembler_;
Mathieu Chartier5e7c6a92017-01-17 16:38:30 -08001941 Stats stats_;
Brian Carlstromaded5f72011-10-07 17:15:04 -07001942};
1943
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001944class ImageDumper {
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001945 public:
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08001946 ImageDumper(std::ostream* os,
1947 gc::space::ImageSpace& image_space,
1948 const ImageHeader& image_header,
1949 OatDumperOptions* oat_dumper_options)
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001950 : os_(os),
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001951 vios_(os),
1952 indent1_(&vios_),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07001953 image_space_(image_space),
1954 image_header_(image_header),
1955 oat_dumper_options_(oat_dumper_options) {}
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001956
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07001957 bool Dump() REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001958 std::ostream& os = *os_;
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001959 std::ostream& indent_os = vios_.Stream();
1960
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001961 os << "MAGIC: " << image_header_.GetMagic() << "\n\n";
Brian Carlstrome24fa612011-09-29 00:53:55 -07001962
Jeff Haodcdc85b2015-12-04 14:06:18 -08001963 os << "IMAGE LOCATION: " << image_space_.GetImageLocation() << "\n\n";
1964
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001965 os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -07001966
Mathieu Chartiere401d142015-04-22 13:56:20 -07001967 os << "IMAGE SIZE: " << image_header_.GetImageSize() << "\n\n";
1968
1969 for (size_t i = 0; i < ImageHeader::kSectionCount; ++i) {
1970 auto section = static_cast<ImageHeader::ImageSections>(i);
1971 os << "IMAGE SECTION " << section << ": " << image_header_.GetImageSection(section) << "\n\n";
1972 }
Mathieu Chartier31e89252013-08-28 11:29:12 -07001973
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001974 os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum());
Brian Carlstrom916e74e2011-09-23 11:42:01 -07001975
Brian Carlstrom700c8d32012-11-05 10:42:02 -08001976 os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -07001977
Brian Carlstrom700c8d32012-11-05 10:42:02 -08001978 os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n";
1979
1980 os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n";
1981
1982 os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001983
Alex Lighta59dd802014-07-02 16:28:08 -07001984 os << "PATCH DELTA:" << image_header_.GetPatchDelta() << "\n\n";
1985
Igor Murashkin46774762014-10-22 11:37:02 -07001986 os << "COMPILE PIC: " << (image_header_.CompilePic() ? "yes" : "no") << "\n\n";
1987
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001988 {
1989 os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n";
Mathieu Chartiere401d142015-04-22 13:56:20 -07001990 static_assert(arraysize(image_roots_descriptions_) ==
1991 static_cast<size_t>(ImageHeader::kImageRootsMax), "sizes must match");
Vladimir Markoeca3eda2016-11-09 16:26:44 +00001992 DCHECK_LE(image_header_.GetImageRoots()->GetLength(), ImageHeader::kImageRootsMax);
1993 for (int32_t i = 0, size = image_header_.GetImageRoots()->GetLength(); i != size; ++i) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08001994 ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i);
1995 const char* image_root_description = image_roots_descriptions_[i];
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001996 mirror::Object* image_root_object = image_header_.GetImageRoot(image_root);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01001997 indent_os << StringPrintf("%s: %p\n", image_root_description, image_root_object);
Vladimir Markoeca3eda2016-11-09 16:26:44 +00001998 if (image_root_object != nullptr && image_root_object->IsObjectArray()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08001999 mirror::ObjectArray<mirror::Object>* image_root_object_array
Ian Rogersfa824272013-11-05 16:12:57 -08002000 = image_root_object->AsObjectArray<mirror::Object>();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002001 ScopedIndentation indent2(&vios_);
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002002 for (int j = 0; j < image_root_object_array->GetLength(); j++) {
2003 mirror::Object* value = image_root_object_array->Get(j);
Ian Rogersfa824272013-11-05 16:12:57 -08002004 size_t run = 0;
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002005 for (int32_t k = j + 1; k < image_root_object_array->GetLength(); k++) {
2006 if (value == image_root_object_array->Get(k)) {
Ian Rogersfa824272013-11-05 16:12:57 -08002007 run++;
2008 } else {
2009 break;
2010 }
2011 }
2012 if (run == 0) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002013 indent_os << StringPrintf("%d: ", j);
Ian Rogersfa824272013-11-05 16:12:57 -08002014 } else {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002015 indent_os << StringPrintf("%d to %zd: ", j, j + run);
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002016 j = j + run;
Ian Rogersfa824272013-11-05 16:12:57 -08002017 }
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002018 if (value != nullptr) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002019 PrettyObjectValue(indent_os, value->GetClass(), value);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002020 } else {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002021 indent_os << j << ": null\n";
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002022 }
Ian Rogersd5b32602012-02-26 16:40:04 -08002023 }
Brian Carlstrom34f426c2011-10-04 12:58:02 -07002024 }
2025 }
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002026 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002027
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002028 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002029 os << "METHOD ROOTS\n";
2030 static_assert(arraysize(image_methods_descriptions_) ==
2031 static_cast<size_t>(ImageHeader::kImageMethodsCount), "sizes must match");
2032 for (int i = 0; i < ImageHeader::kImageMethodsCount; i++) {
2033 auto image_root = static_cast<ImageHeader::ImageMethod>(i);
2034 const char* description = image_methods_descriptions_[i];
2035 auto* image_method = image_header_.GetImageMethod(image_root);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002036 indent_os << StringPrintf("%s: %p\n", description, image_method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002037 }
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002038 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002039 os << "\n";
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002040
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -07002041 Runtime* const runtime = Runtime::Current();
2042 ClassLinker* class_linker = runtime->GetClassLinker();
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002043 std::string image_filename = image_space_.GetImageFilename();
2044 std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002045 os << "OAT LOCATION: " << oat_location;
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002046 os << "\n";
Ian Rogers8d31bbd2013-10-13 10:44:14 -07002047 std::string error_msg;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002048 const OatFile* oat_file = image_space_.GetOatFile();
Alex Lighta59dd802014-07-02 16:28:08 -07002049 if (oat_file == nullptr) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002050 oat_file = runtime->GetOatFileManager().FindOpenedOatFileFromOatLocation(oat_location);
2051 }
2052 if (oat_file == nullptr) {
2053 oat_file = OatFile::Open(oat_location,
2054 oat_location,
2055 nullptr,
2056 nullptr,
2057 false,
2058 /*low_4gb*/false,
2059 nullptr,
Igor Murashkinb1d8c312015-08-04 11:18:43 -07002060 &error_msg);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002061 }
2062 if (oat_file == nullptr) {
2063 os << "OAT FILE NOT FOUND: " << error_msg << "\n";
2064 return EXIT_FAILURE;
Brian Carlstromaded5f72011-10-07 17:15:04 -07002065 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002066 os << "\n";
Brian Carlstromaded5f72011-10-07 17:15:04 -07002067
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002068 stats_.oat_file_bytes = oat_file->Size();
2069
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08002070 oat_dumper_.reset(new OatDumper(*oat_file, *oat_dumper_options_));
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002071
Mathieu Chartier02e25112013-08-14 16:14:24 -07002072 for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) {
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002073 CHECK(oat_dex_file != nullptr);
Mathieu Chartier02e25112013-08-14 16:14:24 -07002074 stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(),
2075 oat_dex_file->FileSize()));
Ian Rogers05f28c62012-10-23 18:12:13 -07002076 }
2077
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002078 os << "OBJECTS:\n" << std::flush;
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07002079
Jeff Haodcdc85b2015-12-04 14:06:18 -08002080 // Loop through the image space and dump its objects.
Mathieu Chartierf9c6fc62015-10-07 11:44:05 -07002081 gc::Heap* heap = runtime->GetHeap();
Ian Rogers50b35e22012-10-04 10:09:15 -07002082 Thread* self = Thread::Current();
Mathieu Chartier357e9be2012-08-01 11:00:14 -07002083 {
Mathieu Chartierc22c59e2014-02-24 15:16:06 -08002084 {
2085 WriterMutexLock mu(self, *Locks::heap_bitmap_lock_);
2086 heap->FlushAllocStack();
2087 }
Hiroshi Yamauchi90d70682014-02-20 16:17:30 -08002088 // Since FlushAllocStack() above resets the (active) allocation
2089 // stack. Need to revoke the thread-local allocation stacks that
2090 // point into it.
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07002091 ScopedThreadSuspension sts(self, kNative);
Mathieu Chartier4f55e222015-09-04 13:26:21 -07002092 ScopedSuspendAll ssa(__FUNCTION__);
Mathieu Chartierf1d666e2015-09-03 16:13:34 -07002093 heap->RevokeAllThreadLocalAllocationStacks(self);
Mathieu Chartier357e9be2012-08-01 11:00:14 -07002094 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002095 {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002096 // Mark dex caches.
Vladimir Marko05792b92015-08-03 11:56:49 +01002097 dex_caches_.clear();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002098 {
Andreas Gampecc1b5352016-12-01 16:58:38 -08002099 ReaderMutexLock mu(self, *Locks::dex_lock_);
Hiroshi Yamauchi04302db2015-11-11 23:45:34 -08002100 for (const ClassLinker::DexCacheData& data : class_linker->GetDexCachesData()) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002101 ObjPtr<mirror::DexCache> dex_cache =
2102 ObjPtr<mirror::DexCache>::DownCast(self->DecodeJObject(data.weak_root));
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002103 if (dex_cache != nullptr) {
Mathieu Chartierc4f39252016-10-05 18:32:08 -07002104 dex_caches_.insert(dex_cache.Ptr());
Mathieu Chartier673ed3d2015-08-28 14:56:43 -07002105 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002106 }
2107 }
Andreas Gampe0c183382017-07-13 22:26:24 -07002108 auto dump_visitor = [&](mirror::Object* obj) REQUIRES_SHARED(Locks::mutator_lock_) {
2109 DumpObject(obj);
2110 };
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002111 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002112 // Dump the normal objects before ArtMethods.
Andreas Gampe0c183382017-07-13 22:26:24 -07002113 image_space_.GetLiveBitmap()->Walk(dump_visitor);
Jeff Haodcdc85b2015-12-04 14:06:18 -08002114 indent_os << "\n";
2115 // TODO: Dump fields.
2116 // Dump methods after.
Jeff Haodcdc85b2015-12-04 14:06:18 -08002117 DumpArtMethodVisitor visitor(this);
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002118 image_header_.VisitPackedArtMethods(&visitor,
2119 image_space_.Begin(),
2120 image_header_.GetPointerSize());
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002121 // Dump the large objects separately.
Andreas Gampe0c183382017-07-13 22:26:24 -07002122 heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(dump_visitor);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002123 indent_os << "\n";
Mathieu Chartierb062fdd2012-07-03 09:51:48 -07002124 }
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002125 os << "STATS:\n" << std::flush;
Ian Rogers700a4022014-05-19 16:49:03 -07002126 std::unique_ptr<File> file(OS::OpenFileForReading(image_filename.c_str()));
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002127 size_t data_size = image_header_.GetDataSize(); // stored size in file.
2128 if (file == nullptr) {
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002129 LOG(WARNING) << "Failed to find image in " << image_filename;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002130 } else {
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002131 stats_.file_bytes = file->GetLength();
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002132 // If the image is compressed, adjust to decompressed size.
2133 size_t uncompressed_size = image_header_.GetImageSize() - sizeof(ImageHeader);
2134 if (image_header_.GetStorageMode() == ImageHeader::kStorageModeUncompressed) {
2135 DCHECK_EQ(uncompressed_size, data_size) << "Sizes should match for uncompressed image";
2136 }
2137 stats_.file_bytes += uncompressed_size - data_size;
Brian Carlstrom6f277752013-09-30 17:56:45 -07002138 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002139 size_t header_bytes = sizeof(ImageHeader);
Vladimir Markocd87c3e2017-09-05 13:11:57 +01002140 const auto& object_section = image_header_.GetObjectsSection();
2141 const auto& field_section = image_header_.GetFieldsSection();
Mathieu Chartiere401d142015-04-22 13:56:20 -07002142 const auto& method_section = image_header_.GetMethodsSection();
Vladimir Markocd87c3e2017-09-05 13:11:57 +01002143 const auto& dex_cache_arrays_section = image_header_.GetDexCacheArraysSection();
2144 const auto& intern_section = image_header_.GetInternedStringsSection();
2145 const auto& class_table_section = image_header_.GetClassTableSection();
2146 const auto& bitmap_section = image_header_.GetImageBitmapSection();
Andreas Gampeace0dc12016-01-20 13:33:13 -08002147
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002148 stats_.header_bytes = header_bytes;
Andreas Gampeace0dc12016-01-20 13:33:13 -08002149
2150 // Objects are kObjectAlignment-aligned.
2151 // CHECK_EQ(RoundUp(header_bytes, kObjectAlignment), object_section.Offset());
2152 if (object_section.Offset() > header_bytes) {
2153 stats_.alignment_bytes += object_section.Offset() - header_bytes;
2154 }
2155
2156 // Field section is 4-byte aligned.
2157 constexpr size_t kFieldSectionAlignment = 4U;
2158 uint32_t end_objects = object_section.Offset() + object_section.Size();
2159 CHECK_EQ(RoundUp(end_objects, kFieldSectionAlignment), field_section.Offset());
2160 stats_.alignment_bytes += field_section.Offset() - end_objects;
2161
2162 // Method section is 4/8 byte aligned depending on target. Just check for 4-byte alignment.
2163 uint32_t end_fields = field_section.Offset() + field_section.Size();
2164 CHECK_ALIGNED(method_section.Offset(), 4);
2165 stats_.alignment_bytes += method_section.Offset() - end_fields;
2166
2167 // Dex cache arrays section is aligned depending on the target. Just check for 4-byte alignment.
2168 uint32_t end_methods = method_section.Offset() + method_section.Size();
2169 CHECK_ALIGNED(dex_cache_arrays_section.Offset(), 4);
2170 stats_.alignment_bytes += dex_cache_arrays_section.Offset() - end_methods;
2171
2172 // Intern table is 8-byte aligned.
2173 uint32_t end_caches = dex_cache_arrays_section.Offset() + dex_cache_arrays_section.Size();
Vladimir Marko6cfbdbc2017-07-25 13:26:39 +01002174 CHECK_ALIGNED(intern_section.Offset(), sizeof(uint64_t));
Andreas Gampeace0dc12016-01-20 13:33:13 -08002175 stats_.alignment_bytes += intern_section.Offset() - end_caches;
2176
2177 // Add space between intern table and class table.
2178 uint32_t end_intern = intern_section.Offset() + intern_section.Size();
2179 stats_.alignment_bytes += class_table_section.Offset() - end_intern;
2180
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002181 // Add space between end of image data and bitmap. Expect the bitmap to be page-aligned.
2182 const size_t bitmap_offset = sizeof(ImageHeader) + data_size;
Andreas Gampeace0dc12016-01-20 13:33:13 -08002183 CHECK_ALIGNED(bitmap_section.Offset(), kPageSize);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002184 stats_.alignment_bytes += RoundUp(bitmap_offset, kPageSize) - bitmap_offset;
Andreas Gampeace0dc12016-01-20 13:33:13 -08002185
Mathieu Chartiere401d142015-04-22 13:56:20 -07002186 stats_.bitmap_bytes += bitmap_section.Size();
2187 stats_.art_field_bytes += field_section.Size();
Vladimir Markocf36d492015-08-12 19:27:26 +01002188 stats_.art_method_bytes += method_section.Size();
Vladimir Marko05792b92015-08-03 11:56:49 +01002189 stats_.dex_cache_arrays_bytes += dex_cache_arrays_section.Size();
Mathieu Chartierd39645e2015-06-09 17:50:29 -07002190 stats_.interned_strings_bytes += intern_section.Size();
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002191 stats_.class_table_bytes += class_table_section.Size();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002192 stats_.Dump(os, indent_os);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002193 os << "\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002194
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002195 os << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002196
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07002197 return oat_dumper_->Dump(os);
Brian Carlstrom78128a62011-09-15 17:21:19 -07002198 }
2199
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002200 private:
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002201 class DumpArtMethodVisitor : public ArtMethodVisitor {
2202 public:
2203 explicit DumpArtMethodVisitor(ImageDumper* image_dumper) : image_dumper_(image_dumper) {}
2204
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002205 virtual void Visit(ArtMethod* method) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002206 std::ostream& indent_os = image_dumper_->vios_.Stream();
David Sehr709b0702016-10-13 09:12:37 -07002207 indent_os << method << " " << " ArtMethod: " << ArtMethod::PrettyMethod(method) << "\n";
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002208 image_dumper_->DumpMethod(method, indent_os);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002209 indent_os << "\n";
2210 }
2211
2212 private:
2213 ImageDumper* const image_dumper_;
2214 };
2215
Mathieu Chartier3398c782016-09-30 10:27:43 -07002216 static void PrettyObjectValue(std::ostream& os,
2217 ObjPtr<mirror::Class> type,
2218 ObjPtr<mirror::Object> value)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002219 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002220 CHECK(type != nullptr);
2221 if (value == nullptr) {
David Sehr709b0702016-10-13 09:12:37 -07002222 os << StringPrintf("null %s\n", type->PrettyDescriptor().c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002223 } else if (type->IsStringClass()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002224 mirror::String* string = value->AsString();
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002225 os << StringPrintf("%p String: %s\n", string,
Ian Rogers68b56852014-08-29 20:19:11 -07002226 PrintableString(string->ToModifiedUtf8().c_str()).c_str());
Ian Rogers64b6d142012-10-29 16:34:15 -07002227 } else if (type->IsClassClass()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002228 mirror::Class* klass = value->AsClass();
David Sehr709b0702016-10-13 09:12:37 -07002229 os << StringPrintf("%p Class: %s\n", klass, mirror::Class::PrettyDescriptor(klass).c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002230 } else {
David Sehr709b0702016-10-13 09:12:37 -07002231 os << StringPrintf("%p %s\n", value.Ptr(), type->PrettyDescriptor().c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002232 }
2233 }
2234
Mathieu Chartier3398c782016-09-30 10:27:43 -07002235 static void PrintField(std::ostream& os, ArtField* field, ObjPtr<mirror::Object> obj)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002236 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier61c5ebc2014-06-05 17:42:53 -07002237 os << StringPrintf("%s: ", field->GetName());
Ian Rogers08f1f502014-12-02 15:04:37 -08002238 switch (field->GetTypeAsPrimitiveType()) {
2239 case Primitive::kPrimLong:
Ian Rogersef7d42f2014-01-06 12:55:46 -08002240 os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002241 break;
2242 case Primitive::kPrimDouble:
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002243 os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002244 break;
2245 case Primitive::kPrimFloat:
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002246 os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002247 break;
2248 case Primitive::kPrimInt:
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002249 os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002250 break;
2251 case Primitive::kPrimChar:
Fred Shih37f05ef2014-07-16 18:38:08 -07002252 os << StringPrintf("%u (0x%x)\n", field->GetChar(obj), field->GetChar(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002253 break;
2254 case Primitive::kPrimShort:
Fred Shih37f05ef2014-07-16 18:38:08 -07002255 os << StringPrintf("%d (0x%x)\n", field->GetShort(obj), field->GetShort(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002256 break;
2257 case Primitive::kPrimBoolean:
Roland Levillain5e8d5f02016-10-18 18:03:43 +01002258 os << StringPrintf("%s (0x%x)\n", field->GetBoolean(obj) ? "true" : "false",
Fred Shih37f05ef2014-07-16 18:38:08 -07002259 field->GetBoolean(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002260 break;
2261 case Primitive::kPrimByte:
Fred Shih37f05ef2014-07-16 18:38:08 -07002262 os << StringPrintf("%d (0x%x)\n", field->GetByte(obj), field->GetByte(obj));
Ian Rogers08f1f502014-12-02 15:04:37 -08002263 break;
2264 case Primitive::kPrimNot: {
2265 // Get the value, don't compute the type unless it is non-null as we don't want
2266 // to cause class loading.
Mathieu Chartier3398c782016-09-30 10:27:43 -07002267 ObjPtr<mirror::Object> value = field->GetObj(obj);
Ian Rogers08f1f502014-12-02 15:04:37 -08002268 if (value == nullptr) {
2269 os << StringPrintf("null %s\n", PrettyDescriptor(field->GetTypeDescriptor()).c_str());
Ian Rogers50239c72013-06-17 14:53:22 -07002270 } else {
Ian Rogers08f1f502014-12-02 15:04:37 -08002271 // Grab the field type without causing resolution.
Vladimir Marko4098a7a2017-11-06 16:00:51 +00002272 ObjPtr<mirror::Class> field_type = field->LookupType();
Ian Rogers08f1f502014-12-02 15:04:37 -08002273 if (field_type != nullptr) {
2274 PrettyObjectValue(os, field_type, value);
2275 } else {
Mathieu Chartier3398c782016-09-30 10:27:43 -07002276 os << StringPrintf("%p %s\n",
Mathieu Chartier1cc62e42016-10-03 18:01:28 -07002277 value.Ptr(),
Ian Rogers08f1f502014-12-02 15:04:37 -08002278 PrettyDescriptor(field->GetTypeDescriptor()).c_str());
2279 }
Ian Rogers50239c72013-06-17 14:53:22 -07002280 }
Ian Rogers08f1f502014-12-02 15:04:37 -08002281 break;
Ian Rogers48efc2b2012-08-27 17:20:31 -07002282 }
Ian Rogers08f1f502014-12-02 15:04:37 -08002283 default:
2284 os << "unexpected field type: " << field->GetTypeDescriptor() << "\n";
2285 break;
Ian Rogersd5b32602012-02-26 16:40:04 -08002286 }
2287 }
2288
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002289 static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002290 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002291 mirror::Class* super = klass->GetSuperClass();
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002292 if (super != nullptr) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002293 DumpFields(os, obj, super);
Ian Rogersd5b32602012-02-26 16:40:04 -08002294 }
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002295 for (ArtField& field : klass->GetIFields()) {
2296 PrintField(os, &field, obj);
Ian Rogersd5b32602012-02-26 16:40:04 -08002297 }
2298 }
2299
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002300 bool InDumpSpace(const mirror::Object* object) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002301 return image_space_.Contains(object);
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002302 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002303
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002304 const void* GetQuickOatCodeBegin(ArtMethod* m) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiera7dd0382014-11-20 17:08:58 -08002305 const void* quick_code = m->GetEntryPointFromQuickCompiledCodePtrSize(
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002306 image_header_.GetPointerSize());
Ian Rogers6f3dbba2014-10-14 17:41:57 -07002307 if (Runtime::Current()->GetClassLinker()->IsQuickResolutionStub(quick_code)) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002308 quick_code = oat_dumper_->GetQuickOatCode(m);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002309 }
Vladimir Marko33bff252017-11-01 14:35:42 +00002310 if (oat_dumper_->GetInstructionSet() == InstructionSet::kThumb2) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002311 quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1);
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002312 }
Ian Rogersef7d42f2014-01-06 12:55:46 -08002313 return quick_code;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002314 }
2315
Mathieu Chartiere401d142015-04-22 13:56:20 -07002316 uint32_t GetQuickOatCodeSize(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002317 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002318 const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m));
2319 if (oat_code_begin == nullptr) {
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002320 return 0;
2321 }
2322 return oat_code_begin[-1];
2323 }
2324
Mathieu Chartiere401d142015-04-22 13:56:20 -07002325 const void* GetQuickOatCodeEnd(ArtMethod* m)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002326 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogersef7d42f2014-01-06 12:55:46 -08002327 const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m));
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002328 if (oat_code_begin == nullptr) {
2329 return nullptr;
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002330 }
Ian Rogersef7d42f2014-01-06 12:55:46 -08002331 return oat_code_begin + GetQuickOatCodeSize(m);
Brian Carlstromf8bbb842012-03-14 03:01:42 -07002332 }
2333
Andreas Gampe0c183382017-07-13 22:26:24 -07002334 void DumpObject(mirror::Object* obj) REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002335 DCHECK(obj != nullptr);
Andreas Gampe0c183382017-07-13 22:26:24 -07002336 if (!InDumpSpace(obj)) {
Brian Carlstrom78128a62011-09-15 17:21:19 -07002337 return;
2338 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002339
2340 size_t object_bytes = obj->SizeOf();
2341 size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes;
Andreas Gampe0c183382017-07-13 22:26:24 -07002342 stats_.object_bytes += object_bytes;
2343 stats_.alignment_bytes += alignment_bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002344
Andreas Gampe0c183382017-07-13 22:26:24 -07002345 std::ostream& os = vios_.Stream();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002346
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002347 mirror::Class* obj_class = obj->GetClass();
Ian Rogersd5b32602012-02-26 16:40:04 -08002348 if (obj_class->IsArrayClass()) {
David Sehr709b0702016-10-13 09:12:37 -07002349 os << StringPrintf("%p: %s length:%d\n", obj, obj_class->PrettyDescriptor().c_str(),
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002350 obj->AsArray()->GetLength());
Ian Rogersd5b32602012-02-26 16:40:04 -08002351 } else if (obj->IsClass()) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002352 mirror::Class* klass = obj->AsClass();
David Sehr709b0702016-10-13 09:12:37 -07002353 os << StringPrintf("%p: java.lang.Class \"%s\" (", obj,
2354 mirror::Class::PrettyDescriptor(klass).c_str())
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002355 << klass->GetStatus() << ")\n";
Ian Rogersd5b32602012-02-26 16:40:04 -08002356 } else if (obj_class->IsStringClass()) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002357 os << StringPrintf("%p: java.lang.String %s\n", obj,
Ian Rogers68b56852014-08-29 20:19:11 -07002358 PrintableString(obj->AsString()->ToModifiedUtf8().c_str()).c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002359 } else {
David Sehr709b0702016-10-13 09:12:37 -07002360 os << StringPrintf("%p: %s\n", obj, obj_class->PrettyDescriptor().c_str());
Ian Rogersd5b32602012-02-26 16:40:04 -08002361 }
Andreas Gampe0c183382017-07-13 22:26:24 -07002362 ScopedIndentation indent1(&vios_);
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002363 DumpFields(os, obj, obj_class);
Andreas Gampe0c183382017-07-13 22:26:24 -07002364 const PointerSize image_pointer_size = image_header_.GetPointerSize();
Ian Rogersd5b32602012-02-26 16:40:04 -08002365 if (obj->IsObjectArray()) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002366 auto* obj_array = obj->AsObjectArray<mirror::Object>();
2367 for (int32_t i = 0, length = obj_array->GetLength(); i < length; i++) {
Ian Rogers2dd0e2c2013-01-24 12:42:14 -08002368 mirror::Object* value = obj_array->Get(i);
Ian Rogersd5b32602012-02-26 16:40:04 -08002369 size_t run = 0;
2370 for (int32_t j = i + 1; j < length; j++) {
2371 if (value == obj_array->Get(j)) {
2372 run++;
2373 } else {
2374 break;
2375 }
2376 }
2377 if (run == 0) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002378 os << StringPrintf("%d: ", i);
Ian Rogersd5b32602012-02-26 16:40:04 -08002379 } else {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002380 os << StringPrintf("%d to %zd: ", i, i + run);
Ian Rogersd5b32602012-02-26 16:40:04 -08002381 i = i + run;
2382 }
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002383 mirror::Class* value_class =
Andreas Gampe2ed8def2014-08-28 14:41:02 -07002384 (value == nullptr) ? obj_class->GetComponentType() : value->GetClass();
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002385 PrettyObjectValue(os, value_class, value);
Ian Rogersd5b32602012-02-26 16:40:04 -08002386 }
2387 } else if (obj->IsClass()) {
Mathieu Chartierc7853442015-03-27 14:35:38 -07002388 mirror::Class* klass = obj->AsClass();
Igor Murashkin86083f72017-10-27 10:59:04 -07002389
2390 os << "SUBTYPE_CHECK_BITS: ";
2391 SubtypeCheck<mirror::Class*>::Dump(klass, os);
2392 os << "\n";
2393
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002394 if (klass->NumStaticFields() != 0) {
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002395 os << "STATICS:\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002396 ScopedIndentation indent2(&vios_);
Mathieu Chartier54d220e2015-07-30 16:20:06 -07002397 for (ArtField& field : klass->GetSFields()) {
2398 PrintField(os, &field, field.GetDeclaringClass());
Ian Rogersd5b32602012-02-26 16:40:04 -08002399 }
2400 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002401 } else {
Andreas Gampe0c183382017-07-13 22:26:24 -07002402 auto it = dex_caches_.find(obj);
2403 if (it != dex_caches_.end()) {
Vladimir Marko05792b92015-08-03 11:56:49 +01002404 auto* dex_cache = down_cast<mirror::DexCache*>(obj);
Vladimir Markocd87c3e2017-09-05 13:11:57 +01002405 const auto& field_section = image_header_.GetFieldsSection();
Andreas Gampe0c183382017-07-13 22:26:24 -07002406 const auto& method_section = image_header_.GetMethodsSection();
Vladimir Marko05792b92015-08-03 11:56:49 +01002407 size_t num_methods = dex_cache->NumResolvedMethods();
2408 if (num_methods != 0u) {
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002409 os << "Methods (size=" << num_methods << "):\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002410 ScopedIndentation indent2(&vios_);
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002411 mirror::MethodDexCacheType* resolved_methods = dex_cache->GetResolvedMethods();
Vladimir Marko05792b92015-08-03 11:56:49 +01002412 for (size_t i = 0, length = dex_cache->NumResolvedMethods(); i < length; ++i) {
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002413 ArtMethod* elem = mirror::DexCache::GetNativePairPtrSize(
2414 resolved_methods, i, image_pointer_size).object;
Vladimir Marko05792b92015-08-03 11:56:49 +01002415 size_t run = 0;
2416 for (size_t j = i + 1;
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002417 j != length &&
2418 elem == mirror::DexCache::GetNativePairPtrSize(
2419 resolved_methods, j, image_pointer_size).object;
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002420 ++j) {
2421 ++run;
2422 }
Vladimir Marko05792b92015-08-03 11:56:49 +01002423 if (run == 0) {
2424 os << StringPrintf("%zd: ", i);
2425 } else {
2426 os << StringPrintf("%zd to %zd: ", i, i + run);
2427 i = i + run;
2428 }
2429 std::string msg;
2430 if (elem == nullptr) {
2431 msg = "null";
2432 } else if (method_section.Contains(
Andreas Gampe0c183382017-07-13 22:26:24 -07002433 reinterpret_cast<uint8_t*>(elem) - image_space_.Begin())) {
David Sehr709b0702016-10-13 09:12:37 -07002434 msg = reinterpret_cast<ArtMethod*>(elem)->PrettyMethod();
Vladimir Marko05792b92015-08-03 11:56:49 +01002435 } else {
2436 msg = "<not in method section>";
2437 }
2438 os << StringPrintf("%p %s\n", elem, msg.c_str());
Ian Rogers0d2d3782012-04-10 11:09:18 -07002439 }
Vladimir Marko05792b92015-08-03 11:56:49 +01002440 }
2441 size_t num_fields = dex_cache->NumResolvedFields();
2442 if (num_fields != 0u) {
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002443 os << "Fields (size=" << num_fields << "):\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002444 ScopedIndentation indent2(&vios_);
Vladimir Marko05792b92015-08-03 11:56:49 +01002445 auto* resolved_fields = dex_cache->GetResolvedFields();
2446 for (size_t i = 0, length = dex_cache->NumResolvedFields(); i < length; ++i) {
Vladimir Marko07bfbac2017-07-06 14:55:02 +01002447 ArtField* elem = mirror::DexCache::GetNativePairPtrSize(
Vladimir Markof44d36c2017-03-14 14:18:46 +00002448 resolved_fields, i, image_pointer_size).object;
Vladimir Marko05792b92015-08-03 11:56:49 +01002449 size_t run = 0;
2450 for (size_t j = i + 1;
Vladimir Markof44d36c2017-03-14 14:18:46 +00002451 j != length &&
2452 elem == mirror::DexCache::GetNativePairPtrSize(
2453 resolved_fields, j, image_pointer_size).object;
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002454 ++j) {
2455 ++run;
2456 }
Vladimir Marko05792b92015-08-03 11:56:49 +01002457 if (run == 0) {
2458 os << StringPrintf("%zd: ", i);
2459 } else {
2460 os << StringPrintf("%zd to %zd: ", i, i + run);
2461 i = i + run;
2462 }
2463 std::string msg;
2464 if (elem == nullptr) {
2465 msg = "null";
2466 } else if (field_section.Contains(
Andreas Gampe0c183382017-07-13 22:26:24 -07002467 reinterpret_cast<uint8_t*>(elem) - image_space_.Begin())) {
David Sehr709b0702016-10-13 09:12:37 -07002468 msg = reinterpret_cast<ArtField*>(elem)->PrettyField();
Vladimir Marko05792b92015-08-03 11:56:49 +01002469 } else {
2470 msg = "<not in field section>";
2471 }
2472 os << StringPrintf("%p %s\n", elem, msg.c_str());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002473 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002474 }
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002475 size_t num_types = dex_cache->NumResolvedTypes();
2476 if (num_types != 0u) {
2477 os << "Types (size=" << num_types << "):\n";
Andreas Gampe0c183382017-07-13 22:26:24 -07002478 ScopedIndentation indent2(&vios_);
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002479 auto* resolved_types = dex_cache->GetResolvedTypes();
2480 for (size_t i = 0; i < num_types; ++i) {
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002481 auto pair = resolved_types[i].load(std::memory_order_relaxed);
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002482 size_t run = 0;
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002483 for (size_t j = i + 1; j != num_types; ++j) {
2484 auto other_pair = resolved_types[j].load(std::memory_order_relaxed);
2485 if (pair.index != other_pair.index ||
2486 pair.object.Read() != other_pair.object.Read()) {
2487 break;
2488 }
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002489 ++run;
2490 }
2491 if (run == 0) {
2492 os << StringPrintf("%zd: ", i);
2493 } else {
2494 os << StringPrintf("%zd to %zd: ", i, i + run);
2495 i = i + run;
2496 }
2497 std::string msg;
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002498 auto* elem = pair.object.Read();
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002499 if (elem == nullptr) {
2500 msg = "null";
2501 } else {
David Sehr709b0702016-10-13 09:12:37 -07002502 msg = elem->PrettyClass();
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002503 }
Vladimir Marko8d6768d2017-03-14 10:13:21 +00002504 os << StringPrintf("%p %u %s\n", elem, pair.index, msg.c_str());
Nicolas Geoffrayc6df1e32016-07-04 10:15:47 +01002505 }
2506 }
Brian Carlstrom78128a62011-09-15 17:21:19 -07002507 }
2508 }
Ian Rogers1ff3c982014-08-12 02:30:58 -07002509 std::string temp;
Andreas Gampe0c183382017-07-13 22:26:24 -07002510 stats_.Update(obj_class->GetDescriptor(&temp), object_bytes);
Brian Carlstrom78128a62011-09-15 17:21:19 -07002511 }
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002512
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002513 void DumpMethod(ArtMethod* method, std::ostream& indent_os)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002514 REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002515 DCHECK(method != nullptr);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002516 const void* quick_oat_code_begin = GetQuickOatCodeBegin(method);
2517 const void* quick_oat_code_end = GetQuickOatCodeEnd(method);
Andreas Gampe542451c2016-07-26 09:02:02 -07002518 const PointerSize pointer_size = image_header_.GetPointerSize();
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002519 OatQuickMethodHeader* method_header = reinterpret_cast<OatQuickMethodHeader*>(
2520 reinterpret_cast<uintptr_t>(quick_oat_code_begin) - sizeof(OatQuickMethodHeader));
Mathieu Chartiere401d142015-04-22 13:56:20 -07002521 if (method->IsNative()) {
Mathieu Chartiere401d142015-04-22 13:56:20 -07002522 bool first_occurrence;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002523 uint32_t quick_oat_code_size = GetQuickOatCodeSize(method);
2524 ComputeOatSize(quick_oat_code_begin, &first_occurrence);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002525 if (first_occurrence) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002526 stats_.native_to_managed_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002527 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002528 if (quick_oat_code_begin != method->GetEntryPointFromQuickCompiledCodePtrSize(
2529 image_header_.GetPointerSize())) {
Nicolas Geoffray6bc43742015-10-12 18:11:10 +01002530 indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code_begin);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002531 }
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002532 } else if (method->IsAbstract() || method->IsClassInitializer()) {
Nicolas Geoffray796d6302016-03-13 22:22:31 +00002533 // Don't print information for these.
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002534 } else if (method->IsRuntimeMethod()) {
2535 ImtConflictTable* table = method->GetImtConflictTable(image_header_.GetPointerSize());
2536 if (table != nullptr) {
2537 indent_os << "IMT conflict table " << table << " method: ";
2538 for (size_t i = 0, count = table->NumEntries(pointer_size); i < count; ++i) {
David Sehr709b0702016-10-13 09:12:37 -07002539 indent_os << ArtMethod::PrettyMethod(table->GetImplementationMethod(i, pointer_size))
2540 << " ";
Mathieu Chartiere42888f2016-04-14 10:49:19 -07002541 }
2542 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002543 } else {
Mathieu Chartierd5c0a0a2017-11-10 14:16:34 -08002544 CodeItemDataAccessor code_item_accessor(method);
2545 size_t dex_instruction_bytes = code_item_accessor.InsnsSizeInCodeUnits() * 2;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002546 stats_.dex_instruction_bytes += dex_instruction_bytes;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002547
2548 bool first_occurrence;
Roland Levillain6d7f1792015-07-02 10:59:15 +01002549 size_t vmap_table_bytes = 0u;
Nicolas Geoffray524e7ea2015-10-16 17:13:34 +01002550 if (!method_header->IsOptimized()) {
Roland Levillain6d7f1792015-07-02 10:59:15 +01002551 // Method compiled with the optimizing compiler have no vmap table.
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002552 vmap_table_bytes = ComputeOatSize(method_header->GetVmapTable(), &first_occurrence);
Roland Levillain6d7f1792015-07-02 10:59:15 +01002553 if (first_occurrence) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002554 stats_.vmap_table_bytes += vmap_table_bytes;
Roland Levillain6d7f1792015-07-02 10:59:15 +01002555 }
Mathieu Chartiere401d142015-04-22 13:56:20 -07002556 }
2557
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002558 uint32_t quick_oat_code_size = GetQuickOatCodeSize(method);
2559 ComputeOatSize(quick_oat_code_begin, &first_occurrence);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002560 if (first_occurrence) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002561 stats_.managed_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002562 if (method->IsConstructor()) {
2563 if (method->IsStatic()) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002564 stats_.class_initializer_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002565 } else if (dex_instruction_bytes > kLargeConstructorDexBytes) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002566 stats_.large_initializer_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002567 }
2568 } else if (dex_instruction_bytes > kLargeMethodDexBytes) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002569 stats_.large_method_code_bytes += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002570 }
2571 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002572 stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002573
Igor Murashkin7617abd2015-07-10 18:27:47 -07002574 uint32_t method_access_flags = method->GetAccessFlags();
2575
Mathieu Chartiere401d142015-04-22 13:56:20 -07002576 indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end);
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002577 indent_os << StringPrintf("SIZE: Dex Instructions=%zd StackMaps=%zd AccessFlags=0x%x\n",
2578 dex_instruction_bytes,
2579 vmap_table_bytes,
Igor Murashkin7617abd2015-07-10 18:27:47 -07002580 method_access_flags);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002581
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002582 size_t total_size = dex_instruction_bytes +
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002583 vmap_table_bytes + quick_oat_code_size + ArtMethod::Size(image_header_.GetPointerSize());
Mathieu Chartiere401d142015-04-22 13:56:20 -07002584
2585 double expansion =
2586 static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes);
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002587 stats_.ComputeOutliers(total_size, expansion, method);
Mathieu Chartiere401d142015-04-22 13:56:20 -07002588 }
2589 }
2590
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002591 std::set<const void*> already_seen_;
2592 // Compute the size of the given data within the oat file and whether this is the first time
2593 // this data has been requested
Elliott Hughesa0e18062012-04-13 15:59:59 -07002594 size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002595 if (already_seen_.count(oat_data) == 0) {
Elliott Hughesa0e18062012-04-13 15:59:59 -07002596 *first_occurrence = true;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002597 already_seen_.insert(oat_data);
2598 } else {
Elliott Hughesa0e18062012-04-13 15:59:59 -07002599 *first_occurrence = false;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002600 }
2601 return oat_dumper_->ComputeSize(oat_data);
Brian Carlstrom27ec9612011-09-19 20:20:38 -07002602 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002603
2604 public:
2605 struct Stats {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002606 size_t oat_file_bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002607 size_t file_bytes;
2608
2609 size_t header_bytes;
2610 size_t object_bytes;
Mathieu Chartiere401d142015-04-22 13:56:20 -07002611 size_t art_field_bytes;
2612 size_t art_method_bytes;
Vladimir Marko05792b92015-08-03 11:56:49 +01002613 size_t dex_cache_arrays_bytes;
Mathieu Chartierd39645e2015-06-09 17:50:29 -07002614 size_t interned_strings_bytes;
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002615 size_t class_table_bytes;
Mathieu Chartier32327092013-08-30 14:04:08 -07002616 size_t bitmap_bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002617 size_t alignment_bytes;
2618
2619 size_t managed_code_bytes;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002620 size_t managed_code_bytes_ignoring_deduplication;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002621 size_t native_to_managed_code_bytes;
Ian Rogers0d2d3782012-04-10 11:09:18 -07002622 size_t class_initializer_code_bytes;
2623 size_t large_initializer_code_bytes;
2624 size_t large_method_code_bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002625
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002626 size_t vmap_table_bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002627
2628 size_t dex_instruction_bytes;
2629
Mathieu Chartiere401d142015-04-22 13:56:20 -07002630 std::vector<ArtMethod*> method_outlier;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002631 std::vector<size_t> method_outlier_size;
2632 std::vector<double> method_outlier_expansion;
Ian Rogers700a4022014-05-19 16:49:03 -07002633 std::vector<std::pair<std::string, size_t>> oat_dex_file_sizes;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002634
Roland Levillain3887c462015-08-12 18:15:42 +01002635 Stats()
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002636 : oat_file_bytes(0),
2637 file_bytes(0),
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002638 header_bytes(0),
2639 object_bytes(0),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002640 art_field_bytes(0),
2641 art_method_bytes(0),
Vladimir Marko05792b92015-08-03 11:56:49 +01002642 dex_cache_arrays_bytes(0),
Mathieu Chartierd39645e2015-06-09 17:50:29 -07002643 interned_strings_bytes(0),
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002644 class_table_bytes(0),
Mathieu Chartier32327092013-08-30 14:04:08 -07002645 bitmap_bytes(0),
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002646 alignment_bytes(0),
2647 managed_code_bytes(0),
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002648 managed_code_bytes_ignoring_deduplication(0),
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002649 native_to_managed_code_bytes(0),
Ian Rogers0d2d3782012-04-10 11:09:18 -07002650 class_initializer_code_bytes(0),
2651 large_initializer_code_bytes(0),
2652 large_method_code_bytes(0),
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002653 vmap_table_bytes(0),
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002654 dex_instruction_bytes(0) {}
2655
Elliott Hughesa0e18062012-04-13 15:59:59 -07002656 struct SizeAndCount {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002657 SizeAndCount(size_t bytes_in, size_t count_in) : bytes(bytes_in), count(count_in) {}
Elliott Hughesa0e18062012-04-13 15:59:59 -07002658 size_t bytes;
2659 size_t count;
2660 };
2661 typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable;
2662 SizeAndCountTable sizes_and_counts;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002663
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002664 void Update(const char* descriptor, size_t object_bytes_in) {
Elliott Hughesa0e18062012-04-13 15:59:59 -07002665 SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor);
2666 if (it != sizes_and_counts.end()) {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002667 it->second.bytes += object_bytes_in;
Elliott Hughesa0e18062012-04-13 15:59:59 -07002668 it->second.count += 1;
2669 } else {
Andreas Gampe277ccbd2014-11-03 21:36:10 -08002670 sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes_in, 1));
Elliott Hughesa0e18062012-04-13 15:59:59 -07002671 }
2672 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002673
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002674 double PercentOfOatBytes(size_t size) {
2675 return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100;
2676 }
2677
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002678 double PercentOfFileBytes(size_t size) {
2679 return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100;
2680 }
2681
2682 double PercentOfObjectBytes(size_t size) {
2683 return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100;
2684 }
2685
Mathieu Chartiere401d142015-04-22 13:56:20 -07002686 void ComputeOutliers(size_t total_size, double expansion, ArtMethod* method) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002687 method_outlier_size.push_back(total_size);
2688 method_outlier_expansion.push_back(expansion);
2689 method_outlier.push_back(method);
2690 }
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002691
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002692 void DumpOutliers(std::ostream& os)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002693 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002694 size_t sum_of_sizes = 0;
2695 size_t sum_of_sizes_squared = 0;
2696 size_t sum_of_expansion = 0;
2697 size_t sum_of_expansion_squared = 0;
2698 size_t n = method_outlier_size.size();
Mathieu Chartier1ebf8d32016-06-09 11:51:27 -07002699 if (n <= 1) {
Jeff Haodcdc85b2015-12-04 14:06:18 -08002700 return;
2701 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002702 for (size_t i = 0; i < n; i++) {
2703 size_t cur_size = method_outlier_size[i];
2704 sum_of_sizes += cur_size;
2705 sum_of_sizes_squared += cur_size * cur_size;
2706 double cur_expansion = method_outlier_expansion[i];
2707 sum_of_expansion += cur_expansion;
2708 sum_of_expansion_squared += cur_expansion * cur_expansion;
2709 }
2710 size_t size_mean = sum_of_sizes / n;
2711 size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1);
2712 double expansion_mean = sum_of_expansion / n;
2713 double expansion_variance =
2714 (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1);
2715
2716 // Dump methods whose size is a certain number of standard deviations from the mean
2717 size_t dumped_values = 0;
2718 size_t skipped_values = 0;
2719 for (size_t i = 100; i > 0; i--) { // i is the current number of standard deviations
2720 size_t cur_size_variance = i * i * size_variance;
2721 bool first = true;
2722 for (size_t j = 0; j < n; j++) {
2723 size_t cur_size = method_outlier_size[j];
2724 if (cur_size > size_mean) {
2725 size_t cur_var = cur_size - size_mean;
2726 cur_var = cur_var * cur_var;
2727 if (cur_var > cur_size_variance) {
2728 if (dumped_values > 20) {
2729 if (i == 1) {
2730 skipped_values++;
2731 } else {
2732 i = 2; // jump to counting for 1 standard deviation
2733 break;
2734 }
2735 } else {
2736 if (first) {
Elliott Hughesc073b072012-05-24 19:29:17 -07002737 os << "\nBig methods (size > " << i << " standard deviations the norm):\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002738 first = false;
2739 }
David Sehr709b0702016-10-13 09:12:37 -07002740 os << ArtMethod::PrettyMethod(method_outlier[j]) << " requires storage of "
Elliott Hughesc073b072012-05-24 19:29:17 -07002741 << PrettySize(cur_size) << "\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002742 method_outlier_size[j] = 0; // don't consider this method again
2743 dumped_values++;
2744 }
2745 }
2746 }
2747 }
2748 }
2749 if (skipped_values > 0) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002750 os << "... skipped " << skipped_values
Elliott Hughesc073b072012-05-24 19:29:17 -07002751 << " methods with size > 1 standard deviation from the norm\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002752 }
Elliott Hughesc073b072012-05-24 19:29:17 -07002753 os << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002754
2755 // Dump methods whose expansion is a certain number of standard deviations from the mean
2756 dumped_values = 0;
2757 skipped_values = 0;
2758 for (size_t i = 10; i > 0; i--) { // i is the current number of standard deviations
2759 double cur_expansion_variance = i * i * expansion_variance;
2760 bool first = true;
2761 for (size_t j = 0; j < n; j++) {
2762 double cur_expansion = method_outlier_expansion[j];
2763 if (cur_expansion > expansion_mean) {
2764 size_t cur_var = cur_expansion - expansion_mean;
2765 cur_var = cur_var * cur_var;
2766 if (cur_var > cur_expansion_variance) {
2767 if (dumped_values > 20) {
2768 if (i == 1) {
2769 skipped_values++;
2770 } else {
2771 i = 2; // jump to counting for 1 standard deviation
2772 break;
2773 }
2774 } else {
2775 if (first) {
2776 os << "\nLarge expansion methods (size > " << i
Elliott Hughesc073b072012-05-24 19:29:17 -07002777 << " standard deviations the norm):\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002778 first = false;
2779 }
David Sehr709b0702016-10-13 09:12:37 -07002780 os << ArtMethod::PrettyMethod(method_outlier[j]) << " expanded code by "
Elliott Hughesc073b072012-05-24 19:29:17 -07002781 << cur_expansion << "\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002782 method_outlier_expansion[j] = 0.0; // don't consider this method again
2783 dumped_values++;
2784 }
2785 }
2786 }
2787 }
2788 }
2789 if (skipped_values > 0) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002790 os << "... skipped " << skipped_values
Elliott Hughesc073b072012-05-24 19:29:17 -07002791 << " methods with expansion > 1 standard deviation from the norm\n";
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002792 }
Elliott Hughesc073b072012-05-24 19:29:17 -07002793 os << "\n" << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002794 }
2795
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002796 void Dump(std::ostream& os, std::ostream& indent_os)
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002797 REQUIRES_SHARED(Locks::mutator_lock_) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002798 {
2799 os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n"
2800 << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n";
Vladimir Marko05792b92015-08-03 11:56:49 +01002801 indent_os << StringPrintf("header_bytes = %8zd (%2.0f%% of art file bytes)\n"
2802 "object_bytes = %8zd (%2.0f%% of art file bytes)\n"
2803 "art_field_bytes = %8zd (%2.0f%% of art file bytes)\n"
2804 "art_method_bytes = %8zd (%2.0f%% of art file bytes)\n"
2805 "dex_cache_arrays_bytes = %8zd (%2.0f%% of art file bytes)\n"
2806 "interned_string_bytes = %8zd (%2.0f%% of art file bytes)\n"
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002807 "class_table_bytes = %8zd (%2.0f%% of art file bytes)\n"
Vladimir Marko05792b92015-08-03 11:56:49 +01002808 "bitmap_bytes = %8zd (%2.0f%% of art file bytes)\n"
2809 "alignment_bytes = %8zd (%2.0f%% of art file bytes)\n\n",
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002810 header_bytes, PercentOfFileBytes(header_bytes),
2811 object_bytes, PercentOfFileBytes(object_bytes),
Mathieu Chartiere401d142015-04-22 13:56:20 -07002812 art_field_bytes, PercentOfFileBytes(art_field_bytes),
2813 art_method_bytes, PercentOfFileBytes(art_method_bytes),
Vladimir Marko05792b92015-08-03 11:56:49 +01002814 dex_cache_arrays_bytes,
2815 PercentOfFileBytes(dex_cache_arrays_bytes),
Mathieu Chartierd39645e2015-06-09 17:50:29 -07002816 interned_strings_bytes,
2817 PercentOfFileBytes(interned_strings_bytes),
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002818 class_table_bytes, PercentOfFileBytes(class_table_bytes),
Mathieu Chartier32327092013-08-30 14:04:08 -07002819 bitmap_bytes, PercentOfFileBytes(bitmap_bytes),
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002820 alignment_bytes, PercentOfFileBytes(alignment_bytes))
2821 << std::flush;
Mathieu Chartier208a5cb2015-12-02 15:44:07 -08002822 CHECK_EQ(file_bytes,
2823 header_bytes + object_bytes + art_field_bytes + art_method_bytes +
2824 dex_cache_arrays_bytes + interned_strings_bytes + class_table_bytes +
2825 bitmap_bytes + alignment_bytes);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002826 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002827
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002828 os << "object_bytes breakdown:\n";
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002829 size_t object_bytes_total = 0;
Mathieu Chartier02e25112013-08-14 16:14:24 -07002830 for (const auto& sizes_and_count : sizes_and_counts) {
2831 const std::string& descriptor(sizes_and_count.first);
2832 double average = static_cast<double>(sizes_and_count.second.bytes) /
2833 static_cast<double>(sizes_and_count.second.count);
2834 double percent = PercentOfObjectBytes(sizes_and_count.second.bytes);
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002835 os << StringPrintf("%32s %8zd bytes %6zd instances "
Elliott Hughesa0e18062012-04-13 15:59:59 -07002836 "(%4.0f bytes/instance) %2.0f%% of object_bytes\n",
Mathieu Chartier02e25112013-08-14 16:14:24 -07002837 descriptor.c_str(), sizes_and_count.second.bytes,
2838 sizes_and_count.second.count, average, percent);
2839 object_bytes_total += sizes_and_count.second.bytes;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002840 }
Elliott Hughesc073b072012-05-24 19:29:17 -07002841 os << "\n" << std::flush;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002842 CHECK_EQ(object_bytes, object_bytes_total);
2843
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002844 os << StringPrintf("oat_file_bytes = %8zd\n"
2845 "managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002846 "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n"
2847 "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2848 "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n"
2849 "large_method_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n",
Ian Rogers05f28c62012-10-23 18:12:13 -07002850 oat_file_bytes,
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002851 managed_code_bytes,
2852 PercentOfOatBytes(managed_code_bytes),
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002853 native_to_managed_code_bytes,
2854 PercentOfOatBytes(native_to_managed_code_bytes),
2855 class_initializer_code_bytes,
2856 PercentOfOatBytes(class_initializer_code_bytes),
2857 large_initializer_code_bytes,
2858 PercentOfOatBytes(large_initializer_code_bytes),
2859 large_method_code_bytes,
2860 PercentOfOatBytes(large_method_code_bytes))
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002861 << "DexFile sizes:\n";
Mathieu Chartier02e25112013-08-14 16:14:24 -07002862 for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) {
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002863 os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n",
Mathieu Chartier02e25112013-08-14 16:14:24 -07002864 oat_dex_file_size.first.c_str(), oat_dex_file_size.second,
2865 PercentOfOatBytes(oat_dex_file_size.second));
Ian Rogers05f28c62012-10-23 18:12:13 -07002866 }
2867
Vladimir Marko9d07e3d2016-03-31 12:02:28 +01002868 os << "\n" << StringPrintf("vmap_table_bytes = %7zd (%2.0f%% of oat file bytes)\n\n",
Ian Rogers05f28c62012-10-23 18:12:13 -07002869 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes))
Elliott Hughesc073b072012-05-24 19:29:17 -07002870 << std::flush;
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002871
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002872 os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes)
2873 << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n",
Brian Carlstrom2ec65202014-03-03 15:16:37 -08002874 static_cast<double>(managed_code_bytes) /
2875 static_cast<double>(dex_instruction_bytes),
Elliott Hughesc073b072012-05-24 19:29:17 -07002876 static_cast<double>(managed_code_bytes_ignoring_deduplication) /
Elliott Hughescf44e6f2012-05-24 19:42:18 -07002877 static_cast<double>(dex_instruction_bytes))
Elliott Hughesc073b072012-05-24 19:29:17 -07002878 << std::flush;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002879
2880 DumpOutliers(os);
Brian Carlstrom916e74e2011-09-23 11:42:01 -07002881 }
2882 } stats_;
2883
2884 private:
Ian Rogers0d2d3782012-04-10 11:09:18 -07002885 enum {
2886 // Number of bytes for a constructor to be considered large. Based on the 1000 basic block
2887 // threshold, we assume 2 bytes per instruction and 2 instructions per block.
2888 kLargeConstructorDexBytes = 4000,
2889 // Number of bytes for a method to be considered large. Based on the 4000 basic block
2890 // threshold, we assume 2 bytes per instruction and 2 instructions per block.
2891 kLargeMethodDexBytes = 16000
2892 };
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002893
2894 // For performance, use the *os_ directly for anything that doesn't need indentation
2895 // and prepare an indentation stream with default indentation 1.
Ian Rogers2bcb4a42012-11-08 10:39:18 -08002896 std::ostream* os_;
Vladimir Marko8f1e08a2015-06-26 12:06:30 +01002897 VariableIndentationOutputStream vios_;
2898 ScopedIndentation indent1_;
2899
Ian Rogers1d54e732013-05-02 21:10:01 -07002900 gc::space::ImageSpace& image_space_;
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002901 const ImageHeader& image_header_;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -07002902 std::unique_ptr<OatDumper> oat_dumper_;
Andreas Gampedf2bb1f2015-05-04 18:25:23 -07002903 OatDumperOptions* oat_dumper_options_;
Vladimir Marko05792b92015-08-03 11:56:49 +01002904 std::set<mirror::Object*> dex_caches_;
Elliott Hughesd1bb4f62011-09-23 14:09:45 -07002905
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08002906 DISALLOW_COPY_AND_ASSIGN(ImageDumper);
Brian Carlstrom78128a62011-09-15 17:21:19 -07002907};
2908
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002909static int DumpImage(gc::space::ImageSpace* image_space,
2910 OatDumperOptions* options,
Andreas Gampebdf7f1c2016-08-30 16:38:47 -07002911 std::ostream* os) REQUIRES_SHARED(Locks::mutator_lock_) {
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002912 const ImageHeader& image_header = image_space->GetImageHeader();
2913 if (!image_header.IsValid()) {
2914 fprintf(stderr, "Invalid image header %s\n", image_space->GetImageLocation().c_str());
2915 return EXIT_FAILURE;
2916 }
2917 ImageDumper image_dumper(os, *image_space, image_header, options);
2918 if (!image_dumper.Dump()) {
2919 return EXIT_FAILURE;
2920 }
2921 return EXIT_SUCCESS;
2922}
2923
2924static int DumpImages(Runtime* runtime, OatDumperOptions* options, std::ostream* os) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002925 // Dumping the image, no explicit class loader.
Mathieu Chartier9865bde2015-12-21 09:58:16 -08002926 ScopedNullHandle<mirror::ClassLoader> null_class_loader;
Andreas Gampe00b25f32014-09-17 21:49:05 -07002927 options->class_loader_ = &null_class_loader;
2928
Ian Rogers00f7d0e2012-07-19 15:28:27 -07002929 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002930 if (options->app_image_ != nullptr) {
2931 if (options->app_oat_ == nullptr) {
2932 LOG(ERROR) << "Can not dump app image without app oat file";
Jeff Haodcdc85b2015-12-04 14:06:18 -08002933 return EXIT_FAILURE;
2934 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002935 // We can't know if the app image is 32 bits yet, but it contains pointers into the oat file.
2936 // We need to map the oat file in the low 4gb or else the fixup wont be able to fit oat file
2937 // pointers into 32 bit pointer sized ArtMethods.
2938 std::string error_msg;
2939 std::unique_ptr<OatFile> oat_file(OatFile::Open(options->app_oat_,
2940 options->app_oat_,
2941 nullptr,
2942 nullptr,
2943 false,
2944 /*low_4gb*/true,
2945 nullptr,
2946 &error_msg));
2947 if (oat_file == nullptr) {
2948 LOG(ERROR) << "Failed to open oat file " << options->app_oat_ << " with error " << error_msg;
Jeff Haodcdc85b2015-12-04 14:06:18 -08002949 return EXIT_FAILURE;
2950 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08002951 std::unique_ptr<gc::space::ImageSpace> space(
2952 gc::space::ImageSpace::CreateFromAppImage(options->app_image_, oat_file.get(), &error_msg));
2953 if (space == nullptr) {
2954 LOG(ERROR) << "Failed to open app image " << options->app_image_ << " with error "
2955 << error_msg;
2956 }
2957 // Open dex files for the image.
2958 std::vector<std::unique_ptr<const DexFile>> dex_files;
2959 if (!runtime->GetClassLinker()->OpenImageDexFiles(space.get(), &dex_files, &error_msg)) {
2960 LOG(ERROR) << "Failed to open app image dex files " << options->app_image_ << " with error "
2961 << error_msg;
2962 }
2963 // Dump the actual image.
2964 int result = DumpImage(space.get(), options, os);
2965 if (result != EXIT_SUCCESS) {
2966 return result;
2967 }
2968 // Fall through to dump the boot images.
2969 }
2970
2971 gc::Heap* heap = runtime->GetHeap();
2972 CHECK(heap->HasBootImageSpace()) << "No image spaces";
2973 for (gc::space::ImageSpace* image_space : heap->GetBootImageSpaces()) {
2974 int result = DumpImage(image_space, options, os);
2975 if (result != EXIT_SUCCESS) {
2976 return result;
2977 }
Brian Carlstrom78128a62011-09-15 17:21:19 -07002978 }
Jeff Haodcdc85b2015-12-04 14:06:18 -08002979 return EXIT_SUCCESS;
Brian Carlstrom78128a62011-09-15 17:21:19 -07002980}
2981
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002982static jobject InstallOatFile(Runtime* runtime,
2983 std::unique_ptr<OatFile> oat_file,
2984 std::vector<const DexFile*>* class_path)
2985 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002986 Thread* self = Thread::Current();
2987 CHECK(self != nullptr);
2988 // Need well-known-classes.
2989 WellKnownClasses::Init(self->GetJniEnv());
2990
2991 // Need to register dex files to get a working dex cache.
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002992 OatFile* oat_file_ptr = oat_file.get();
Andreas Gampe00b25f32014-09-17 21:49:05 -07002993 ClassLinker* class_linker = runtime->GetClassLinker();
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07002994 runtime->GetOatFileManager().RegisterOatFile(std::move(oat_file));
2995 for (const OatFile::OatDexFile* odf : oat_file_ptr->GetOatDexFiles()) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07002996 std::string error_msg;
Mathieu Chartierac8f4392015-08-27 13:54:20 -07002997 const DexFile* const dex_file = OpenDexFile(odf, &error_msg);
Andreas Gampe00b25f32014-09-17 21:49:05 -07002998 CHECK(dex_file != nullptr) << error_msg;
Vladimir Markocd556b02017-02-03 11:47:34 +00002999 ObjPtr<mirror::DexCache> dex_cache =
3000 class_linker->RegisterDexFile(*dex_file, nullptr);
3001 CHECK(dex_cache != nullptr);
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003002 class_path->push_back(dex_file);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003003 }
3004
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003005 // Need a class loader. Fake that we're a compiler.
3006 // Note: this will run initializers through the unstarted runtime, so make sure it's
3007 // initialized.
3008 interpreter::UnstartedRuntime::Initialize();
3009
3010 jobject class_loader = class_linker->CreatePathClassLoader(self, *class_path);
3011
3012 return class_loader;
3013}
3014
3015static int DumpOatWithRuntime(Runtime* runtime,
3016 std::unique_ptr<OatFile> oat_file,
3017 OatDumperOptions* options,
3018 std::ostream* os) {
3019 CHECK(runtime != nullptr && oat_file != nullptr && options != nullptr);
3020 ScopedObjectAccess soa(Thread::Current());
3021
3022 OatFile* oat_file_ptr = oat_file.get();
3023 std::vector<const DexFile*> class_path;
3024 jobject class_loader = InstallOatFile(runtime, std::move(oat_file), &class_path);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003025
3026 // Use the class loader while dumping.
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003027 StackHandleScope<1> scope(soa.Self());
Andreas Gampe00b25f32014-09-17 21:49:05 -07003028 Handle<mirror::ClassLoader> loader_handle = scope.NewHandle(
Mathieu Chartier0795f232016-09-27 18:43:30 -07003029 soa.Decode<mirror::ClassLoader>(class_loader));
Andreas Gampe00b25f32014-09-17 21:49:05 -07003030 options->class_loader_ = &loader_handle;
3031
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003032 OatDumper oat_dumper(*oat_file_ptr, *options);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003033 bool success = oat_dumper.Dump(*os);
3034 return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
3035}
3036
3037static int DumpOatWithoutRuntime(OatFile* oat_file, OatDumperOptions* options, std::ostream* os) {
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003038 CHECK(oat_file != nullptr && options != nullptr);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003039 // No image = no class loader.
Mathieu Chartier9865bde2015-12-21 09:58:16 -08003040 ScopedNullHandle<mirror::ClassLoader> null_class_loader;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003041 options->class_loader_ = &null_class_loader;
3042
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003043 OatDumper oat_dumper(*oat_file, *options);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003044 bool success = oat_dumper.Dump(*os);
3045 return (success) ? EXIT_SUCCESS : EXIT_FAILURE;
3046}
3047
3048static int DumpOat(Runtime* runtime, const char* oat_filename, OatDumperOptions* options,
3049 std::ostream* os) {
3050 std::string error_msg;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003051 std::unique_ptr<OatFile> oat_file(OatFile::Open(oat_filename,
3052 oat_filename,
3053 nullptr,
3054 nullptr,
3055 false,
3056 /*low_4gb*/false,
3057 nullptr,
3058 &error_msg));
Andreas Gampe00b25f32014-09-17 21:49:05 -07003059 if (oat_file == nullptr) {
3060 fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
3061 return EXIT_FAILURE;
3062 }
3063
3064 if (runtime != nullptr) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003065 return DumpOatWithRuntime(runtime, std::move(oat_file), options, os);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003066 } else {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003067 return DumpOatWithoutRuntime(oat_file.get(), options, os);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003068 }
3069}
3070
David Srbecky2fdd03c2016-03-10 15:32:37 +00003071static int SymbolizeOat(const char* oat_filename, std::string& output_name, bool no_bits) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07003072 std::string error_msg;
Andreas Gampe08c277c2017-04-26 22:22:15 -07003073 std::unique_ptr<OatFile> oat_file(OatFile::Open(oat_filename,
3074 oat_filename,
3075 nullptr,
3076 nullptr,
3077 false,
3078 /*low_4gb*/false,
3079 nullptr,
3080 &error_msg));
Andreas Gampe00b25f32014-09-17 21:49:05 -07003081 if (oat_file == nullptr) {
3082 fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
3083 return EXIT_FAILURE;
3084 }
3085
Andreas Gampe2d8614b2016-03-07 16:31:34 -08003086 bool result;
3087 // Try to produce an ELF file of the same type. This is finicky, as we have used 32-bit ELF
3088 // files for 64-bit code in the past.
3089 if (Is64BitInstructionSet(oat_file->GetOatHeader().GetInstructionSet())) {
Andreas Gampe08c277c2017-04-26 22:22:15 -07003090 OatSymbolizer<ElfTypes64> oat_symbolizer(oat_file.get(), output_name, no_bits);
Andreas Gampe2d8614b2016-03-07 16:31:34 -08003091 result = oat_symbolizer.Symbolize();
3092 } else {
Andreas Gampe08c277c2017-04-26 22:22:15 -07003093 OatSymbolizer<ElfTypes32> oat_symbolizer(oat_file.get(), output_name, no_bits);
Andreas Gampe2d8614b2016-03-07 16:31:34 -08003094 result = oat_symbolizer.Symbolize();
3095 }
3096 if (!result) {
Andreas Gampe00b25f32014-09-17 21:49:05 -07003097 fprintf(stderr, "Failed to symbolize\n");
3098 return EXIT_FAILURE;
3099 }
3100
3101 return EXIT_SUCCESS;
3102}
3103
Andreas Gampe9fded872016-09-25 16:08:35 -07003104class IMTDumper {
3105 public:
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003106 static bool Dump(Runtime* runtime,
3107 const std::string& imt_file,
3108 bool dump_imt_stats,
3109 const char* oat_filename) {
3110 Thread* self = Thread::Current();
3111
3112 ScopedObjectAccess soa(self);
3113 StackHandleScope<1> scope(self);
3114 MutableHandle<mirror::ClassLoader> class_loader = scope.NewHandle<mirror::ClassLoader>(nullptr);
3115 std::vector<const DexFile*> class_path;
3116
3117 if (oat_filename != nullptr) {
3118 std::string error_msg;
3119 std::unique_ptr<OatFile> oat_file(OatFile::Open(oat_filename,
3120 oat_filename,
3121 nullptr,
3122 nullptr,
3123 false,
3124 /*low_4gb*/false,
3125 nullptr,
3126 &error_msg));
3127 if (oat_file == nullptr) {
3128 fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str());
3129 return false;
3130 }
3131
3132 class_loader.Assign(soa.Decode<mirror::ClassLoader>(
3133 InstallOatFile(runtime, std::move(oat_file), &class_path)));
3134 } else {
3135 class_loader.Assign(nullptr); // Boot classloader. Just here for explicit documentation.
3136 class_path = runtime->GetClassLinker()->GetBootClassPath();
3137 }
3138
3139 if (!imt_file.empty()) {
3140 return DumpImt(runtime, imt_file, class_loader);
3141 }
3142
3143 if (dump_imt_stats) {
3144 return DumpImtStats(runtime, class_path, class_loader);
3145 }
3146
3147 LOG(FATAL) << "Should not reach here";
3148 UNREACHABLE();
3149 }
3150
3151 private:
3152 static bool DumpImt(Runtime* runtime,
3153 const std::string& imt_file,
3154 Handle<mirror::ClassLoader> h_class_loader)
3155 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003156 std::vector<std::string> lines = ReadCommentedInputFromFile(imt_file);
3157 std::unordered_set<std::string> prepared;
3158
3159 for (const std::string& line : lines) {
3160 // A line should be either a class descriptor, in which case we will dump the complete IMT,
3161 // or a class descriptor and an interface method, in which case we will lookup the method,
3162 // determine its IMT slot, and check the class' IMT.
3163 size_t first_space = line.find(' ');
3164 if (first_space == std::string::npos) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003165 DumpIMTForClass(runtime, line, h_class_loader, &prepared);
Andreas Gampe9fded872016-09-25 16:08:35 -07003166 } else {
3167 DumpIMTForMethod(runtime,
3168 line.substr(0, first_space),
3169 line.substr(first_space + 1, std::string::npos),
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003170 h_class_loader,
Andreas Gampe9fded872016-09-25 16:08:35 -07003171 &prepared);
3172 }
3173 std::cerr << std::endl;
3174 }
3175
3176 return true;
3177 }
3178
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003179 static bool DumpImtStats(Runtime* runtime,
3180 const std::vector<const DexFile*>& dex_files,
3181 Handle<mirror::ClassLoader> h_class_loader)
3182 REQUIRES_SHARED(Locks::mutator_lock_) {
3183 size_t without_imt = 0;
3184 size_t with_imt = 0;
Andreas Gampe9fded872016-09-25 16:08:35 -07003185 std::map<size_t, size_t> histogram;
3186
3187 ClassLinker* class_linker = runtime->GetClassLinker();
3188 const PointerSize pointer_size = class_linker->GetImagePointerSize();
3189 std::unordered_set<std::string> prepared;
3190
3191 Thread* self = Thread::Current();
Andreas Gampe9fded872016-09-25 16:08:35 -07003192 StackHandleScope<1> scope(self);
3193 MutableHandle<mirror::Class> h_klass(scope.NewHandle<mirror::Class>(nullptr));
3194
3195 for (const DexFile* dex_file : dex_files) {
3196 for (uint32_t class_def_index = 0;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003197 class_def_index != dex_file->NumClassDefs();
3198 ++class_def_index) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003199 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index);
3200 const char* descriptor = dex_file->GetClassDescriptor(class_def);
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003201 h_klass.Assign(class_linker->FindClass(self, descriptor, h_class_loader));
Andreas Gampefa4333d2017-02-14 11:10:34 -08003202 if (h_klass == nullptr) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003203 std::cerr << "Warning: could not load " << descriptor << std::endl;
3204 continue;
3205 }
3206
3207 if (HasNoIMT(runtime, h_klass, pointer_size, &prepared)) {
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003208 without_imt++;
Andreas Gampe9fded872016-09-25 16:08:35 -07003209 continue;
3210 }
3211
3212 ImTable* im_table = PrepareAndGetImTable(runtime, h_klass, pointer_size, &prepared);
3213 if (im_table == nullptr) {
3214 // Should not happen, but accept.
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003215 without_imt++;
Andreas Gampe9fded872016-09-25 16:08:35 -07003216 continue;
3217 }
3218
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003219 with_imt++;
Andreas Gampe9fded872016-09-25 16:08:35 -07003220 for (size_t imt_index = 0; imt_index != ImTable::kSize; ++imt_index) {
3221 ArtMethod* ptr = im_table->Get(imt_index, pointer_size);
3222 if (ptr->IsRuntimeMethod()) {
3223 if (ptr->IsImtUnimplementedMethod()) {
3224 histogram[0]++;
3225 } else {
3226 ImtConflictTable* current_table = ptr->GetImtConflictTable(pointer_size);
3227 histogram[current_table->NumEntries(pointer_size)]++;
3228 }
3229 } else {
3230 histogram[1]++;
3231 }
3232 }
3233 }
3234 }
3235
3236 std::cerr << "IMT stats:"
3237 << std::endl << std::endl;
3238
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003239 std::cerr << " " << with_imt << " classes with IMT."
Andreas Gampe9fded872016-09-25 16:08:35 -07003240 << std::endl << std::endl;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003241 std::cerr << " " << without_imt << " classes without IMT (or copy from Object)."
Andreas Gampe9fded872016-09-25 16:08:35 -07003242 << std::endl << std::endl;
3243
3244 double sum_one = 0;
3245 size_t count_one = 0;
3246
3247 std::cerr << " " << "IMT histogram" << std::endl;
3248 for (auto& bucket : histogram) {
3249 std::cerr << " " << bucket.first << " " << bucket.second << std::endl;
3250 if (bucket.first > 0) {
3251 sum_one += bucket.second * bucket.first;
3252 count_one += bucket.second;
3253 }
3254 }
3255
3256 double count_zero = count_one + histogram[0];
3257 std::cerr << " Stats:" << std::endl;
3258 std::cerr << " Average depth (including empty): " << (sum_one / count_zero) << std::endl;
3259 std::cerr << " Average depth (excluding empty): " << (sum_one / count_one) << std::endl;
3260
3261 return true;
3262 }
3263
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003264 // Return whether the given class has no IMT (or the one shared with java.lang.Object).
Andreas Gampe9fded872016-09-25 16:08:35 -07003265 static bool HasNoIMT(Runtime* runtime,
3266 Handle<mirror::Class> klass,
3267 const PointerSize pointer_size,
3268 std::unordered_set<std::string>* prepared)
3269 REQUIRES_SHARED(Locks::mutator_lock_) {
3270 if (klass->IsObjectClass() || !klass->ShouldHaveImt()) {
3271 return true;
3272 }
3273
3274 if (klass->GetImt(pointer_size) == nullptr) {
3275 PrepareClass(runtime, klass, prepared);
3276 }
3277
3278 mirror::Class* object_class = mirror::Class::GetJavaLangClass()->GetSuperClass();
3279 DCHECK(object_class->IsObjectClass());
3280
3281 bool result = klass->GetImt(pointer_size) == object_class->GetImt(pointer_size);
3282
Mathieu Chartier6beced42016-11-15 15:51:31 -08003283 if (klass->GetIfTable()->Count() == 0) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003284 DCHECK(result);
3285 }
3286
3287 return result;
3288 }
3289
3290 static void PrintTable(ImtConflictTable* table, PointerSize pointer_size)
3291 REQUIRES_SHARED(Locks::mutator_lock_) {
3292 if (table == nullptr) {
3293 std::cerr << " <No IMT?>" << std::endl;
3294 return;
3295 }
3296 size_t table_index = 0;
3297 for (;;) {
3298 ArtMethod* ptr = table->GetInterfaceMethod(table_index, pointer_size);
3299 if (ptr == nullptr) {
3300 return;
3301 }
3302 table_index++;
David Sehr709b0702016-10-13 09:12:37 -07003303 std::cerr << " " << ptr->PrettyMethod(true) << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003304 }
3305 }
3306
3307 static ImTable* PrepareAndGetImTable(Runtime* runtime,
3308 Thread* self,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003309 Handle<mirror::ClassLoader> h_loader,
Andreas Gampe9fded872016-09-25 16:08:35 -07003310 const std::string& class_name,
3311 const PointerSize pointer_size,
3312 mirror::Class** klass_out,
3313 std::unordered_set<std::string>* prepared)
3314 REQUIRES_SHARED(Locks::mutator_lock_) {
3315 if (class_name.empty()) {
3316 return nullptr;
3317 }
3318
3319 std::string descriptor;
3320 if (class_name[0] == 'L') {
3321 descriptor = class_name;
3322 } else {
3323 descriptor = DotToDescriptor(class_name.c_str());
3324 }
3325
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003326 mirror::Class* klass = runtime->GetClassLinker()->FindClass(self, descriptor.c_str(), h_loader);
Andreas Gampe9fded872016-09-25 16:08:35 -07003327
3328 if (klass == nullptr) {
3329 self->ClearException();
3330 std::cerr << "Did not find " << class_name << std::endl;
3331 *klass_out = nullptr;
3332 return nullptr;
3333 }
3334
3335 StackHandleScope<1> scope(Thread::Current());
3336 Handle<mirror::Class> h_klass = scope.NewHandle<mirror::Class>(klass);
3337
3338 ImTable* ret = PrepareAndGetImTable(runtime, h_klass, pointer_size, prepared);
3339 *klass_out = h_klass.Get();
3340 return ret;
3341 }
3342
3343 static ImTable* PrepareAndGetImTable(Runtime* runtime,
3344 Handle<mirror::Class> h_klass,
3345 const PointerSize pointer_size,
3346 std::unordered_set<std::string>* prepared)
3347 REQUIRES_SHARED(Locks::mutator_lock_) {
3348 PrepareClass(runtime, h_klass, prepared);
3349 return h_klass->GetImt(pointer_size);
3350 }
3351
3352 static void DumpIMTForClass(Runtime* runtime,
3353 const std::string& class_name,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003354 Handle<mirror::ClassLoader> h_loader,
3355 std::unordered_set<std::string>* prepared)
3356 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003357 const PointerSize pointer_size = runtime->GetClassLinker()->GetImagePointerSize();
3358 mirror::Class* klass;
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003359 ImTable* imt = PrepareAndGetImTable(runtime,
3360 Thread::Current(),
3361 h_loader,
3362 class_name,
3363 pointer_size,
3364 &klass,
3365 prepared);
Andreas Gampe9fded872016-09-25 16:08:35 -07003366 if (imt == nullptr) {
3367 return;
3368 }
3369
3370 std::cerr << class_name << std::endl << " IMT:" << std::endl;
3371 for (size_t index = 0; index < ImTable::kSize; ++index) {
3372 std::cerr << " " << index << ":" << std::endl;
3373 ArtMethod* ptr = imt->Get(index, pointer_size);
3374 if (ptr->IsRuntimeMethod()) {
3375 if (ptr->IsImtUnimplementedMethod()) {
3376 std::cerr << " <empty>" << std::endl;
3377 } else {
3378 ImtConflictTable* current_table = ptr->GetImtConflictTable(pointer_size);
3379 PrintTable(current_table, pointer_size);
3380 }
3381 } else {
David Sehr709b0702016-10-13 09:12:37 -07003382 std::cerr << " " << ptr->PrettyMethod(true) << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003383 }
3384 }
3385
3386 std::cerr << " Interfaces:" << std::endl;
3387 // Run through iftable, find methods that slot here, see if they fit.
3388 mirror::IfTable* if_table = klass->GetIfTable();
Mathieu Chartier6beced42016-11-15 15:51:31 -08003389 for (size_t i = 0, num_interfaces = klass->GetIfTableCount(); i < num_interfaces; ++i) {
3390 mirror::Class* iface = if_table->GetInterface(i);
3391 std::string iface_name;
3392 std::cerr << " " << iface->GetDescriptor(&iface_name) << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003393
Mathieu Chartier6beced42016-11-15 15:51:31 -08003394 for (ArtMethod& iface_method : iface->GetVirtualMethods(pointer_size)) {
3395 uint32_t class_hash, name_hash, signature_hash;
3396 ImTable::GetImtHashComponents(&iface_method, &class_hash, &name_hash, &signature_hash);
3397 uint32_t imt_slot = ImTable::GetImtIndex(&iface_method);
3398 std::cerr << " " << iface_method.PrettyMethod(true)
3399 << " slot=" << imt_slot
3400 << std::hex
3401 << " class_hash=0x" << class_hash
3402 << " name_hash=0x" << name_hash
3403 << " signature_hash=0x" << signature_hash
3404 << std::dec
3405 << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003406 }
3407 }
3408 }
3409
3410 static void DumpIMTForMethod(Runtime* runtime,
3411 const std::string& class_name,
3412 const std::string& method,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003413 Handle<mirror::ClassLoader> h_loader,
3414 std::unordered_set<std::string>* prepared)
3415 REQUIRES_SHARED(Locks::mutator_lock_) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003416 const PointerSize pointer_size = runtime->GetClassLinker()->GetImagePointerSize();
3417 mirror::Class* klass;
3418 ImTable* imt = PrepareAndGetImTable(runtime,
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003419 Thread::Current(),
3420 h_loader,
Andreas Gampe9fded872016-09-25 16:08:35 -07003421 class_name,
3422 pointer_size,
3423 &klass,
3424 prepared);
3425 if (imt == nullptr) {
3426 return;
3427 }
3428
3429 std::cerr << class_name << " <" << method << ">" << std::endl;
3430 for (size_t index = 0; index < ImTable::kSize; ++index) {
3431 ArtMethod* ptr = imt->Get(index, pointer_size);
3432 if (ptr->IsRuntimeMethod()) {
3433 if (ptr->IsImtUnimplementedMethod()) {
3434 continue;
3435 }
3436
3437 ImtConflictTable* current_table = ptr->GetImtConflictTable(pointer_size);
3438 if (current_table == nullptr) {
3439 continue;
3440 }
3441
3442 size_t table_index = 0;
3443 for (;;) {
3444 ArtMethod* ptr2 = current_table->GetInterfaceMethod(table_index, pointer_size);
3445 if (ptr2 == nullptr) {
3446 break;
3447 }
3448 table_index++;
3449
David Sehr709b0702016-10-13 09:12:37 -07003450 std::string p_name = ptr2->PrettyMethod(true);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003451 if (android::base::StartsWith(p_name, method.c_str())) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003452 std::cerr << " Slot "
3453 << index
3454 << " ("
3455 << current_table->NumEntries(pointer_size)
3456 << ")"
3457 << std::endl;
3458 PrintTable(current_table, pointer_size);
3459 return;
3460 }
3461 }
3462 } else {
David Sehr709b0702016-10-13 09:12:37 -07003463 std::string p_name = ptr->PrettyMethod(true);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003464 if (android::base::StartsWith(p_name, method.c_str())) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003465 std::cerr << " Slot " << index << " (1)" << std::endl;
3466 std::cerr << " " << p_name << std::endl;
3467 } else {
3468 // Run through iftable, find methods that slot here, see if they fit.
3469 mirror::IfTable* if_table = klass->GetIfTable();
Mathieu Chartier6beced42016-11-15 15:51:31 -08003470 for (size_t i = 0, num_interfaces = klass->GetIfTableCount(); i < num_interfaces; ++i) {
3471 mirror::Class* iface = if_table->GetInterface(i);
3472 size_t num_methods = iface->NumDeclaredVirtualMethods();
3473 if (num_methods > 0) {
3474 for (ArtMethod& iface_method : iface->GetMethods(pointer_size)) {
3475 if (ImTable::GetImtIndex(&iface_method) == index) {
3476 std::string i_name = iface_method.PrettyMethod(true);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003477 if (android::base::StartsWith(i_name, method.c_str())) {
Mathieu Chartier6beced42016-11-15 15:51:31 -08003478 std::cerr << " Slot " << index << " (1)" << std::endl;
3479 std::cerr << " " << p_name << " (" << i_name << ")" << std::endl;
Andreas Gampe9fded872016-09-25 16:08:35 -07003480 }
3481 }
3482 }
3483 }
3484 }
3485 }
3486 }
3487 }
3488 }
3489
3490 // Read lines from the given stream, dropping comments and empty lines
3491 static std::vector<std::string> ReadCommentedInputStream(std::istream& in_stream) {
3492 std::vector<std::string> output;
3493 while (in_stream.good()) {
3494 std::string dot;
3495 std::getline(in_stream, dot);
Andreas Gampe9186ced2016-12-12 14:28:21 -08003496 if (android::base::StartsWith(dot, "#") || dot.empty()) {
Andreas Gampe9fded872016-09-25 16:08:35 -07003497 continue;
3498 }
3499 output.push_back(dot);
3500 }
3501 return output;
3502 }
3503
3504 // Read lines from the given file, dropping comments and empty lines.
3505 static std::vector<std::string> ReadCommentedInputFromFile(const std::string& input_filename) {
3506 std::unique_ptr<std::ifstream> input_file(new std::ifstream(input_filename, std::ifstream::in));
3507 if (input_file.get() == nullptr) {
3508 LOG(ERROR) << "Failed to open input file " << input_filename;
3509 return std::vector<std::string>();
3510 }
3511 std::vector<std::string> result = ReadCommentedInputStream(*input_file);
3512 input_file->close();
3513 return result;
3514 }
3515
3516 // Prepare a class, i.e., ensure it has a filled IMT. Will do so recursively for superclasses,
3517 // and note in the given set that the work was done.
3518 static void PrepareClass(Runtime* runtime,
3519 Handle<mirror::Class> h_klass,
3520 std::unordered_set<std::string>* done)
3521 REQUIRES_SHARED(Locks::mutator_lock_) {
3522 if (!h_klass->ShouldHaveImt()) {
3523 return;
3524 }
3525
3526 std::string name;
3527 name = h_klass->GetDescriptor(&name);
3528
3529 if (done->find(name) != done->end()) {
3530 return;
3531 }
3532 done->insert(name);
3533
3534 if (h_klass->HasSuperClass()) {
3535 StackHandleScope<1> h(Thread::Current());
3536 PrepareClass(runtime, h.NewHandle<mirror::Class>(h_klass->GetSuperClass()), done);
3537 }
3538
3539 if (!h_klass->IsTemp()) {
3540 runtime->GetClassLinker()->FillIMTAndConflictTables(h_klass.Get());
3541 }
3542 }
3543};
3544
Igor Murashkin37743352014-11-13 14:38:00 -08003545struct OatdumpArgs : public CmdlineArgs {
3546 protected:
3547 using Base = CmdlineArgs;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003548
Igor Murashkin37743352014-11-13 14:38:00 -08003549 virtual ParseStatus ParseCustom(const StringPiece& option,
3550 std::string* error_msg) OVERRIDE {
3551 {
3552 ParseStatus base_parse = Base::ParseCustom(option, error_msg);
3553 if (base_parse != kParseUnknownArgument) {
3554 return base_parse;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003555 }
3556 }
3557
Igor Murashkin37743352014-11-13 14:38:00 -08003558 if (option.starts_with("--oat-file=")) {
3559 oat_filename_ = option.substr(strlen("--oat-file=")).data();
3560 } else if (option.starts_with("--image=")) {
3561 image_location_ = option.substr(strlen("--image=")).data();
Igor Murashkin37743352014-11-13 14:38:00 -08003562 } else if (option == "--no-dump:vmap") {
3563 dump_vmap_ = false;
Roland Levillainf2650d12015-05-28 14:53:28 +01003564 } else if (option =="--dump:code_info_stack_maps") {
3565 dump_code_info_stack_maps_ = true;
Igor Murashkin37743352014-11-13 14:38:00 -08003566 } else if (option == "--no-disassemble") {
3567 disassemble_code_ = false;
David Brazdilc03d7b62016-03-02 12:18:03 +00003568 } else if (option =="--header-only") {
3569 dump_header_only_ = true;
Igor Murashkin37743352014-11-13 14:38:00 -08003570 } else if (option.starts_with("--symbolize=")) {
3571 oat_filename_ = option.substr(strlen("--symbolize=")).data();
3572 symbolize_ = true;
David Srbecky2fdd03c2016-03-10 15:32:37 +00003573 } else if (option.starts_with("--only-keep-debug")) {
3574 only_keep_debug_ = true;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003575 } else if (option.starts_with("--class-filter=")) {
3576 class_filter_ = option.substr(strlen("--class-filter=")).data();
Igor Murashkin37743352014-11-13 14:38:00 -08003577 } else if (option.starts_with("--method-filter=")) {
3578 method_filter_ = option.substr(strlen("--method-filter=")).data();
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003579 } else if (option.starts_with("--list-classes")) {
3580 list_classes_ = true;
3581 } else if (option.starts_with("--list-methods")) {
3582 list_methods_ = true;
3583 } else if (option.starts_with("--export-dex-to=")) {
3584 export_dex_location_ = option.substr(strlen("--export-dex-to=")).data();
3585 } else if (option.starts_with("--addr2instr=")) {
3586 if (!ParseUint(option.substr(strlen("--addr2instr=")).data(), &addr2instr_)) {
3587 *error_msg = "Address conversion failed";
3588 return kParseError;
3589 }
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003590 } else if (option.starts_with("--app-image=")) {
3591 app_image_ = option.substr(strlen("--app-image=")).data();
3592 } else if (option.starts_with("--app-oat=")) {
3593 app_oat_ = option.substr(strlen("--app-oat=")).data();
Andreas Gampe9fded872016-09-25 16:08:35 -07003594 } else if (option.starts_with("--dump-imt=")) {
3595 imt_dump_ = option.substr(strlen("--dump-imt=")).data();
3596 } else if (option == "--dump-imt-stats") {
3597 imt_stat_dump_ = true;
Igor Murashkin37743352014-11-13 14:38:00 -08003598 } else {
3599 return kParseUnknownArgument;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003600 }
3601
Igor Murashkin37743352014-11-13 14:38:00 -08003602 return kParseOk;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003603 }
3604
Igor Murashkin37743352014-11-13 14:38:00 -08003605 virtual ParseStatus ParseChecks(std::string* error_msg) OVERRIDE {
3606 // Infer boot image location from the image location if possible.
3607 if (boot_image_location_ == nullptr) {
3608 boot_image_location_ = image_location_;
3609 }
3610
3611 // Perform the parent checks.
3612 ParseStatus parent_checks = Base::ParseChecks(error_msg);
3613 if (parent_checks != kParseOk) {
3614 return parent_checks;
3615 }
3616
3617 // Perform our own checks.
3618 if (image_location_ == nullptr && oat_filename_ == nullptr) {
3619 *error_msg = "Either --image or --oat-file must be specified";
3620 return kParseError;
3621 } else if (image_location_ != nullptr && oat_filename_ != nullptr) {
3622 *error_msg = "Either --image or --oat-file must be specified but not both";
3623 return kParseError;
3624 }
3625
3626 return kParseOk;
3627 }
3628
3629 virtual std::string GetUsage() const {
3630 std::string usage;
3631
3632 usage +=
3633 "Usage: oatdump [options] ...\n"
3634 " Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art\n"
3635 " Example: adb shell oatdump --image=/system/framework/boot.art\n"
3636 "\n"
3637 // Either oat-file or image is required.
3638 " --oat-file=<file.oat>: specifies an input oat filename.\n"
3639 " Example: --oat-file=/system/framework/boot.oat\n"
3640 "\n"
3641 " --image=<file.art>: specifies an input image location.\n"
3642 " Example: --image=/system/framework/boot.art\n"
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003643 "\n"
3644 " --app-image=<file.art>: specifies an input app image. Must also have a specified\n"
Roland Levillain4f1c9e62017-06-28 16:44:30 +01003645 " boot image (with --image) and app oat file (with --app-oat).\n"
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003646 " Example: --app-image=app.art\n"
3647 "\n"
3648 " --app-oat=<file.odex>: specifies an input app oat.\n"
3649 " Example: --app-oat=app.odex\n"
Igor Murashkin37743352014-11-13 14:38:00 -08003650 "\n";
3651
3652 usage += Base::GetUsage();
3653
3654 usage += // Optional.
Igor Murashkin37743352014-11-13 14:38:00 -08003655 " --no-dump:vmap may be used to disable vmap dumping.\n"
3656 " Example: --no-dump:vmap\n"
3657 "\n"
Roland Levillainf2650d12015-05-28 14:53:28 +01003658 " --dump:code_info_stack_maps enables dumping of stack maps in CodeInfo sections.\n"
3659 " Example: --dump:code_info_stack_maps\n"
3660 "\n"
Igor Murashkin37743352014-11-13 14:38:00 -08003661 " --no-disassemble may be used to disable disassembly.\n"
3662 " Example: --no-disassemble\n"
3663 "\n"
David Brazdilc03d7b62016-03-02 12:18:03 +00003664 " --header-only may be used to print only the oat header.\n"
3665 " Example: --header-only\n"
3666 "\n"
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003667 " --list-classes may be used to list target file classes (can be used with filters).\n"
3668 " Example: --list-classes\n"
3669 " Example: --list-classes --class-filter=com.example.foo\n"
3670 "\n"
3671 " --list-methods may be used to list target file methods (can be used with filters).\n"
3672 " Example: --list-methods\n"
3673 " Example: --list-methods --class-filter=com.example --method-filter=foo\n"
3674 "\n"
3675 " --symbolize=<file.oat>: output a copy of file.oat with elf symbols included.\n"
3676 " Example: --symbolize=/system/framework/boot.oat\n"
3677 "\n"
David Srbecky2fdd03c2016-03-10 15:32:37 +00003678 " --only-keep-debug<file.oat>: Modifies the behaviour of --symbolize so that\n"
3679 " .rodata and .text sections are omitted in the output file to save space.\n"
3680 " Example: --symbolize=/system/framework/boot.oat --only-keep-debug\n"
3681 "\n"
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003682 " --class-filter=<class name>: only dumps classes that contain the filter.\n"
3683 " Example: --class-filter=com.example.foo\n"
3684 "\n"
Igor Murashkin37743352014-11-13 14:38:00 -08003685 " --method-filter=<method name>: only dumps methods that contain the filter.\n"
3686 " Example: --method-filter=foo\n"
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003687 "\n"
3688 " --export-dex-to=<directory>: may be used to export oat embedded dex files.\n"
3689 " Example: --export-dex-to=/data/local/tmp\n"
3690 "\n"
3691 " --addr2instr=<address>: output matching method disassembled code from relative\n"
3692 " address (e.g. PC from crash dump)\n"
3693 " Example: --addr2instr=0x00001a3b\n"
Andreas Gampe9fded872016-09-25 16:08:35 -07003694 "\n"
3695 " --dump-imt=<file.txt>: output IMT collisions (if any) for the given receiver\n"
3696 " types and interface methods in the given file. The file\n"
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003697 " is read line-wise, where each line should either be a class\n"
Andreas Gampe9fded872016-09-25 16:08:35 -07003698 " name or descriptor, or a class name/descriptor and a prefix\n"
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003699 " of a complete method name (separated by a whitespace).\n"
Andreas Gampe9fded872016-09-25 16:08:35 -07003700 " Example: --dump-imt=imt.txt\n"
3701 "\n"
3702 " --dump-imt-stats: output IMT statistics for the given boot image\n"
3703 " Example: --dump-imt-stats"
Igor Murashkin37743352014-11-13 14:38:00 -08003704 "\n";
3705
3706 return usage;
3707 }
3708
3709 public:
Andreas Gampe00b25f32014-09-17 21:49:05 -07003710 const char* oat_filename_ = nullptr;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003711 const char* class_filter_ = "";
Nicolas Geoffray3fcd2202014-11-12 18:02:36 +00003712 const char* method_filter_ = "";
Andreas Gampe00b25f32014-09-17 21:49:05 -07003713 const char* image_location_ = nullptr;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003714 std::string elf_filename_prefix_;
Andreas Gampe9fded872016-09-25 16:08:35 -07003715 std::string imt_dump_;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003716 bool dump_vmap_ = true;
Roland Levillainf2650d12015-05-28 14:53:28 +01003717 bool dump_code_info_stack_maps_ = false;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003718 bool disassemble_code_ = true;
3719 bool symbolize_ = false;
David Srbecky2fdd03c2016-03-10 15:32:37 +00003720 bool only_keep_debug_ = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003721 bool list_classes_ = false;
3722 bool list_methods_ = false;
David Brazdilc03d7b62016-03-02 12:18:03 +00003723 bool dump_header_only_ = false;
Andreas Gampe9fded872016-09-25 16:08:35 -07003724 bool imt_stat_dump_ = false;
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003725 uint32_t addr2instr_ = 0;
3726 const char* export_dex_location_ = nullptr;
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003727 const char* app_image_ = nullptr;
3728 const char* app_oat_ = nullptr;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003729};
3730
Igor Murashkin37743352014-11-13 14:38:00 -08003731struct OatdumpMain : public CmdlineMain<OatdumpArgs> {
3732 virtual bool NeedsRuntime() OVERRIDE {
3733 CHECK(args_ != nullptr);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003734
Igor Murashkin37743352014-11-13 14:38:00 -08003735 // If we are only doing the oat file, disable absolute_addresses. Keep them for image dumping.
3736 bool absolute_addresses = (args_->oat_filename_ == nullptr);
3737
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003738 oat_dumper_options_.reset(new OatDumperOptions(
Igor Murashkin37743352014-11-13 14:38:00 -08003739 args_->dump_vmap_,
Roland Levillainf2650d12015-05-28 14:53:28 +01003740 args_->dump_code_info_stack_maps_,
Igor Murashkin37743352014-11-13 14:38:00 -08003741 args_->disassemble_code_,
3742 absolute_addresses,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003743 args_->class_filter_,
3744 args_->method_filter_,
3745 args_->list_classes_,
3746 args_->list_methods_,
David Brazdilc03d7b62016-03-02 12:18:03 +00003747 args_->dump_header_only_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003748 args_->export_dex_location_,
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003749 args_->app_image_,
3750 args_->app_oat_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003751 args_->addr2instr_));
Igor Murashkin37743352014-11-13 14:38:00 -08003752
Andreas Gampe9fded872016-09-25 16:08:35 -07003753 return (args_->boot_image_location_ != nullptr ||
3754 args_->image_location_ != nullptr ||
3755 !args_->imt_dump_.empty()) &&
Igor Murashkin37743352014-11-13 14:38:00 -08003756 !args_->symbolize_;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003757 }
3758
Igor Murashkin37743352014-11-13 14:38:00 -08003759 virtual bool ExecuteWithoutRuntime() OVERRIDE {
3760 CHECK(args_ != nullptr);
Andreas Gampec24f3992014-12-17 20:40:11 -08003761 CHECK(args_->oat_filename_ != nullptr);
Andreas Gampe00b25f32014-09-17 21:49:05 -07003762
Mathieu Chartierd424d082014-10-15 10:31:46 -07003763 MemMap::Init();
Igor Murashkin37743352014-11-13 14:38:00 -08003764
Andreas Gampec24f3992014-12-17 20:40:11 -08003765 if (args_->symbolize_) {
David Srbecky2fdd03c2016-03-10 15:32:37 +00003766 // ELF has special kind of section called SHT_NOBITS which allows us to create
3767 // sections which exist but their data is omitted from the ELF file to save space.
3768 // This is what "strip --only-keep-debug" does when it creates separate ELF file
3769 // with only debug data. We use it in similar way to exclude .rodata and .text.
3770 bool no_bits = args_->only_keep_debug_;
3771 return SymbolizeOat(args_->oat_filename_, args_->output_name_, no_bits) == EXIT_SUCCESS;
Andreas Gampec24f3992014-12-17 20:40:11 -08003772 } else {
3773 return DumpOat(nullptr,
3774 args_->oat_filename_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003775 oat_dumper_options_.get(),
Andreas Gampec24f3992014-12-17 20:40:11 -08003776 args_->os_) == EXIT_SUCCESS;
3777 }
Andreas Gampe00b25f32014-09-17 21:49:05 -07003778 }
3779
Igor Murashkin37743352014-11-13 14:38:00 -08003780 virtual bool ExecuteWithRuntime(Runtime* runtime) {
3781 CHECK(args_ != nullptr);
3782
Andreas Gampeebfc1ac2016-09-29 19:50:27 -07003783 if (!args_->imt_dump_.empty() || args_->imt_stat_dump_) {
3784 return IMTDumper::Dump(runtime,
3785 args_->imt_dump_,
3786 args_->imt_stat_dump_,
3787 args_->oat_filename_);
Andreas Gampe9fded872016-09-25 16:08:35 -07003788 }
3789
Igor Murashkin37743352014-11-13 14:38:00 -08003790 if (args_->oat_filename_ != nullptr) {
3791 return DumpOat(runtime,
3792 args_->oat_filename_,
Anestis Bechtsoudis32f500d2015-02-22 22:32:57 -08003793 oat_dumper_options_.get(),
Igor Murashkin37743352014-11-13 14:38:00 -08003794 args_->os_) == EXIT_SUCCESS;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003795 }
Igor Murashkin37743352014-11-13 14:38:00 -08003796
Mathieu Chartier0b4cbd02016-03-08 16:49:58 -08003797 return DumpImages(runtime, oat_dumper_options_.get(), args_->os_) == EXIT_SUCCESS;
Andreas Gampe00b25f32014-09-17 21:49:05 -07003798 }
3799
Igor Murashkin37743352014-11-13 14:38:00 -08003800 std::unique_ptr<OatDumperOptions> oat_dumper_options_;
3801};
Andreas Gampe00b25f32014-09-17 21:49:05 -07003802
Brian Carlstrom7934ac22013-07-26 10:54:15 -07003803} // namespace art
Brian Carlstrom78128a62011-09-15 17:21:19 -07003804
3805int main(int argc, char** argv) {
Igor Murashkin37743352014-11-13 14:38:00 -08003806 art::OatdumpMain main;
3807 return main.Main(argc, argv);
Brian Carlstrom78128a62011-09-15 17:21:19 -07003808}