oatdump.cc revision 20d3eae6bd65bea5206e57acab8145956e36ab08
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 <string> 23#include <unordered_map> 24#include <vector> 25 26#include "base/stringpiece.h" 27#include "base/unix_file/fd_file.h" 28#include "class_linker.h" 29#include "class_linker-inl.h" 30#include "dex_file-inl.h" 31#include "dex_instruction.h" 32#include "disassembler.h" 33#include "elf_builder.h" 34#include "field_helper.h" 35#include "gc_map.h" 36#include "gc/space/image_space.h" 37#include "gc/space/large_object_space.h" 38#include "gc/space/space-inl.h" 39#include "image.h" 40#include "indenter.h" 41#include "mapping_table.h" 42#include "mirror/art_field-inl.h" 43#include "mirror/art_method-inl.h" 44#include "mirror/array-inl.h" 45#include "mirror/class-inl.h" 46#include "mirror/object-inl.h" 47#include "mirror/object_array-inl.h" 48#include "noop_compiler_callbacks.h" 49#include "oat.h" 50#include "oat_file-inl.h" 51#include "os.h" 52#include "output_stream.h" 53#include "runtime.h" 54#include "safe_map.h" 55#include "scoped_thread_state_change.h" 56#include "thread_list.h" 57#include "verifier/dex_gc_map.h" 58#include "verifier/method_verifier.h" 59#include "vmap_table.h" 60 61namespace art { 62 63static void usage() { 64 fprintf(stderr, 65 "Usage: oatdump [options] ...\n" 66 " Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art\n" 67 " Example: adb shell oatdump --image=/system/framework/boot.art\n" 68 "\n"); 69 fprintf(stderr, 70 " --oat-file=<file.oat>: specifies an input oat filename.\n" 71 " Example: --oat-file=/system/framework/boot.oat\n" 72 "\n"); 73 fprintf(stderr, 74 " --image=<file.art>: specifies an input image filename.\n" 75 " Example: --image=/system/framework/boot.art\n" 76 "\n"); 77 fprintf(stderr, 78 " --boot-image=<file.art>: provide the image file for the boot class path.\n" 79 " Example: --boot-image=/system/framework/boot.art\n" 80 "\n"); 81 fprintf(stderr, 82 " --instruction-set=(arm|arm64|mips|x86|x86_64): for locating the image\n" 83 " file based on the image location set.\n" 84 " Example: --instruction-set=x86\n" 85 " Default: %s\n" 86 "\n", 87 GetInstructionSetString(kRuntimeISA)); 88 fprintf(stderr, 89 " --output=<file> may be used to send the output to a file.\n" 90 " Example: --output=/tmp/oatdump.txt\n" 91 "\n"); 92 fprintf(stderr, 93 " --dump:raw_mapping_table enables dumping of the mapping table.\n" 94 " Example: --dump:raw_mapping_table\n" 95 "\n"); 96 fprintf(stderr, 97 " --dump:raw_mapping_table enables dumping of the GC map.\n" 98 " Example: --dump:raw_gc_map\n" 99 "\n"); 100 fprintf(stderr, 101 " --no-dump:vmap may be used to disable vmap dumping.\n" 102 " Example: --no-dump:vmap\n" 103 "\n"); 104 fprintf(stderr, 105 " --no-disassemble may be used to disable disassembly.\n" 106 " Example: --no-disassemble\n" 107 "\n"); 108 exit(EXIT_FAILURE); 109} 110 111const char* image_roots_descriptions_[] = { 112 "kResolutionMethod", 113 "kImtConflictMethod", 114 "kDefaultImt", 115 "kCalleeSaveMethod", 116 "kRefsOnlySaveMethod", 117 "kRefsAndArgsSaveMethod", 118 "kDexCaches", 119 "kClassRoots", 120}; 121 122class OatSymbolizer : public CodeOutput { 123 public: 124 explicit OatSymbolizer(const OatFile* oat_file, std::string& output_name) : 125 oat_file_(oat_file), builder_(nullptr), elf_output_(nullptr), output_name_(output_name) {} 126 127 bool Init() { 128 Elf32_Word oat_data_size = oat_file_->GetOatHeader().GetExecutableOffset(); 129 130 uint32_t diff = static_cast<uint32_t>(oat_file_->End() - oat_file_->Begin()); 131 uint32_t oat_exec_size = diff - oat_data_size; 132 133 if (output_name_.empty()) { 134 output_name_ = "symbolized.oat"; 135 } 136 elf_output_ = OS::CreateEmptyFile(output_name_.c_str()); 137 138 builder_.reset(new ElfBuilder<Elf32_Word, Elf32_Sword, Elf32_Addr, Elf32_Dyn, 139 Elf32_Sym, Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr>( 140 this, 141 elf_output_, 142 oat_file_->GetOatHeader().GetInstructionSet(), 143 0, 144 oat_data_size, 145 oat_data_size, 146 oat_exec_size, 147 true, 148 false)); 149 150 if (!builder_->Init()) { 151 builder_.reset(nullptr); 152 return false; 153 } 154 155 return true; 156 } 157 158 typedef void (OatSymbolizer::*Callback)(const DexFile::ClassDef&, 159 uint32_t, 160 const OatFile::OatMethod&, 161 const DexFile&, 162 uint32_t, 163 const DexFile::CodeItem*, 164 uint32_t); 165 166 bool Symbolize() { 167 if (builder_.get() == nullptr) { 168 return false; 169 } 170 171 Walk(&art::OatSymbolizer::RegisterForDedup); 172 173 NormalizeState(); 174 175 Walk(&art::OatSymbolizer::AddSymbol); 176 177 bool result = builder_->Write(); 178 179 elf_output_->Flush(); 180 elf_output_->Close(); 181 182 return result; 183 } 184 185 void Walk(Callback callback) { 186 std::vector<const OatFile::OatDexFile*> oat_dex_files = oat_file_->GetOatDexFiles(); 187 for (size_t i = 0; i < oat_dex_files.size(); i++) { 188 const OatFile::OatDexFile* oat_dex_file = oat_dex_files[i]; 189 CHECK(oat_dex_file != NULL); 190 WalkOatDexFile(oat_dex_file, callback); 191 } 192 } 193 194 void WalkOatDexFile(const OatFile::OatDexFile* oat_dex_file, Callback callback) { 195 std::string error_msg; 196 std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg)); 197 if (dex_file.get() == nullptr) { 198 return; 199 } 200 for (size_t class_def_index = 0; 201 class_def_index < dex_file->NumClassDefs(); 202 class_def_index++) { 203 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index); 204 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index); 205 OatClassType type = oat_class.GetType(); 206 switch (type) { 207 case kOatClassAllCompiled: 208 case kOatClassSomeCompiled: 209 WalkOatClass(oat_class, *dex_file.get(), class_def, callback); 210 break; 211 212 case kOatClassNoneCompiled: 213 case kOatClassMax: 214 // Ignore. 215 break; 216 } 217 } 218 } 219 220 void WalkOatClass(const OatFile::OatClass& oat_class, const DexFile& dex_file, 221 const DexFile::ClassDef& class_def, Callback callback) { 222 const byte* class_data = dex_file.GetClassData(class_def); 223 if (class_data == nullptr) { // empty class such as a marker interface? 224 return; 225 } 226 // Note: even if this is an interface or a native class, we still have to walk it, as there 227 // might be a static initializer. 228 ClassDataItemIterator it(dex_file, class_data); 229 SkipAllFields(&it); 230 uint32_t class_method_idx = 0; 231 while (it.HasNextDirectMethod()) { 232 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx); 233 WalkOatMethod(class_def, class_method_idx, oat_method, dex_file, it.GetMemberIndex(), 234 it.GetMethodCodeItem(), it.GetMethodAccessFlags(), callback); 235 class_method_idx++; 236 it.Next(); 237 } 238 while (it.HasNextVirtualMethod()) { 239 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx); 240 WalkOatMethod(class_def, class_method_idx, oat_method, dex_file, it.GetMemberIndex(), 241 it.GetMethodCodeItem(), it.GetMethodAccessFlags(), callback); 242 class_method_idx++; 243 it.Next(); 244 } 245 DCHECK(!it.HasNext()); 246 } 247 248 void WalkOatMethod(const DexFile::ClassDef& class_def, uint32_t class_method_index, 249 const OatFile::OatMethod& oat_method, const DexFile& dex_file, 250 uint32_t dex_method_idx, const DexFile::CodeItem* code_item, 251 uint32_t method_access_flags, Callback callback) { 252 if ((method_access_flags & kAccAbstract) != 0) { 253 // Abstract method, no code. 254 return; 255 } 256 if (oat_method.GetCodeOffset() == 0) { 257 // No code. 258 return; 259 } 260 261 (this->*callback)(class_def, class_method_index, oat_method, dex_file, dex_method_idx, code_item, 262 method_access_flags); 263 } 264 265 void RegisterForDedup(const DexFile::ClassDef& class_def, uint32_t class_method_index, 266 const OatFile::OatMethod& oat_method, const DexFile& dex_file, 267 uint32_t dex_method_idx, const DexFile::CodeItem* code_item, 268 uint32_t method_access_flags) { 269 state_[oat_method.GetCodeOffset()]++; 270 } 271 272 void NormalizeState() { 273 for (auto& x : state_) { 274 if (x.second == 1) { 275 state_[x.first] = 0; 276 } 277 } 278 } 279 280 enum class DedupState { // private 281 kNotDeduplicated, 282 kDeduplicatedFirst, 283 kDeduplicatedOther 284 }; 285 DedupState IsDuplicated(uint32_t offset) { 286 if (state_[offset] == 0) { 287 return DedupState::kNotDeduplicated; 288 } 289 if (state_[offset] == 1) { 290 return DedupState::kDeduplicatedOther; 291 } 292 state_[offset] = 1; 293 return DedupState::kDeduplicatedFirst; 294 } 295 296 void AddSymbol(const DexFile::ClassDef& class_def, uint32_t class_method_index, 297 const OatFile::OatMethod& oat_method, const DexFile& dex_file, 298 uint32_t dex_method_idx, const DexFile::CodeItem* code_item, 299 uint32_t method_access_flags) { 300 DedupState dedup = IsDuplicated(oat_method.GetCodeOffset()); 301 if (dedup != DedupState::kDeduplicatedOther) { 302 std::string pretty_name = PrettyMethod(dex_method_idx, dex_file, true); 303 304 if (dedup == DedupState::kDeduplicatedFirst) { 305 pretty_name = "[Dedup]" + pretty_name; 306 } 307 308 ElfSymtabBuilder<Elf32_Word, Elf32_Sword, Elf32_Addr, 309 Elf32_Sym, Elf32_Shdr>* symtab = &builder_->symtab_builder_; 310 311 symtab->AddSymbol(pretty_name, &builder_->text_builder_, oat_method.GetCodeOffset() - 312 oat_file_->GetOatHeader().GetExecutableOffset(), true, 313 oat_method.GetQuickCodeSize(), STB_GLOBAL, STT_FUNC); 314 } 315 } 316 317 // Write oat code. Required by ElfBuilder/CodeOutput. 318 bool Write(OutputStream* out) { 319 return out->WriteFully(oat_file_->Begin(), oat_file_->End() - oat_file_->Begin()); 320 } 321 322 private: 323 static void SkipAllFields(ClassDataItemIterator* it) { 324 while (it->HasNextStaticField()) { 325 it->Next(); 326 } 327 while (it->HasNextInstanceField()) { 328 it->Next(); 329 } 330 } 331 332 const OatFile* oat_file_; 333 std::unique_ptr<ElfBuilder<Elf32_Word, Elf32_Sword, Elf32_Addr, Elf32_Dyn, 334 Elf32_Sym, Elf32_Ehdr, Elf32_Phdr, Elf32_Shdr> > builder_; 335 File* elf_output_; 336 std::unordered_map<uint32_t, uint32_t> state_; 337 std::string output_name_; 338}; 339 340class OatDumperOptions { 341 public: 342 OatDumperOptions(bool dump_raw_mapping_table, 343 bool dump_raw_gc_map, 344 bool dump_vmap, 345 bool disassemble_code, 346 bool absolute_addresses) 347 : dump_raw_mapping_table_(dump_raw_mapping_table), 348 dump_raw_gc_map_(dump_raw_gc_map), 349 dump_vmap_(dump_vmap), 350 disassemble_code_(disassemble_code), 351 absolute_addresses_(absolute_addresses) {} 352 353 const bool dump_raw_mapping_table_; 354 const bool dump_raw_gc_map_; 355 const bool dump_vmap_; 356 const bool disassemble_code_; 357 const bool absolute_addresses_; 358}; 359 360class OatDumper { 361 public: 362 explicit OatDumper(const OatFile& oat_file, OatDumperOptions* options) 363 : oat_file_(oat_file), 364 oat_dex_files_(oat_file.GetOatDexFiles()), 365 options_(options), 366 disassembler_(Disassembler::Create(oat_file_.GetOatHeader().GetInstructionSet(), 367 new DisassemblerOptions(options_->absolute_addresses_, 368 oat_file.Begin()))) { 369 AddAllOffsets(); 370 } 371 372 ~OatDumper() { 373 delete options_; 374 delete disassembler_; 375 } 376 377 bool Dump(std::ostream& os) { 378 bool success = true; 379 const OatHeader& oat_header = oat_file_.GetOatHeader(); 380 381 os << "MAGIC:\n"; 382 os << oat_header.GetMagic() << "\n\n"; 383 384 os << "CHECKSUM:\n"; 385 os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum()); 386 387 os << "INSTRUCTION SET:\n"; 388 os << oat_header.GetInstructionSet() << "\n\n"; 389 390 os << "INSTRUCTION SET FEATURES:\n"; 391 os << oat_header.GetInstructionSetFeatures().GetFeatureString() << "\n\n"; 392 393 os << "DEX FILE COUNT:\n"; 394 os << oat_header.GetDexFileCount() << "\n\n"; 395 396#define DUMP_OAT_HEADER_OFFSET(label, offset) \ 397 os << label " OFFSET:\n"; \ 398 os << StringPrintf("0x%08x", oat_header.offset()); \ 399 if (oat_header.offset() != 0 && options_->absolute_addresses_) { \ 400 os << StringPrintf(" (%p)", oat_file_.Begin() + oat_header.offset()); \ 401 } \ 402 os << StringPrintf("\n\n"); 403 404 DUMP_OAT_HEADER_OFFSET("EXECUTABLE", GetExecutableOffset); 405 DUMP_OAT_HEADER_OFFSET("INTERPRETER TO INTERPRETER BRIDGE", 406 GetInterpreterToInterpreterBridgeOffset); 407 DUMP_OAT_HEADER_OFFSET("INTERPRETER TO COMPILED CODE BRIDGE", 408 GetInterpreterToCompiledCodeBridgeOffset); 409 DUMP_OAT_HEADER_OFFSET("JNI DLSYM LOOKUP", 410 GetJniDlsymLookupOffset); 411 DUMP_OAT_HEADER_OFFSET("PORTABLE IMT CONFLICT TRAMPOLINE", 412 GetPortableImtConflictTrampolineOffset); 413 DUMP_OAT_HEADER_OFFSET("PORTABLE RESOLUTION TRAMPOLINE", 414 GetPortableResolutionTrampolineOffset); 415 DUMP_OAT_HEADER_OFFSET("PORTABLE TO INTERPRETER BRIDGE", 416 GetPortableToInterpreterBridgeOffset); 417 DUMP_OAT_HEADER_OFFSET("QUICK GENERIC JNI TRAMPOLINE", 418 GetQuickGenericJniTrampolineOffset); 419 DUMP_OAT_HEADER_OFFSET("QUICK IMT CONFLICT TRAMPOLINE", 420 GetQuickImtConflictTrampolineOffset); 421 DUMP_OAT_HEADER_OFFSET("QUICK RESOLUTION TRAMPOLINE", 422 GetQuickResolutionTrampolineOffset); 423 DUMP_OAT_HEADER_OFFSET("QUICK TO INTERPRETER BRIDGE", 424 GetQuickToInterpreterBridgeOffset); 425#undef DUMP_OAT_HEADER_OFFSET 426 427 os << "IMAGE PATCH DELTA:\n"; 428 os << StringPrintf("%d (0x%08x)\n\n", 429 oat_header.GetImagePatchDelta(), 430 oat_header.GetImagePatchDelta()); 431 432 os << "IMAGE FILE LOCATION OAT CHECKSUM:\n"; 433 os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatChecksum()); 434 435 os << "IMAGE FILE LOCATION OAT BEGIN:\n"; 436 os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatDataBegin()); 437 438 // Print the key-value store. 439 { 440 os << "KEY VALUE STORE:\n"; 441 size_t index = 0; 442 const char* key; 443 const char* value; 444 while (oat_header.GetStoreKeyValuePairByIndex(index, &key, &value)) { 445 os << key << " = " << value << "\n"; 446 index++; 447 } 448 os << "\n"; 449 } 450 451 if (options_->absolute_addresses_) { 452 os << "BEGIN:\n"; 453 os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n"; 454 455 os << "END:\n"; 456 os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n"; 457 } 458 459 os << "SIZE:\n"; 460 os << oat_file_.Size() << "\n\n"; 461 462 os << std::flush; 463 464 for (size_t i = 0; i < oat_dex_files_.size(); i++) { 465 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i]; 466 CHECK(oat_dex_file != nullptr); 467 if (!DumpOatDexFile(os, *oat_dex_file)) { 468 success = false; 469 } 470 } 471 os << std::flush; 472 return success; 473 } 474 475 size_t ComputeSize(const void* oat_data) { 476 if (reinterpret_cast<const byte*>(oat_data) < oat_file_.Begin() || 477 reinterpret_cast<const byte*>(oat_data) > oat_file_.End()) { 478 return 0; // Address not in oat file 479 } 480 uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) - 481 reinterpret_cast<uintptr_t>(oat_file_.Begin()); 482 auto it = offsets_.upper_bound(begin_offset); 483 CHECK(it != offsets_.end()); 484 uintptr_t end_offset = *it; 485 return end_offset - begin_offset; 486 } 487 488 InstructionSet GetInstructionSet() { 489 return oat_file_.GetOatHeader().GetInstructionSet(); 490 } 491 492 const void* GetQuickOatCode(mirror::ArtMethod* m) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 493 for (size_t i = 0; i < oat_dex_files_.size(); i++) { 494 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i]; 495 CHECK(oat_dex_file != nullptr); 496 std::string error_msg; 497 std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg)); 498 if (dex_file.get() == nullptr) { 499 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation() 500 << "': " << error_msg; 501 } else { 502 const DexFile::ClassDef* class_def = 503 dex_file->FindClassDef(m->GetDeclaringClassDescriptor()); 504 if (class_def != nullptr) { 505 uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def); 506 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index); 507 size_t method_index = m->GetMethodIndex(); 508 return oat_class.GetOatMethod(method_index).GetQuickCode(); 509 } 510 } 511 } 512 return nullptr; 513 } 514 515 private: 516 void AddAllOffsets() { 517 // We don't know the length of the code for each method, but we need to know where to stop 518 // when disassembling. What we do know is that a region of code will be followed by some other 519 // region, so if we keep a sorted sequence of the start of each region, we can infer the length 520 // of a piece of code by using upper_bound to find the start of the next region. 521 for (size_t i = 0; i < oat_dex_files_.size(); i++) { 522 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i]; 523 CHECK(oat_dex_file != nullptr); 524 std::string error_msg; 525 std::unique_ptr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg)); 526 if (dex_file.get() == nullptr) { 527 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation() 528 << "': " << error_msg; 529 continue; 530 } 531 offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader())); 532 for (size_t class_def_index = 0; 533 class_def_index < dex_file->NumClassDefs(); 534 class_def_index++) { 535 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index); 536 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(class_def_index); 537 const byte* class_data = dex_file->GetClassData(class_def); 538 if (class_data != nullptr) { 539 ClassDataItemIterator it(*dex_file, class_data); 540 SkipAllFields(it); 541 uint32_t class_method_index = 0; 542 while (it.HasNextDirectMethod()) { 543 AddOffsets(oat_class.GetOatMethod(class_method_index++)); 544 it.Next(); 545 } 546 while (it.HasNextVirtualMethod()) { 547 AddOffsets(oat_class.GetOatMethod(class_method_index++)); 548 it.Next(); 549 } 550 } 551 } 552 } 553 554 // If the last thing in the file is code for a method, there won't be an offset for the "next" 555 // thing. Instead of having a special case in the upper_bound code, let's just add an entry 556 // for the end of the file. 557 offsets_.insert(oat_file_.Size()); 558 } 559 560 static uint32_t AlignCodeOffset(uint32_t maybe_thumb_offset) { 561 return maybe_thumb_offset & ~0x1; // TODO: Make this Thumb2 specific. 562 } 563 564 void AddOffsets(const OatFile::OatMethod& oat_method) { 565 uint32_t code_offset = oat_method.GetCodeOffset(); 566 if (oat_file_.GetOatHeader().GetInstructionSet() == kThumb2) { 567 code_offset &= ~0x1; 568 } 569 offsets_.insert(code_offset); 570 offsets_.insert(oat_method.GetMappingTableOffset()); 571 offsets_.insert(oat_method.GetVmapTableOffset()); 572 offsets_.insert(oat_method.GetNativeGcMapOffset()); 573 } 574 575 bool DumpOatDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) { 576 bool success = true; 577 os << "OatDexFile:\n"; 578 os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str()); 579 os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum()); 580 581 // Create the verifier early. 582 583 std::string error_msg; 584 std::unique_ptr<const DexFile> dex_file(oat_dex_file.OpenDexFile(&error_msg)); 585 if (dex_file.get() == nullptr) { 586 os << "NOT FOUND: " << error_msg << "\n\n"; 587 os << std::flush; 588 return false; 589 } 590 for (size_t class_def_index = 0; 591 class_def_index < dex_file->NumClassDefs(); 592 class_def_index++) { 593 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index); 594 const char* descriptor = dex_file->GetClassDescriptor(class_def); 595 uint32_t oat_class_offset = oat_dex_file.GetOatClassOffset(class_def_index); 596 const OatFile::OatClass oat_class = oat_dex_file.GetOatClass(class_def_index); 597 os << StringPrintf("%zd: %s (offset=0x%08x) (type_idx=%d)", 598 class_def_index, descriptor, oat_class_offset, class_def.class_idx_) 599 << " (" << oat_class.GetStatus() << ")" 600 << " (" << oat_class.GetType() << ")\n"; 601 // TODO: include bitmap here if type is kOatClassSomeCompiled? 602 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 603 std::ostream indented_os(&indent_filter); 604 if (!DumpOatClass(indented_os, oat_class, *(dex_file.get()), class_def)) { 605 success = false; 606 } 607 } 608 609 os << std::flush; 610 return success; 611 } 612 613 static void SkipAllFields(ClassDataItemIterator& it) { 614 while (it.HasNextStaticField()) { 615 it.Next(); 616 } 617 while (it.HasNextInstanceField()) { 618 it.Next(); 619 } 620 } 621 622 bool DumpOatClass(std::ostream& os, const OatFile::OatClass& oat_class, const DexFile& dex_file, 623 const DexFile::ClassDef& class_def) { 624 bool success = true; 625 const byte* class_data = dex_file.GetClassData(class_def); 626 if (class_data == nullptr) { // empty class such as a marker interface? 627 os << std::flush; 628 return success; 629 } 630 ClassDataItemIterator it(dex_file, class_data); 631 SkipAllFields(it); 632 uint32_t class_method_index = 0; 633 while (it.HasNextDirectMethod()) { 634 if (!DumpOatMethod(os, class_def, class_method_index, oat_class, dex_file, 635 it.GetMemberIndex(), it.GetMethodCodeItem(), 636 it.GetRawMemberAccessFlags())) { 637 success = false; 638 } 639 class_method_index++; 640 it.Next(); 641 } 642 while (it.HasNextVirtualMethod()) { 643 if (!DumpOatMethod(os, class_def, class_method_index, oat_class, dex_file, 644 it.GetMemberIndex(), it.GetMethodCodeItem(), 645 it.GetRawMemberAccessFlags())) { 646 success = false; 647 } 648 class_method_index++; 649 it.Next(); 650 } 651 DCHECK(!it.HasNext()); 652 os << std::flush; 653 return success; 654 } 655 656 static constexpr uint32_t kPrologueBytes = 16; 657 658 // When this was picked, the largest arm method was 55,256 bytes and arm64 was 50,412 bytes. 659 static constexpr uint32_t kMaxCodeSize = 100 * 1000; 660 661 bool DumpOatMethod(std::ostream& os, const DexFile::ClassDef& class_def, 662 uint32_t class_method_index, 663 const OatFile::OatClass& oat_class, const DexFile& dex_file, 664 uint32_t dex_method_idx, const DexFile::CodeItem* code_item, 665 uint32_t method_access_flags) { 666 bool success = true; 667 os << StringPrintf("%d: %s (dex_method_idx=%d)\n", 668 class_method_index, PrettyMethod(dex_method_idx, dex_file, true).c_str(), 669 dex_method_idx); 670 Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 671 std::unique_ptr<std::ostream> indent1_os(new std::ostream(&indent1_filter)); 672 Indenter indent2_filter(indent1_os->rdbuf(), kIndentChar, kIndentBy1Count); 673 std::unique_ptr<std::ostream> indent2_os(new std::ostream(&indent2_filter)); 674 { 675 *indent1_os << "DEX CODE:\n"; 676 DumpDexCode(*indent2_os, dex_file, code_item); 677 } 678 679 std::unique_ptr<verifier::MethodVerifier> verifier; 680 if (Runtime::Current() != nullptr) { 681 *indent1_os << "VERIFIER TYPE ANALYSIS:\n"; 682 verifier.reset(DumpVerifier(*indent2_os, dex_method_idx, &dex_file, class_def, code_item, 683 method_access_flags)); 684 } 685 686 uint32_t oat_method_offsets_offset = oat_class.GetOatMethodOffsetsOffset(class_method_index); 687 const OatMethodOffsets* oat_method_offsets = oat_class.GetOatMethodOffsets(class_method_index); 688 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_index); 689 { 690 *indent1_os << "OatMethodOffsets "; 691 if (options_->absolute_addresses_) { 692 *indent1_os << StringPrintf("%p ", oat_method_offsets); 693 } 694 *indent1_os << StringPrintf("(offset=0x%08x)\n", oat_method_offsets_offset); 695 if (oat_method_offsets_offset > oat_file_.Size()) { 696 *indent1_os << StringPrintf( 697 "WARNING: oat method offsets offset 0x%08x is past end of file 0x%08zx.\n", 698 oat_method_offsets_offset, oat_file_.Size()); 699 // If we can't read OatMethodOffsets, the rest of the data is dangerous to read. 700 os << std::flush; 701 return false; 702 } 703 704 uint32_t code_offset = oat_method.GetCodeOffset(); 705 *indent2_os << StringPrintf("code_offset: 0x%08x ", code_offset); 706 uint32_t aligned_code_begin = AlignCodeOffset(oat_method.GetCodeOffset()); 707 if (aligned_code_begin > oat_file_.Size()) { 708 *indent2_os << StringPrintf("WARNING: " 709 "code offset 0x%08x is past end of file 0x%08zx.\n", 710 aligned_code_begin, oat_file_.Size()); 711 success = false; 712 } 713 *indent2_os << "\n"; 714 715 *indent2_os << "gc_map: "; 716 if (options_->absolute_addresses_) { 717 *indent2_os << StringPrintf("%p ", oat_method.GetNativeGcMap()); 718 } 719 uint32_t gc_map_offset = oat_method.GetNativeGcMapOffset(); 720 *indent2_os << StringPrintf("(offset=0x%08x)\n", gc_map_offset); 721 if (gc_map_offset > oat_file_.Size()) { 722 *indent2_os << StringPrintf("WARNING: " 723 "gc map table offset 0x%08x is past end of file 0x%08zx.\n", 724 gc_map_offset, oat_file_.Size()); 725 success = false; 726 } else if (options_->dump_raw_gc_map_) { 727 Indenter indent3_filter(indent2_os->rdbuf(), kIndentChar, kIndentBy1Count); 728 std::ostream indent3_os(&indent3_filter); 729 DumpGcMap(indent3_os, oat_method, code_item); 730 } 731 } 732 { 733 *indent1_os << "OatQuickMethodHeader "; 734 uint32_t method_header_offset = oat_method.GetOatQuickMethodHeaderOffset(); 735 const OatQuickMethodHeader* method_header = oat_method.GetOatQuickMethodHeader(); 736 737 if (options_->absolute_addresses_) { 738 *indent1_os << StringPrintf("%p ", method_header); 739 } 740 *indent1_os << StringPrintf("(offset=0x%08x)\n", method_header_offset); 741 if (method_header_offset > oat_file_.Size()) { 742 *indent1_os << StringPrintf( 743 "WARNING: oat quick method header offset 0x%08x is past end of file 0x%08zx.\n", 744 method_header_offset, oat_file_.Size()); 745 // If we can't read the OatQuickMethodHeader, the rest of the data is dangerous to read. 746 os << std::flush; 747 return false; 748 } 749 750 *indent2_os << "mapping_table: "; 751 if (options_->absolute_addresses_) { 752 *indent2_os << StringPrintf("%p ", oat_method.GetMappingTable()); 753 } 754 uint32_t mapping_table_offset = oat_method.GetMappingTableOffset(); 755 *indent2_os << StringPrintf("(offset=0x%08x)\n", oat_method.GetMappingTableOffset()); 756 if (mapping_table_offset > oat_file_.Size()) { 757 *indent2_os << StringPrintf("WARNING: " 758 "mapping table offset 0x%08x is past end of file 0x%08zx. " 759 "mapping table offset was loaded from offset 0x%08x.\n", 760 mapping_table_offset, oat_file_.Size(), 761 oat_method.GetMappingTableOffsetOffset()); 762 success = false; 763 } else if (options_->dump_raw_mapping_table_) { 764 Indenter indent3_filter(indent2_os->rdbuf(), kIndentChar, kIndentBy1Count); 765 std::ostream indent3_os(&indent3_filter); 766 DumpMappingTable(indent3_os, oat_method); 767 } 768 769 *indent2_os << "vmap_table: "; 770 if (options_->absolute_addresses_) { 771 *indent2_os << StringPrintf("%p ", oat_method.GetVmapTable()); 772 } 773 uint32_t vmap_table_offset = oat_method.GetVmapTableOffset(); 774 *indent2_os << StringPrintf("(offset=0x%08x)\n", vmap_table_offset); 775 if (vmap_table_offset > oat_file_.Size()) { 776 *indent2_os << StringPrintf("WARNING: " 777 "vmap table offset 0x%08x is past end of file 0x%08zx. " 778 "vmap table offset was loaded from offset 0x%08x.\n", 779 vmap_table_offset, oat_file_.Size(), 780 oat_method.GetVmapTableOffsetOffset()); 781 success = false; 782 } else if (options_->dump_vmap_) { 783 DumpVmap(*indent2_os, oat_method); 784 } 785 } 786 { 787 *indent1_os << "QuickMethodFrameInfo\n"; 788 789 *indent2_os << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes()); 790 *indent2_os << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask()); 791 DumpSpillMask(*indent2_os, oat_method.GetCoreSpillMask(), false); 792 *indent2_os << "\n"; 793 *indent2_os << StringPrintf("fp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask()); 794 DumpSpillMask(*indent2_os, oat_method.GetFpSpillMask(), true); 795 *indent2_os << "\n"; 796 } 797 { 798 // Based on spill masks from QuickMethodFrameInfo so placed 799 // after it is dumped, but useful for understanding quick 800 // code, so dumped here. 801 DumpVregLocations(*indent2_os, oat_method, code_item); 802 } 803 { 804 *indent1_os << "CODE: "; 805 uint32_t code_size_offset = oat_method.GetQuickCodeSizeOffset(); 806 if (code_size_offset > oat_file_.Size()) { 807 *indent2_os << StringPrintf("WARNING: " 808 "code size offset 0x%08x is past end of file 0x%08zx.", 809 code_size_offset, oat_file_.Size()); 810 success = false; 811 } else { 812 const void* code = oat_method.GetQuickCode(); 813 uint32_t code_size = oat_method.GetQuickCodeSize(); 814 if (code == nullptr) { 815 code = oat_method.GetPortableCode(); 816 code_size = oat_method.GetPortableCodeSize(); 817 code_size_offset = 0; 818 } 819 uint32_t code_offset = oat_method.GetCodeOffset(); 820 uint32_t aligned_code_begin = AlignCodeOffset(code_offset); 821 uint64_t aligned_code_end = aligned_code_begin + code_size; 822 823 if (options_->absolute_addresses_) { 824 *indent1_os << StringPrintf("%p ", code); 825 } 826 *indent1_os << StringPrintf("(code_offset=0x%08x size_offset=0x%08x size=%u)%s\n", 827 code_offset, 828 code_size_offset, 829 code_size, 830 code != nullptr ? "..." : ""); 831 832 if (aligned_code_begin > oat_file_.Size()) { 833 *indent2_os << StringPrintf("WARNING: " 834 "start of code at 0x%08x is past end of file 0x%08zx.", 835 aligned_code_begin, oat_file_.Size()); 836 success = false; 837 } else if (aligned_code_end > oat_file_.Size()) { 838 *indent2_os << StringPrintf("WARNING: " 839 "end of code at 0x%08" PRIx64 " is past end of file 0x%08zx. " 840 "code size is 0x%08x loaded from offset 0x%08x.\n", 841 aligned_code_end, oat_file_.Size(), 842 code_size, code_size_offset); 843 success = false; 844 if (options_->disassemble_code_) { 845 if (code_size_offset + kPrologueBytes <= oat_file_.Size()) { 846 DumpCode(*indent2_os, verifier.get(), oat_method, code_item, true, kPrologueBytes); 847 } 848 } 849 } else if (code_size > kMaxCodeSize) { 850 *indent2_os << StringPrintf("WARNING: " 851 "code size %d is bigger than max expected threshold of %d. " 852 "code size is 0x%08x loaded from offset 0x%08x.\n", 853 code_size, kMaxCodeSize, 854 code_size, code_size_offset); 855 success = false; 856 if (options_->disassemble_code_) { 857 if (code_size_offset + kPrologueBytes <= oat_file_.Size()) { 858 DumpCode(*indent2_os, verifier.get(), oat_method, code_item, true, kPrologueBytes); 859 } 860 } 861 } else if (options_->disassemble_code_) { 862 DumpCode(*indent2_os, verifier.get(), oat_method, code_item, !success, 0); 863 } 864 } 865 } 866 os << std::flush; 867 return success; 868 } 869 870 void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) { 871 if (spill_mask == 0) { 872 return; 873 } 874 os << "("; 875 for (size_t i = 0; i < 32; i++) { 876 if ((spill_mask & (1 << i)) != 0) { 877 if (is_float) { 878 os << "fr" << i; 879 } else { 880 os << "r" << i; 881 } 882 spill_mask ^= 1 << i; // clear bit 883 if (spill_mask != 0) { 884 os << ", "; 885 } else { 886 break; 887 } 888 } 889 } 890 os << ")"; 891 } 892 893 void DumpVmap(std::ostream& os, const OatFile::OatMethod& oat_method) { 894 // If the native GC map is null, then this method has been compiled with the 895 // optimizing compiler. The optimizing compiler currently outputs its stack map 896 // in the vmap table, and the code below does not work with such a stack map. 897 if (oat_method.GetNativeGcMap() == nullptr) { 898 return; 899 } 900 const uint8_t* raw_table = oat_method.GetVmapTable(); 901 if (raw_table != nullptr) { 902 const VmapTable vmap_table(raw_table); 903 bool first = true; 904 bool processing_fp = false; 905 uint32_t spill_mask = oat_method.GetCoreSpillMask(); 906 for (size_t i = 0; i < vmap_table.Size(); i++) { 907 uint16_t dex_reg = vmap_table[i]; 908 uint32_t cpu_reg = vmap_table.ComputeRegister(spill_mask, i, 909 processing_fp ? kFloatVReg : kIntVReg); 910 os << (first ? "v" : ", v") << dex_reg; 911 if (!processing_fp) { 912 os << "/r" << cpu_reg; 913 } else { 914 os << "/fr" << cpu_reg; 915 } 916 first = false; 917 if (!processing_fp && dex_reg == 0xFFFF) { 918 processing_fp = true; 919 spill_mask = oat_method.GetFpSpillMask(); 920 } 921 } 922 os << "\n"; 923 } 924 } 925 926 void DumpVregLocations(std::ostream& os, const OatFile::OatMethod& oat_method, 927 const DexFile::CodeItem* code_item) { 928 if (code_item != nullptr) { 929 size_t num_locals_ins = code_item->registers_size_; 930 size_t num_ins = code_item->ins_size_; 931 size_t num_locals = num_locals_ins - num_ins; 932 size_t num_outs = code_item->outs_size_; 933 934 os << "vr_stack_locations:"; 935 for (size_t reg = 0; reg <= num_locals_ins; reg++) { 936 // For readability, delimit the different kinds of VRs. 937 if (reg == num_locals_ins) { 938 os << "\n\tmethod*:"; 939 } else if (reg == num_locals && num_ins > 0) { 940 os << "\n\tins:"; 941 } else if (reg == 0 && num_locals > 0) { 942 os << "\n\tlocals:"; 943 } 944 945 uint32_t offset = StackVisitor::GetVRegOffset(code_item, oat_method.GetCoreSpillMask(), 946 oat_method.GetFpSpillMask(), 947 oat_method.GetFrameSizeInBytes(), reg, 948 GetInstructionSet()); 949 os << " v" << reg << "[sp + #" << offset << "]"; 950 } 951 952 for (size_t out_reg = 0; out_reg < num_outs; out_reg++) { 953 if (out_reg == 0) { 954 os << "\n\touts:"; 955 } 956 957 uint32_t offset = StackVisitor::GetOutVROffset(out_reg, GetInstructionSet()); 958 os << " v" << out_reg << "[sp + #" << offset << "]"; 959 } 960 961 os << "\n"; 962 } 963 } 964 965 void DescribeVReg(std::ostream& os, const OatFile::OatMethod& oat_method, 966 const DexFile::CodeItem* code_item, size_t reg, VRegKind kind) { 967 const uint8_t* raw_table = oat_method.GetVmapTable(); 968 if (raw_table != nullptr) { 969 const VmapTable vmap_table(raw_table); 970 uint32_t vmap_offset; 971 if (vmap_table.IsInContext(reg, kind, &vmap_offset)) { 972 bool is_float = (kind == kFloatVReg) || (kind == kDoubleLoVReg) || (kind == kDoubleHiVReg); 973 uint32_t spill_mask = is_float ? oat_method.GetFpSpillMask() 974 : oat_method.GetCoreSpillMask(); 975 os << (is_float ? "fr" : "r") << vmap_table.ComputeRegister(spill_mask, vmap_offset, kind); 976 } else { 977 uint32_t offset = StackVisitor::GetVRegOffset(code_item, oat_method.GetCoreSpillMask(), 978 oat_method.GetFpSpillMask(), 979 oat_method.GetFrameSizeInBytes(), reg, 980 GetInstructionSet()); 981 os << "[sp + #" << offset << "]"; 982 } 983 } 984 } 985 986 void DumpGcMapRegisters(std::ostream& os, const OatFile::OatMethod& oat_method, 987 const DexFile::CodeItem* code_item, 988 size_t num_regs, const uint8_t* reg_bitmap) { 989 bool first = true; 990 for (size_t reg = 0; reg < num_regs; reg++) { 991 if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) { 992 if (first) { 993 os << " v" << reg << " ("; 994 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 995 os << ")"; 996 first = false; 997 } else { 998 os << ", v" << reg << " ("; 999 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 1000 os << ")"; 1001 } 1002 } 1003 } 1004 if (first) { 1005 os << "No registers in GC map\n"; 1006 } else { 1007 os << "\n"; 1008 } 1009 } 1010 void DumpGcMap(std::ostream& os, const OatFile::OatMethod& oat_method, 1011 const DexFile::CodeItem* code_item) { 1012 const uint8_t* gc_map_raw = oat_method.GetNativeGcMap(); 1013 if (gc_map_raw == nullptr) { 1014 return; // No GC map. 1015 } 1016 const void* quick_code = oat_method.GetQuickCode(); 1017 if (quick_code != nullptr) { 1018 NativePcOffsetToReferenceMap map(gc_map_raw); 1019 for (size_t entry = 0; entry < map.NumEntries(); entry++) { 1020 const uint8_t* native_pc = reinterpret_cast<const uint8_t*>(quick_code) + 1021 map.GetNativePcOffset(entry); 1022 os << StringPrintf("%p", native_pc); 1023 DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry)); 1024 } 1025 } else { 1026 const void* portable_code = oat_method.GetPortableCode(); 1027 CHECK(portable_code != nullptr); 1028 verifier::DexPcToReferenceMap map(gc_map_raw); 1029 for (size_t entry = 0; entry < map.NumEntries(); entry++) { 1030 uint32_t dex_pc = map.GetDexPc(entry); 1031 os << StringPrintf("0x%08x", dex_pc); 1032 DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry)); 1033 } 1034 } 1035 } 1036 1037 void DumpMappingTable(std::ostream& os, const OatFile::OatMethod& oat_method) { 1038 const void* quick_code = oat_method.GetQuickCode(); 1039 if (quick_code == nullptr) { 1040 return; 1041 } 1042 MappingTable table(oat_method.GetMappingTable()); 1043 if (table.TotalSize() != 0) { 1044 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1045 std::ostream indent_os(&indent_filter); 1046 if (table.PcToDexSize() != 0) { 1047 typedef MappingTable::PcToDexIterator It; 1048 os << "suspend point mappings {\n"; 1049 for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) { 1050 indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc()); 1051 } 1052 os << "}\n"; 1053 } 1054 if (table.DexToPcSize() != 0) { 1055 typedef MappingTable::DexToPcIterator It; 1056 os << "catch entry mappings {\n"; 1057 for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) { 1058 indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc()); 1059 } 1060 os << "}\n"; 1061 } 1062 } 1063 } 1064 1065 uint32_t DumpMappingAtOffset(std::ostream& os, const OatFile::OatMethod& oat_method, 1066 size_t offset, bool suspend_point_mapping) { 1067 MappingTable table(oat_method.GetMappingTable()); 1068 if (suspend_point_mapping && table.PcToDexSize() > 0) { 1069 typedef MappingTable::PcToDexIterator It; 1070 for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) { 1071 if (offset == cur.NativePcOffset()) { 1072 os << StringPrintf("suspend point dex PC: 0x%04x\n", cur.DexPc()); 1073 return cur.DexPc(); 1074 } 1075 } 1076 } else if (!suspend_point_mapping && table.DexToPcSize() > 0) { 1077 typedef MappingTable::DexToPcIterator It; 1078 for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) { 1079 if (offset == cur.NativePcOffset()) { 1080 os << StringPrintf("catch entry dex PC: 0x%04x\n", cur.DexPc()); 1081 return cur.DexPc(); 1082 } 1083 } 1084 } 1085 return DexFile::kDexNoIndex; 1086 } 1087 1088 void DumpGcMapAtNativePcOffset(std::ostream& os, const OatFile::OatMethod& oat_method, 1089 const DexFile::CodeItem* code_item, size_t native_pc_offset) { 1090 const uint8_t* gc_map_raw = oat_method.GetNativeGcMap(); 1091 if (gc_map_raw != nullptr) { 1092 NativePcOffsetToReferenceMap map(gc_map_raw); 1093 if (map.HasEntry(native_pc_offset)) { 1094 size_t num_regs = map.RegWidth() * 8; 1095 const uint8_t* reg_bitmap = map.FindBitMap(native_pc_offset); 1096 bool first = true; 1097 for (size_t reg = 0; reg < num_regs; reg++) { 1098 if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) { 1099 if (first) { 1100 os << "GC map objects: v" << reg << " ("; 1101 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 1102 os << ")"; 1103 first = false; 1104 } else { 1105 os << ", v" << reg << " ("; 1106 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 1107 os << ")"; 1108 } 1109 } 1110 } 1111 if (!first) { 1112 os << "\n"; 1113 } 1114 } 1115 } 1116 } 1117 1118 void DumpVRegsAtDexPc(std::ostream& os, verifier::MethodVerifier* verifier, 1119 const OatFile::OatMethod& oat_method, 1120 const DexFile::CodeItem* code_item, uint32_t dex_pc) { 1121 DCHECK(verifier != nullptr); 1122 std::vector<int32_t> kinds = verifier->DescribeVRegs(dex_pc); 1123 bool first = true; 1124 for (size_t reg = 0; reg < code_item->registers_size_; reg++) { 1125 VRegKind kind = static_cast<VRegKind>(kinds.at(reg * 2)); 1126 if (kind != kUndefined) { 1127 if (first) { 1128 os << "VRegs: v"; 1129 first = false; 1130 } else { 1131 os << ", v"; 1132 } 1133 os << reg << " ("; 1134 switch (kind) { 1135 case kImpreciseConstant: 1136 os << "Imprecise Constant: " << kinds.at((reg * 2) + 1) << ", "; 1137 DescribeVReg(os, oat_method, code_item, reg, kind); 1138 break; 1139 case kConstant: 1140 os << "Constant: " << kinds.at((reg * 2) + 1); 1141 break; 1142 default: 1143 DescribeVReg(os, oat_method, code_item, reg, kind); 1144 break; 1145 } 1146 os << ")"; 1147 } 1148 } 1149 if (!first) { 1150 os << "\n"; 1151 } 1152 } 1153 1154 1155 void DumpDexCode(std::ostream& os, const DexFile& dex_file, const DexFile::CodeItem* code_item) { 1156 if (code_item != nullptr) { 1157 size_t i = 0; 1158 while (i < code_item->insns_size_in_code_units_) { 1159 const Instruction* instruction = Instruction::At(&code_item->insns_[i]); 1160 os << StringPrintf("0x%04zx: %s\n", i, instruction->DumpString(&dex_file).c_str()); 1161 i += instruction->SizeInCodeUnits(); 1162 } 1163 } 1164 } 1165 1166 verifier::MethodVerifier* DumpVerifier(std::ostream& os, uint32_t dex_method_idx, 1167 const DexFile* dex_file, 1168 const DexFile::ClassDef& class_def, 1169 const DexFile::CodeItem* code_item, 1170 uint32_t method_access_flags) { 1171 if ((method_access_flags & kAccNative) == 0) { 1172 ScopedObjectAccess soa(Thread::Current()); 1173 StackHandleScope<1> hs(soa.Self()); 1174 Handle<mirror::DexCache> dex_cache( 1175 hs.NewHandle(Runtime::Current()->GetClassLinker()->FindDexCache(*dex_file))); 1176 return verifier::MethodVerifier::VerifyMethodAndDump(soa.Self(), os, dex_method_idx, dex_file, 1177 dex_cache, 1178 NullHandle<mirror::ClassLoader>(), 1179 &class_def, code_item, 1180 NullHandle<mirror::ArtMethod>(), 1181 method_access_flags); 1182 } 1183 1184 return nullptr; 1185 } 1186 1187 void DumpCode(std::ostream& os, verifier::MethodVerifier* verifier, 1188 const OatFile::OatMethod& oat_method, const DexFile::CodeItem* code_item, 1189 bool bad_input, size_t code_size) { 1190 const void* portable_code = oat_method.GetPortableCode(); 1191 const void* quick_code = oat_method.GetQuickCode(); 1192 1193 if (code_size == 0) { 1194 code_size = oat_method.GetQuickCodeSize(); 1195 } 1196 if ((code_size == 0) || ((portable_code == nullptr) && (quick_code == nullptr))) { 1197 os << "NO CODE!\n"; 1198 return; 1199 } else if (quick_code != nullptr) { 1200 const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code); 1201 size_t offset = 0; 1202 while (offset < code_size) { 1203 if (!bad_input) { 1204 DumpMappingAtOffset(os, oat_method, offset, false); 1205 } 1206 offset += disassembler_->Dump(os, quick_native_pc + offset); 1207 if (!bad_input) { 1208 uint32_t dex_pc = DumpMappingAtOffset(os, oat_method, offset, true); 1209 if (dex_pc != DexFile::kDexNoIndex) { 1210 DumpGcMapAtNativePcOffset(os, oat_method, code_item, offset); 1211 if (verifier != nullptr) { 1212 DumpVRegsAtDexPc(os, verifier, oat_method, code_item, dex_pc); 1213 } 1214 } 1215 } 1216 } 1217 } else { 1218 CHECK(portable_code != nullptr); 1219 CHECK_EQ(code_size, 0U); // TODO: disassembly of portable is currently not supported. 1220 } 1221 } 1222 1223 const OatFile& oat_file_; 1224 const std::vector<const OatFile::OatDexFile*> oat_dex_files_; 1225 const OatDumperOptions* options_; 1226 std::set<uintptr_t> offsets_; 1227 Disassembler* disassembler_; 1228}; 1229 1230class ImageDumper { 1231 public: 1232 explicit ImageDumper(std::ostream* os, gc::space::ImageSpace& image_space, 1233 const ImageHeader& image_header, OatDumperOptions* oat_dumper_options) 1234 : os_(os), 1235 image_space_(image_space), 1236 image_header_(image_header), 1237 oat_dumper_options_(oat_dumper_options) {} 1238 1239 bool Dump() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1240 std::ostream& os = *os_; 1241 os << "MAGIC: " << image_header_.GetMagic() << "\n\n"; 1242 1243 os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n"; 1244 1245 os << "IMAGE BITMAP OFFSET: " << reinterpret_cast<void*>(image_header_.GetImageBitmapOffset()) 1246 << " SIZE: " << reinterpret_cast<void*>(image_header_.GetImageBitmapSize()) << "\n\n"; 1247 1248 os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum()); 1249 1250 os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n"; 1251 1252 os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n"; 1253 1254 os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n"; 1255 1256 os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n"; 1257 1258 os << "PATCH DELTA:" << image_header_.GetPatchDelta() << "\n\n"; 1259 1260 { 1261 os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n"; 1262 Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1263 std::ostream indent1_os(&indent1_filter); 1264 CHECK_EQ(arraysize(image_roots_descriptions_), size_t(ImageHeader::kImageRootsMax)); 1265 for (int i = 0; i < ImageHeader::kImageRootsMax; i++) { 1266 ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i); 1267 const char* image_root_description = image_roots_descriptions_[i]; 1268 mirror::Object* image_root_object = image_header_.GetImageRoot(image_root); 1269 indent1_os << StringPrintf("%s: %p\n", image_root_description, image_root_object); 1270 if (image_root_object->IsObjectArray()) { 1271 Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count); 1272 std::ostream indent2_os(&indent2_filter); 1273 mirror::ObjectArray<mirror::Object>* image_root_object_array 1274 = image_root_object->AsObjectArray<mirror::Object>(); 1275 for (int i = 0; i < image_root_object_array->GetLength(); i++) { 1276 mirror::Object* value = image_root_object_array->Get(i); 1277 size_t run = 0; 1278 for (int32_t j = i + 1; j < image_root_object_array->GetLength(); j++) { 1279 if (value == image_root_object_array->Get(j)) { 1280 run++; 1281 } else { 1282 break; 1283 } 1284 } 1285 if (run == 0) { 1286 indent2_os << StringPrintf("%d: ", i); 1287 } else { 1288 indent2_os << StringPrintf("%d to %zd: ", i, i + run); 1289 i = i + run; 1290 } 1291 if (value != nullptr) { 1292 PrettyObjectValue(indent2_os, value->GetClass(), value); 1293 } else { 1294 indent2_os << i << ": null\n"; 1295 } 1296 } 1297 } 1298 } 1299 } 1300 os << "\n"; 1301 1302 ClassLinker* class_linker = Runtime::Current()->GetClassLinker(); 1303 std::string image_filename = image_space_.GetImageFilename(); 1304 std::string oat_location = ImageHeader::GetOatLocationFromImageLocation(image_filename); 1305 os << "OAT LOCATION: " << oat_location; 1306 os << "\n"; 1307 std::string error_msg; 1308 const OatFile* oat_file = class_linker->FindOpenedOatFileFromOatLocation(oat_location); 1309 if (oat_file == nullptr) { 1310 oat_file = OatFile::Open(oat_location, oat_location, nullptr, false, &error_msg); 1311 if (oat_file == nullptr) { 1312 os << "NOT FOUND: " << error_msg << "\n"; 1313 return false; 1314 } 1315 } 1316 os << "\n"; 1317 1318 stats_.oat_file_bytes = oat_file->Size(); 1319 1320 oat_dumper_.reset(new OatDumper(*oat_file, oat_dumper_options_.release())); 1321 1322 for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) { 1323 CHECK(oat_dex_file != nullptr); 1324 stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(), 1325 oat_dex_file->FileSize())); 1326 } 1327 1328 os << "OBJECTS:\n" << std::flush; 1329 1330 // Loop through all the image spaces and dump their objects. 1331 gc::Heap* heap = Runtime::Current()->GetHeap(); 1332 const std::vector<gc::space::ContinuousSpace*>& spaces = heap->GetContinuousSpaces(); 1333 Thread* self = Thread::Current(); 1334 { 1335 { 1336 WriterMutexLock mu(self, *Locks::heap_bitmap_lock_); 1337 heap->FlushAllocStack(); 1338 } 1339 // Since FlushAllocStack() above resets the (active) allocation 1340 // stack. Need to revoke the thread-local allocation stacks that 1341 // point into it. 1342 { 1343 self->TransitionFromRunnableToSuspended(kNative); 1344 ThreadList* thread_list = Runtime::Current()->GetThreadList(); 1345 thread_list->SuspendAll(); 1346 heap->RevokeAllThreadLocalAllocationStacks(self); 1347 thread_list->ResumeAll(); 1348 self->TransitionFromSuspendedToRunnable(); 1349 } 1350 } 1351 { 1352 std::ostream* saved_os = os_; 1353 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1354 std::ostream indent_os(&indent_filter); 1355 os_ = &indent_os; 1356 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_); 1357 for (const auto& space : spaces) { 1358 if (space->IsImageSpace()) { 1359 gc::space::ImageSpace* image_space = space->AsImageSpace(); 1360 image_space->GetLiveBitmap()->Walk(ImageDumper::Callback, this); 1361 indent_os << "\n"; 1362 } 1363 } 1364 // Dump the large objects separately. 1365 heap->GetLargeObjectsSpace()->GetLiveBitmap()->Walk(ImageDumper::Callback, this); 1366 indent_os << "\n"; 1367 os_ = saved_os; 1368 } 1369 os << "STATS:\n" << std::flush; 1370 std::unique_ptr<File> file(OS::OpenFileForReading(image_filename.c_str())); 1371 if (file.get() == nullptr) { 1372 LOG(WARNING) << "Failed to find image in " << image_filename; 1373 } 1374 if (file.get() != nullptr) { 1375 stats_.file_bytes = file->GetLength(); 1376 } 1377 size_t header_bytes = sizeof(ImageHeader); 1378 stats_.header_bytes = header_bytes; 1379 size_t alignment_bytes = RoundUp(header_bytes, kObjectAlignment) - header_bytes; 1380 stats_.alignment_bytes += alignment_bytes; 1381 stats_.alignment_bytes += image_header_.GetImageBitmapOffset() - image_header_.GetImageSize(); 1382 stats_.bitmap_bytes += image_header_.GetImageBitmapSize(); 1383 stats_.Dump(os); 1384 os << "\n"; 1385 1386 os << std::flush; 1387 1388 return oat_dumper_->Dump(os); 1389 } 1390 1391 private: 1392 static void PrettyObjectValue(std::ostream& os, mirror::Class* type, mirror::Object* value) 1393 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1394 CHECK(type != nullptr); 1395 if (value == nullptr) { 1396 os << StringPrintf("null %s\n", PrettyDescriptor(type).c_str()); 1397 } else if (type->IsStringClass()) { 1398 mirror::String* string = value->AsString(); 1399 os << StringPrintf("%p String: %s\n", string, 1400 PrintableString(string->ToModifiedUtf8().c_str()).c_str()); 1401 } else if (type->IsClassClass()) { 1402 mirror::Class* klass = value->AsClass(); 1403 os << StringPrintf("%p Class: %s\n", klass, PrettyDescriptor(klass).c_str()); 1404 } else if (type->IsArtFieldClass()) { 1405 mirror::ArtField* field = value->AsArtField(); 1406 os << StringPrintf("%p Field: %s\n", field, PrettyField(field).c_str()); 1407 } else if (type->IsArtMethodClass()) { 1408 mirror::ArtMethod* method = value->AsArtMethod(); 1409 os << StringPrintf("%p Method: %s\n", method, PrettyMethod(method).c_str()); 1410 } else { 1411 os << StringPrintf("%p %s\n", value, PrettyDescriptor(type).c_str()); 1412 } 1413 } 1414 1415 static void PrintField(std::ostream& os, mirror::ArtField* field, mirror::Object* obj) 1416 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1417 const char* descriptor = field->GetTypeDescriptor(); 1418 os << StringPrintf("%s: ", field->GetName()); 1419 if (descriptor[0] != 'L' && descriptor[0] != '[') { 1420 StackHandleScope<1> hs(Thread::Current()); 1421 FieldHelper fh(hs.NewHandle(field)); 1422 mirror::Class* type = fh.GetType(); 1423 DCHECK(type->IsPrimitive()); 1424 if (type->IsPrimitiveLong()) { 1425 os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj)); 1426 } else if (type->IsPrimitiveDouble()) { 1427 os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj)); 1428 } else if (type->IsPrimitiveFloat()) { 1429 os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj)); 1430 } else if (type->IsPrimitiveInt()) { 1431 os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj)); 1432 } else if (type->IsPrimitiveChar()) { 1433 os << StringPrintf("%u (0x%x)\n", field->GetChar(obj), field->GetChar(obj)); 1434 } else if (type->IsPrimitiveShort()) { 1435 os << StringPrintf("%d (0x%x)\n", field->GetShort(obj), field->GetShort(obj)); 1436 } else if (type->IsPrimitiveBoolean()) { 1437 os << StringPrintf("%s (0x%x)\n", field->GetBoolean(obj)? "true" : "false", 1438 field->GetBoolean(obj)); 1439 } else if (type->IsPrimitiveByte()) { 1440 os << StringPrintf("%d (0x%x)\n", field->GetByte(obj), field->GetByte(obj)); 1441 } else { 1442 LOG(FATAL) << "Unknown type: " << PrettyClass(type); 1443 } 1444 } else { 1445 // Get the value, don't compute the type unless it is non-null as we don't want 1446 // to cause class loading. 1447 mirror::Object* value = field->GetObj(obj); 1448 if (value == nullptr) { 1449 os << StringPrintf("null %s\n", PrettyDescriptor(descriptor).c_str()); 1450 } else { 1451 // Grab the field type without causing resolution. 1452 StackHandleScope<1> hs(Thread::Current()); 1453 FieldHelper fh(hs.NewHandle(field)); 1454 mirror::Class* field_type = fh.GetType(false); 1455 if (field_type != nullptr) { 1456 PrettyObjectValue(os, field_type, value); 1457 } else { 1458 os << StringPrintf("%p %s\n", value, PrettyDescriptor(descriptor).c_str()); 1459 } 1460 } 1461 } 1462 } 1463 1464 static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass) 1465 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1466 mirror::Class* super = klass->GetSuperClass(); 1467 if (super != nullptr) { 1468 DumpFields(os, obj, super); 1469 } 1470 mirror::ObjectArray<mirror::ArtField>* fields = klass->GetIFields(); 1471 if (fields != nullptr) { 1472 for (int32_t i = 0; i < fields->GetLength(); i++) { 1473 mirror::ArtField* field = fields->Get(i); 1474 PrintField(os, field, obj); 1475 } 1476 } 1477 } 1478 1479 bool InDumpSpace(const mirror::Object* object) { 1480 return image_space_.Contains(object); 1481 } 1482 1483 const void* GetQuickOatCodeBegin(mirror::ArtMethod* m) 1484 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1485 const void* quick_code = m->GetEntryPointFromQuickCompiledCode(); 1486 if (quick_code == Runtime::Current()->GetClassLinker()->GetQuickResolutionTrampoline()) { 1487 quick_code = oat_dumper_->GetQuickOatCode(m); 1488 } 1489 if (oat_dumper_->GetInstructionSet() == kThumb2) { 1490 quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1); 1491 } 1492 return quick_code; 1493 } 1494 1495 uint32_t GetQuickOatCodeSize(mirror::ArtMethod* m) 1496 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1497 const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m)); 1498 if (oat_code_begin == nullptr) { 1499 return 0; 1500 } 1501 return oat_code_begin[-1]; 1502 } 1503 1504 const void* GetQuickOatCodeEnd(mirror::ArtMethod* m) 1505 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1506 const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m)); 1507 if (oat_code_begin == nullptr) { 1508 return nullptr; 1509 } 1510 return oat_code_begin + GetQuickOatCodeSize(m); 1511 } 1512 1513 static void Callback(mirror::Object* obj, void* arg) 1514 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1515 DCHECK(obj != nullptr); 1516 DCHECK(arg != nullptr); 1517 ImageDumper* state = reinterpret_cast<ImageDumper*>(arg); 1518 if (!state->InDumpSpace(obj)) { 1519 return; 1520 } 1521 1522 size_t object_bytes = obj->SizeOf(); 1523 size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes; 1524 state->stats_.object_bytes += object_bytes; 1525 state->stats_.alignment_bytes += alignment_bytes; 1526 1527 std::ostream& os = *state->os_; 1528 mirror::Class* obj_class = obj->GetClass(); 1529 if (obj_class->IsArrayClass()) { 1530 os << StringPrintf("%p: %s length:%d\n", obj, PrettyDescriptor(obj_class).c_str(), 1531 obj->AsArray()->GetLength()); 1532 } else if (obj->IsClass()) { 1533 mirror::Class* klass = obj->AsClass(); 1534 os << StringPrintf("%p: java.lang.Class \"%s\" (", obj, PrettyDescriptor(klass).c_str()) 1535 << klass->GetStatus() << ")\n"; 1536 } else if (obj->IsArtField()) { 1537 os << StringPrintf("%p: java.lang.reflect.ArtField %s\n", obj, 1538 PrettyField(obj->AsArtField()).c_str()); 1539 } else if (obj->IsArtMethod()) { 1540 os << StringPrintf("%p: java.lang.reflect.ArtMethod %s\n", obj, 1541 PrettyMethod(obj->AsArtMethod()).c_str()); 1542 } else if (obj_class->IsStringClass()) { 1543 os << StringPrintf("%p: java.lang.String %s\n", obj, 1544 PrintableString(obj->AsString()->ToModifiedUtf8().c_str()).c_str()); 1545 } else { 1546 os << StringPrintf("%p: %s\n", obj, PrettyDescriptor(obj_class).c_str()); 1547 } 1548 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1549 std::ostream indent_os(&indent_filter); 1550 DumpFields(indent_os, obj, obj_class); 1551 if (obj->IsObjectArray()) { 1552 mirror::ObjectArray<mirror::Object>* obj_array = obj->AsObjectArray<mirror::Object>(); 1553 int32_t length = obj_array->GetLength(); 1554 for (int32_t i = 0; i < length; i++) { 1555 mirror::Object* value = obj_array->Get(i); 1556 size_t run = 0; 1557 for (int32_t j = i + 1; j < length; j++) { 1558 if (value == obj_array->Get(j)) { 1559 run++; 1560 } else { 1561 break; 1562 } 1563 } 1564 if (run == 0) { 1565 indent_os << StringPrintf("%d: ", i); 1566 } else { 1567 indent_os << StringPrintf("%d to %zd: ", i, i + run); 1568 i = i + run; 1569 } 1570 mirror::Class* value_class = 1571 (value == nullptr) ? obj_class->GetComponentType() : value->GetClass(); 1572 PrettyObjectValue(indent_os, value_class, value); 1573 } 1574 } else if (obj->IsClass()) { 1575 mirror::ObjectArray<mirror::ArtField>* sfields = obj->AsClass()->GetSFields(); 1576 if (sfields != nullptr) { 1577 indent_os << "STATICS:\n"; 1578 Indenter indent2_filter(indent_os.rdbuf(), kIndentChar, kIndentBy1Count); 1579 std::ostream indent2_os(&indent2_filter); 1580 for (int32_t i = 0; i < sfields->GetLength(); i++) { 1581 mirror::ArtField* field = sfields->Get(i); 1582 PrintField(indent2_os, field, field->GetDeclaringClass()); 1583 } 1584 } 1585 } else if (obj->IsArtMethod()) { 1586 mirror::ArtMethod* method = obj->AsArtMethod(); 1587 if (method->IsNative()) { 1588 // TODO: portable dumping. 1589 DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method); 1590 DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method); 1591 bool first_occurrence; 1592 const void* quick_oat_code = state->GetQuickOatCodeBegin(method); 1593 uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method); 1594 state->ComputeOatSize(quick_oat_code, &first_occurrence); 1595 if (first_occurrence) { 1596 state->stats_.native_to_managed_code_bytes += quick_oat_code_size; 1597 } 1598 if (quick_oat_code != method->GetEntryPointFromQuickCompiledCode()) { 1599 indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code); 1600 } 1601 } else if (method->IsAbstract() || method->IsCalleeSaveMethod() || 1602 method->IsResolutionMethod() || method->IsImtConflictMethod() || 1603 method->IsClassInitializer()) { 1604 DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method); 1605 DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method); 1606 } else { 1607 const DexFile::CodeItem* code_item = method->GetCodeItem(); 1608 size_t dex_instruction_bytes = code_item->insns_size_in_code_units_ * 2; 1609 state->stats_.dex_instruction_bytes += dex_instruction_bytes; 1610 1611 bool first_occurrence; 1612 size_t gc_map_bytes = state->ComputeOatSize(method->GetNativeGcMap(), &first_occurrence); 1613 if (first_occurrence) { 1614 state->stats_.gc_map_bytes += gc_map_bytes; 1615 } 1616 1617 size_t pc_mapping_table_bytes = 1618 state->ComputeOatSize(method->GetMappingTable(), &first_occurrence); 1619 if (first_occurrence) { 1620 state->stats_.pc_mapping_table_bytes += pc_mapping_table_bytes; 1621 } 1622 1623 size_t vmap_table_bytes = 1624 state->ComputeOatSize(method->GetVmapTable(), &first_occurrence); 1625 if (first_occurrence) { 1626 state->stats_.vmap_table_bytes += vmap_table_bytes; 1627 } 1628 1629 // TODO: portable dumping. 1630 const void* quick_oat_code_begin = state->GetQuickOatCodeBegin(method); 1631 const void* quick_oat_code_end = state->GetQuickOatCodeEnd(method); 1632 uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method); 1633 state->ComputeOatSize(quick_oat_code_begin, &first_occurrence); 1634 if (first_occurrence) { 1635 state->stats_.managed_code_bytes += quick_oat_code_size; 1636 if (method->IsConstructor()) { 1637 if (method->IsStatic()) { 1638 state->stats_.class_initializer_code_bytes += quick_oat_code_size; 1639 } else if (dex_instruction_bytes > kLargeConstructorDexBytes) { 1640 state->stats_.large_initializer_code_bytes += quick_oat_code_size; 1641 } 1642 } else if (dex_instruction_bytes > kLargeMethodDexBytes) { 1643 state->stats_.large_method_code_bytes += quick_oat_code_size; 1644 } 1645 } 1646 state->stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size; 1647 1648 indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end); 1649 indent_os << StringPrintf("SIZE: Dex Instructions=%zd GC=%zd Mapping=%zd\n", 1650 dex_instruction_bytes, gc_map_bytes, pc_mapping_table_bytes); 1651 1652 size_t total_size = dex_instruction_bytes + gc_map_bytes + pc_mapping_table_bytes + 1653 vmap_table_bytes + quick_oat_code_size + object_bytes; 1654 1655 double expansion = 1656 static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes); 1657 state->stats_.ComputeOutliers(total_size, expansion, method); 1658 } 1659 } 1660 std::string temp; 1661 state->stats_.Update(obj_class->GetDescriptor(&temp), object_bytes); 1662 } 1663 1664 std::set<const void*> already_seen_; 1665 // Compute the size of the given data within the oat file and whether this is the first time 1666 // this data has been requested 1667 size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) { 1668 if (already_seen_.count(oat_data) == 0) { 1669 *first_occurrence = true; 1670 already_seen_.insert(oat_data); 1671 } else { 1672 *first_occurrence = false; 1673 } 1674 return oat_dumper_->ComputeSize(oat_data); 1675 } 1676 1677 public: 1678 struct Stats { 1679 size_t oat_file_bytes; 1680 size_t file_bytes; 1681 1682 size_t header_bytes; 1683 size_t object_bytes; 1684 size_t bitmap_bytes; 1685 size_t alignment_bytes; 1686 1687 size_t managed_code_bytes; 1688 size_t managed_code_bytes_ignoring_deduplication; 1689 size_t managed_to_native_code_bytes; 1690 size_t native_to_managed_code_bytes; 1691 size_t class_initializer_code_bytes; 1692 size_t large_initializer_code_bytes; 1693 size_t large_method_code_bytes; 1694 1695 size_t gc_map_bytes; 1696 size_t pc_mapping_table_bytes; 1697 size_t vmap_table_bytes; 1698 1699 size_t dex_instruction_bytes; 1700 1701 std::vector<mirror::ArtMethod*> method_outlier; 1702 std::vector<size_t> method_outlier_size; 1703 std::vector<double> method_outlier_expansion; 1704 std::vector<std::pair<std::string, size_t>> oat_dex_file_sizes; 1705 1706 explicit Stats() 1707 : oat_file_bytes(0), 1708 file_bytes(0), 1709 header_bytes(0), 1710 object_bytes(0), 1711 bitmap_bytes(0), 1712 alignment_bytes(0), 1713 managed_code_bytes(0), 1714 managed_code_bytes_ignoring_deduplication(0), 1715 managed_to_native_code_bytes(0), 1716 native_to_managed_code_bytes(0), 1717 class_initializer_code_bytes(0), 1718 large_initializer_code_bytes(0), 1719 large_method_code_bytes(0), 1720 gc_map_bytes(0), 1721 pc_mapping_table_bytes(0), 1722 vmap_table_bytes(0), 1723 dex_instruction_bytes(0) {} 1724 1725 struct SizeAndCount { 1726 SizeAndCount(size_t bytes, size_t count) : bytes(bytes), count(count) {} 1727 size_t bytes; 1728 size_t count; 1729 }; 1730 typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable; 1731 SizeAndCountTable sizes_and_counts; 1732 1733 void Update(const char* descriptor, size_t object_bytes) { 1734 SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor); 1735 if (it != sizes_and_counts.end()) { 1736 it->second.bytes += object_bytes; 1737 it->second.count += 1; 1738 } else { 1739 sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes, 1)); 1740 } 1741 } 1742 1743 double PercentOfOatBytes(size_t size) { 1744 return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100; 1745 } 1746 1747 double PercentOfFileBytes(size_t size) { 1748 return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100; 1749 } 1750 1751 double PercentOfObjectBytes(size_t size) { 1752 return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100; 1753 } 1754 1755 void ComputeOutliers(size_t total_size, double expansion, mirror::ArtMethod* method) { 1756 method_outlier_size.push_back(total_size); 1757 method_outlier_expansion.push_back(expansion); 1758 method_outlier.push_back(method); 1759 } 1760 1761 void DumpOutliers(std::ostream& os) 1762 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1763 size_t sum_of_sizes = 0; 1764 size_t sum_of_sizes_squared = 0; 1765 size_t sum_of_expansion = 0; 1766 size_t sum_of_expansion_squared = 0; 1767 size_t n = method_outlier_size.size(); 1768 for (size_t i = 0; i < n; i++) { 1769 size_t cur_size = method_outlier_size[i]; 1770 sum_of_sizes += cur_size; 1771 sum_of_sizes_squared += cur_size * cur_size; 1772 double cur_expansion = method_outlier_expansion[i]; 1773 sum_of_expansion += cur_expansion; 1774 sum_of_expansion_squared += cur_expansion * cur_expansion; 1775 } 1776 size_t size_mean = sum_of_sizes / n; 1777 size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1); 1778 double expansion_mean = sum_of_expansion / n; 1779 double expansion_variance = 1780 (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1); 1781 1782 // Dump methods whose size is a certain number of standard deviations from the mean 1783 size_t dumped_values = 0; 1784 size_t skipped_values = 0; 1785 for (size_t i = 100; i > 0; i--) { // i is the current number of standard deviations 1786 size_t cur_size_variance = i * i * size_variance; 1787 bool first = true; 1788 for (size_t j = 0; j < n; j++) { 1789 size_t cur_size = method_outlier_size[j]; 1790 if (cur_size > size_mean) { 1791 size_t cur_var = cur_size - size_mean; 1792 cur_var = cur_var * cur_var; 1793 if (cur_var > cur_size_variance) { 1794 if (dumped_values > 20) { 1795 if (i == 1) { 1796 skipped_values++; 1797 } else { 1798 i = 2; // jump to counting for 1 standard deviation 1799 break; 1800 } 1801 } else { 1802 if (first) { 1803 os << "\nBig methods (size > " << i << " standard deviations the norm):\n"; 1804 first = false; 1805 } 1806 os << PrettyMethod(method_outlier[j]) << " requires storage of " 1807 << PrettySize(cur_size) << "\n"; 1808 method_outlier_size[j] = 0; // don't consider this method again 1809 dumped_values++; 1810 } 1811 } 1812 } 1813 } 1814 } 1815 if (skipped_values > 0) { 1816 os << "... skipped " << skipped_values 1817 << " methods with size > 1 standard deviation from the norm\n"; 1818 } 1819 os << std::flush; 1820 1821 // Dump methods whose expansion is a certain number of standard deviations from the mean 1822 dumped_values = 0; 1823 skipped_values = 0; 1824 for (size_t i = 10; i > 0; i--) { // i is the current number of standard deviations 1825 double cur_expansion_variance = i * i * expansion_variance; 1826 bool first = true; 1827 for (size_t j = 0; j < n; j++) { 1828 double cur_expansion = method_outlier_expansion[j]; 1829 if (cur_expansion > expansion_mean) { 1830 size_t cur_var = cur_expansion - expansion_mean; 1831 cur_var = cur_var * cur_var; 1832 if (cur_var > cur_expansion_variance) { 1833 if (dumped_values > 20) { 1834 if (i == 1) { 1835 skipped_values++; 1836 } else { 1837 i = 2; // jump to counting for 1 standard deviation 1838 break; 1839 } 1840 } else { 1841 if (first) { 1842 os << "\nLarge expansion methods (size > " << i 1843 << " standard deviations the norm):\n"; 1844 first = false; 1845 } 1846 os << PrettyMethod(method_outlier[j]) << " expanded code by " 1847 << cur_expansion << "\n"; 1848 method_outlier_expansion[j] = 0.0; // don't consider this method again 1849 dumped_values++; 1850 } 1851 } 1852 } 1853 } 1854 } 1855 if (skipped_values > 0) { 1856 os << "... skipped " << skipped_values 1857 << " methods with expansion > 1 standard deviation from the norm\n"; 1858 } 1859 os << "\n" << std::flush; 1860 } 1861 1862 void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1863 { 1864 os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n" 1865 << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n"; 1866 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1867 std::ostream indent_os(&indent_filter); 1868 indent_os << StringPrintf("header_bytes = %8zd (%2.0f%% of art file bytes)\n" 1869 "object_bytes = %8zd (%2.0f%% of art file bytes)\n" 1870 "bitmap_bytes = %8zd (%2.0f%% of art file bytes)\n" 1871 "alignment_bytes = %8zd (%2.0f%% of art file bytes)\n\n", 1872 header_bytes, PercentOfFileBytes(header_bytes), 1873 object_bytes, PercentOfFileBytes(object_bytes), 1874 bitmap_bytes, PercentOfFileBytes(bitmap_bytes), 1875 alignment_bytes, PercentOfFileBytes(alignment_bytes)) 1876 << std::flush; 1877 CHECK_EQ(file_bytes, bitmap_bytes + header_bytes + object_bytes + alignment_bytes); 1878 } 1879 1880 os << "object_bytes breakdown:\n"; 1881 size_t object_bytes_total = 0; 1882 for (const auto& sizes_and_count : sizes_and_counts) { 1883 const std::string& descriptor(sizes_and_count.first); 1884 double average = static_cast<double>(sizes_and_count.second.bytes) / 1885 static_cast<double>(sizes_and_count.second.count); 1886 double percent = PercentOfObjectBytes(sizes_and_count.second.bytes); 1887 os << StringPrintf("%32s %8zd bytes %6zd instances " 1888 "(%4.0f bytes/instance) %2.0f%% of object_bytes\n", 1889 descriptor.c_str(), sizes_and_count.second.bytes, 1890 sizes_and_count.second.count, average, percent); 1891 object_bytes_total += sizes_and_count.second.bytes; 1892 } 1893 os << "\n" << std::flush; 1894 CHECK_EQ(object_bytes, object_bytes_total); 1895 1896 os << StringPrintf("oat_file_bytes = %8zd\n" 1897 "managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1898 "managed_to_native_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1899 "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n" 1900 "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1901 "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1902 "large_method_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n", 1903 oat_file_bytes, 1904 managed_code_bytes, 1905 PercentOfOatBytes(managed_code_bytes), 1906 managed_to_native_code_bytes, 1907 PercentOfOatBytes(managed_to_native_code_bytes), 1908 native_to_managed_code_bytes, 1909 PercentOfOatBytes(native_to_managed_code_bytes), 1910 class_initializer_code_bytes, 1911 PercentOfOatBytes(class_initializer_code_bytes), 1912 large_initializer_code_bytes, 1913 PercentOfOatBytes(large_initializer_code_bytes), 1914 large_method_code_bytes, 1915 PercentOfOatBytes(large_method_code_bytes)) 1916 << "DexFile sizes:\n"; 1917 for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) { 1918 os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n", 1919 oat_dex_file_size.first.c_str(), oat_dex_file_size.second, 1920 PercentOfOatBytes(oat_dex_file_size.second)); 1921 } 1922 1923 os << "\n" << StringPrintf("gc_map_bytes = %7zd (%2.0f%% of oat file bytes)\n" 1924 "pc_mapping_table_bytes = %7zd (%2.0f%% of oat file bytes)\n" 1925 "vmap_table_bytes = %7zd (%2.0f%% of oat file bytes)\n\n", 1926 gc_map_bytes, PercentOfOatBytes(gc_map_bytes), 1927 pc_mapping_table_bytes, PercentOfOatBytes(pc_mapping_table_bytes), 1928 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes)) 1929 << std::flush; 1930 1931 os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes) 1932 << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n", 1933 static_cast<double>(managed_code_bytes) / 1934 static_cast<double>(dex_instruction_bytes), 1935 static_cast<double>(managed_code_bytes_ignoring_deduplication) / 1936 static_cast<double>(dex_instruction_bytes)) 1937 << std::flush; 1938 1939 DumpOutliers(os); 1940 } 1941 } stats_; 1942 1943 private: 1944 enum { 1945 // Number of bytes for a constructor to be considered large. Based on the 1000 basic block 1946 // threshold, we assume 2 bytes per instruction and 2 instructions per block. 1947 kLargeConstructorDexBytes = 4000, 1948 // Number of bytes for a method to be considered large. Based on the 4000 basic block 1949 // threshold, we assume 2 bytes per instruction and 2 instructions per block. 1950 kLargeMethodDexBytes = 16000 1951 }; 1952 std::ostream* os_; 1953 gc::space::ImageSpace& image_space_; 1954 const ImageHeader& image_header_; 1955 std::unique_ptr<OatDumper> oat_dumper_; 1956 std::unique_ptr<OatDumperOptions> oat_dumper_options_; 1957 1958 DISALLOW_COPY_AND_ASSIGN(ImageDumper); 1959}; 1960 1961static int oatdump(int argc, char** argv) { 1962 InitLogging(argv); 1963 1964 // Skip over argv[0]. 1965 argv++; 1966 argc--; 1967 1968 if (argc == 0) { 1969 fprintf(stderr, "No arguments specified\n"); 1970 usage(); 1971 } 1972 1973 const char* oat_filename = nullptr; 1974 const char* image_location = nullptr; 1975 const char* boot_image_location = nullptr; 1976 InstructionSet instruction_set = kRuntimeISA; 1977 std::string elf_filename_prefix; 1978 std::ostream* os = &std::cout; 1979 std::unique_ptr<std::ofstream> out; 1980 std::string output_name; 1981 bool dump_raw_mapping_table = false; 1982 bool dump_raw_gc_map = false; 1983 bool dump_vmap = true; 1984 bool disassemble_code = true; 1985 bool symbolize = false; 1986 1987 for (int i = 0; i < argc; i++) { 1988 const StringPiece option(argv[i]); 1989 if (option.starts_with("--oat-file=")) { 1990 oat_filename = option.substr(strlen("--oat-file=")).data(); 1991 } else if (option.starts_with("--image=")) { 1992 image_location = option.substr(strlen("--image=")).data(); 1993 } else if (option.starts_with("--boot-image=")) { 1994 boot_image_location = option.substr(strlen("--boot-image=")).data(); 1995 } else if (option.starts_with("--instruction-set=")) { 1996 StringPiece instruction_set_str = option.substr(strlen("--instruction-set=")).data(); 1997 if (instruction_set_str == "arm") { 1998 instruction_set = kThumb2; 1999 } else if (instruction_set_str == "arm64") { 2000 instruction_set = kArm64; 2001 } else if (instruction_set_str == "mips") { 2002 instruction_set = kMips; 2003 } else if (instruction_set_str == "x86") { 2004 instruction_set = kX86; 2005 } else if (instruction_set_str == "x86_64") { 2006 instruction_set = kX86_64; 2007 } 2008 } else if (option =="--dump:raw_mapping_table") { 2009 dump_raw_mapping_table = true; 2010 } else if (option == "--dump:raw_gc_map") { 2011 dump_raw_gc_map = true; 2012 } else if (option == "--no-dump:vmap") { 2013 dump_vmap = false; 2014 } else if (option == "--no-disassemble") { 2015 disassemble_code = false; 2016 } else if (option.starts_with("--output=")) { 2017 output_name = option.substr(strlen("--output=")).ToString(); 2018 const char* filename = output_name.c_str(); 2019 out.reset(new std::ofstream(filename)); 2020 if (!out->good()) { 2021 fprintf(stderr, "Failed to open output filename %s\n", filename); 2022 usage(); 2023 } 2024 os = out.get(); 2025 } else if (option.starts_with("--symbolize=")) { 2026 oat_filename = option.substr(strlen("--symbolize=")).data(); 2027 symbolize = true; 2028 } else { 2029 fprintf(stderr, "Unknown argument %s\n", option.data()); 2030 usage(); 2031 } 2032 } 2033 2034 if (image_location == nullptr && oat_filename == nullptr) { 2035 fprintf(stderr, "Either --image or --oat must be specified\n"); 2036 return EXIT_FAILURE; 2037 } 2038 2039 if (image_location != nullptr && oat_filename != nullptr) { 2040 fprintf(stderr, "Either --image or --oat must be specified but not both\n"); 2041 return EXIT_FAILURE; 2042 } 2043 2044 // If we are only doing the oat file, disable absolute_addresses. Keep them for image dumping. 2045 bool absolute_addresses = (oat_filename == nullptr); 2046 std::unique_ptr<OatDumperOptions> oat_dumper_options(new OatDumperOptions(dump_raw_mapping_table, 2047 dump_raw_gc_map, 2048 dump_vmap, 2049 disassemble_code, 2050 absolute_addresses)); 2051 if (oat_filename != nullptr) { 2052 std::string error_msg; 2053 OatFile* oat_file = 2054 OatFile::Open(oat_filename, oat_filename, nullptr, false, &error_msg); 2055 if (oat_file == nullptr) { 2056 fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str()); 2057 return EXIT_FAILURE; 2058 } 2059 if (symbolize) { 2060 OatSymbolizer oat_symbolizer(oat_file, output_name); 2061 if (!oat_symbolizer.Init()) { 2062 fprintf(stderr, "Failed to initialize symbolizer\n"); 2063 return EXIT_FAILURE; 2064 } 2065 if (!oat_symbolizer.Symbolize()) { 2066 fprintf(stderr, "Failed to symbolize\n"); 2067 return EXIT_FAILURE; 2068 } 2069 } else { 2070 OatDumper oat_dumper(*oat_file, oat_dumper_options.release()); 2071 bool success = oat_dumper.Dump(*os); 2072 return (success) ? EXIT_SUCCESS : EXIT_FAILURE; 2073 } 2074 return EXIT_SUCCESS; 2075 } 2076 2077 RuntimeOptions options; 2078 std::string image_option; 2079 std::string oat_option; 2080 std::string boot_image_option; 2081 std::string boot_oat_option; 2082 2083 // We are more like a compiler than a run-time. We don't want to execute code. 2084 NoopCompilerCallbacks callbacks; 2085 options.push_back(std::make_pair("compilercallbacks", &callbacks)); 2086 2087 if (boot_image_location != nullptr) { 2088 boot_image_option += "-Ximage:"; 2089 boot_image_option += boot_image_location; 2090 options.push_back(std::make_pair(boot_image_option.c_str(), nullptr)); 2091 } 2092 if (image_location != nullptr) { 2093 image_option += "-Ximage:"; 2094 image_option += image_location; 2095 options.push_back(std::make_pair(image_option.c_str(), nullptr)); 2096 } 2097 options.push_back( 2098 std::make_pair("imageinstructionset", 2099 reinterpret_cast<const void*>(GetInstructionSetString(instruction_set)))); 2100 2101 if (!Runtime::Create(options, false)) { 2102 fprintf(stderr, "Failed to create runtime\n"); 2103 return EXIT_FAILURE; 2104 } 2105 std::unique_ptr<Runtime> runtime(Runtime::Current()); 2106 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 2107 // give it away now and then switch to a more manageable ScopedObjectAccess. 2108 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 2109 ScopedObjectAccess soa(Thread::Current()); 2110 gc::Heap* heap = Runtime::Current()->GetHeap(); 2111 gc::space::ImageSpace* image_space = heap->GetImageSpace(); 2112 CHECK(image_space != nullptr); 2113 const ImageHeader& image_header = image_space->GetImageHeader(); 2114 if (!image_header.IsValid()) { 2115 fprintf(stderr, "Invalid image header %s\n", image_location); 2116 return EXIT_FAILURE; 2117 } 2118 ImageDumper image_dumper(os, *image_space, image_header, oat_dumper_options.release()); 2119 bool success = image_dumper.Dump(); 2120 return (success) ? EXIT_SUCCESS : EXIT_FAILURE; 2121} 2122 2123} // namespace art 2124 2125int main(int argc, char** argv) { 2126 return art::oatdump(argc, argv); 2127} 2128