oatdump.cc revision 404f59f4125ec9935ad8cffac56ab99d6320b17b
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 <vector> 24 25#include "base/stringpiece.h" 26#include "base/unix_file/fd_file.h" 27#include "class_linker.h" 28#include "class_linker-inl.h" 29#include "compiler_callbacks.h" 30#include "dex_file-inl.h" 31#include "dex_instruction.h" 32#include "disassembler.h" 33#include "gc_map.h" 34#include "gc/space/image_space.h" 35#include "gc/space/large_object_space.h" 36#include "gc/space/space-inl.h" 37#include "image.h" 38#include "indenter.h" 39#include "mapping_table.h" 40#include "mirror/art_field-inl.h" 41#include "mirror/art_method-inl.h" 42#include "mirror/array-inl.h" 43#include "mirror/class-inl.h" 44#include "mirror/object-inl.h" 45#include "mirror/object_array-inl.h" 46#include "oat.h" 47#include "object_utils.h" 48#include "os.h" 49#include "runtime.h" 50#include "safe_map.h" 51#include "scoped_thread_state_change.h" 52#include "verifier/dex_gc_map.h" 53#include "verifier/method_verifier.h" 54#include "vmap_table.h" 55 56namespace art { 57 58static void usage() { 59 fprintf(stderr, 60 "Usage: oatdump [options] ...\n" 61 " Example: oatdump --image=$ANDROID_PRODUCT_OUT/system/framework/boot.art --host-prefix=$ANDROID_PRODUCT_OUT\n" 62 " Example: adb shell oatdump --image=/system/framework/boot.art\n" 63 "\n"); 64 fprintf(stderr, 65 " --oat-file=<file.oat>: specifies an input oat filename.\n" 66 " Example: --oat-file=/system/framework/boot.oat\n" 67 "\n"); 68 fprintf(stderr, 69 " --image=<file.art>: specifies an input image filename.\n" 70 " Example: --image=/system/framework/boot.art\n" 71 "\n"); 72 fprintf(stderr, 73 " --boot-image=<file.art>: provide the image file for the boot class path.\n" 74 " Example: --boot-image=/system/framework/boot.art\n" 75 "\n"); 76 fprintf(stderr, 77 " --host-prefix may be used to translate host paths to target paths during\n" 78 " cross compilation.\n" 79 " Example: --host-prefix=out/target/product/crespo\n" 80 " Default: $ANDROID_PRODUCT_OUT\n" 81 "\n"); 82 fprintf(stderr, 83 " --output=<file> may be used to send the output to a file.\n" 84 " Example: --output=/tmp/oatdump.txt\n" 85 "\n"); 86 fprintf(stderr, 87 " --dump:[raw_mapping_table|raw_gc_map]\n" 88 " Example: --dump:raw_gc_map\n" 89 " Default: neither\n" 90 "\n"); 91 exit(EXIT_FAILURE); 92} 93 94const char* image_roots_descriptions_[] = { 95 "kResolutionMethod", 96 "kImtConflictMethod", 97 "kDefaultImt", 98 "kCalleeSaveMethod", 99 "kRefsOnlySaveMethod", 100 "kRefsAndArgsSaveMethod", 101 "kOatLocation", 102 "kDexCaches", 103 "kClassRoots", 104}; 105 106class OatDumper { 107 public: 108 explicit OatDumper(const std::string& host_prefix, const OatFile& oat_file, bool dump_raw_mapping_table, bool dump_raw_gc_map) 109 : host_prefix_(host_prefix), 110 oat_file_(oat_file), 111 oat_dex_files_(oat_file.GetOatDexFiles()), 112 dump_raw_mapping_table_(dump_raw_mapping_table), 113 dump_raw_gc_map_(dump_raw_gc_map), 114 disassembler_(Disassembler::Create(oat_file_.GetOatHeader().GetInstructionSet())) { 115 AddAllOffsets(); 116 } 117 118 void Dump(std::ostream& os) { 119 const OatHeader& oat_header = oat_file_.GetOatHeader(); 120 121 os << "MAGIC:\n"; 122 os << oat_header.GetMagic() << "\n\n"; 123 124 os << "CHECKSUM:\n"; 125 os << StringPrintf("0x%08x\n\n", oat_header.GetChecksum()); 126 127 os << "INSTRUCTION SET:\n"; 128 os << oat_header.GetInstructionSet() << "\n\n"; 129 130 os << "INSTRUCTION SET FEATURES:\n"; 131 os << oat_header.GetInstructionSetFeatures().GetFeatureString() << "\n\n"; 132 133 os << "DEX FILE COUNT:\n"; 134 os << oat_header.GetDexFileCount() << "\n\n"; 135 136 os << "EXECUTABLE OFFSET:\n"; 137 os << StringPrintf("0x%08x\n\n", oat_header.GetExecutableOffset()); 138 139 os << "IMAGE FILE LOCATION OAT CHECKSUM:\n"; 140 os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatChecksum()); 141 142 os << "IMAGE FILE LOCATION OAT BEGIN:\n"; 143 os << StringPrintf("0x%08x\n\n", oat_header.GetImageFileLocationOatDataBegin()); 144 145 os << "IMAGE FILE LOCATION:\n"; 146 const std::string image_file_location(oat_header.GetImageFileLocation()); 147 os << image_file_location; 148 if (!image_file_location.empty() && !host_prefix_.empty()) { 149 os << " (" << host_prefix_ << image_file_location << ")"; 150 } 151 os << "\n\n"; 152 153 os << "BEGIN:\n"; 154 os << reinterpret_cast<const void*>(oat_file_.Begin()) << "\n\n"; 155 156 os << "END:\n"; 157 os << reinterpret_cast<const void*>(oat_file_.End()) << "\n\n"; 158 159 os << std::flush; 160 161 for (size_t i = 0; i < oat_dex_files_.size(); i++) { 162 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i]; 163 CHECK(oat_dex_file != NULL); 164 DumpOatDexFile(os, *oat_dex_file); 165 } 166 } 167 168 size_t ComputeSize(const void* oat_data) { 169 if (reinterpret_cast<const byte*>(oat_data) < oat_file_.Begin() || 170 reinterpret_cast<const byte*>(oat_data) > oat_file_.End()) { 171 return 0; // Address not in oat file 172 } 173 uintptr_t begin_offset = reinterpret_cast<uintptr_t>(oat_data) - 174 reinterpret_cast<uintptr_t>(oat_file_.Begin()); 175 auto it = offsets_.upper_bound(begin_offset); 176 CHECK(it != offsets_.end()); 177 uintptr_t end_offset = *it; 178 return end_offset - begin_offset; 179 } 180 181 InstructionSet GetInstructionSet() { 182 return oat_file_.GetOatHeader().GetInstructionSet(); 183 } 184 185 const void* GetQuickOatCode(mirror::ArtMethod* m) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 186 MethodHelper mh(m); 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 != nullptr); 190 std::string error_msg; 191 UniquePtr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg)); 192 if (dex_file.get() == nullptr) { 193 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation() 194 << "': " << error_msg; 195 } else { 196 const DexFile::ClassDef* class_def = 197 dex_file->FindClassDef(mh.GetDeclaringClassDescriptor()); 198 if (class_def != NULL) { 199 uint16_t class_def_index = dex_file->GetIndexForClassDef(*class_def); 200 const OatFile::OatClass* oat_class = oat_dex_file->GetOatClass(class_def_index); 201 CHECK(oat_class != NULL); 202 size_t method_index = m->GetMethodIndex(); 203 return oat_class->GetOatMethod(method_index).GetQuickCode(); 204 } 205 } 206 } 207 return NULL; 208 } 209 210 private: 211 void AddAllOffsets() { 212 // We don't know the length of the code for each method, but we need to know where to stop 213 // when disassembling. What we do know is that a region of code will be followed by some other 214 // region, so if we keep a sorted sequence of the start of each region, we can infer the length 215 // of a piece of code by using upper_bound to find the start of the next region. 216 for (size_t i = 0; i < oat_dex_files_.size(); i++) { 217 const OatFile::OatDexFile* oat_dex_file = oat_dex_files_[i]; 218 CHECK(oat_dex_file != NULL); 219 std::string error_msg; 220 UniquePtr<const DexFile> dex_file(oat_dex_file->OpenDexFile(&error_msg)); 221 if (dex_file.get() == nullptr) { 222 LOG(WARNING) << "Failed to open dex file '" << oat_dex_file->GetDexFileLocation() 223 << "': " << error_msg; 224 continue; 225 } 226 offsets_.insert(reinterpret_cast<uintptr_t>(&dex_file->GetHeader())); 227 for (size_t class_def_index = 0; class_def_index < dex_file->NumClassDefs(); class_def_index++) { 228 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index); 229 UniquePtr<const OatFile::OatClass> oat_class(oat_dex_file->GetOatClass(class_def_index)); 230 const byte* class_data = dex_file->GetClassData(class_def); 231 if (class_data != NULL) { 232 ClassDataItemIterator it(*dex_file, class_data); 233 SkipAllFields(it); 234 uint32_t class_method_index = 0; 235 while (it.HasNextDirectMethod()) { 236 AddOffsets(oat_class->GetOatMethod(class_method_index++)); 237 it.Next(); 238 } 239 while (it.HasNextVirtualMethod()) { 240 AddOffsets(oat_class->GetOatMethod(class_method_index++)); 241 it.Next(); 242 } 243 } 244 } 245 } 246 247 // If the last thing in the file is code for a method, there won't be an offset for the "next" 248 // thing. Instead of having a special case in the upper_bound code, let's just add an entry 249 // for the end of the file. 250 offsets_.insert(oat_file_.Size()); 251 } 252 253 void AddOffsets(const OatFile::OatMethod& oat_method) { 254 uint32_t code_offset = oat_method.GetCodeOffset(); 255 if (oat_file_.GetOatHeader().GetInstructionSet() == kThumb2) { 256 code_offset &= ~0x1; 257 } 258 offsets_.insert(code_offset); 259 offsets_.insert(oat_method.GetMappingTableOffset()); 260 offsets_.insert(oat_method.GetVmapTableOffset()); 261 offsets_.insert(oat_method.GetNativeGcMapOffset()); 262 } 263 264 void DumpOatDexFile(std::ostream& os, const OatFile::OatDexFile& oat_dex_file) { 265 os << "OAT DEX FILE:\n"; 266 os << StringPrintf("location: %s\n", oat_dex_file.GetDexFileLocation().c_str()); 267 os << StringPrintf("checksum: 0x%08x\n", oat_dex_file.GetDexFileLocationChecksum()); 268 269 // Create the verifier early. 270 271 std::string error_msg; 272 UniquePtr<const DexFile> dex_file(oat_dex_file.OpenDexFile(&error_msg)); 273 if (dex_file.get() == NULL) { 274 os << "NOT FOUND: " << error_msg << "\n\n"; 275 return; 276 } 277 for (size_t class_def_index = 0; class_def_index < dex_file->NumClassDefs(); class_def_index++) { 278 const DexFile::ClassDef& class_def = dex_file->GetClassDef(class_def_index); 279 const char* descriptor = dex_file->GetClassDescriptor(class_def); 280 UniquePtr<const OatFile::OatClass> oat_class(oat_dex_file.GetOatClass(class_def_index)); 281 CHECK(oat_class.get() != NULL); 282 os << StringPrintf("%zd: %s (type_idx=%d)", class_def_index, descriptor, class_def.class_idx_) 283 << " (" << oat_class->GetStatus() << ")" 284 << " (" << oat_class->GetType() << ")\n"; 285 // TODO: include bitmap here if type is kOatClassBitmap? 286 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 287 std::ostream indented_os(&indent_filter); 288 DumpOatClass(indented_os, *oat_class.get(), *(dex_file.get()), class_def); 289 } 290 291 os << std::flush; 292 } 293 294 static void SkipAllFields(ClassDataItemIterator& it) { 295 while (it.HasNextStaticField()) { 296 it.Next(); 297 } 298 while (it.HasNextInstanceField()) { 299 it.Next(); 300 } 301 } 302 303 void DumpOatClass(std::ostream& os, const OatFile::OatClass& oat_class, const DexFile& dex_file, 304 const DexFile::ClassDef& class_def) { 305 const byte* class_data = dex_file.GetClassData(class_def); 306 if (class_data == NULL) { // empty class such as a marker interface? 307 return; 308 } 309 ClassDataItemIterator it(dex_file, class_data); 310 SkipAllFields(it); 311 uint32_t class_method_idx = 0; 312 while (it.HasNextDirectMethod()) { 313 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx); 314 DumpOatMethod(os, class_def, class_method_idx, oat_method, dex_file, 315 it.GetMemberIndex(), it.GetMethodCodeItem(), it.GetMemberAccessFlags()); 316 class_method_idx++; 317 it.Next(); 318 } 319 while (it.HasNextVirtualMethod()) { 320 const OatFile::OatMethod oat_method = oat_class.GetOatMethod(class_method_idx); 321 DumpOatMethod(os, class_def, class_method_idx, oat_method, dex_file, 322 it.GetMemberIndex(), it.GetMethodCodeItem(), it.GetMemberAccessFlags()); 323 class_method_idx++; 324 it.Next(); 325 } 326 DCHECK(!it.HasNext()); 327 os << std::flush; 328 } 329 330 void DumpOatMethod(std::ostream& os, const DexFile::ClassDef& class_def, 331 uint32_t class_method_index, 332 const OatFile::OatMethod& oat_method, const DexFile& dex_file, 333 uint32_t dex_method_idx, const DexFile::CodeItem* code_item, 334 uint32_t method_access_flags) { 335 os << StringPrintf("%d: %s (dex_method_idx=%d)\n", 336 class_method_index, PrettyMethod(dex_method_idx, dex_file, true).c_str(), 337 dex_method_idx); 338 Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 339 std::ostream indent1_os(&indent1_filter); 340 { 341 indent1_os << "DEX CODE:\n"; 342 Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count); 343 std::ostream indent2_os(&indent2_filter); 344 DumpDexCode(indent2_os, dex_file, code_item); 345 } 346 if (Runtime::Current() != NULL) { 347 indent1_os << "VERIFIER TYPE ANALYSIS:\n"; 348 Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count); 349 std::ostream indent2_os(&indent2_filter); 350 DumpVerifier(indent2_os, dex_method_idx, &dex_file, class_def, code_item, 351 method_access_flags); 352 } 353 { 354 indent1_os << "OAT DATA:\n"; 355 Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count); 356 std::ostream indent2_os(&indent2_filter); 357 358 indent2_os << StringPrintf("frame_size_in_bytes: %zd\n", oat_method.GetFrameSizeInBytes()); 359 indent2_os << StringPrintf("core_spill_mask: 0x%08x ", oat_method.GetCoreSpillMask()); 360 DumpSpillMask(indent2_os, oat_method.GetCoreSpillMask(), false); 361 indent2_os << StringPrintf("\nfp_spill_mask: 0x%08x ", oat_method.GetFpSpillMask()); 362 DumpSpillMask(indent2_os, oat_method.GetFpSpillMask(), true); 363 indent2_os << StringPrintf("\nvmap_table: %p (offset=0x%08x)\n", 364 oat_method.GetVmapTable(), oat_method.GetVmapTableOffset()); 365 DumpVmap(indent2_os, oat_method); 366 indent2_os << StringPrintf("mapping_table: %p (offset=0x%08x)\n", 367 oat_method.GetMappingTable(), oat_method.GetMappingTableOffset()); 368 if (dump_raw_mapping_table_) { 369 Indenter indent3_filter(indent2_os.rdbuf(), kIndentChar, kIndentBy1Count); 370 std::ostream indent3_os(&indent3_filter); 371 DumpMappingTable(indent3_os, oat_method); 372 } 373 indent2_os << StringPrintf("gc_map: %p (offset=0x%08x)\n", 374 oat_method.GetNativeGcMap(), oat_method.GetNativeGcMapOffset()); 375 if (dump_raw_gc_map_) { 376 Indenter indent3_filter(indent2_os.rdbuf(), kIndentChar, kIndentBy1Count); 377 std::ostream indent3_os(&indent3_filter); 378 DumpGcMap(indent3_os, oat_method, code_item); 379 } 380 } 381 { 382 const void* code = oat_method.GetQuickCode(); 383 uint32_t code_size = oat_method.GetQuickCodeSize(); 384 if (code == nullptr) { 385 code = oat_method.GetPortableCode(); 386 code_size = oat_method.GetPortableCodeSize(); 387 } 388 indent1_os << StringPrintf("CODE: %p (offset=0x%08x size=%d)%s\n", 389 code, 390 oat_method.GetCodeOffset(), 391 code_size, 392 code != nullptr ? "..." : ""); 393 Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count); 394 std::ostream indent2_os(&indent2_filter); 395 396 Runtime* runtime = Runtime::Current(); 397 if (runtime != nullptr) { 398 ScopedObjectAccess soa(Thread::Current()); 399 SirtRef<mirror::DexCache> dex_cache( 400 soa.Self(), runtime->GetClassLinker()->FindDexCache(dex_file)); 401 SirtRef<mirror::ClassLoader> class_loader(soa.Self(), nullptr); 402 verifier::MethodVerifier verifier(&dex_file, &dex_cache, &class_loader, &class_def, code_item, 403 dex_method_idx, nullptr, method_access_flags, true, true); 404 verifier.Verify(); 405 DumpCode(indent2_os, &verifier, oat_method, code_item); 406 } else { 407 DumpCode(indent2_os, nullptr, oat_method, code_item); 408 } 409 } 410 } 411 412 void DumpSpillMask(std::ostream& os, uint32_t spill_mask, bool is_float) { 413 if (spill_mask == 0) { 414 return; 415 } 416 os << "("; 417 for (size_t i = 0; i < 32; i++) { 418 if ((spill_mask & (1 << i)) != 0) { 419 if (is_float) { 420 os << "fr" << i; 421 } else { 422 os << "r" << i; 423 } 424 spill_mask ^= 1 << i; // clear bit 425 if (spill_mask != 0) { 426 os << ", "; 427 } else { 428 break; 429 } 430 } 431 } 432 os << ")"; 433 } 434 435 void DumpVmap(std::ostream& os, const OatFile::OatMethod& oat_method) { 436 const uint8_t* raw_table = oat_method.GetVmapTable(); 437 if (raw_table != NULL) { 438 const VmapTable vmap_table(raw_table); 439 bool first = true; 440 bool processing_fp = false; 441 uint32_t spill_mask = oat_method.GetCoreSpillMask(); 442 for (size_t i = 0; i < vmap_table.Size(); i++) { 443 uint16_t dex_reg = vmap_table[i]; 444 uint32_t cpu_reg = vmap_table.ComputeRegister(spill_mask, i, 445 processing_fp ? kFloatVReg : kIntVReg); 446 os << (first ? "v" : ", v") << dex_reg; 447 if (!processing_fp) { 448 os << "/r" << cpu_reg; 449 } else { 450 os << "/fr" << cpu_reg; 451 } 452 first = false; 453 if (!processing_fp && dex_reg == 0xFFFF) { 454 processing_fp = true; 455 spill_mask = oat_method.GetFpSpillMask(); 456 } 457 } 458 os << "\n"; 459 } 460 } 461 462 void DescribeVReg(std::ostream& os, const OatFile::OatMethod& oat_method, 463 const DexFile::CodeItem* code_item, size_t reg, VRegKind kind) { 464 const uint8_t* raw_table = oat_method.GetVmapTable(); 465 if (raw_table != NULL) { 466 const VmapTable vmap_table(raw_table); 467 uint32_t vmap_offset; 468 if (vmap_table.IsInContext(reg, kind, &vmap_offset)) { 469 bool is_float = (kind == kFloatVReg) || (kind == kDoubleLoVReg) || (kind == kDoubleHiVReg); 470 uint32_t spill_mask = is_float ? oat_method.GetFpSpillMask() 471 : oat_method.GetCoreSpillMask(); 472 os << (is_float ? "fr" : "r") << vmap_table.ComputeRegister(spill_mask, vmap_offset, kind); 473 } else { 474 uint32_t offset = StackVisitor::GetVRegOffset(code_item, oat_method.GetCoreSpillMask(), 475 oat_method.GetFpSpillMask(), 476 oat_method.GetFrameSizeInBytes(), reg); 477 os << "[sp + #" << offset << "]"; 478 } 479 } 480 } 481 482 void DumpGcMapRegisters(std::ostream& os, const OatFile::OatMethod& oat_method, 483 const DexFile::CodeItem* code_item, 484 size_t num_regs, const uint8_t* reg_bitmap) { 485 bool first = true; 486 for (size_t reg = 0; reg < num_regs; reg++) { 487 if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) { 488 if (first) { 489 os << " v" << reg << " ("; 490 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 491 os << ")"; 492 first = false; 493 } else { 494 os << ", v" << reg << " ("; 495 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 496 os << ")"; 497 } 498 } 499 } 500 if (first) { 501 os << "No registers in GC map\n"; 502 } else { 503 os << "\n"; 504 } 505 } 506 void DumpGcMap(std::ostream& os, const OatFile::OatMethod& oat_method, 507 const DexFile::CodeItem* code_item) { 508 const uint8_t* gc_map_raw = oat_method.GetNativeGcMap(); 509 if (gc_map_raw == nullptr) { 510 return; // No GC map. 511 } 512 const void* quick_code = oat_method.GetQuickCode(); 513 if (quick_code != nullptr) { 514 NativePcOffsetToReferenceMap map(gc_map_raw); 515 for (size_t entry = 0; entry < map.NumEntries(); entry++) { 516 const uint8_t* native_pc = reinterpret_cast<const uint8_t*>(quick_code) + 517 map.GetNativePcOffset(entry); 518 os << StringPrintf("%p", native_pc); 519 DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry)); 520 } 521 } else { 522 const void* portable_code = oat_method.GetPortableCode(); 523 CHECK(portable_code != nullptr); 524 verifier::DexPcToReferenceMap map(gc_map_raw); 525 for (size_t entry = 0; entry < map.NumEntries(); entry++) { 526 uint32_t dex_pc = map.GetDexPc(entry); 527 os << StringPrintf("0x%08x", dex_pc); 528 DumpGcMapRegisters(os, oat_method, code_item, map.RegWidth() * 8, map.GetBitMap(entry)); 529 } 530 } 531 } 532 533 void DumpMappingTable(std::ostream& os, const OatFile::OatMethod& oat_method) { 534 const void* quick_code = oat_method.GetQuickCode(); 535 if (quick_code == nullptr) { 536 return; 537 } 538 MappingTable table(oat_method.GetMappingTable()); 539 if (table.TotalSize() != 0) { 540 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 541 std::ostream indent_os(&indent_filter); 542 if (table.PcToDexSize() != 0) { 543 typedef MappingTable::PcToDexIterator It; 544 os << "suspend point mappings {\n"; 545 for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) { 546 indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc()); 547 } 548 os << "}\n"; 549 } 550 if (table.DexToPcSize() != 0) { 551 typedef MappingTable::DexToPcIterator It; 552 os << "catch entry mappings {\n"; 553 for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) { 554 indent_os << StringPrintf("0x%04x -> 0x%04x\n", cur.NativePcOffset(), cur.DexPc()); 555 } 556 os << "}\n"; 557 } 558 } 559 } 560 561 uint32_t DumpMappingAtOffset(std::ostream& os, const OatFile::OatMethod& oat_method, 562 size_t offset, bool suspend_point_mapping) { 563 MappingTable table(oat_method.GetMappingTable()); 564 if (suspend_point_mapping && table.PcToDexSize() > 0) { 565 typedef MappingTable::PcToDexIterator It; 566 for (It cur = table.PcToDexBegin(), end = table.PcToDexEnd(); cur != end; ++cur) { 567 if (offset == cur.NativePcOffset()) { 568 os << StringPrintf("suspend point dex PC: 0x%04x\n", cur.DexPc()); 569 return cur.DexPc(); 570 } 571 } 572 } else if (!suspend_point_mapping && table.DexToPcSize() > 0) { 573 typedef MappingTable::DexToPcIterator It; 574 for (It cur = table.DexToPcBegin(), end = table.DexToPcEnd(); cur != end; ++cur) { 575 if (offset == cur.NativePcOffset()) { 576 os << StringPrintf("catch entry dex PC: 0x%04x\n", cur.DexPc()); 577 return cur.DexPc(); 578 } 579 } 580 } 581 return DexFile::kDexNoIndex; 582 } 583 584 void DumpGcMapAtNativePcOffset(std::ostream& os, const OatFile::OatMethod& oat_method, 585 const DexFile::CodeItem* code_item, size_t native_pc_offset) { 586 const uint8_t* gc_map_raw = oat_method.GetNativeGcMap(); 587 if (gc_map_raw != NULL) { 588 NativePcOffsetToReferenceMap map(gc_map_raw); 589 if (map.HasEntry(native_pc_offset)) { 590 size_t num_regs = map.RegWidth() * 8; 591 const uint8_t* reg_bitmap = map.FindBitMap(native_pc_offset); 592 bool first = true; 593 for (size_t reg = 0; reg < num_regs; reg++) { 594 if (((reg_bitmap[reg / 8] >> (reg % 8)) & 0x01) != 0) { 595 if (first) { 596 os << "GC map objects: v" << reg << " ("; 597 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 598 os << ")"; 599 first = false; 600 } else { 601 os << ", v" << reg << " ("; 602 DescribeVReg(os, oat_method, code_item, reg, kReferenceVReg); 603 os << ")"; 604 } 605 } 606 } 607 if (!first) { 608 os << "\n"; 609 } 610 } 611 } 612 } 613 614 void DumpVRegsAtDexPc(std::ostream& os, verifier::MethodVerifier* verifier, 615 const OatFile::OatMethod& oat_method, 616 const DexFile::CodeItem* code_item, uint32_t dex_pc) { 617 DCHECK(verifier != nullptr); 618 std::vector<int32_t> kinds = verifier->DescribeVRegs(dex_pc); 619 bool first = true; 620 for (size_t reg = 0; reg < code_item->registers_size_; reg++) { 621 VRegKind kind = static_cast<VRegKind>(kinds.at(reg * 2)); 622 if (kind != kUndefined) { 623 if (first) { 624 os << "VRegs: v"; 625 first = false; 626 } else { 627 os << ", v"; 628 } 629 os << reg << " ("; 630 switch (kind) { 631 case kImpreciseConstant: 632 os << "Imprecise Constant: " << kinds.at((reg * 2) + 1) << ", "; 633 DescribeVReg(os, oat_method, code_item, reg, kind); 634 break; 635 case kConstant: 636 os << "Constant: " << kinds.at((reg * 2) + 1); 637 break; 638 default: 639 DescribeVReg(os, oat_method, code_item, reg, kind); 640 break; 641 } 642 os << ")"; 643 } 644 } 645 if (!first) { 646 os << "\n"; 647 } 648 } 649 650 651 void DumpDexCode(std::ostream& os, const DexFile& dex_file, const DexFile::CodeItem* code_item) { 652 if (code_item != NULL) { 653 size_t i = 0; 654 while (i < code_item->insns_size_in_code_units_) { 655 const Instruction* instruction = Instruction::At(&code_item->insns_[i]); 656 os << StringPrintf("0x%04zx: %s\n", i, instruction->DumpString(&dex_file).c_str()); 657 i += instruction->SizeInCodeUnits(); 658 } 659 } 660 } 661 662 void DumpVerifier(std::ostream& os, uint32_t dex_method_idx, const DexFile* dex_file, 663 const DexFile::ClassDef& class_def, const DexFile::CodeItem* code_item, 664 uint32_t method_access_flags) { 665 if ((method_access_flags & kAccNative) == 0) { 666 ScopedObjectAccess soa(Thread::Current()); 667 SirtRef<mirror::DexCache> dex_cache(soa.Self(), Runtime::Current()->GetClassLinker()->FindDexCache(*dex_file)); 668 SirtRef<mirror::ClassLoader> class_loader(soa.Self(), nullptr); 669 verifier::MethodVerifier::VerifyMethodAndDump(os, dex_method_idx, dex_file, dex_cache, 670 class_loader, &class_def, code_item, NULL, 671 method_access_flags); 672 } 673 } 674 675 void DumpCode(std::ostream& os, verifier::MethodVerifier* verifier, 676 const OatFile::OatMethod& oat_method, const DexFile::CodeItem* code_item) { 677 const void* portable_code = oat_method.GetPortableCode(); 678 const void* quick_code = oat_method.GetQuickCode(); 679 680 size_t code_size = oat_method.GetQuickCodeSize(); 681 if ((code_size == 0) || ((portable_code == nullptr) && (quick_code == nullptr))) { 682 os << "NO CODE!\n"; 683 return; 684 } else if (quick_code != nullptr) { 685 const uint8_t* quick_native_pc = reinterpret_cast<const uint8_t*>(quick_code); 686 size_t offset = 0; 687 while (offset < code_size) { 688 DumpMappingAtOffset(os, oat_method, offset, false); 689 offset += disassembler_->Dump(os, quick_native_pc + offset); 690 uint32_t dex_pc = DumpMappingAtOffset(os, oat_method, offset, true); 691 if (dex_pc != DexFile::kDexNoIndex) { 692 DumpGcMapAtNativePcOffset(os, oat_method, code_item, offset); 693 if (verifier != nullptr) { 694 DumpVRegsAtDexPc(os, verifier, oat_method, code_item, dex_pc); 695 } 696 } 697 } 698 } else { 699 CHECK(portable_code != nullptr); 700 CHECK_EQ(code_size, 0U); // TODO: disassembly of portable is currently not supported. 701 } 702 } 703 704 const std::string host_prefix_; 705 const OatFile& oat_file_; 706 std::vector<const OatFile::OatDexFile*> oat_dex_files_; 707 bool dump_raw_mapping_table_; 708 bool dump_raw_gc_map_; 709 std::set<uintptr_t> offsets_; 710 UniquePtr<Disassembler> disassembler_; 711}; 712 713class ImageDumper { 714 public: 715 explicit ImageDumper(std::ostream* os, const std::string& image_filename, 716 const std::string& host_prefix, gc::space::ImageSpace& image_space, 717 const ImageHeader& image_header, bool dump_raw_mapping_table, 718 bool dump_raw_gc_map) 719 : os_(os), image_filename_(image_filename), host_prefix_(host_prefix), 720 image_space_(image_space), image_header_(image_header), 721 dump_raw_mapping_table_(dump_raw_mapping_table), 722 dump_raw_gc_map_(dump_raw_gc_map) {} 723 724 void Dump() SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 725 std::ostream& os = *os_; 726 os << "MAGIC: " << image_header_.GetMagic() << "\n\n"; 727 728 os << "IMAGE BEGIN: " << reinterpret_cast<void*>(image_header_.GetImageBegin()) << "\n\n"; 729 730 os << "IMAGE BITMAP OFFSET: " << reinterpret_cast<void*>(image_header_.GetImageBitmapOffset()) 731 << " SIZE: " << reinterpret_cast<void*>(image_header_.GetImageBitmapSize()) << "\n\n"; 732 733 os << "OAT CHECKSUM: " << StringPrintf("0x%08x\n\n", image_header_.GetOatChecksum()); 734 735 os << "OAT FILE BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatFileBegin()) << "\n\n"; 736 737 os << "OAT DATA BEGIN:" << reinterpret_cast<void*>(image_header_.GetOatDataBegin()) << "\n\n"; 738 739 os << "OAT DATA END:" << reinterpret_cast<void*>(image_header_.GetOatDataEnd()) << "\n\n"; 740 741 os << "OAT FILE END:" << reinterpret_cast<void*>(image_header_.GetOatFileEnd()) << "\n\n"; 742 743 { 744 os << "ROOTS: " << reinterpret_cast<void*>(image_header_.GetImageRoots()) << "\n"; 745 Indenter indent1_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 746 std::ostream indent1_os(&indent1_filter); 747 CHECK_EQ(arraysize(image_roots_descriptions_), size_t(ImageHeader::kImageRootsMax)); 748 for (int i = 0; i < ImageHeader::kImageRootsMax; i++) { 749 ImageHeader::ImageRoot image_root = static_cast<ImageHeader::ImageRoot>(i); 750 const char* image_root_description = image_roots_descriptions_[i]; 751 mirror::Object* image_root_object = image_header_.GetImageRoot(image_root); 752 indent1_os << StringPrintf("%s: %p\n", image_root_description, image_root_object); 753 if (image_root_object->IsObjectArray()) { 754 Indenter indent2_filter(indent1_os.rdbuf(), kIndentChar, kIndentBy1Count); 755 std::ostream indent2_os(&indent2_filter); 756 mirror::ObjectArray<mirror::Object>* image_root_object_array 757 = image_root_object->AsObjectArray<mirror::Object>(); 758 for (int i = 0; i < image_root_object_array->GetLength(); i++) { 759 mirror::Object* value = image_root_object_array->Get(i); 760 size_t run = 0; 761 for (int32_t j = i + 1; j < image_root_object_array->GetLength(); j++) { 762 if (value == image_root_object_array->Get(j)) { 763 run++; 764 } else { 765 break; 766 } 767 } 768 if (run == 0) { 769 indent2_os << StringPrintf("%d: ", i); 770 } else { 771 indent2_os << StringPrintf("%d to %zd: ", i, i + run); 772 i = i + run; 773 } 774 if (value != NULL) { 775 PrettyObjectValue(indent2_os, value->GetClass(), value); 776 } else { 777 indent2_os << i << ": null\n"; 778 } 779 } 780 } 781 } 782 } 783 os << "\n"; 784 785 ClassLinker* class_linker = Runtime::Current()->GetClassLinker(); 786 mirror::Object* oat_location_object = image_header_.GetImageRoot(ImageHeader::kOatLocation); 787 std::string oat_location(oat_location_object->AsString()->ToModifiedUtf8()); 788 os << "OAT LOCATION: " << oat_location; 789 if (!host_prefix_.empty()) { 790 oat_location = host_prefix_ + oat_location; 791 os << " (" << oat_location << ")"; 792 } 793 os << "\n"; 794 std::string error_msg; 795 const OatFile* oat_file = class_linker->FindOatFileFromOatLocation(oat_location, &error_msg); 796 if (oat_file == NULL) { 797 os << "NOT FOUND: " << error_msg << "\n"; 798 return; 799 } 800 os << "\n"; 801 802 stats_.oat_file_bytes = oat_file->Size(); 803 804 oat_dumper_.reset(new OatDumper(host_prefix_, *oat_file, dump_raw_mapping_table_, 805 dump_raw_gc_map_)); 806 807 for (const OatFile::OatDexFile* oat_dex_file : oat_file->GetOatDexFiles()) { 808 CHECK(oat_dex_file != NULL); 809 stats_.oat_dex_file_sizes.push_back(std::make_pair(oat_dex_file->GetDexFileLocation(), 810 oat_dex_file->FileSize())); 811 } 812 813 os << "OBJECTS:\n" << std::flush; 814 815 // Loop through all the image spaces and dump their objects. 816 gc::Heap* heap = Runtime::Current()->GetHeap(); 817 const std::vector<gc::space::ContinuousSpace*>& spaces = heap->GetContinuousSpaces(); 818 Thread* self = Thread::Current(); 819 { 820 WriterMutexLock mu(self, *Locks::heap_bitmap_lock_); 821 heap->FlushAllocStack(); 822 // Since FlushAllocStack() above resets the (active) allocation 823 // stack. Need to revoke the thread-local allocation stacks that 824 // point into it. 825 heap->RevokeAllThreadLocalAllocationStacks(self); 826 } 827 { 828 std::ostream* saved_os = os_; 829 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 830 std::ostream indent_os(&indent_filter); 831 os_ = &indent_os; 832 ReaderMutexLock mu(self, *Locks::heap_bitmap_lock_); 833 for (const auto& space : spaces) { 834 if (space->IsImageSpace()) { 835 gc::space::ImageSpace* image_space = space->AsImageSpace(); 836 image_space->GetLiveBitmap()->Walk(ImageDumper::Callback, this); 837 indent_os << "\n"; 838 } 839 } 840 // Dump the large objects separately. 841 heap->GetLargeObjectsSpace()->GetLiveObjects()->Walk(ImageDumper::Callback, this); 842 indent_os << "\n"; 843 os_ = saved_os; 844 } 845 os << "STATS:\n" << std::flush; 846 UniquePtr<File> file(OS::OpenFileForReading(image_filename_.c_str())); 847 if (file.get() == NULL) { 848 std::string cache_location(GetDalvikCacheFilenameOrDie(image_filename_.c_str())); 849 file.reset(OS::OpenFileForReading(cache_location.c_str())); 850 if (file.get() == NULL) { 851 LOG(WARNING) << "Failed to find image in " << image_filename_ 852 << " and " << cache_location; 853 } 854 } 855 if (file.get() != NULL) { 856 stats_.file_bytes = file->GetLength(); 857 } 858 size_t header_bytes = sizeof(ImageHeader); 859 stats_.header_bytes = header_bytes; 860 size_t alignment_bytes = RoundUp(header_bytes, kObjectAlignment) - header_bytes; 861 stats_.alignment_bytes += alignment_bytes; 862 stats_.alignment_bytes += image_header_.GetImageBitmapOffset() - image_header_.GetImageSize(); 863 stats_.bitmap_bytes += image_header_.GetImageBitmapSize(); 864 stats_.Dump(os); 865 os << "\n"; 866 867 os << std::flush; 868 869 oat_dumper_->Dump(os); 870 } 871 872 private: 873 static void PrettyObjectValue(std::ostream& os, mirror::Class* type, mirror::Object* value) 874 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 875 CHECK(type != NULL); 876 if (value == NULL) { 877 os << StringPrintf("null %s\n", PrettyDescriptor(type).c_str()); 878 } else if (type->IsStringClass()) { 879 mirror::String* string = value->AsString(); 880 os << StringPrintf("%p String: %s\n", string, 881 PrintableString(string->ToModifiedUtf8()).c_str()); 882 } else if (type->IsClassClass()) { 883 mirror::Class* klass = value->AsClass(); 884 os << StringPrintf("%p Class: %s\n", klass, PrettyDescriptor(klass).c_str()); 885 } else if (type->IsArtFieldClass()) { 886 mirror::ArtField* field = value->AsArtField(); 887 os << StringPrintf("%p Field: %s\n", field, PrettyField(field).c_str()); 888 } else if (type->IsArtMethodClass()) { 889 mirror::ArtMethod* method = value->AsArtMethod(); 890 os << StringPrintf("%p Method: %s\n", method, PrettyMethod(method).c_str()); 891 } else { 892 os << StringPrintf("%p %s\n", value, PrettyDescriptor(type).c_str()); 893 } 894 } 895 896 static void PrintField(std::ostream& os, mirror::ArtField* field, mirror::Object* obj) 897 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 898 FieldHelper fh(field); 899 const char* descriptor = fh.GetTypeDescriptor(); 900 os << StringPrintf("%s: ", fh.GetName()); 901 if (descriptor[0] != 'L' && descriptor[0] != '[') { 902 mirror::Class* type = fh.GetType(); 903 if (type->IsPrimitiveLong()) { 904 os << StringPrintf("%" PRId64 " (0x%" PRIx64 ")\n", field->Get64(obj), field->Get64(obj)); 905 } else if (type->IsPrimitiveDouble()) { 906 os << StringPrintf("%f (%a)\n", field->GetDouble(obj), field->GetDouble(obj)); 907 } else if (type->IsPrimitiveFloat()) { 908 os << StringPrintf("%f (%a)\n", field->GetFloat(obj), field->GetFloat(obj)); 909 } else { 910 DCHECK(type->IsPrimitive()); 911 os << StringPrintf("%d (0x%x)\n", field->Get32(obj), field->Get32(obj)); 912 } 913 } else { 914 // Get the value, don't compute the type unless it is non-null as we don't want 915 // to cause class loading. 916 mirror::Object* value = field->GetObj(obj); 917 if (value == NULL) { 918 os << StringPrintf("null %s\n", PrettyDescriptor(descriptor).c_str()); 919 } else { 920 // Grab the field type without causing resolution. 921 mirror::Class* field_type = fh.GetType(false); 922 if (field_type != NULL) { 923 PrettyObjectValue(os, field_type, value); 924 } else { 925 os << StringPrintf("%p %s\n", value, PrettyDescriptor(descriptor).c_str()); 926 } 927 } 928 } 929 } 930 931 static void DumpFields(std::ostream& os, mirror::Object* obj, mirror::Class* klass) 932 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 933 mirror::Class* super = klass->GetSuperClass(); 934 if (super != NULL) { 935 DumpFields(os, obj, super); 936 } 937 mirror::ObjectArray<mirror::ArtField>* fields = klass->GetIFields(); 938 if (fields != NULL) { 939 for (int32_t i = 0; i < fields->GetLength(); i++) { 940 mirror::ArtField* field = fields->Get(i); 941 PrintField(os, field, obj); 942 } 943 } 944 } 945 946 bool InDumpSpace(const mirror::Object* object) { 947 return image_space_.Contains(object); 948 } 949 950 const void* GetQuickOatCodeBegin(mirror::ArtMethod* m) 951 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 952 const void* quick_code = m->GetEntryPointFromQuickCompiledCode(); 953 if (quick_code == GetQuickResolutionTrampoline(Runtime::Current()->GetClassLinker())) { 954 quick_code = oat_dumper_->GetQuickOatCode(m); 955 } 956 if (oat_dumper_->GetInstructionSet() == kThumb2) { 957 quick_code = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(quick_code) & ~0x1); 958 } 959 return quick_code; 960 } 961 962 uint32_t GetQuickOatCodeSize(mirror::ArtMethod* m) 963 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 964 const uint32_t* oat_code_begin = reinterpret_cast<const uint32_t*>(GetQuickOatCodeBegin(m)); 965 if (oat_code_begin == nullptr) { 966 return 0; 967 } 968 return oat_code_begin[-1]; 969 } 970 971 const void* GetQuickOatCodeEnd(mirror::ArtMethod* m) 972 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 973 const uint8_t* oat_code_begin = reinterpret_cast<const uint8_t*>(GetQuickOatCodeBegin(m)); 974 if (oat_code_begin == NULL) { 975 return NULL; 976 } 977 return oat_code_begin + GetQuickOatCodeSize(m); 978 } 979 980 static void Callback(mirror::Object* obj, void* arg) 981 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 982 DCHECK(obj != NULL); 983 DCHECK(arg != NULL); 984 ImageDumper* state = reinterpret_cast<ImageDumper*>(arg); 985 if (!state->InDumpSpace(obj)) { 986 return; 987 } 988 989 size_t object_bytes = obj->SizeOf(); 990 size_t alignment_bytes = RoundUp(object_bytes, kObjectAlignment) - object_bytes; 991 state->stats_.object_bytes += object_bytes; 992 state->stats_.alignment_bytes += alignment_bytes; 993 994 std::ostream& os = *state->os_; 995 mirror::Class* obj_class = obj->GetClass(); 996 if (obj_class->IsArrayClass()) { 997 os << StringPrintf("%p: %s length:%d\n", obj, PrettyDescriptor(obj_class).c_str(), 998 obj->AsArray()->GetLength()); 999 } else if (obj->IsClass()) { 1000 mirror::Class* klass = obj->AsClass(); 1001 os << StringPrintf("%p: java.lang.Class \"%s\" (", obj, PrettyDescriptor(klass).c_str()) 1002 << klass->GetStatus() << ")\n"; 1003 } else if (obj->IsArtField()) { 1004 os << StringPrintf("%p: java.lang.reflect.ArtField %s\n", obj, 1005 PrettyField(obj->AsArtField()).c_str()); 1006 } else if (obj->IsArtMethod()) { 1007 os << StringPrintf("%p: java.lang.reflect.ArtMethod %s\n", obj, 1008 PrettyMethod(obj->AsArtMethod()).c_str()); 1009 } else if (obj_class->IsStringClass()) { 1010 os << StringPrintf("%p: java.lang.String %s\n", obj, 1011 PrintableString(obj->AsString()->ToModifiedUtf8()).c_str()); 1012 } else { 1013 os << StringPrintf("%p: %s\n", obj, PrettyDescriptor(obj_class).c_str()); 1014 } 1015 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1016 std::ostream indent_os(&indent_filter); 1017 DumpFields(indent_os, obj, obj_class); 1018 if (obj->IsObjectArray()) { 1019 mirror::ObjectArray<mirror::Object>* obj_array = obj->AsObjectArray<mirror::Object>(); 1020 int32_t length = obj_array->GetLength(); 1021 for (int32_t i = 0; i < length; i++) { 1022 mirror::Object* value = obj_array->Get(i); 1023 size_t run = 0; 1024 for (int32_t j = i + 1; j < length; j++) { 1025 if (value == obj_array->Get(j)) { 1026 run++; 1027 } else { 1028 break; 1029 } 1030 } 1031 if (run == 0) { 1032 indent_os << StringPrintf("%d: ", i); 1033 } else { 1034 indent_os << StringPrintf("%d to %zd: ", i, i + run); 1035 i = i + run; 1036 } 1037 mirror::Class* value_class = value == NULL ? obj_class->GetComponentType() : value->GetClass(); 1038 PrettyObjectValue(indent_os, value_class, value); 1039 } 1040 } else if (obj->IsClass()) { 1041 mirror::ObjectArray<mirror::ArtField>* sfields = obj->AsClass()->GetSFields(); 1042 if (sfields != NULL) { 1043 indent_os << "STATICS:\n"; 1044 Indenter indent2_filter(indent_os.rdbuf(), kIndentChar, kIndentBy1Count); 1045 std::ostream indent2_os(&indent2_filter); 1046 for (int32_t i = 0; i < sfields->GetLength(); i++) { 1047 mirror::ArtField* field = sfields->Get(i); 1048 PrintField(indent2_os, field, field->GetDeclaringClass()); 1049 } 1050 } 1051 } else if (obj->IsArtMethod()) { 1052 mirror::ArtMethod* method = obj->AsArtMethod(); 1053 if (method->IsNative()) { 1054 // TODO: portable dumping. 1055 DCHECK(method->GetNativeGcMap() == nullptr) << PrettyMethod(method); 1056 DCHECK(method->GetMappingTable() == nullptr) << PrettyMethod(method); 1057 bool first_occurrence; 1058 const void* quick_oat_code = state->GetQuickOatCodeBegin(method); 1059 uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method); 1060 state->ComputeOatSize(quick_oat_code, &first_occurrence); 1061 if (first_occurrence) { 1062 state->stats_.native_to_managed_code_bytes += quick_oat_code_size; 1063 } 1064 if (quick_oat_code != method->GetEntryPointFromQuickCompiledCode()) { 1065 indent_os << StringPrintf("OAT CODE: %p\n", quick_oat_code); 1066 } 1067 } else if (method->IsAbstract() || method->IsCalleeSaveMethod() || 1068 method->IsResolutionMethod() || method->IsImtConflictMethod() || 1069 MethodHelper(method).IsClassInitializer()) { 1070 DCHECK(method->GetNativeGcMap() == NULL) << PrettyMethod(method); 1071 DCHECK(method->GetMappingTable() == NULL) << PrettyMethod(method); 1072 } else { 1073 // TODO: we check there is a GC map here, we may not have a GC map if the code is pointing 1074 // to the quick/portable to interpreter bridge. 1075 CHECK(method->GetNativeGcMap() != NULL) << PrettyMethod(method); 1076 1077 const DexFile::CodeItem* code_item = MethodHelper(method).GetCodeItem(); 1078 size_t dex_instruction_bytes = code_item->insns_size_in_code_units_ * 2; 1079 state->stats_.dex_instruction_bytes += dex_instruction_bytes; 1080 1081 bool first_occurrence; 1082 size_t gc_map_bytes = state->ComputeOatSize(method->GetNativeGcMap(), &first_occurrence); 1083 if (first_occurrence) { 1084 state->stats_.gc_map_bytes += gc_map_bytes; 1085 } 1086 1087 size_t pc_mapping_table_bytes = 1088 state->ComputeOatSize(method->GetMappingTable(), &first_occurrence); 1089 if (first_occurrence) { 1090 state->stats_.pc_mapping_table_bytes += pc_mapping_table_bytes; 1091 } 1092 1093 size_t vmap_table_bytes = 1094 state->ComputeOatSize(method->GetVmapTable(), &first_occurrence); 1095 if (first_occurrence) { 1096 state->stats_.vmap_table_bytes += vmap_table_bytes; 1097 } 1098 1099 // TODO: portable dumping. 1100 const void* quick_oat_code_begin = state->GetQuickOatCodeBegin(method); 1101 const void* quick_oat_code_end = state->GetQuickOatCodeEnd(method); 1102 uint32_t quick_oat_code_size = state->GetQuickOatCodeSize(method); 1103 state->ComputeOatSize(quick_oat_code_begin, &first_occurrence); 1104 if (first_occurrence) { 1105 state->stats_.managed_code_bytes += quick_oat_code_size; 1106 if (method->IsConstructor()) { 1107 if (method->IsStatic()) { 1108 state->stats_.class_initializer_code_bytes += quick_oat_code_size; 1109 } else if (dex_instruction_bytes > kLargeConstructorDexBytes) { 1110 state->stats_.large_initializer_code_bytes += quick_oat_code_size; 1111 } 1112 } else if (dex_instruction_bytes > kLargeMethodDexBytes) { 1113 state->stats_.large_method_code_bytes += quick_oat_code_size; 1114 } 1115 } 1116 state->stats_.managed_code_bytes_ignoring_deduplication += quick_oat_code_size; 1117 1118 indent_os << StringPrintf("OAT CODE: %p-%p\n", quick_oat_code_begin, quick_oat_code_end); 1119 indent_os << StringPrintf("SIZE: Dex Instructions=%zd GC=%zd Mapping=%zd\n", 1120 dex_instruction_bytes, gc_map_bytes, pc_mapping_table_bytes); 1121 1122 size_t total_size = dex_instruction_bytes + gc_map_bytes + pc_mapping_table_bytes + 1123 vmap_table_bytes + quick_oat_code_size + object_bytes; 1124 1125 double expansion = 1126 static_cast<double>(quick_oat_code_size) / static_cast<double>(dex_instruction_bytes); 1127 state->stats_.ComputeOutliers(total_size, expansion, method); 1128 } 1129 } 1130 state->stats_.Update(ClassHelper(obj_class).GetDescriptor(), object_bytes); 1131 } 1132 1133 std::set<const void*> already_seen_; 1134 // Compute the size of the given data within the oat file and whether this is the first time 1135 // this data has been requested 1136 size_t ComputeOatSize(const void* oat_data, bool* first_occurrence) { 1137 if (already_seen_.count(oat_data) == 0) { 1138 *first_occurrence = true; 1139 already_seen_.insert(oat_data); 1140 } else { 1141 *first_occurrence = false; 1142 } 1143 return oat_dumper_->ComputeSize(oat_data); 1144 } 1145 1146 public: 1147 struct Stats { 1148 size_t oat_file_bytes; 1149 size_t file_bytes; 1150 1151 size_t header_bytes; 1152 size_t object_bytes; 1153 size_t bitmap_bytes; 1154 size_t alignment_bytes; 1155 1156 size_t managed_code_bytes; 1157 size_t managed_code_bytes_ignoring_deduplication; 1158 size_t managed_to_native_code_bytes; 1159 size_t native_to_managed_code_bytes; 1160 size_t class_initializer_code_bytes; 1161 size_t large_initializer_code_bytes; 1162 size_t large_method_code_bytes; 1163 1164 size_t gc_map_bytes; 1165 size_t pc_mapping_table_bytes; 1166 size_t vmap_table_bytes; 1167 1168 size_t dex_instruction_bytes; 1169 1170 std::vector<mirror::ArtMethod*> method_outlier; 1171 std::vector<size_t> method_outlier_size; 1172 std::vector<double> method_outlier_expansion; 1173 std::vector<std::pair<std::string, size_t> > oat_dex_file_sizes; 1174 1175 explicit Stats() 1176 : oat_file_bytes(0), 1177 file_bytes(0), 1178 header_bytes(0), 1179 object_bytes(0), 1180 bitmap_bytes(0), 1181 alignment_bytes(0), 1182 managed_code_bytes(0), 1183 managed_code_bytes_ignoring_deduplication(0), 1184 managed_to_native_code_bytes(0), 1185 native_to_managed_code_bytes(0), 1186 class_initializer_code_bytes(0), 1187 large_initializer_code_bytes(0), 1188 large_method_code_bytes(0), 1189 gc_map_bytes(0), 1190 pc_mapping_table_bytes(0), 1191 vmap_table_bytes(0), 1192 dex_instruction_bytes(0) {} 1193 1194 struct SizeAndCount { 1195 SizeAndCount(size_t bytes, size_t count) : bytes(bytes), count(count) {} 1196 size_t bytes; 1197 size_t count; 1198 }; 1199 typedef SafeMap<std::string, SizeAndCount> SizeAndCountTable; 1200 SizeAndCountTable sizes_and_counts; 1201 1202 void Update(const char* descriptor, size_t object_bytes) { 1203 SizeAndCountTable::iterator it = sizes_and_counts.find(descriptor); 1204 if (it != sizes_and_counts.end()) { 1205 it->second.bytes += object_bytes; 1206 it->second.count += 1; 1207 } else { 1208 sizes_and_counts.Put(descriptor, SizeAndCount(object_bytes, 1)); 1209 } 1210 } 1211 1212 double PercentOfOatBytes(size_t size) { 1213 return (static_cast<double>(size) / static_cast<double>(oat_file_bytes)) * 100; 1214 } 1215 1216 double PercentOfFileBytes(size_t size) { 1217 return (static_cast<double>(size) / static_cast<double>(file_bytes)) * 100; 1218 } 1219 1220 double PercentOfObjectBytes(size_t size) { 1221 return (static_cast<double>(size) / static_cast<double>(object_bytes)) * 100; 1222 } 1223 1224 void ComputeOutliers(size_t total_size, double expansion, mirror::ArtMethod* method) { 1225 method_outlier_size.push_back(total_size); 1226 method_outlier_expansion.push_back(expansion); 1227 method_outlier.push_back(method); 1228 } 1229 1230 void DumpOutliers(std::ostream& os) 1231 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1232 size_t sum_of_sizes = 0; 1233 size_t sum_of_sizes_squared = 0; 1234 size_t sum_of_expansion = 0; 1235 size_t sum_of_expansion_squared = 0; 1236 size_t n = method_outlier_size.size(); 1237 for (size_t i = 0; i < n; i++) { 1238 size_t cur_size = method_outlier_size[i]; 1239 sum_of_sizes += cur_size; 1240 sum_of_sizes_squared += cur_size * cur_size; 1241 double cur_expansion = method_outlier_expansion[i]; 1242 sum_of_expansion += cur_expansion; 1243 sum_of_expansion_squared += cur_expansion * cur_expansion; 1244 } 1245 size_t size_mean = sum_of_sizes / n; 1246 size_t size_variance = (sum_of_sizes_squared - sum_of_sizes * size_mean) / (n - 1); 1247 double expansion_mean = sum_of_expansion / n; 1248 double expansion_variance = 1249 (sum_of_expansion_squared - sum_of_expansion * expansion_mean) / (n - 1); 1250 1251 // Dump methods whose size is a certain number of standard deviations from the mean 1252 size_t dumped_values = 0; 1253 size_t skipped_values = 0; 1254 for (size_t i = 100; i > 0; i--) { // i is the current number of standard deviations 1255 size_t cur_size_variance = i * i * size_variance; 1256 bool first = true; 1257 for (size_t j = 0; j < n; j++) { 1258 size_t cur_size = method_outlier_size[j]; 1259 if (cur_size > size_mean) { 1260 size_t cur_var = cur_size - size_mean; 1261 cur_var = cur_var * cur_var; 1262 if (cur_var > cur_size_variance) { 1263 if (dumped_values > 20) { 1264 if (i == 1) { 1265 skipped_values++; 1266 } else { 1267 i = 2; // jump to counting for 1 standard deviation 1268 break; 1269 } 1270 } else { 1271 if (first) { 1272 os << "\nBig methods (size > " << i << " standard deviations the norm):\n"; 1273 first = false; 1274 } 1275 os << PrettyMethod(method_outlier[j]) << " requires storage of " 1276 << PrettySize(cur_size) << "\n"; 1277 method_outlier_size[j] = 0; // don't consider this method again 1278 dumped_values++; 1279 } 1280 } 1281 } 1282 } 1283 } 1284 if (skipped_values > 0) { 1285 os << "... skipped " << skipped_values 1286 << " methods with size > 1 standard deviation from the norm\n"; 1287 } 1288 os << std::flush; 1289 1290 // Dump methods whose expansion is a certain number of standard deviations from the mean 1291 dumped_values = 0; 1292 skipped_values = 0; 1293 for (size_t i = 10; i > 0; i--) { // i is the current number of standard deviations 1294 double cur_expansion_variance = i * i * expansion_variance; 1295 bool first = true; 1296 for (size_t j = 0; j < n; j++) { 1297 double cur_expansion = method_outlier_expansion[j]; 1298 if (cur_expansion > expansion_mean) { 1299 size_t cur_var = cur_expansion - expansion_mean; 1300 cur_var = cur_var * cur_var; 1301 if (cur_var > cur_expansion_variance) { 1302 if (dumped_values > 20) { 1303 if (i == 1) { 1304 skipped_values++; 1305 } else { 1306 i = 2; // jump to counting for 1 standard deviation 1307 break; 1308 } 1309 } else { 1310 if (first) { 1311 os << "\nLarge expansion methods (size > " << i 1312 << " standard deviations the norm):\n"; 1313 first = false; 1314 } 1315 os << PrettyMethod(method_outlier[j]) << " expanded code by " 1316 << cur_expansion << "\n"; 1317 method_outlier_expansion[j] = 0.0; // don't consider this method again 1318 dumped_values++; 1319 } 1320 } 1321 } 1322 } 1323 } 1324 if (skipped_values > 0) { 1325 os << "... skipped " << skipped_values 1326 << " methods with expansion > 1 standard deviation from the norm\n"; 1327 } 1328 os << "\n" << std::flush; 1329 } 1330 1331 void Dump(std::ostream& os) SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { 1332 { 1333 os << "art_file_bytes = " << PrettySize(file_bytes) << "\n\n" 1334 << "art_file_bytes = header_bytes + object_bytes + alignment_bytes\n"; 1335 Indenter indent_filter(os.rdbuf(), kIndentChar, kIndentBy1Count); 1336 std::ostream indent_os(&indent_filter); 1337 indent_os << StringPrintf("header_bytes = %8zd (%2.0f%% of art file bytes)\n" 1338 "object_bytes = %8zd (%2.0f%% of art file bytes)\n" 1339 "bitmap_bytes = %8zd (%2.0f%% of art file bytes)\n" 1340 "alignment_bytes = %8zd (%2.0f%% of art file bytes)\n\n", 1341 header_bytes, PercentOfFileBytes(header_bytes), 1342 object_bytes, PercentOfFileBytes(object_bytes), 1343 bitmap_bytes, PercentOfFileBytes(bitmap_bytes), 1344 alignment_bytes, PercentOfFileBytes(alignment_bytes)) 1345 << std::flush; 1346 CHECK_EQ(file_bytes, bitmap_bytes + header_bytes + object_bytes + alignment_bytes); 1347 } 1348 1349 os << "object_bytes breakdown:\n"; 1350 size_t object_bytes_total = 0; 1351 for (const auto& sizes_and_count : sizes_and_counts) { 1352 const std::string& descriptor(sizes_and_count.first); 1353 double average = static_cast<double>(sizes_and_count.second.bytes) / 1354 static_cast<double>(sizes_and_count.second.count); 1355 double percent = PercentOfObjectBytes(sizes_and_count.second.bytes); 1356 os << StringPrintf("%32s %8zd bytes %6zd instances " 1357 "(%4.0f bytes/instance) %2.0f%% of object_bytes\n", 1358 descriptor.c_str(), sizes_and_count.second.bytes, 1359 sizes_and_count.second.count, average, percent); 1360 object_bytes_total += sizes_and_count.second.bytes; 1361 } 1362 os << "\n" << std::flush; 1363 CHECK_EQ(object_bytes, object_bytes_total); 1364 1365 os << StringPrintf("oat_file_bytes = %8zd\n" 1366 "managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1367 "managed_to_native_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1368 "native_to_managed_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n" 1369 "class_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1370 "large_initializer_code_bytes = %8zd (%2.0f%% of oat file bytes)\n" 1371 "large_method_code_bytes = %8zd (%2.0f%% of oat file bytes)\n\n", 1372 oat_file_bytes, 1373 managed_code_bytes, PercentOfOatBytes(managed_code_bytes), 1374 managed_to_native_code_bytes, PercentOfOatBytes(managed_to_native_code_bytes), 1375 native_to_managed_code_bytes, PercentOfOatBytes(native_to_managed_code_bytes), 1376 class_initializer_code_bytes, PercentOfOatBytes(class_initializer_code_bytes), 1377 large_initializer_code_bytes, PercentOfOatBytes(large_initializer_code_bytes), 1378 large_method_code_bytes, PercentOfOatBytes(large_method_code_bytes)) 1379 << "DexFile sizes:\n"; 1380 for (const std::pair<std::string, size_t>& oat_dex_file_size : oat_dex_file_sizes) { 1381 os << StringPrintf("%s = %zd (%2.0f%% of oat file bytes)\n", 1382 oat_dex_file_size.first.c_str(), oat_dex_file_size.second, 1383 PercentOfOatBytes(oat_dex_file_size.second)); 1384 } 1385 1386 os << "\n" << StringPrintf("gc_map_bytes = %7zd (%2.0f%% of oat file bytes)\n" 1387 "pc_mapping_table_bytes = %7zd (%2.0f%% of oat file bytes)\n" 1388 "vmap_table_bytes = %7zd (%2.0f%% of oat file bytes)\n\n", 1389 gc_map_bytes, PercentOfOatBytes(gc_map_bytes), 1390 pc_mapping_table_bytes, PercentOfOatBytes(pc_mapping_table_bytes), 1391 vmap_table_bytes, PercentOfOatBytes(vmap_table_bytes)) 1392 << std::flush; 1393 1394 os << StringPrintf("dex_instruction_bytes = %zd\n", dex_instruction_bytes) 1395 << StringPrintf("managed_code_bytes expansion = %.2f (ignoring deduplication %.2f)\n\n", 1396 static_cast<double>(managed_code_bytes) / static_cast<double>(dex_instruction_bytes), 1397 static_cast<double>(managed_code_bytes_ignoring_deduplication) / 1398 static_cast<double>(dex_instruction_bytes)) 1399 << std::flush; 1400 1401 DumpOutliers(os); 1402 } 1403 } stats_; 1404 1405 private: 1406 enum { 1407 // Number of bytes for a constructor to be considered large. Based on the 1000 basic block 1408 // threshold, we assume 2 bytes per instruction and 2 instructions per block. 1409 kLargeConstructorDexBytes = 4000, 1410 // Number of bytes for a method to be considered large. Based on the 4000 basic block 1411 // threshold, we assume 2 bytes per instruction and 2 instructions per block. 1412 kLargeMethodDexBytes = 16000 1413 }; 1414 UniquePtr<OatDumper> oat_dumper_; 1415 std::ostream* os_; 1416 const std::string image_filename_; 1417 const std::string host_prefix_; 1418 gc::space::ImageSpace& image_space_; 1419 const ImageHeader& image_header_; 1420 bool dump_raw_mapping_table_; 1421 bool dump_raw_gc_map_; 1422 1423 DISALLOW_COPY_AND_ASSIGN(ImageDumper); 1424}; 1425 1426static int oatdump(int argc, char** argv) { 1427 InitLogging(argv); 1428 1429 // Skip over argv[0]. 1430 argv++; 1431 argc--; 1432 1433 if (argc == 0) { 1434 fprintf(stderr, "No arguments specified\n"); 1435 usage(); 1436 } 1437 1438 const char* oat_filename = NULL; 1439 const char* image_filename = NULL; 1440 const char* boot_image_filename = NULL; 1441 std::string elf_filename_prefix; 1442 UniquePtr<std::string> host_prefix; 1443 std::ostream* os = &std::cout; 1444 UniquePtr<std::ofstream> out; 1445 bool dump_raw_mapping_table = false; 1446 bool dump_raw_gc_map = false; 1447 1448 for (int i = 0; i < argc; i++) { 1449 const StringPiece option(argv[i]); 1450 if (option.starts_with("--oat-file=")) { 1451 oat_filename = option.substr(strlen("--oat-file=")).data(); 1452 } else if (option.starts_with("--image=")) { 1453 image_filename = option.substr(strlen("--image=")).data(); 1454 } else if (option.starts_with("--boot-image=")) { 1455 boot_image_filename = option.substr(strlen("--boot-image=")).data(); 1456 } else if (option.starts_with("--host-prefix=")) { 1457 host_prefix.reset(new std::string(option.substr(strlen("--host-prefix=")).data())); 1458 } else if (option.starts_with("--dump:")) { 1459 if (option == "--dump:raw_mapping_table") { 1460 dump_raw_mapping_table = true; 1461 } else if (option == "--dump:raw_gc_map") { 1462 dump_raw_gc_map = true; 1463 } else { 1464 fprintf(stderr, "Unknown argument %s\n", option.data()); 1465 usage(); 1466 } 1467 } else if (option.starts_with("--output=")) { 1468 const char* filename = option.substr(strlen("--output=")).data(); 1469 out.reset(new std::ofstream(filename)); 1470 if (!out->good()) { 1471 fprintf(stderr, "Failed to open output filename %s\n", filename); 1472 usage(); 1473 } 1474 os = out.get(); 1475 } else { 1476 fprintf(stderr, "Unknown argument %s\n", option.data()); 1477 usage(); 1478 } 1479 } 1480 1481 if (image_filename == NULL && oat_filename == NULL) { 1482 fprintf(stderr, "Either --image or --oat must be specified\n"); 1483 return EXIT_FAILURE; 1484 } 1485 1486 if (image_filename != NULL && oat_filename != NULL) { 1487 fprintf(stderr, "Either --image or --oat must be specified but not both\n"); 1488 return EXIT_FAILURE; 1489 } 1490 1491 if (host_prefix.get() == NULL) { 1492 const char* android_product_out = getenv("ANDROID_PRODUCT_OUT"); 1493 if (android_product_out != NULL) { 1494 host_prefix.reset(new std::string(android_product_out)); 1495 } else { 1496 host_prefix.reset(new std::string("")); 1497 } 1498 } 1499 1500 if (oat_filename != NULL) { 1501 std::string error_msg; 1502 OatFile* oat_file = 1503 OatFile::Open(oat_filename, oat_filename, NULL, false, &error_msg); 1504 if (oat_file == NULL) { 1505 fprintf(stderr, "Failed to open oat file from '%s': %s\n", oat_filename, error_msg.c_str()); 1506 return EXIT_FAILURE; 1507 } 1508 OatDumper oat_dumper(*host_prefix.get(), *oat_file, dump_raw_mapping_table, dump_raw_gc_map); 1509 oat_dumper.Dump(*os); 1510 return EXIT_SUCCESS; 1511 } 1512 1513 Runtime::Options options; 1514 std::string image_option; 1515 std::string oat_option; 1516 std::string boot_image_option; 1517 std::string boot_oat_option; 1518 1519 // We are more like a compiler than a run-time. We don't want to execute code. 1520 struct OatDumpCompilerCallbacks : CompilerCallbacks { 1521 virtual bool MethodVerified(verifier::MethodVerifier* /*verifier*/) { return true; } 1522 virtual void ClassRejected(ClassReference /*ref*/) { } 1523 } callbacks; 1524 options.push_back(std::make_pair("compilercallbacks", 1525 static_cast<CompilerCallbacks*>(&callbacks))); 1526 1527 if (boot_image_filename != NULL) { 1528 boot_image_option += "-Ximage:"; 1529 boot_image_option += boot_image_filename; 1530 options.push_back(std::make_pair(boot_image_option.c_str(), reinterpret_cast<void*>(NULL))); 1531 } 1532 if (image_filename != NULL) { 1533 image_option += "-Ximage:"; 1534 image_option += image_filename; 1535 options.push_back(std::make_pair(image_option.c_str(), reinterpret_cast<void*>(NULL))); 1536 } 1537 1538 if (!host_prefix->empty()) { 1539 options.push_back(std::make_pair("host-prefix", host_prefix->c_str())); 1540 } 1541 1542 if (!Runtime::Create(options, false)) { 1543 fprintf(stderr, "Failed to create runtime\n"); 1544 return EXIT_FAILURE; 1545 } 1546 UniquePtr<Runtime> runtime(Runtime::Current()); 1547 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 1548 // give it away now and then switch to a more managable ScopedObjectAccess. 1549 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 1550 ScopedObjectAccess soa(Thread::Current()); 1551 1552 gc::Heap* heap = Runtime::Current()->GetHeap(); 1553 gc::space::ImageSpace* image_space = heap->GetImageSpace(); 1554 CHECK(image_space != NULL); 1555 const ImageHeader& image_header = image_space->GetImageHeader(); 1556 if (!image_header.IsValid()) { 1557 fprintf(stderr, "Invalid image header %s\n", image_filename); 1558 return EXIT_FAILURE; 1559 } 1560 ImageDumper image_dumper(os, image_filename, *host_prefix.get(), *image_space, image_header, 1561 dump_raw_mapping_table, dump_raw_gc_map); 1562 image_dumper.Dump(); 1563 return EXIT_SUCCESS; 1564} 1565 1566} // namespace art 1567 1568int main(int argc, char** argv) { 1569 return art::oatdump(argc, argv); 1570} 1571