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