patchoat.cc revision 4bcde15734613057d8343742b59d0aaae4e133a7
1/* 2 * Copyright (C) 2014 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#include "patchoat.h" 17 18#include <openssl/sha.h> 19#include <stdio.h> 20#include <stdlib.h> 21#include <sys/file.h> 22#include <sys/stat.h> 23#include <unistd.h> 24 25#include <string> 26#include <vector> 27 28#include "android-base/file.h" 29#include "android-base/stringprintf.h" 30#include "android-base/strings.h" 31 32#include "art_field-inl.h" 33#include "art_method-inl.h" 34#include "base/dumpable.h" 35#include "base/file_utils.h" 36#include "base/leb128.h" 37#include "base/logging.h" // For InitLogging. 38#include "base/mutex.h" 39#include "base/memory_tool.h" 40#include "base/os.h" 41#include "base/scoped_flock.h" 42#include "base/stringpiece.h" 43#include "base/unix_file/fd_file.h" 44#include "base/unix_file/random_access_file_utils.h" 45#include "base/utils.h" 46#include "elf_file.h" 47#include "elf_file_impl.h" 48#include "elf_utils.h" 49#include "gc/space/image_space.h" 50#include "image-inl.h" 51#include "intern_table.h" 52#include "mirror/dex_cache.h" 53#include "mirror/executable.h" 54#include "mirror/method.h" 55#include "mirror/object-inl.h" 56#include "mirror/object-refvisitor-inl.h" 57#include "mirror/reference.h" 58#include "noop_compiler_callbacks.h" 59#include "offsets.h" 60#include "runtime.h" 61#include "scoped_thread_state_change-inl.h" 62#include "thread.h" 63 64namespace art { 65 66using android::base::StringPrintf; 67 68namespace { 69 70static const OatHeader* GetOatHeader(const ElfFile* elf_file) { 71 uint64_t off = 0; 72 if (!elf_file->GetSectionOffsetAndSize(".rodata", &off, nullptr)) { 73 return nullptr; 74 } 75 76 OatHeader* oat_header = reinterpret_cast<OatHeader*>(elf_file->Begin() + off); 77 return oat_header; 78} 79 80static File* CreateOrOpen(const char* name) { 81 if (OS::FileExists(name)) { 82 return OS::OpenFileReadWrite(name); 83 } else { 84 std::unique_ptr<File> f(OS::CreateEmptyFile(name)); 85 if (f.get() != nullptr) { 86 if (fchmod(f->Fd(), 0644) != 0) { 87 PLOG(ERROR) << "Unable to make " << name << " world readable"; 88 unlink(name); 89 return nullptr; 90 } 91 } 92 return f.release(); 93 } 94} 95 96// Either try to close the file (close=true), or erase it. 97static bool FinishFile(File* file, bool close) { 98 if (close) { 99 if (file->FlushCloseOrErase() != 0) { 100 PLOG(ERROR) << "Failed to flush and close file."; 101 return false; 102 } 103 return true; 104 } else { 105 file->Erase(); 106 return false; 107 } 108} 109 110static bool SymlinkFile(const std::string& input_filename, const std::string& output_filename) { 111 if (input_filename == output_filename) { 112 // Input and output are the same, nothing to do. 113 return true; 114 } 115 116 // Unlink the original filename, since we are overwriting it. 117 unlink(output_filename.c_str()); 118 119 // Create a symlink from the source file to the target path. 120 if (symlink(input_filename.c_str(), output_filename.c_str()) < 0) { 121 PLOG(ERROR) << "Failed to create symlink " << output_filename << " -> " << input_filename; 122 return false; 123 } 124 125 if (kIsDebugBuild) { 126 LOG(INFO) << "Created symlink " << output_filename << " -> " << input_filename; 127 } 128 129 return true; 130} 131 132// Holder class for runtime options and related objects. 133class PatchoatRuntimeOptionsHolder { 134 public: 135 PatchoatRuntimeOptionsHolder(const std::string& image_location, InstructionSet isa) { 136 options_.push_back(std::make_pair("compilercallbacks", &callbacks_)); 137 img_ = "-Ximage:" + image_location; 138 options_.push_back(std::make_pair(img_.c_str(), nullptr)); 139 isa_name_ = GetInstructionSetString(isa); 140 options_.push_back(std::make_pair("imageinstructionset", 141 reinterpret_cast<const void*>(isa_name_.c_str()))); 142 options_.push_back(std::make_pair("-Xno-sig-chain", nullptr)); 143 // We do not want the runtime to attempt to patch the image. 144 options_.push_back(std::make_pair("-Xnorelocate", nullptr)); 145 // Don't try to compile. 146 options_.push_back(std::make_pair("-Xnoimage-dex2oat", nullptr)); 147 // Do not accept broken image. 148 options_.push_back(std::make_pair("-Xno-dex-file-fallback", nullptr)); 149 } 150 151 const RuntimeOptions& GetRuntimeOptions() { 152 return options_; 153 } 154 155 private: 156 RuntimeOptions options_; 157 NoopCompilerCallbacks callbacks_; 158 std::string isa_name_; 159 std::string img_; 160}; 161 162} // namespace 163 164bool PatchOat::GeneratePatch( 165 const MemMap& original, 166 const MemMap& relocated, 167 std::vector<uint8_t>* output, 168 std::string* error_msg) { 169 // FORMAT of the patch (aka image relocation) file: 170 // * SHA-256 digest (32 bytes) of original/unrelocated file (e.g., the one from /system) 171 // * List of monotonically increasing offsets (max value defined by uint32_t) at which relocations 172 // occur. 173 // Each element is represented as the delta from the previous offset in the list (first element 174 // is a delta from 0). Each delta is encoded using unsigned LEB128: little-endian 175 // variable-length 7 bits per byte encoding, where all bytes have the highest bit (0x80) set 176 // except for the final byte which does not have that bit set. For example, 0x3f is offset 0x3f, 177 // whereas 0xbf 0x05 is offset (0x3f & 0x7f) | (0x5 << 7) which is 0x2bf. Most deltas end up 178 // being encoding using just one byte, achieving ~4x decrease in relocation file size compared 179 // to the encoding where offsets are stored verbatim, as uint32_t. 180 181 size_t original_size = original.Size(); 182 size_t relocated_size = relocated.Size(); 183 if (original_size != relocated_size) { 184 *error_msg = 185 StringPrintf( 186 "Original and relocated image sizes differ: %zu vs %zu", original_size, relocated_size); 187 return false; 188 } 189 if ((original_size % 4) != 0) { 190 *error_msg = StringPrintf("Image size not multiple of 4: %zu", original_size); 191 return false; 192 } 193 if (original_size > UINT32_MAX) { 194 *error_msg = StringPrintf("Image too large: %zu" , original_size); 195 return false; 196 } 197 198 const ImageHeader& relocated_header = 199 *reinterpret_cast<const ImageHeader*>(relocated.Begin()); 200 // Offsets are supposed to differ between original and relocated by this value 201 off_t expected_diff = relocated_header.GetPatchDelta(); 202 if (expected_diff == 0) { 203 // Can't identify offsets which are supposed to differ due to relocation 204 *error_msg = "Relocation delta is 0"; 205 return false; 206 } 207 208 // Output the SHA-256 digest of the original 209 output->resize(SHA256_DIGEST_LENGTH); 210 const uint8_t* original_bytes = original.Begin(); 211 SHA256(original_bytes, original_size, output->data()); 212 213 // Output the list of offsets at which the original and patched images differ 214 size_t last_diff_offset = 0; 215 size_t diff_offset_count = 0; 216 const uint8_t* relocated_bytes = relocated.Begin(); 217 for (size_t offset = 0; offset < original_size; offset += 4) { 218 uint32_t original_value = *reinterpret_cast<const uint32_t*>(original_bytes + offset); 219 uint32_t relocated_value = *reinterpret_cast<const uint32_t*>(relocated_bytes + offset); 220 off_t diff = relocated_value - original_value; 221 if (diff == 0) { 222 continue; 223 } else if (diff != expected_diff) { 224 *error_msg = 225 StringPrintf( 226 "Unexpected diff at offset %zu. Expected: %jd, but was: %jd", 227 offset, 228 (intmax_t) expected_diff, 229 (intmax_t) diff); 230 return false; 231 } 232 233 uint32_t offset_diff = offset - last_diff_offset; 234 last_diff_offset = offset; 235 diff_offset_count++; 236 237 EncodeUnsignedLeb128(output, offset_diff); 238 } 239 240 if (diff_offset_count == 0) { 241 *error_msg = "Original and patched images are identical"; 242 return false; 243 } 244 245 return true; 246} 247 248static bool WriteRelFile( 249 const MemMap& original, 250 const MemMap& relocated, 251 const std::string& rel_filename, 252 std::string* error_msg) { 253 std::vector<uint8_t> output; 254 if (!PatchOat::GeneratePatch(original, relocated, &output, error_msg)) { 255 return false; 256 } 257 258 std::unique_ptr<File> rel_file(OS::CreateEmptyFileWriteOnly(rel_filename.c_str())); 259 if (rel_file.get() == nullptr) { 260 *error_msg = StringPrintf("Failed to create/open output file %s", rel_filename.c_str()); 261 return false; 262 } 263 if (!rel_file->WriteFully(output.data(), output.size())) { 264 *error_msg = StringPrintf("Failed to write to %s", rel_filename.c_str()); 265 return false; 266 } 267 if (rel_file->FlushCloseOrErase() != 0) { 268 *error_msg = StringPrintf("Failed to flush and close %s", rel_filename.c_str()); 269 return false; 270 } 271 272 return true; 273} 274 275static bool CheckImageIdenticalToOriginalExceptForRelocation( 276 const std::string& relocated_filename, 277 const std::string& original_filename, 278 std::string* error_msg) { 279 *error_msg = ""; 280 std::string rel_filename = original_filename + ".rel"; 281 std::unique_ptr<File> rel_file(OS::OpenFileForReading(rel_filename.c_str())); 282 if (rel_file.get() == nullptr) { 283 *error_msg = StringPrintf("Failed to open image relocation file %s", rel_filename.c_str()); 284 return false; 285 } 286 int64_t rel_size = rel_file->GetLength(); 287 if (rel_size < 0) { 288 *error_msg = StringPrintf("Error while getting size of image relocation file %s", 289 rel_filename.c_str()); 290 return false; 291 } 292 std::unique_ptr<uint8_t[]> rel(new uint8_t[rel_size]); 293 if (!rel_file->ReadFully(rel.get(), rel_size)) { 294 *error_msg = StringPrintf("Failed to read image relocation file %s", rel_filename.c_str()); 295 return false; 296 } 297 298 std::unique_ptr<File> image_file(OS::OpenFileForReading(relocated_filename.c_str())); 299 if (image_file.get() == nullptr) { 300 *error_msg = StringPrintf("Unable to open relocated image file %s", 301 relocated_filename.c_str()); 302 return false; 303 } 304 305 int64_t image_size = image_file->GetLength(); 306 if (image_size < 0) { 307 *error_msg = StringPrintf("Error while getting size of relocated image file %s", 308 relocated_filename.c_str()); 309 return false; 310 } 311 if ((image_size % 4) != 0) { 312 *error_msg = 313 StringPrintf( 314 "Relocated image file %s size not multiple of 4: %" PRId64, 315 relocated_filename.c_str(), image_size); 316 return false; 317 } 318 if (image_size > std::numeric_limits<uint32_t>::max()) { 319 *error_msg = 320 StringPrintf( 321 "Relocated image file %s too large: %" PRId64, relocated_filename.c_str(), image_size); 322 return false; 323 } 324 325 std::unique_ptr<uint8_t[]> image(new uint8_t[image_size]); 326 if (!image_file->ReadFully(image.get(), image_size)) { 327 *error_msg = StringPrintf("Failed to read relocated image file %s", relocated_filename.c_str()); 328 return false; 329 } 330 331 const uint8_t* original_image_digest = rel.get(); 332 if (rel_size < SHA256_DIGEST_LENGTH) { 333 *error_msg = StringPrintf("Malformed image relocation file %s: too short", 334 rel_filename.c_str()); 335 return false; 336 } 337 338 const ImageHeader& image_header = *reinterpret_cast<const ImageHeader*>(image.get()); 339 off_t expected_diff = image_header.GetPatchDelta(); 340 341 if (expected_diff == 0) { 342 *error_msg = StringPrintf("Unsuported patch delta of zero in %s", 343 relocated_filename.c_str()); 344 return false; 345 } 346 347 // Relocated image is expected to differ from the original due to relocation. 348 // Unrelocate the image in memory to compensate. 349 uint8_t* image_start = image.get(); 350 const uint8_t* rel_end = &rel[rel_size]; 351 const uint8_t* rel_ptr = &rel[SHA256_DIGEST_LENGTH]; 352 // The remaining .rel file consists of offsets at which relocation should've occurred. 353 // For each offset, we "unrelocate" the image by subtracting the expected relocation 354 // diff value (as specified in the image header). 355 // 356 // Each offset is encoded as a delta/diff relative to the previous offset. With the 357 // very first offset being encoded relative to offset 0. 358 // Deltas are encoded using little-endian 7 bits per byte encoding, with all bytes except 359 // the last one having the highest bit set. 360 uint32_t offset = 0; 361 while (rel_ptr != rel_end) { 362 uint32_t offset_delta = 0; 363 if (DecodeUnsignedLeb128Checked(&rel_ptr, rel_end, &offset_delta)) { 364 offset += offset_delta; 365 uint32_t *image_value = reinterpret_cast<uint32_t*>(image_start + offset); 366 *image_value -= expected_diff; 367 } else { 368 *error_msg = 369 StringPrintf( 370 "Malformed image relocation file %s: " 371 "last byte has it's most significant bit set", 372 rel_filename.c_str()); 373 return false; 374 } 375 } 376 377 // Image in memory is now supposed to be identical to the original. We 378 // confirm this by comparing the digest of the in-memory image to the expected 379 // digest from relocation file. 380 uint8_t image_digest[SHA256_DIGEST_LENGTH]; 381 SHA256(image.get(), image_size, image_digest); 382 if (memcmp(image_digest, original_image_digest, SHA256_DIGEST_LENGTH) != 0) { 383 *error_msg = 384 StringPrintf( 385 "Relocated image %s does not match the original %s after unrelocation", 386 relocated_filename.c_str(), 387 original_filename.c_str()); 388 return false; 389 } 390 391 // Relocated image is identical to the original, once relocations are taken into account 392 return true; 393} 394 395static bool VerifySymlink(const std::string& intended_target, const std::string& link_name) { 396 std::string actual_target; 397 if (!android::base::Readlink(link_name, &actual_target)) { 398 PLOG(ERROR) << "Readlink on " << link_name << " failed."; 399 return false; 400 } 401 return actual_target == intended_target; 402} 403 404static bool VerifyVdexAndOatSymlinks(const std::string& input_image_filename, 405 const std::string& output_image_filename) { 406 return VerifySymlink(ImageHeader::GetVdexLocationFromImageLocation(input_image_filename), 407 ImageHeader::GetVdexLocationFromImageLocation(output_image_filename)) 408 && VerifySymlink(ImageHeader::GetOatLocationFromImageLocation(input_image_filename), 409 ImageHeader::GetOatLocationFromImageLocation(output_image_filename)); 410} 411 412bool PatchOat::CreateVdexAndOatSymlinks(const std::string& input_image_filename, 413 const std::string& output_image_filename) { 414 std::string input_vdex_filename = 415 ImageHeader::GetVdexLocationFromImageLocation(input_image_filename); 416 std::string input_oat_filename = 417 ImageHeader::GetOatLocationFromImageLocation(input_image_filename); 418 419 std::unique_ptr<File> input_oat_file(OS::OpenFileForReading(input_oat_filename.c_str())); 420 if (input_oat_file.get() == nullptr) { 421 LOG(ERROR) << "Unable to open input oat file at " << input_oat_filename; 422 return false; 423 } 424 std::string error_msg; 425 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat_file.get(), 426 PROT_READ | PROT_WRITE, 427 MAP_PRIVATE, 428 &error_msg)); 429 if (elf.get() == nullptr) { 430 LOG(ERROR) << "Unable to open oat file " << input_oat_filename << " : " << error_msg; 431 return false; 432 } 433 434 MaybePic is_oat_pic = IsOatPic(elf.get()); 435 if (is_oat_pic >= ERROR_FIRST) { 436 // Error logged by IsOatPic 437 return false; 438 } else if (is_oat_pic == NOT_PIC) { 439 LOG(ERROR) << "patchoat cannot be used on non-PIC oat file: " << input_oat_filename; 440 return false; 441 } 442 443 CHECK(is_oat_pic == PIC); 444 445 std::string output_vdex_filename = 446 ImageHeader::GetVdexLocationFromImageLocation(output_image_filename); 447 std::string output_oat_filename = 448 ImageHeader::GetOatLocationFromImageLocation(output_image_filename); 449 450 return SymlinkFile(input_oat_filename, output_oat_filename) && 451 SymlinkFile(input_vdex_filename, output_vdex_filename); 452} 453 454bool PatchOat::Patch(const std::string& image_location, 455 off_t delta, 456 const std::string& output_image_directory, 457 const std::string& output_image_relocation_directory, 458 InstructionSet isa, 459 TimingLogger* timings) { 460 bool output_image = !output_image_directory.empty(); 461 bool output_image_relocation = !output_image_relocation_directory.empty(); 462 if ((!output_image) && (!output_image_relocation)) { 463 // Nothing to do 464 return true; 465 } 466 if ((output_image_relocation) && (delta == 0)) { 467 LOG(ERROR) << "Cannot output image relocation information when requested relocation delta is 0"; 468 return false; 469 } 470 471 CHECK(Runtime::Current() == nullptr); 472 CHECK(!image_location.empty()) << "image file must have a filename."; 473 474 TimingLogger::ScopedTiming t("Runtime Setup", timings); 475 476 CHECK_NE(isa, InstructionSet::kNone); 477 478 // Set up the runtime 479 PatchoatRuntimeOptionsHolder options_holder(image_location, isa); 480 if (!Runtime::Create(options_holder.GetRuntimeOptions(), false)) { 481 LOG(ERROR) << "Unable to initialize runtime"; 482 return false; 483 } 484 std::unique_ptr<Runtime> runtime(Runtime::Current()); 485 486 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 487 // give it away now and then switch to a more manageable ScopedObjectAccess. 488 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 489 ScopedObjectAccess soa(Thread::Current()); 490 491 std::vector<gc::space::ImageSpace*> spaces = Runtime::Current()->GetHeap()->GetBootImageSpaces(); 492 std::map<gc::space::ImageSpace*, std::unique_ptr<MemMap>> space_to_memmap_map; 493 494 for (size_t i = 0; i < spaces.size(); ++i) { 495 t.NewTiming("Image Patching setup"); 496 gc::space::ImageSpace* space = spaces[i]; 497 std::string input_image_filename = space->GetImageFilename(); 498 std::unique_ptr<File> input_image(OS::OpenFileForReading(input_image_filename.c_str())); 499 if (input_image.get() == nullptr) { 500 LOG(ERROR) << "Unable to open input image file at " << input_image_filename; 501 return false; 502 } 503 504 int64_t image_len = input_image->GetLength(); 505 if (image_len < 0) { 506 LOG(ERROR) << "Error while getting image length"; 507 return false; 508 } 509 ImageHeader image_header; 510 if (sizeof(image_header) != input_image->Read(reinterpret_cast<char*>(&image_header), 511 sizeof(image_header), 0)) { 512 LOG(ERROR) << "Unable to read image header from image file " << input_image->GetPath(); 513 } 514 515 /*bool is_image_pic = */IsImagePic(image_header, input_image->GetPath()); 516 // Nothing special to do right now since the image always needs to get patched. 517 // Perhaps in some far-off future we may have images with relative addresses that are true-PIC. 518 519 // Create the map where we will write the image patches to. 520 std::string error_msg; 521 std::unique_ptr<MemMap> image(MemMap::MapFile(image_len, 522 PROT_READ | PROT_WRITE, 523 MAP_PRIVATE, 524 input_image->Fd(), 525 0, 526 /*low_4gb*/false, 527 input_image->GetPath().c_str(), 528 &error_msg)); 529 if (image.get() == nullptr) { 530 LOG(ERROR) << "Unable to map image file " << input_image->GetPath() << " : " << error_msg; 531 return false; 532 } 533 534 535 space_to_memmap_map.emplace(space, std::move(image)); 536 PatchOat p = PatchOat(isa, 537 space_to_memmap_map.at(space).get(), 538 space->GetLiveBitmap(), 539 space->GetMemMap(), 540 delta, 541 &space_to_memmap_map, 542 timings); 543 544 t.NewTiming("Patching image"); 545 if (!p.PatchImage(i == 0)) { 546 LOG(ERROR) << "Failed to patch image file " << input_image_filename; 547 return false; 548 } 549 550 // Write the patched image spaces. 551 if (output_image) { 552 std::string output_image_filename; 553 if (!GetDalvikCacheFilename(space->GetImageLocation().c_str(), 554 output_image_directory.c_str(), 555 &output_image_filename, 556 &error_msg)) { 557 LOG(ERROR) << "Failed to find relocated image file name: " << error_msg; 558 return false; 559 } 560 561 if (!CreateVdexAndOatSymlinks(input_image_filename, output_image_filename)) 562 return false; 563 564 t.NewTiming("Writing image"); 565 std::unique_ptr<File> output_image_file(CreateOrOpen(output_image_filename.c_str())); 566 if (output_image_file.get() == nullptr) { 567 LOG(ERROR) << "Failed to open output image file at " << output_image_filename; 568 return false; 569 } 570 571 bool success = p.WriteImage(output_image_file.get()); 572 success = FinishFile(output_image_file.get(), success); 573 if (!success) { 574 return false; 575 } 576 } 577 578 if (output_image_relocation) { 579 t.NewTiming("Writing image relocation"); 580 std::string original_image_filename(space->GetImageLocation() + ".rel"); 581 std::string image_relocation_filename = 582 output_image_relocation_directory 583 + (android::base::StartsWith(original_image_filename, "/") ? "" : "/") 584 + original_image_filename.substr(original_image_filename.find_last_of("/")); 585 int64_t input_image_size = input_image->GetLength(); 586 if (input_image_size < 0) { 587 LOG(ERROR) << "Error while getting input image size"; 588 return false; 589 } 590 std::unique_ptr<MemMap> original(MemMap::MapFile(input_image_size, 591 PROT_READ, 592 MAP_PRIVATE, 593 input_image->Fd(), 594 0, 595 /*low_4gb*/false, 596 input_image->GetPath().c_str(), 597 &error_msg)); 598 if (original.get() == nullptr) { 599 LOG(ERROR) << "Unable to map image file " << input_image->GetPath() << " : " << error_msg; 600 return false; 601 } 602 603 const MemMap* relocated = p.image_; 604 605 if (!WriteRelFile(*original, *relocated, image_relocation_filename, &error_msg)) { 606 LOG(ERROR) << "Failed to create image relocation file " << image_relocation_filename 607 << ": " << error_msg; 608 return false; 609 } 610 } 611 } 612 613 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) { 614 // We want to just exit on non-debug builds, not bringing the runtime down 615 // in an orderly fashion. So release the following fields. 616 runtime.release(); 617 } 618 619 return true; 620} 621 622bool PatchOat::Verify(const std::string& image_location, 623 const std::string& output_image_directory, 624 InstructionSet isa, 625 TimingLogger* timings) { 626 if (image_location.empty()) { 627 LOG(ERROR) << "Original image file not provided"; 628 return false; 629 } 630 if (output_image_directory.empty()) { 631 LOG(ERROR) << "Relocated image directory not provided"; 632 return false; 633 } 634 635 TimingLogger::ScopedTiming t("Runtime Setup", timings); 636 637 CHECK_NE(isa, InstructionSet::kNone); 638 639 // Set up the runtime 640 PatchoatRuntimeOptionsHolder options_holder(image_location, isa); 641 if (!Runtime::Create(options_holder.GetRuntimeOptions(), false)) { 642 LOG(ERROR) << "Unable to initialize runtime"; 643 return false; 644 } 645 std::unique_ptr<Runtime> runtime(Runtime::Current()); 646 647 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 648 // give it away now and then switch to a more manageable ScopedObjectAccess. 649 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 650 ScopedObjectAccess soa(Thread::Current()); 651 652 t.NewTiming("Image Verification setup"); 653 std::vector<gc::space::ImageSpace*> spaces = Runtime::Current()->GetHeap()->GetBootImageSpaces(); 654 655 // TODO: Check that no other .rel files exist in the original dir 656 657 bool success = true; 658 std::string image_location_dir = android::base::Dirname(image_location); 659 for (size_t i = 0; i < spaces.size(); ++i) { 660 gc::space::ImageSpace* space = spaces[i]; 661 662 std::string relocated_image_filename; 663 std::string error_msg; 664 if (!GetDalvikCacheFilename(space->GetImageLocation().c_str(), 665 output_image_directory.c_str(), &relocated_image_filename, &error_msg)) { 666 LOG(ERROR) << "Failed to find relocated image file name: " << error_msg; 667 success = false; 668 break; 669 } 670 // location: /system/framework/boot.art 671 // isa: arm64 672 // basename: boot.art 673 // original: /system/framework/arm64/boot.art 674 // relocation: /system/framework/arm64/boot.art.rel 675 std::string original_image_filename = 676 GetSystemImageFilename(space->GetImageLocation().c_str(), isa); 677 678 if (!CheckImageIdenticalToOriginalExceptForRelocation( 679 relocated_image_filename, original_image_filename, &error_msg)) { 680 LOG(ERROR) << error_msg; 681 success = false; 682 break; 683 } 684 685 if (!VerifyVdexAndOatSymlinks(original_image_filename, relocated_image_filename)) { 686 LOG(ERROR) << "Verification of vdex and oat symlinks for " 687 << space->GetImageLocation() << " failed."; 688 success = false; 689 break; 690 } 691 } 692 693 if (!kIsDebugBuild && !(RUNNING_ON_MEMORY_TOOL && kMemoryToolDetectsLeaks)) { 694 // We want to just exit on non-debug builds, not bringing the runtime down 695 // in an orderly fashion. So release the following fields. 696 runtime.release(); 697 } 698 699 return success; 700} 701 702bool PatchOat::WriteImage(File* out) { 703 TimingLogger::ScopedTiming t("Writing image File", timings_); 704 std::string error_msg; 705 706 // No error checking here, this is best effort. The locking may or may not 707 // succeed and we don't really care either way. 708 ScopedFlock img_flock = LockedFile::DupOf(out->Fd(), out->GetPath(), 709 true /* read_only_mode */, &error_msg); 710 711 CHECK(image_ != nullptr); 712 CHECK(out != nullptr); 713 size_t expect = image_->Size(); 714 if (out->WriteFully(reinterpret_cast<char*>(image_->Begin()), expect) && 715 out->SetLength(expect) == 0) { 716 return true; 717 } else { 718 LOG(ERROR) << "Writing to image file " << out->GetPath() << " failed."; 719 return false; 720 } 721} 722 723bool PatchOat::IsImagePic(const ImageHeader& image_header, const std::string& image_path) { 724 if (!image_header.CompilePic()) { 725 if (kIsDebugBuild) { 726 LOG(INFO) << "image at location " << image_path << " was *not* compiled pic"; 727 } 728 return false; 729 } 730 731 if (kIsDebugBuild) { 732 LOG(INFO) << "image at location " << image_path << " was compiled PIC"; 733 } 734 735 return true; 736} 737 738PatchOat::MaybePic PatchOat::IsOatPic(const ElfFile* oat_in) { 739 if (oat_in == nullptr) { 740 LOG(ERROR) << "No ELF input oat fie available"; 741 return ERROR_OAT_FILE; 742 } 743 744 const std::string& file_path = oat_in->GetFilePath(); 745 746 const OatHeader* oat_header = GetOatHeader(oat_in); 747 if (oat_header == nullptr) { 748 LOG(ERROR) << "Failed to find oat header in oat file " << file_path; 749 return ERROR_OAT_FILE; 750 } 751 752 if (!oat_header->IsValid()) { 753 LOG(ERROR) << "Elf file " << file_path << " has an invalid oat header"; 754 return ERROR_OAT_FILE; 755 } 756 757 bool is_pic = oat_header->IsPic(); 758 if (kIsDebugBuild) { 759 LOG(INFO) << "Oat file at " << file_path << " is " << (is_pic ? "PIC" : "not pic"); 760 } 761 762 return is_pic ? PIC : NOT_PIC; 763} 764 765class PatchOat::PatchOatArtFieldVisitor : public ArtFieldVisitor { 766 public: 767 explicit PatchOatArtFieldVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 768 769 void Visit(ArtField* field) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 770 ArtField* const dest = patch_oat_->RelocatedCopyOf(field); 771 dest->SetDeclaringClass( 772 patch_oat_->RelocatedAddressOfPointer(field->GetDeclaringClass().Ptr())); 773 } 774 775 private: 776 PatchOat* const patch_oat_; 777}; 778 779void PatchOat::PatchArtFields(const ImageHeader* image_header) { 780 PatchOatArtFieldVisitor visitor(this); 781 image_header->VisitPackedArtFields(&visitor, heap_->Begin()); 782} 783 784class PatchOat::PatchOatArtMethodVisitor : public ArtMethodVisitor { 785 public: 786 explicit PatchOatArtMethodVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 787 788 void Visit(ArtMethod* method) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 789 ArtMethod* const dest = patch_oat_->RelocatedCopyOf(method); 790 patch_oat_->FixupMethod(method, dest); 791 } 792 793 private: 794 PatchOat* const patch_oat_; 795}; 796 797void PatchOat::PatchArtMethods(const ImageHeader* image_header) { 798 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 799 PatchOatArtMethodVisitor visitor(this); 800 image_header->VisitPackedArtMethods(&visitor, heap_->Begin(), pointer_size); 801} 802 803void PatchOat::PatchImTables(const ImageHeader* image_header) { 804 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 805 // We can safely walk target image since the conflict tables are independent. 806 image_header->VisitPackedImTables( 807 [this](ArtMethod* method) { 808 return RelocatedAddressOfPointer(method); 809 }, 810 image_->Begin(), 811 pointer_size); 812} 813 814void PatchOat::PatchImtConflictTables(const ImageHeader* image_header) { 815 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 816 // We can safely walk target image since the conflict tables are independent. 817 image_header->VisitPackedImtConflictTables( 818 [this](ArtMethod* method) { 819 return RelocatedAddressOfPointer(method); 820 }, 821 image_->Begin(), 822 pointer_size); 823} 824 825class PatchOat::FixupRootVisitor : public RootVisitor { 826 public: 827 explicit FixupRootVisitor(const PatchOat* patch_oat) : patch_oat_(patch_oat) { 828 } 829 830 void VisitRoots(mirror::Object*** roots, size_t count, const RootInfo& info ATTRIBUTE_UNUSED) 831 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 832 for (size_t i = 0; i < count; ++i) { 833 *roots[i] = patch_oat_->RelocatedAddressOfPointer(*roots[i]); 834 } 835 } 836 837 void VisitRoots(mirror::CompressedReference<mirror::Object>** roots, size_t count, 838 const RootInfo& info ATTRIBUTE_UNUSED) 839 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 840 for (size_t i = 0; i < count; ++i) { 841 roots[i]->Assign(patch_oat_->RelocatedAddressOfPointer(roots[i]->AsMirrorPtr())); 842 } 843 } 844 845 private: 846 const PatchOat* const patch_oat_; 847}; 848 849void PatchOat::PatchInternedStrings(const ImageHeader* image_header) { 850 const auto& section = image_header->GetInternedStringsSection(); 851 if (section.Size() == 0) { 852 return; 853 } 854 InternTable temp_table; 855 // Note that we require that ReadFromMemory does not make an internal copy of the elements. 856 // This also relies on visit roots not doing any verification which could fail after we update 857 // the roots to be the image addresses. 858 temp_table.AddTableFromMemory(image_->Begin() + section.Offset()); 859 FixupRootVisitor visitor(this); 860 temp_table.VisitRoots(&visitor, kVisitRootFlagAllRoots); 861} 862 863void PatchOat::PatchClassTable(const ImageHeader* image_header) { 864 const auto& section = image_header->GetClassTableSection(); 865 if (section.Size() == 0) { 866 return; 867 } 868 // Note that we require that ReadFromMemory does not make an internal copy of the elements. 869 // This also relies on visit roots not doing any verification which could fail after we update 870 // the roots to be the image addresses. 871 WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_); 872 ClassTable temp_table; 873 temp_table.ReadFromMemory(image_->Begin() + section.Offset()); 874 FixupRootVisitor visitor(this); 875 temp_table.VisitRoots(UnbufferedRootVisitor(&visitor, RootInfo(kRootUnknown))); 876} 877 878 879class PatchOat::RelocatedPointerVisitor { 880 public: 881 explicit RelocatedPointerVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 882 883 template <typename T> 884 T* operator()(T* ptr, void** dest_addr ATTRIBUTE_UNUSED = 0) const { 885 return patch_oat_->RelocatedAddressOfPointer(ptr); 886 } 887 888 private: 889 PatchOat* const patch_oat_; 890}; 891 892void PatchOat::PatchDexFileArrays(mirror::ObjectArray<mirror::Object>* img_roots) { 893 auto* dex_caches = down_cast<mirror::ObjectArray<mirror::DexCache>*>( 894 img_roots->Get(ImageHeader::kDexCaches)); 895 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 896 for (size_t i = 0, count = dex_caches->GetLength(); i < count; ++i) { 897 auto* orig_dex_cache = dex_caches->GetWithoutChecks(i); 898 auto* copy_dex_cache = RelocatedCopyOf(orig_dex_cache); 899 // Though the DexCache array fields are usually treated as native pointers, we set the full 900 // 64-bit values here, clearing the top 32 bits for 32-bit targets. The zero-extension is 901 // done by casting to the unsigned type uintptr_t before casting to int64_t, i.e. 902 // static_cast<int64_t>(reinterpret_cast<uintptr_t>(image_begin_ + offset))). 903 mirror::StringDexCacheType* orig_strings = orig_dex_cache->GetStrings(); 904 mirror::StringDexCacheType* relocated_strings = RelocatedAddressOfPointer(orig_strings); 905 copy_dex_cache->SetField64<false>( 906 mirror::DexCache::StringsOffset(), 907 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_strings))); 908 if (orig_strings != nullptr) { 909 orig_dex_cache->FixupStrings(RelocatedCopyOf(orig_strings), RelocatedPointerVisitor(this)); 910 } 911 mirror::TypeDexCacheType* orig_types = orig_dex_cache->GetResolvedTypes(); 912 mirror::TypeDexCacheType* relocated_types = RelocatedAddressOfPointer(orig_types); 913 copy_dex_cache->SetField64<false>( 914 mirror::DexCache::ResolvedTypesOffset(), 915 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_types))); 916 if (orig_types != nullptr) { 917 orig_dex_cache->FixupResolvedTypes(RelocatedCopyOf(orig_types), 918 RelocatedPointerVisitor(this)); 919 } 920 mirror::MethodDexCacheType* orig_methods = orig_dex_cache->GetResolvedMethods(); 921 mirror::MethodDexCacheType* relocated_methods = RelocatedAddressOfPointer(orig_methods); 922 copy_dex_cache->SetField64<false>( 923 mirror::DexCache::ResolvedMethodsOffset(), 924 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_methods))); 925 if (orig_methods != nullptr) { 926 mirror::MethodDexCacheType* copy_methods = RelocatedCopyOf(orig_methods); 927 for (size_t j = 0, num = orig_dex_cache->NumResolvedMethods(); j != num; ++j) { 928 mirror::MethodDexCachePair orig = 929 mirror::DexCache::GetNativePairPtrSize(orig_methods, j, pointer_size); 930 mirror::MethodDexCachePair copy(RelocatedAddressOfPointer(orig.object), orig.index); 931 mirror::DexCache::SetNativePairPtrSize(copy_methods, j, copy, pointer_size); 932 } 933 } 934 mirror::FieldDexCacheType* orig_fields = orig_dex_cache->GetResolvedFields(); 935 mirror::FieldDexCacheType* relocated_fields = RelocatedAddressOfPointer(orig_fields); 936 copy_dex_cache->SetField64<false>( 937 mirror::DexCache::ResolvedFieldsOffset(), 938 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_fields))); 939 if (orig_fields != nullptr) { 940 mirror::FieldDexCacheType* copy_fields = RelocatedCopyOf(orig_fields); 941 for (size_t j = 0, num = orig_dex_cache->NumResolvedFields(); j != num; ++j) { 942 mirror::FieldDexCachePair orig = 943 mirror::DexCache::GetNativePairPtrSize(orig_fields, j, pointer_size); 944 mirror::FieldDexCachePair copy(RelocatedAddressOfPointer(orig.object), orig.index); 945 mirror::DexCache::SetNativePairPtrSize(copy_fields, j, copy, pointer_size); 946 } 947 } 948 mirror::MethodTypeDexCacheType* orig_method_types = orig_dex_cache->GetResolvedMethodTypes(); 949 mirror::MethodTypeDexCacheType* relocated_method_types = 950 RelocatedAddressOfPointer(orig_method_types); 951 copy_dex_cache->SetField64<false>( 952 mirror::DexCache::ResolvedMethodTypesOffset(), 953 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_method_types))); 954 if (orig_method_types != nullptr) { 955 orig_dex_cache->FixupResolvedMethodTypes(RelocatedCopyOf(orig_method_types), 956 RelocatedPointerVisitor(this)); 957 } 958 959 GcRoot<mirror::CallSite>* orig_call_sites = orig_dex_cache->GetResolvedCallSites(); 960 GcRoot<mirror::CallSite>* relocated_call_sites = RelocatedAddressOfPointer(orig_call_sites); 961 copy_dex_cache->SetField64<false>( 962 mirror::DexCache::ResolvedCallSitesOffset(), 963 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_call_sites))); 964 if (orig_call_sites != nullptr) { 965 orig_dex_cache->FixupResolvedCallSites(RelocatedCopyOf(orig_call_sites), 966 RelocatedPointerVisitor(this)); 967 } 968 } 969} 970 971bool PatchOat::PatchImage(bool primary_image) { 972 ImageHeader* image_header = reinterpret_cast<ImageHeader*>(image_->Begin()); 973 CHECK_GT(image_->Size(), sizeof(ImageHeader)); 974 // These are the roots from the original file. 975 auto* img_roots = image_header->GetImageRoots(); 976 image_header->RelocateImage(delta_); 977 978 PatchArtFields(image_header); 979 PatchArtMethods(image_header); 980 PatchImTables(image_header); 981 PatchImtConflictTables(image_header); 982 PatchInternedStrings(image_header); 983 PatchClassTable(image_header); 984 // Patch dex file int/long arrays which point to ArtFields. 985 PatchDexFileArrays(img_roots); 986 987 if (primary_image) { 988 VisitObject(img_roots); 989 } 990 991 if (!image_header->IsValid()) { 992 LOG(ERROR) << "relocation renders image header invalid"; 993 return false; 994 } 995 996 { 997 TimingLogger::ScopedTiming t("Walk Bitmap", timings_); 998 // Walk the bitmap. 999 WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_); 1000 auto visitor = [&](mirror::Object* obj) REQUIRES_SHARED(Locks::mutator_lock_) { 1001 VisitObject(obj); 1002 }; 1003 bitmap_->Walk(visitor); 1004 } 1005 return true; 1006} 1007 1008 1009void PatchOat::PatchVisitor::operator() (ObjPtr<mirror::Object> obj, 1010 MemberOffset off, 1011 bool is_static_unused ATTRIBUTE_UNUSED) const { 1012 mirror::Object* referent = obj->GetFieldObject<mirror::Object, kVerifyNone>(off); 1013 mirror::Object* moved_object = patcher_->RelocatedAddressOfPointer(referent); 1014 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 1015} 1016 1017void PatchOat::PatchVisitor::operator() (ObjPtr<mirror::Class> cls ATTRIBUTE_UNUSED, 1018 ObjPtr<mirror::Reference> ref) const { 1019 MemberOffset off = mirror::Reference::ReferentOffset(); 1020 mirror::Object* referent = ref->GetReferent(); 1021 DCHECK(referent == nullptr || 1022 Runtime::Current()->GetHeap()->ObjectIsInBootImageSpace(referent)) << referent; 1023 mirror::Object* moved_object = patcher_->RelocatedAddressOfPointer(referent); 1024 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 1025} 1026 1027// Called by PatchImage. 1028void PatchOat::VisitObject(mirror::Object* object) { 1029 mirror::Object* copy = RelocatedCopyOf(object); 1030 CHECK(copy != nullptr); 1031 if (kUseBakerReadBarrier) { 1032 object->AssertReadBarrierState(); 1033 } 1034 PatchOat::PatchVisitor visitor(this, copy); 1035 object->VisitReferences<kVerifyNone>(visitor, visitor); 1036 if (object->IsClass<kVerifyNone>()) { 1037 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 1038 mirror::Class* klass = object->AsClass(); 1039 mirror::Class* copy_klass = down_cast<mirror::Class*>(copy); 1040 RelocatedPointerVisitor native_visitor(this); 1041 klass->FixupNativePointers(copy_klass, pointer_size, native_visitor); 1042 auto* vtable = klass->GetVTable(); 1043 if (vtable != nullptr) { 1044 vtable->Fixup(RelocatedCopyOfFollowImages(vtable), pointer_size, native_visitor); 1045 } 1046 mirror::IfTable* iftable = klass->GetIfTable(); 1047 for (int32_t i = 0; i < klass->GetIfTableCount(); ++i) { 1048 if (iftable->GetMethodArrayCount(i) > 0) { 1049 auto* method_array = iftable->GetMethodArray(i); 1050 CHECK(method_array != nullptr); 1051 method_array->Fixup(RelocatedCopyOfFollowImages(method_array), 1052 pointer_size, 1053 native_visitor); 1054 } 1055 } 1056 } else if (object->GetClass() == mirror::Method::StaticClass() || 1057 object->GetClass() == mirror::Constructor::StaticClass()) { 1058 // Need to go update the ArtMethod. 1059 auto* dest = down_cast<mirror::Executable*>(copy); 1060 auto* src = down_cast<mirror::Executable*>(object); 1061 dest->SetArtMethod(RelocatedAddressOfPointer(src->GetArtMethod())); 1062 } 1063} 1064 1065void PatchOat::FixupMethod(ArtMethod* object, ArtMethod* copy) { 1066 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 1067 copy->CopyFrom(object, pointer_size); 1068 // Just update the entry points if it looks like we should. 1069 // TODO: sanity check all the pointers' values 1070 copy->SetDeclaringClass(RelocatedAddressOfPointer(object->GetDeclaringClass())); 1071 copy->SetEntryPointFromQuickCompiledCodePtrSize(RelocatedAddressOfPointer( 1072 object->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size)), pointer_size); 1073 // No special handling for IMT conflict table since all pointers are moved by the same offset. 1074 copy->SetDataPtrSize(RelocatedAddressOfPointer( 1075 object->GetDataPtrSize(pointer_size)), pointer_size); 1076} 1077 1078static int orig_argc; 1079static char** orig_argv; 1080 1081static std::string CommandLine() { 1082 std::vector<std::string> command; 1083 for (int i = 0; i < orig_argc; ++i) { 1084 command.push_back(orig_argv[i]); 1085 } 1086 return android::base::Join(command, ' '); 1087} 1088 1089static void UsageErrorV(const char* fmt, va_list ap) { 1090 std::string error; 1091 android::base::StringAppendV(&error, fmt, ap); 1092 LOG(ERROR) << error; 1093} 1094 1095static void UsageError(const char* fmt, ...) { 1096 va_list ap; 1097 va_start(ap, fmt); 1098 UsageErrorV(fmt, ap); 1099 va_end(ap); 1100} 1101 1102NO_RETURN static void Usage(const char *fmt, ...) { 1103 va_list ap; 1104 va_start(ap, fmt); 1105 UsageErrorV(fmt, ap); 1106 va_end(ap); 1107 1108 UsageError("Command: %s", CommandLine().c_str()); 1109 UsageError("Usage: patchoat [options]..."); 1110 UsageError(""); 1111 UsageError(" --instruction-set=<isa>: Specifies the instruction set the patched code is"); 1112 UsageError(" compiled for (required)."); 1113 UsageError(""); 1114 UsageError(" --input-image-location=<file.art>: Specifies the 'location' of the image file to"); 1115 UsageError(" be patched."); 1116 UsageError(""); 1117 UsageError(" --output-image-directory=<dir>: Specifies the directory to write the patched"); 1118 UsageError(" image file(s) to."); 1119 UsageError(""); 1120 UsageError(" --output-image-relocation-directory=<dir>: Specifies the directory to write"); 1121 UsageError(" the image relocation information to."); 1122 UsageError(""); 1123 UsageError(" --base-offset-delta=<delta>: Specify the amount to change the old base-offset by."); 1124 UsageError(" This value may be negative."); 1125 UsageError(""); 1126 UsageError(" --verify: Verify an existing patched file instead of creating one."); 1127 UsageError(""); 1128 UsageError(" --dump-timings: dump out patch timing information"); 1129 UsageError(""); 1130 UsageError(" --no-dump-timings: do not dump out patch timing information"); 1131 UsageError(""); 1132 1133 exit(EXIT_FAILURE); 1134} 1135 1136static int patchoat_patch_image(TimingLogger& timings, 1137 InstructionSet isa, 1138 const std::string& input_image_location, 1139 const std::string& output_image_directory, 1140 const std::string& output_image_relocation_directory, 1141 off_t base_delta, 1142 bool base_delta_set, 1143 bool debug) { 1144 CHECK(!input_image_location.empty()); 1145 if ((output_image_directory.empty()) && (output_image_relocation_directory.empty())) { 1146 Usage("Image patching requires --output-image-directory or --output-image-relocation-directory"); 1147 } 1148 1149 if (!base_delta_set) { 1150 Usage("Must supply a desired new offset or delta."); 1151 } 1152 1153 if (!IsAligned<kPageSize>(base_delta)) { 1154 Usage("Base offset/delta must be aligned to a pagesize (0x%08x) boundary.", kPageSize); 1155 } 1156 1157 if (debug) { 1158 LOG(INFO) << "moving offset by " << base_delta 1159 << " (0x" << std::hex << base_delta << ") bytes or " 1160 << std::dec << (base_delta/kPageSize) << " pages."; 1161 } 1162 1163 TimingLogger::ScopedTiming pt("patch image and oat", &timings); 1164 1165 bool ret = 1166 PatchOat::Patch( 1167 input_image_location, 1168 base_delta, 1169 output_image_directory, 1170 output_image_relocation_directory, 1171 isa, 1172 &timings); 1173 1174 if (kIsDebugBuild) { 1175 LOG(INFO) << "Exiting with return ... " << ret; 1176 } 1177 return ret ? EXIT_SUCCESS : EXIT_FAILURE; 1178} 1179 1180static int patchoat_verify_image(TimingLogger& timings, 1181 InstructionSet isa, 1182 const std::string& input_image_location, 1183 const std::string& output_image_directory) { 1184 CHECK(!input_image_location.empty()); 1185 TimingLogger::ScopedTiming pt("verify image and oat", &timings); 1186 1187 bool ret = 1188 PatchOat::Verify( 1189 input_image_location, 1190 output_image_directory, 1191 isa, 1192 &timings); 1193 1194 if (kIsDebugBuild) { 1195 LOG(INFO) << "Exiting with return ... " << ret; 1196 } 1197 return ret ? EXIT_SUCCESS : EXIT_FAILURE; 1198} 1199 1200static int patchoat(int argc, char **argv) { 1201 Locks::Init(); 1202 InitLogging(argv, Runtime::Abort); 1203 MemMap::Init(); 1204 const bool debug = kIsDebugBuild; 1205 orig_argc = argc; 1206 orig_argv = argv; 1207 TimingLogger timings("patcher", false, false); 1208 1209 // Skip over the command name. 1210 argv++; 1211 argc--; 1212 1213 if (argc == 0) { 1214 Usage("No arguments specified"); 1215 } 1216 1217 timings.StartTiming("Patchoat"); 1218 1219 // cmd line args 1220 bool isa_set = false; 1221 InstructionSet isa = InstructionSet::kNone; 1222 std::string input_image_location; 1223 std::string output_image_directory; 1224 std::string output_image_relocation_directory; 1225 off_t base_delta = 0; 1226 bool base_delta_set = false; 1227 bool dump_timings = kIsDebugBuild; 1228 bool verify = false; 1229 1230 for (int i = 0; i < argc; ++i) { 1231 const StringPiece option(argv[i]); 1232 const bool log_options = false; 1233 if (log_options) { 1234 LOG(INFO) << "patchoat: option[" << i << "]=" << argv[i]; 1235 } 1236 if (option.starts_with("--instruction-set=")) { 1237 isa_set = true; 1238 const char* isa_str = option.substr(strlen("--instruction-set=")).data(); 1239 isa = GetInstructionSetFromString(isa_str); 1240 if (isa == InstructionSet::kNone) { 1241 Usage("Unknown or invalid instruction set %s", isa_str); 1242 } 1243 } else if (option.starts_with("--input-image-location=")) { 1244 input_image_location = option.substr(strlen("--input-image-location=")).data(); 1245 } else if (option.starts_with("--output-image-directory=")) { 1246 output_image_directory = option.substr(strlen("--output-image-directory=")).data(); 1247 } else if (option.starts_with("--output-image-relocation-directory=")) { 1248 output_image_relocation_directory = 1249 option.substr(strlen("--output-image-relocation-directory=")).data(); 1250 } else if (option.starts_with("--base-offset-delta=")) { 1251 const char* base_delta_str = option.substr(strlen("--base-offset-delta=")).data(); 1252 base_delta_set = true; 1253 if (!ParseInt(base_delta_str, &base_delta)) { 1254 Usage("Failed to parse --base-offset-delta argument '%s' as an off_t", base_delta_str); 1255 } 1256 } else if (option == "--dump-timings") { 1257 dump_timings = true; 1258 } else if (option == "--no-dump-timings") { 1259 dump_timings = false; 1260 } else if (option == "--verify") { 1261 verify = true; 1262 } else { 1263 Usage("Unknown argument %s", option.data()); 1264 } 1265 } 1266 1267 // The instruction set is mandatory. This simplifies things... 1268 if (!isa_set) { 1269 Usage("Instruction set must be set."); 1270 } 1271 1272 int ret; 1273 if (verify) { 1274 ret = patchoat_verify_image(timings, 1275 isa, 1276 input_image_location, 1277 output_image_directory); 1278 } else { 1279 ret = patchoat_patch_image(timings, 1280 isa, 1281 input_image_location, 1282 output_image_directory, 1283 output_image_relocation_directory, 1284 base_delta, 1285 base_delta_set, 1286 debug); 1287 } 1288 1289 timings.EndTiming(); 1290 if (dump_timings) { 1291 LOG(INFO) << Dumpable<TimingLogger>(timings); 1292 } 1293 1294 return ret; 1295} 1296 1297} // namespace art 1298 1299int main(int argc, char **argv) { 1300 return art::patchoat(argc, argv); 1301} 1302