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