patchoat.cc revision ea0831f60d26e3297e6463634a9fbb6384f00661
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 <stdio.h> 19#include <stdlib.h> 20#include <sys/file.h> 21#include <sys/stat.h> 22#include <unistd.h> 23 24#include <string> 25#include <vector> 26 27#include "art_field-inl.h" 28#include "art_method-inl.h" 29#include "base/dumpable.h" 30#include "base/scoped_flock.h" 31#include "base/stringpiece.h" 32#include "base/stringprintf.h" 33#include "base/unix_file/fd_file.h" 34#include "elf_utils.h" 35#include "elf_file.h" 36#include "elf_file_impl.h" 37#include "gc/space/image_space.h" 38#include "image.h" 39#include "mirror/abstract_method.h" 40#include "mirror/object-inl.h" 41#include "mirror/method.h" 42#include "mirror/reference.h" 43#include "noop_compiler_callbacks.h" 44#include "offsets.h" 45#include "os.h" 46#include "runtime.h" 47#include "scoped_thread_state_change.h" 48#include "thread.h" 49#include "utils.h" 50 51namespace art { 52 53static bool LocationToFilename(const std::string& location, InstructionSet isa, 54 std::string* filename) { 55 bool has_system = false; 56 bool has_cache = false; 57 // image_location = /system/framework/boot.art 58 // system_image_filename = /system/framework/<image_isa>/boot.art 59 std::string system_filename(GetSystemImageFilename(location.c_str(), isa)); 60 if (OS::FileExists(system_filename.c_str())) { 61 has_system = true; 62 } 63 64 bool have_android_data = false; 65 bool dalvik_cache_exists = false; 66 bool is_global_cache = false; 67 std::string dalvik_cache; 68 GetDalvikCache(GetInstructionSetString(isa), false, &dalvik_cache, 69 &have_android_data, &dalvik_cache_exists, &is_global_cache); 70 71 std::string cache_filename; 72 if (have_android_data && dalvik_cache_exists) { 73 // Always set output location even if it does not exist, 74 // so that the caller knows where to create the image. 75 // 76 // image_location = /system/framework/boot.art 77 // *image_filename = /data/dalvik-cache/<image_isa>/boot.art 78 std::string error_msg; 79 if (GetDalvikCacheFilename(location.c_str(), dalvik_cache.c_str(), 80 &cache_filename, &error_msg)) { 81 has_cache = true; 82 } 83 } 84 if (has_system) { 85 *filename = system_filename; 86 return true; 87 } else if (has_cache) { 88 *filename = cache_filename; 89 return true; 90 } else { 91 return false; 92 } 93} 94 95static const OatHeader* GetOatHeader(const ElfFile* elf_file) { 96 uint64_t off = 0; 97 if (!elf_file->GetSectionOffsetAndSize(".rodata", &off, nullptr)) { 98 return nullptr; 99 } 100 101 OatHeader* oat_header = reinterpret_cast<OatHeader*>(elf_file->Begin() + off); 102 return oat_header; 103} 104 105// This function takes an elf file and reads the current patch delta value 106// encoded in its oat header value 107static bool ReadOatPatchDelta(const ElfFile* elf_file, off_t* delta, std::string* error_msg) { 108 const OatHeader* oat_header = GetOatHeader(elf_file); 109 if (oat_header == nullptr) { 110 *error_msg = "Unable to get oat header from elf file."; 111 return false; 112 } 113 if (!oat_header->IsValid()) { 114 *error_msg = "Elf file has an invalid oat header"; 115 return false; 116 } 117 *delta = oat_header->GetImagePatchDelta(); 118 return true; 119} 120 121static File* CreateOrOpen(const char* name, bool* created) { 122 if (OS::FileExists(name)) { 123 *created = false; 124 return OS::OpenFileReadWrite(name); 125 } else { 126 *created = true; 127 std::unique_ptr<File> f(OS::CreateEmptyFile(name)); 128 if (f.get() != nullptr) { 129 if (fchmod(f->Fd(), 0644) != 0) { 130 PLOG(ERROR) << "Unable to make " << name << " world readable"; 131 TEMP_FAILURE_RETRY(unlink(name)); 132 return nullptr; 133 } 134 } 135 return f.release(); 136 } 137} 138 139// Either try to close the file (close=true), or erase it. 140static bool FinishFile(File* file, bool close) { 141 if (close) { 142 if (file->FlushCloseOrErase() != 0) { 143 PLOG(ERROR) << "Failed to flush and close file."; 144 return false; 145 } 146 return true; 147 } else { 148 file->Erase(); 149 return false; 150 } 151} 152 153bool PatchOat::Patch(File* input_oat, const std::string& image_location, off_t delta, 154 File* output_oat, File* output_image, InstructionSet isa, 155 TimingLogger* timings, 156 bool output_oat_opened_from_fd ATTRIBUTE_UNUSED, 157 bool new_oat_out) { 158 CHECK(Runtime::Current() == nullptr); 159 CHECK(output_image != nullptr); 160 CHECK_GE(output_image->Fd(), 0); 161 CHECK(input_oat != nullptr); 162 CHECK(output_oat != nullptr); 163 CHECK_GE(input_oat->Fd(), 0); 164 CHECK_GE(output_oat->Fd(), 0); 165 CHECK(!image_location.empty()) << "image file must have a filename."; 166 167 TimingLogger::ScopedTiming t("Runtime Setup", timings); 168 169 if (isa == kNone) { 170 Elf32_Ehdr elf_hdr; 171 if (sizeof(elf_hdr) != input_oat->Read(reinterpret_cast<char*>(&elf_hdr), sizeof(elf_hdr), 0)) { 172 LOG(ERROR) << "unable to read elf header"; 173 return false; 174 } 175 isa = GetInstructionSetFromELF(elf_hdr.e_machine, elf_hdr.e_flags); 176 } 177 const char* isa_name = GetInstructionSetString(isa); 178 179 // Set up the runtime 180 RuntimeOptions options; 181 NoopCompilerCallbacks callbacks; 182 options.push_back(std::make_pair("compilercallbacks", &callbacks)); 183 std::string img = "-Ximage:" + image_location; 184 options.push_back(std::make_pair(img.c_str(), nullptr)); 185 options.push_back(std::make_pair("imageinstructionset", reinterpret_cast<const void*>(isa_name))); 186 options.push_back(std::make_pair("-Xno-sig-chain", nullptr)); 187 if (!Runtime::Create(options, false)) { 188 LOG(ERROR) << "Unable to initialize runtime"; 189 return false; 190 } 191 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 192 // give it away now and then switch to a more manageable ScopedObjectAccess. 193 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 194 ScopedObjectAccess soa(Thread::Current()); 195 196 std::string output_directory = 197 output_image->GetPath().substr(0, output_image->GetPath().find_last_of("/")); 198 t.NewTiming("Image and oat Patching setup"); 199 std::vector<gc::space::ImageSpace*> spaces = Runtime::Current()->GetHeap()->GetBootImageSpaces(); 200 std::map<gc::space::ImageSpace*, std::unique_ptr<File>> space_to_file_map; 201 std::map<gc::space::ImageSpace*, std::unique_ptr<MemMap>> space_to_memmap_map; 202 std::map<gc::space::ImageSpace*, PatchOat> space_to_patchoat_map; 203 std::map<gc::space::ImageSpace*, bool> space_to_skip_patching_map; 204 205 for (size_t i = 0; i < spaces.size(); ++i) { 206 gc::space::ImageSpace* space = spaces[i]; 207 std::string input_image_filename = space->GetImageFilename(); 208 std::unique_ptr<File> input_image(OS::OpenFileForReading(input_image_filename.c_str())); 209 if (input_image.get() == nullptr) { 210 LOG(ERROR) << "Unable to open input image file at " << input_image_filename; 211 return false; 212 } 213 214 int64_t image_len = input_image->GetLength(); 215 if (image_len < 0) { 216 LOG(ERROR) << "Error while getting image length"; 217 return false; 218 } 219 ImageHeader image_header; 220 if (sizeof(image_header) != input_image->Read(reinterpret_cast<char*>(&image_header), 221 sizeof(image_header), 0)) { 222 LOG(ERROR) << "Unable to read image header from image file " << input_image->GetPath(); 223 } 224 225 /*bool is_image_pic = */IsImagePic(image_header, input_image->GetPath()); 226 // Nothing special to do right now since the image always needs to get patched. 227 // Perhaps in some far-off future we may have images with relative addresses that are true-PIC. 228 229 // Create the map where we will write the image patches to. 230 std::string error_msg; 231 std::unique_ptr<MemMap> image(MemMap::MapFile(image_len, 232 PROT_READ | PROT_WRITE, 233 MAP_PRIVATE, 234 input_image->Fd(), 235 0, 236 /*low_4gb*/false, 237 input_image->GetPath().c_str(), 238 &error_msg)); 239 if (image.get() == nullptr) { 240 LOG(ERROR) << "Unable to map image file " << input_image->GetPath() << " : " << error_msg; 241 return false; 242 } 243 space_to_file_map.emplace(space, std::move(input_image)); 244 space_to_memmap_map.emplace(space, std::move(image)); 245 } 246 247 for (size_t i = 0; i < spaces.size(); ++i) { 248 gc::space::ImageSpace* space = spaces[i]; 249 std::string input_image_filename = space->GetImageFilename(); 250 std::string input_oat_filename = 251 ImageHeader::GetOatLocationFromImageLocation(input_image_filename); 252 std::unique_ptr<File> input_oat_file(OS::OpenFileForReading(input_oat_filename.c_str())); 253 if (input_oat_file.get() == nullptr) { 254 LOG(ERROR) << "Unable to open input oat file at " << input_oat_filename; 255 return false; 256 } 257 std::string error_msg; 258 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat_file.get(), 259 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg)); 260 if (elf.get() == nullptr) { 261 LOG(ERROR) << "Unable to open oat file " << input_oat_file->GetPath() << " : " << error_msg; 262 return false; 263 } 264 265 bool skip_patching_oat = false; 266 MaybePic is_oat_pic = IsOatPic(elf.get()); 267 if (is_oat_pic >= ERROR_FIRST) { 268 // Error logged by IsOatPic 269 return false; 270 } else if (is_oat_pic == PIC) { 271 // Do not need to do ELF-file patching. Create a symlink and skip the ELF patching. 272 273 std::string converted_image_filename = space->GetImageLocation(); 274 std::replace(converted_image_filename.begin() + 1, converted_image_filename.end(), '/', '@'); 275 std::string output_image_filename = output_directory + 276 (StartsWith(converted_image_filename, "/") ? "" : "/") + 277 converted_image_filename; 278 std::string output_oat_filename = 279 ImageHeader::GetOatLocationFromImageLocation(output_image_filename); 280 281 if (!ReplaceOatFileWithSymlink(input_oat_file->GetPath(), 282 output_oat_filename, 283 false, 284 true)) { 285 // Errors already logged by above call. 286 return false; 287 } 288 // Don't patch the OAT, since we just symlinked it. Image still needs patching. 289 skip_patching_oat = true; 290 } else { 291 CHECK(is_oat_pic == NOT_PIC); 292 } 293 294 PatchOat& p = space_to_patchoat_map.emplace(space, 295 PatchOat( 296 isa, 297 elf.release(), 298 space_to_memmap_map.find(space)->second.get(), 299 space->GetLiveBitmap(), 300 space->GetMemMap(), 301 delta, 302 &space_to_memmap_map, 303 timings)).first->second; 304 305 t.NewTiming("Patching files"); 306 if (!skip_patching_oat && !p.PatchElf()) { 307 LOG(ERROR) << "Failed to patch oat file " << input_oat_file->GetPath(); 308 return false; 309 } 310 if (!p.PatchImage(i == 0)) { 311 LOG(ERROR) << "Failed to patch image file " << input_image_filename; 312 return false; 313 } 314 315 space_to_skip_patching_map.emplace(space, skip_patching_oat); 316 } 317 318 for (size_t i = 0; i < spaces.size(); ++i) { 319 gc::space::ImageSpace* space = spaces[i]; 320 std::string input_image_filename = space->GetImageFilename(); 321 322 t.NewTiming("Writing files"); 323 std::string converted_image_filename = space->GetImageLocation(); 324 std::replace(converted_image_filename.begin() + 1, converted_image_filename.end(), '/', '@'); 325 std::string output_image_filename = output_directory + 326 (StartsWith(converted_image_filename, "/") ? "" : "/") + 327 converted_image_filename; 328 std::unique_ptr<File> 329 output_image_file(CreateOrOpen(output_image_filename.c_str(), &new_oat_out)); 330 if (output_image_file.get() == nullptr) { 331 LOG(ERROR) << "Failed to open output image file at " << output_image_filename; 332 return false; 333 } 334 335 PatchOat& p = space_to_patchoat_map.find(space)->second; 336 337 if (!p.WriteImage(output_image_file.get())) { 338 LOG(ERROR) << "Failed to write image file " << output_image_file->GetPath(); 339 return false; 340 } 341 FinishFile(output_image_file.get(), true); 342 343 bool skip_patching_oat = space_to_skip_patching_map.find(space)->second; 344 if (!skip_patching_oat) { 345 std::string output_oat_filename = 346 ImageHeader::GetOatLocationFromImageLocation(output_image_filename); 347 std::unique_ptr<File> 348 output_oat_file(CreateOrOpen(output_oat_filename.c_str(), &new_oat_out)); 349 if (output_oat_file.get() == nullptr) { 350 LOG(ERROR) << "Failed to open output oat file at " << output_oat_filename; 351 return false; 352 } 353 if (!p.WriteElf(output_oat_file.get())) { 354 LOG(ERROR) << "Failed to write oat file " << output_oat_file->GetPath(); 355 return false; 356 } 357 FinishFile(output_oat_file.get(), true); 358 } 359 } 360 return true; 361} 362 363bool PatchOat::WriteElf(File* out) { 364 TimingLogger::ScopedTiming t("Writing Elf File", timings_); 365 366 CHECK(oat_file_.get() != nullptr); 367 CHECK(out != nullptr); 368 size_t expect = oat_file_->Size(); 369 if (out->WriteFully(reinterpret_cast<char*>(oat_file_->Begin()), expect) && 370 out->SetLength(expect) == 0) { 371 return true; 372 } else { 373 LOG(ERROR) << "Writing to oat file " << out->GetPath() << " failed."; 374 return false; 375 } 376} 377 378bool PatchOat::WriteImage(File* out) { 379 TimingLogger::ScopedTiming t("Writing image File", timings_); 380 std::string error_msg; 381 382 ScopedFlock img_flock; 383 img_flock.Init(out, &error_msg); 384 385 CHECK(image_ != nullptr); 386 CHECK(out != nullptr); 387 size_t expect = image_->Size(); 388 if (out->WriteFully(reinterpret_cast<char*>(image_->Begin()), expect) && 389 out->SetLength(expect) == 0) { 390 return true; 391 } else { 392 LOG(ERROR) << "Writing to image file " << out->GetPath() << " failed."; 393 return false; 394 } 395} 396 397bool PatchOat::IsImagePic(const ImageHeader& image_header, const std::string& image_path) { 398 if (!image_header.CompilePic()) { 399 if (kIsDebugBuild) { 400 LOG(INFO) << "image at location " << image_path << " was *not* compiled pic"; 401 } 402 return false; 403 } 404 405 if (kIsDebugBuild) { 406 LOG(INFO) << "image at location " << image_path << " was compiled PIC"; 407 } 408 409 return true; 410} 411 412PatchOat::MaybePic PatchOat::IsOatPic(const ElfFile* oat_in) { 413 if (oat_in == nullptr) { 414 LOG(ERROR) << "No ELF input oat fie available"; 415 return ERROR_OAT_FILE; 416 } 417 418 const std::string& file_path = oat_in->GetFile().GetPath(); 419 420 const OatHeader* oat_header = GetOatHeader(oat_in); 421 if (oat_header == nullptr) { 422 LOG(ERROR) << "Failed to find oat header in oat file " << file_path; 423 return ERROR_OAT_FILE; 424 } 425 426 if (!oat_header->IsValid()) { 427 LOG(ERROR) << "Elf file " << file_path << " has an invalid oat header"; 428 return ERROR_OAT_FILE; 429 } 430 431 bool is_pic = oat_header->IsPic(); 432 if (kIsDebugBuild) { 433 LOG(INFO) << "Oat file at " << file_path << " is " << (is_pic ? "PIC" : "not pic"); 434 } 435 436 return is_pic ? PIC : NOT_PIC; 437} 438 439bool PatchOat::ReplaceOatFileWithSymlink(const std::string& input_oat_filename, 440 const std::string& output_oat_filename, 441 bool output_oat_opened_from_fd, 442 bool new_oat_out) { 443 // Need a file when we are PIC, since we symlink over it. Refusing to symlink into FD. 444 if (output_oat_opened_from_fd) { 445 // TODO: installd uses --output-oat-fd. Should we change class linking logic for PIC? 446 LOG(ERROR) << "No output oat filename specified, needs filename for when we are PIC"; 447 return false; 448 } 449 450 // Image was PIC. Create symlink where the oat is supposed to go. 451 if (!new_oat_out) { 452 LOG(ERROR) << "Oat file " << output_oat_filename << " already exists, refusing to overwrite"; 453 return false; 454 } 455 456 // Delete the original file, since we won't need it. 457 TEMP_FAILURE_RETRY(unlink(output_oat_filename.c_str())); 458 459 // Create a symlink from the old oat to the new oat 460 if (symlink(input_oat_filename.c_str(), output_oat_filename.c_str()) < 0) { 461 int err = errno; 462 LOG(ERROR) << "Failed to create symlink at " << output_oat_filename 463 << " error(" << err << "): " << strerror(err); 464 return false; 465 } 466 467 if (kIsDebugBuild) { 468 LOG(INFO) << "Created symlink " << output_oat_filename << " -> " << input_oat_filename; 469 } 470 471 return true; 472} 473 474class PatchOatArtFieldVisitor : public ArtFieldVisitor { 475 public: 476 explicit PatchOatArtFieldVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 477 478 void Visit(ArtField* field) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) { 479 ArtField* const dest = patch_oat_->RelocatedCopyOf(field); 480 dest->SetDeclaringClass(patch_oat_->RelocatedAddressOfPointer(field->GetDeclaringClass())); 481 } 482 483 private: 484 PatchOat* const patch_oat_; 485}; 486 487void PatchOat::PatchArtFields(const ImageHeader* image_header) { 488 PatchOatArtFieldVisitor visitor(this); 489 const auto& section = image_header->GetImageSection(ImageHeader::kSectionArtFields); 490 section.VisitPackedArtFields(&visitor, heap_->Begin()); 491} 492 493class PatchOatArtMethodVisitor : public ArtMethodVisitor { 494 public: 495 explicit PatchOatArtMethodVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 496 497 void Visit(ArtMethod* method) OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) { 498 ArtMethod* const dest = patch_oat_->RelocatedCopyOf(method); 499 patch_oat_->FixupMethod(method, dest); 500 } 501 502 private: 503 PatchOat* const patch_oat_; 504}; 505 506void PatchOat::PatchArtMethods(const ImageHeader* image_header) { 507 const auto& section = image_header->GetMethodsSection(); 508 const size_t pointer_size = InstructionSetPointerSize(isa_); 509 PatchOatArtMethodVisitor visitor(this); 510 section.VisitPackedArtMethods(&visitor, heap_->Begin(), pointer_size); 511} 512 513class FixupRootVisitor : public RootVisitor { 514 public: 515 explicit FixupRootVisitor(const PatchOat* patch_oat) : patch_oat_(patch_oat) { 516 } 517 518 void VisitRoots(mirror::Object*** roots, size_t count, const RootInfo& info ATTRIBUTE_UNUSED) 519 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) { 520 for (size_t i = 0; i < count; ++i) { 521 *roots[i] = patch_oat_->RelocatedAddressOfPointer(*roots[i]); 522 } 523 } 524 525 void VisitRoots(mirror::CompressedReference<mirror::Object>** roots, size_t count, 526 const RootInfo& info ATTRIBUTE_UNUSED) 527 OVERRIDE SHARED_REQUIRES(Locks::mutator_lock_) { 528 for (size_t i = 0; i < count; ++i) { 529 roots[i]->Assign(patch_oat_->RelocatedAddressOfPointer(roots[i]->AsMirrorPtr())); 530 } 531 } 532 533 private: 534 const PatchOat* const patch_oat_; 535}; 536 537void PatchOat::PatchInternedStrings(const ImageHeader* image_header) { 538 const auto& section = image_header->GetImageSection(ImageHeader::kSectionInternedStrings); 539 InternTable temp_table; 540 // Note that we require that ReadFromMemory does not make an internal copy of the elements. 541 // This also relies on visit roots not doing any verification which could fail after we update 542 // the roots to be the image addresses. 543 temp_table.AddTableFromMemory(image_->Begin() + section.Offset()); 544 FixupRootVisitor visitor(this); 545 temp_table.VisitRoots(&visitor, kVisitRootFlagAllRoots); 546} 547 548void PatchOat::PatchClassTable(const ImageHeader* image_header) { 549 const auto& section = image_header->GetImageSection(ImageHeader::kSectionClassTable); 550 // Note that we require that ReadFromMemory does not make an internal copy of the elements. 551 // This also relies on visit roots not doing any verification which could fail after we update 552 // the roots to be the image addresses. 553 WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_); 554 ClassTable temp_table; 555 temp_table.ReadFromMemory(image_->Begin() + section.Offset()); 556 FixupRootVisitor visitor(this); 557 BufferedRootVisitor<kDefaultBufferedRootCount> buffered_visitor(&visitor, RootInfo(kRootUnknown)); 558 temp_table.VisitRoots(buffered_visitor); 559} 560 561 562class RelocatedPointerVisitor { 563 public: 564 explicit RelocatedPointerVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 565 566 template <typename T> 567 T* operator()(T* ptr) const { 568 return patch_oat_->RelocatedAddressOfPointer(ptr); 569 } 570 571 private: 572 PatchOat* const patch_oat_; 573}; 574 575void PatchOat::PatchDexFileArrays(mirror::ObjectArray<mirror::Object>* img_roots) { 576 auto* dex_caches = down_cast<mirror::ObjectArray<mirror::DexCache>*>( 577 img_roots->Get(ImageHeader::kDexCaches)); 578 const size_t pointer_size = InstructionSetPointerSize(isa_); 579 for (size_t i = 0, count = dex_caches->GetLength(); i < count; ++i) { 580 auto* orig_dex_cache = dex_caches->GetWithoutChecks(i); 581 auto* copy_dex_cache = RelocatedCopyOf(orig_dex_cache); 582 // Though the DexCache array fields are usually treated as native pointers, we set the full 583 // 64-bit values here, clearing the top 32 bits for 32-bit targets. The zero-extension is 584 // done by casting to the unsigned type uintptr_t before casting to int64_t, i.e. 585 // static_cast<int64_t>(reinterpret_cast<uintptr_t>(image_begin_ + offset))). 586 GcRoot<mirror::String>* orig_strings = orig_dex_cache->GetStrings(); 587 GcRoot<mirror::String>* relocated_strings = RelocatedAddressOfPointer(orig_strings); 588 copy_dex_cache->SetField64<false>( 589 mirror::DexCache::StringsOffset(), 590 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_strings))); 591 if (orig_strings != nullptr) { 592 orig_dex_cache->FixupStrings(RelocatedCopyOf(orig_strings), RelocatedPointerVisitor(this)); 593 } 594 GcRoot<mirror::Class>* orig_types = orig_dex_cache->GetResolvedTypes(); 595 GcRoot<mirror::Class>* relocated_types = RelocatedAddressOfPointer(orig_types); 596 copy_dex_cache->SetField64<false>( 597 mirror::DexCache::ResolvedTypesOffset(), 598 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_types))); 599 if (orig_types != nullptr) { 600 orig_dex_cache->FixupResolvedTypes(RelocatedCopyOf(orig_types), 601 RelocatedPointerVisitor(this)); 602 } 603 ArtMethod** orig_methods = orig_dex_cache->GetResolvedMethods(); 604 ArtMethod** relocated_methods = RelocatedAddressOfPointer(orig_methods); 605 copy_dex_cache->SetField64<false>( 606 mirror::DexCache::ResolvedMethodsOffset(), 607 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_methods))); 608 if (orig_methods != nullptr) { 609 ArtMethod** copy_methods = RelocatedCopyOf(orig_methods); 610 for (size_t j = 0, num = orig_dex_cache->NumResolvedMethods(); j != num; ++j) { 611 ArtMethod* orig = mirror::DexCache::GetElementPtrSize(orig_methods, j, pointer_size); 612 ArtMethod* copy = RelocatedAddressOfPointer(orig); 613 mirror::DexCache::SetElementPtrSize(copy_methods, j, copy, pointer_size); 614 } 615 } 616 ArtField** orig_fields = orig_dex_cache->GetResolvedFields(); 617 ArtField** relocated_fields = RelocatedAddressOfPointer(orig_fields); 618 copy_dex_cache->SetField64<false>( 619 mirror::DexCache::ResolvedFieldsOffset(), 620 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_fields))); 621 if (orig_fields != nullptr) { 622 ArtField** copy_fields = RelocatedCopyOf(orig_fields); 623 for (size_t j = 0, num = orig_dex_cache->NumResolvedFields(); j != num; ++j) { 624 ArtField* orig = mirror::DexCache::GetElementPtrSize(orig_fields, j, pointer_size); 625 ArtField* copy = RelocatedAddressOfPointer(orig); 626 mirror::DexCache::SetElementPtrSize(copy_fields, j, copy, pointer_size); 627 } 628 } 629 } 630} 631 632bool PatchOat::PatchImage(bool primary_image) { 633 ImageHeader* image_header = reinterpret_cast<ImageHeader*>(image_->Begin()); 634 CHECK_GT(image_->Size(), sizeof(ImageHeader)); 635 // These are the roots from the original file. 636 auto* img_roots = image_header->GetImageRoots(); 637 image_header->RelocateImage(delta_); 638 639 PatchArtFields(image_header); 640 PatchArtMethods(image_header); 641 PatchInternedStrings(image_header); 642 PatchClassTable(image_header); 643 // Patch dex file int/long arrays which point to ArtFields. 644 PatchDexFileArrays(img_roots); 645 646 if (primary_image) { 647 VisitObject(img_roots); 648 } 649 650 if (!image_header->IsValid()) { 651 LOG(ERROR) << "relocation renders image header invalid"; 652 return false; 653 } 654 655 { 656 TimingLogger::ScopedTiming t("Walk Bitmap", timings_); 657 // Walk the bitmap. 658 WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_); 659 bitmap_->Walk(PatchOat::BitmapCallback, this); 660 } 661 return true; 662} 663 664bool PatchOat::InHeap(mirror::Object* o) { 665 uintptr_t begin = reinterpret_cast<uintptr_t>(heap_->Begin()); 666 uintptr_t end = reinterpret_cast<uintptr_t>(heap_->End()); 667 uintptr_t obj = reinterpret_cast<uintptr_t>(o); 668 return o == nullptr || (begin <= obj && obj < end); 669} 670 671void PatchOat::PatchVisitor::operator() (mirror::Object* obj, MemberOffset off, 672 bool is_static_unused ATTRIBUTE_UNUSED) const { 673 mirror::Object* referent = obj->GetFieldObject<mirror::Object, kVerifyNone>(off); 674 mirror::Object* moved_object = patcher_->RelocatedAddressOfPointer(referent); 675 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 676} 677 678void PatchOat::PatchVisitor::operator() (mirror::Class* cls ATTRIBUTE_UNUSED, 679 mirror::Reference* ref) const { 680 MemberOffset off = mirror::Reference::ReferentOffset(); 681 mirror::Object* referent = ref->GetReferent(); 682 DCHECK(patcher_->InHeap(referent)) << "Referent is not in the heap."; 683 mirror::Object* moved_object = patcher_->RelocatedAddressOfPointer(referent); 684 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 685} 686 687// Called by BitmapCallback 688void PatchOat::VisitObject(mirror::Object* object) { 689 mirror::Object* copy = RelocatedCopyOf(object); 690 CHECK(copy != nullptr); 691 if (kUseBakerOrBrooksReadBarrier) { 692 object->AssertReadBarrierPointer(); 693 if (kUseBrooksReadBarrier) { 694 mirror::Object* moved_to = RelocatedAddressOfPointer(object); 695 copy->SetReadBarrierPointer(moved_to); 696 DCHECK_EQ(copy->GetReadBarrierPointer(), moved_to); 697 } 698 } 699 PatchOat::PatchVisitor visitor(this, copy); 700 object->VisitReferences<kVerifyNone>(visitor, visitor); 701 if (object->IsClass<kVerifyNone>()) { 702 const size_t pointer_size = InstructionSetPointerSize(isa_); 703 mirror::Class* klass = object->AsClass(); 704 mirror::Class* copy_klass = down_cast<mirror::Class*>(copy); 705 RelocatedPointerVisitor native_visitor(this); 706 klass->FixupNativePointers(copy_klass, pointer_size, native_visitor); 707 auto* vtable = klass->GetVTable(); 708 if (vtable != nullptr) { 709 vtable->Fixup(RelocatedCopyOfFollowImages(vtable), pointer_size, native_visitor); 710 } 711 auto* iftable = klass->GetIfTable(); 712 if (iftable != nullptr) { 713 for (int32_t i = 0; i < klass->GetIfTableCount(); ++i) { 714 if (iftable->GetMethodArrayCount(i) > 0) { 715 auto* method_array = iftable->GetMethodArray(i); 716 CHECK(method_array != nullptr); 717 method_array->Fixup(RelocatedCopyOfFollowImages(method_array), 718 pointer_size, 719 native_visitor); 720 } 721 } 722 } 723 } else if (object->GetClass() == mirror::Method::StaticClass() || 724 object->GetClass() == mirror::Constructor::StaticClass()) { 725 // Need to go update the ArtMethod. 726 auto* dest = down_cast<mirror::AbstractMethod*>(copy); 727 auto* src = down_cast<mirror::AbstractMethod*>(object); 728 dest->SetArtMethod(RelocatedAddressOfPointer(src->GetArtMethod())); 729 } 730} 731 732void PatchOat::FixupMethod(ArtMethod* object, ArtMethod* copy) { 733 const size_t pointer_size = InstructionSetPointerSize(isa_); 734 copy->CopyFrom(object, pointer_size); 735 // Just update the entry points if it looks like we should. 736 // TODO: sanity check all the pointers' values 737 copy->SetDeclaringClass(RelocatedAddressOfPointer(object->GetDeclaringClass())); 738 copy->SetDexCacheResolvedMethods( 739 RelocatedAddressOfPointer(object->GetDexCacheResolvedMethods(pointer_size)), pointer_size); 740 copy->SetDexCacheResolvedTypes( 741 RelocatedAddressOfPointer(object->GetDexCacheResolvedTypes(pointer_size)), pointer_size); 742 copy->SetEntryPointFromQuickCompiledCodePtrSize(RelocatedAddressOfPointer( 743 object->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size)), pointer_size); 744 copy->SetEntryPointFromJniPtrSize(RelocatedAddressOfPointer( 745 object->GetEntryPointFromJniPtrSize(pointer_size)), pointer_size); 746} 747 748bool PatchOat::Patch(File* input_oat, off_t delta, File* output_oat, TimingLogger* timings, 749 bool output_oat_opened_from_fd, bool new_oat_out) { 750 CHECK(input_oat != nullptr); 751 CHECK(output_oat != nullptr); 752 CHECK_GE(input_oat->Fd(), 0); 753 CHECK_GE(output_oat->Fd(), 0); 754 TimingLogger::ScopedTiming t("Setup Oat File Patching", timings); 755 756 std::string error_msg; 757 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat, 758 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg)); 759 if (elf.get() == nullptr) { 760 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg; 761 return false; 762 } 763 764 MaybePic is_oat_pic = IsOatPic(elf.get()); 765 if (is_oat_pic >= ERROR_FIRST) { 766 // Error logged by IsOatPic 767 return false; 768 } else if (is_oat_pic == PIC) { 769 // Do not need to do ELF-file patching. Create a symlink and skip the rest. 770 // Any errors will be logged by the function call. 771 return ReplaceOatFileWithSymlink(input_oat->GetPath(), 772 output_oat->GetPath(), 773 output_oat_opened_from_fd, 774 new_oat_out); 775 } else { 776 CHECK(is_oat_pic == NOT_PIC); 777 } 778 779 PatchOat p(elf.release(), delta, timings); 780 t.NewTiming("Patch Oat file"); 781 if (!p.PatchElf()) { 782 return false; 783 } 784 785 t.NewTiming("Writing oat file"); 786 if (!p.WriteElf(output_oat)) { 787 return false; 788 } 789 return true; 790} 791 792template <typename ElfFileImpl> 793bool PatchOat::PatchOatHeader(ElfFileImpl* oat_file) { 794 auto rodata_sec = oat_file->FindSectionByName(".rodata"); 795 if (rodata_sec == nullptr) { 796 return false; 797 } 798 OatHeader* oat_header = reinterpret_cast<OatHeader*>(oat_file->Begin() + rodata_sec->sh_offset); 799 if (!oat_header->IsValid()) { 800 LOG(ERROR) << "Elf file " << oat_file->GetFile().GetPath() << " has an invalid oat header"; 801 return false; 802 } 803 oat_header->RelocateOat(delta_); 804 return true; 805} 806 807bool PatchOat::PatchElf() { 808 if (oat_file_->Is64Bit()) 809 return PatchElf<ElfFileImpl64>(oat_file_->GetImpl64()); 810 else 811 return PatchElf<ElfFileImpl32>(oat_file_->GetImpl32()); 812} 813 814template <typename ElfFileImpl> 815bool PatchOat::PatchElf(ElfFileImpl* oat_file) { 816 TimingLogger::ScopedTiming t("Fixup Elf Text Section", timings_); 817 818 // Fix up absolute references to locations within the boot image. 819 if (!oat_file->ApplyOatPatchesTo(".text", delta_)) { 820 return false; 821 } 822 823 // Update the OatHeader fields referencing the boot image. 824 if (!PatchOatHeader<ElfFileImpl>(oat_file)) { 825 return false; 826 } 827 828 bool need_boot_oat_fixup = true; 829 for (unsigned int i = 0; i < oat_file->GetProgramHeaderNum(); ++i) { 830 auto hdr = oat_file->GetProgramHeader(i); 831 if (hdr->p_type == PT_LOAD && hdr->p_vaddr == 0u) { 832 need_boot_oat_fixup = false; 833 break; 834 } 835 } 836 if (!need_boot_oat_fixup) { 837 // This is an app oat file that can be loaded at an arbitrary address in memory. 838 // Boot image references were patched above and there's nothing else to do. 839 return true; 840 } 841 842 // This is a boot oat file that's loaded at a particular address and we need 843 // to patch all absolute addresses, starting with ELF program headers. 844 845 t.NewTiming("Fixup Elf Headers"); 846 // Fixup Phdr's 847 oat_file->FixupProgramHeaders(delta_); 848 849 t.NewTiming("Fixup Section Headers"); 850 // Fixup Shdr's 851 oat_file->FixupSectionHeaders(delta_); 852 853 t.NewTiming("Fixup Dynamics"); 854 oat_file->FixupDynamic(delta_); 855 856 t.NewTiming("Fixup Elf Symbols"); 857 // Fixup dynsym 858 if (!oat_file->FixupSymbols(delta_, true)) { 859 return false; 860 } 861 // Fixup symtab 862 if (!oat_file->FixupSymbols(delta_, false)) { 863 return false; 864 } 865 866 t.NewTiming("Fixup Debug Sections"); 867 if (!oat_file->FixupDebugSections(delta_)) { 868 return false; 869 } 870 871 return true; 872} 873 874static int orig_argc; 875static char** orig_argv; 876 877static std::string CommandLine() { 878 std::vector<std::string> command; 879 for (int i = 0; i < orig_argc; ++i) { 880 command.push_back(orig_argv[i]); 881 } 882 return Join(command, ' '); 883} 884 885static void UsageErrorV(const char* fmt, va_list ap) { 886 std::string error; 887 StringAppendV(&error, fmt, ap); 888 LOG(ERROR) << error; 889} 890 891static void UsageError(const char* fmt, ...) { 892 va_list ap; 893 va_start(ap, fmt); 894 UsageErrorV(fmt, ap); 895 va_end(ap); 896} 897 898NO_RETURN static void Usage(const char *fmt, ...) { 899 va_list ap; 900 va_start(ap, fmt); 901 UsageErrorV(fmt, ap); 902 va_end(ap); 903 904 UsageError("Command: %s", CommandLine().c_str()); 905 UsageError("Usage: patchoat [options]..."); 906 UsageError(""); 907 UsageError(" --instruction-set=<isa>: Specifies the instruction set the patched code is"); 908 UsageError(" compiled for. Required if you use --input-oat-location"); 909 UsageError(""); 910 UsageError(" --input-oat-file=<file.oat>: Specifies the exact filename of the oat file to be"); 911 UsageError(" patched."); 912 UsageError(""); 913 UsageError(" --input-oat-fd=<file-descriptor>: Specifies the file-descriptor of the oat file"); 914 UsageError(" to be patched."); 915 UsageError(""); 916 UsageError(" --input-oat-location=<file.oat>: Specifies the 'location' to read the patched"); 917 UsageError(" oat file from. If used one must also supply the --instruction-set"); 918 UsageError(""); 919 UsageError(" --input-image-location=<file.art>: Specifies the 'location' of the image file to"); 920 UsageError(" be patched. If --instruction-set is not given it will use the instruction set"); 921 UsageError(" extracted from the --input-oat-file."); 922 UsageError(""); 923 UsageError(" --output-oat-file=<file.oat>: Specifies the exact file to write the patched oat"); 924 UsageError(" file to."); 925 UsageError(""); 926 UsageError(" --output-oat-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 927 UsageError(" the patched oat file to."); 928 UsageError(""); 929 UsageError(" --output-image-file=<file.art>: Specifies the exact file to write the patched"); 930 UsageError(" image file to."); 931 UsageError(""); 932 UsageError(" --output-image-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 933 UsageError(" the patched image file to."); 934 UsageError(""); 935 UsageError(" --orig-base-offset=<original-base-offset>: Specify the base offset the input file"); 936 UsageError(" was compiled with. This is needed if one is specifying a --base-offset"); 937 UsageError(""); 938 UsageError(" --base-offset=<new-base-offset>: Specify the base offset we will repatch the"); 939 UsageError(" given files to use. This requires that --orig-base-offset is also given."); 940 UsageError(""); 941 UsageError(" --base-offset-delta=<delta>: Specify the amount to change the old base-offset by."); 942 UsageError(" This value may be negative."); 943 UsageError(""); 944 UsageError(" --patched-image-file=<file.art>: Relocate the oat file to be the same as the"); 945 UsageError(" given image file."); 946 UsageError(""); 947 UsageError(" --patched-image-location=<file.art>: Relocate the oat file to be the same as the"); 948 UsageError(" image at the given location. If used one must also specify the"); 949 UsageError(" --instruction-set flag. It will search for this image in the same way that"); 950 UsageError(" is done when loading one."); 951 UsageError(""); 952 UsageError(" --lock-output: Obtain a flock on output oat file before starting."); 953 UsageError(""); 954 UsageError(" --no-lock-output: Do not attempt to obtain a flock on output oat file."); 955 UsageError(""); 956 UsageError(" --dump-timings: dump out patch timing information"); 957 UsageError(""); 958 UsageError(" --no-dump-timings: do not dump out patch timing information"); 959 UsageError(""); 960 961 exit(EXIT_FAILURE); 962} 963 964static bool ReadBaseDelta(const char* name, off_t* delta, std::string* error_msg) { 965 CHECK(name != nullptr); 966 CHECK(delta != nullptr); 967 std::unique_ptr<File> file; 968 if (OS::FileExists(name)) { 969 file.reset(OS::OpenFileForReading(name)); 970 if (file.get() == nullptr) { 971 *error_msg = "Failed to open file %s for reading"; 972 return false; 973 } 974 } else { 975 *error_msg = "File %s does not exist"; 976 return false; 977 } 978 CHECK(file.get() != nullptr); 979 ImageHeader hdr; 980 if (sizeof(hdr) != file->Read(reinterpret_cast<char*>(&hdr), sizeof(hdr), 0)) { 981 *error_msg = "Failed to read file %s"; 982 return false; 983 } 984 if (!hdr.IsValid()) { 985 *error_msg = "%s does not contain a valid image header."; 986 return false; 987 } 988 *delta = hdr.GetPatchDelta(); 989 return true; 990} 991 992static int patchoat(int argc, char **argv) { 993 InitLogging(argv); 994 MemMap::Init(); 995 const bool debug = kIsDebugBuild; 996 orig_argc = argc; 997 orig_argv = argv; 998 TimingLogger timings("patcher", false, false); 999 1000 InitLogging(argv); 1001 1002 // Skip over the command name. 1003 argv++; 1004 argc--; 1005 1006 if (argc == 0) { 1007 Usage("No arguments specified"); 1008 } 1009 1010 timings.StartTiming("Patchoat"); 1011 1012 // cmd line args 1013 bool isa_set = false; 1014 InstructionSet isa = kNone; 1015 std::string input_oat_filename; 1016 std::string input_oat_location; 1017 int input_oat_fd = -1; 1018 bool have_input_oat = false; 1019 std::string input_image_location; 1020 std::string output_oat_filename; 1021 int output_oat_fd = -1; 1022 bool have_output_oat = false; 1023 std::string output_image_filename; 1024 int output_image_fd = -1; 1025 bool have_output_image = false; 1026 uintptr_t base_offset = 0; 1027 bool base_offset_set = false; 1028 uintptr_t orig_base_offset = 0; 1029 bool orig_base_offset_set = false; 1030 off_t base_delta = 0; 1031 bool base_delta_set = false; 1032 bool match_delta = false; 1033 std::string patched_image_filename; 1034 std::string patched_image_location; 1035 bool dump_timings = kIsDebugBuild; 1036 bool lock_output = true; 1037 1038 for (int i = 0; i < argc; ++i) { 1039 const StringPiece option(argv[i]); 1040 const bool log_options = false; 1041 if (log_options) { 1042 LOG(INFO) << "patchoat: option[" << i << "]=" << argv[i]; 1043 } 1044 if (option.starts_with("--instruction-set=")) { 1045 isa_set = true; 1046 const char* isa_str = option.substr(strlen("--instruction-set=")).data(); 1047 isa = GetInstructionSetFromString(isa_str); 1048 if (isa == kNone) { 1049 Usage("Unknown or invalid instruction set %s", isa_str); 1050 } 1051 } else if (option.starts_with("--input-oat-location=")) { 1052 if (have_input_oat) { 1053 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 1054 } 1055 have_input_oat = true; 1056 input_oat_location = option.substr(strlen("--input-oat-location=")).data(); 1057 } else if (option.starts_with("--input-oat-file=")) { 1058 if (have_input_oat) { 1059 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 1060 } 1061 have_input_oat = true; 1062 input_oat_filename = option.substr(strlen("--input-oat-file=")).data(); 1063 } else if (option.starts_with("--input-oat-fd=")) { 1064 if (have_input_oat) { 1065 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 1066 } 1067 have_input_oat = true; 1068 const char* oat_fd_str = option.substr(strlen("--input-oat-fd=")).data(); 1069 if (!ParseInt(oat_fd_str, &input_oat_fd)) { 1070 Usage("Failed to parse --input-oat-fd argument '%s' as an integer", oat_fd_str); 1071 } 1072 if (input_oat_fd < 0) { 1073 Usage("--input-oat-fd pass a negative value %d", input_oat_fd); 1074 } 1075 } else if (option.starts_with("--input-image-location=")) { 1076 input_image_location = option.substr(strlen("--input-image-location=")).data(); 1077 } else if (option.starts_with("--output-oat-file=")) { 1078 if (have_output_oat) { 1079 Usage("Only one of --output-oat-file, and --output-oat-fd may be used."); 1080 } 1081 have_output_oat = true; 1082 output_oat_filename = option.substr(strlen("--output-oat-file=")).data(); 1083 } else if (option.starts_with("--output-oat-fd=")) { 1084 if (have_output_oat) { 1085 Usage("Only one of --output-oat-file, --output-oat-fd may be used."); 1086 } 1087 have_output_oat = true; 1088 const char* oat_fd_str = option.substr(strlen("--output-oat-fd=")).data(); 1089 if (!ParseInt(oat_fd_str, &output_oat_fd)) { 1090 Usage("Failed to parse --output-oat-fd argument '%s' as an integer", oat_fd_str); 1091 } 1092 if (output_oat_fd < 0) { 1093 Usage("--output-oat-fd pass a negative value %d", output_oat_fd); 1094 } 1095 } else if (option.starts_with("--output-image-file=")) { 1096 if (have_output_image) { 1097 Usage("Only one of --output-image-file, and --output-image-fd may be used."); 1098 } 1099 have_output_image = true; 1100 output_image_filename = option.substr(strlen("--output-image-file=")).data(); 1101 } else if (option.starts_with("--output-image-fd=")) { 1102 if (have_output_image) { 1103 Usage("Only one of --output-image-file, and --output-image-fd may be used."); 1104 } 1105 have_output_image = true; 1106 const char* image_fd_str = option.substr(strlen("--output-image-fd=")).data(); 1107 if (!ParseInt(image_fd_str, &output_image_fd)) { 1108 Usage("Failed to parse --output-image-fd argument '%s' as an integer", image_fd_str); 1109 } 1110 if (output_image_fd < 0) { 1111 Usage("--output-image-fd pass a negative value %d", output_image_fd); 1112 } 1113 } else if (option.starts_with("--orig-base-offset=")) { 1114 const char* orig_base_offset_str = option.substr(strlen("--orig-base-offset=")).data(); 1115 orig_base_offset_set = true; 1116 if (!ParseUint(orig_base_offset_str, &orig_base_offset)) { 1117 Usage("Failed to parse --orig-base-offset argument '%s' as an uintptr_t", 1118 orig_base_offset_str); 1119 } 1120 } else if (option.starts_with("--base-offset=")) { 1121 const char* base_offset_str = option.substr(strlen("--base-offset=")).data(); 1122 base_offset_set = true; 1123 if (!ParseUint(base_offset_str, &base_offset)) { 1124 Usage("Failed to parse --base-offset argument '%s' as an uintptr_t", base_offset_str); 1125 } 1126 } else if (option.starts_with("--base-offset-delta=")) { 1127 const char* base_delta_str = option.substr(strlen("--base-offset-delta=")).data(); 1128 base_delta_set = true; 1129 if (!ParseInt(base_delta_str, &base_delta)) { 1130 Usage("Failed to parse --base-offset-delta argument '%s' as an off_t", base_delta_str); 1131 } 1132 } else if (option.starts_with("--patched-image-location=")) { 1133 patched_image_location = option.substr(strlen("--patched-image-location=")).data(); 1134 } else if (option.starts_with("--patched-image-file=")) { 1135 patched_image_filename = option.substr(strlen("--patched-image-file=")).data(); 1136 } else if (option == "--lock-output") { 1137 lock_output = true; 1138 } else if (option == "--no-lock-output") { 1139 lock_output = false; 1140 } else if (option == "--dump-timings") { 1141 dump_timings = true; 1142 } else if (option == "--no-dump-timings") { 1143 dump_timings = false; 1144 } else { 1145 Usage("Unknown argument %s", option.data()); 1146 } 1147 } 1148 1149 { 1150 // Only 1 of these may be set. 1151 uint32_t cnt = 0; 1152 cnt += (base_delta_set) ? 1 : 0; 1153 cnt += (base_offset_set && orig_base_offset_set) ? 1 : 0; 1154 cnt += (!patched_image_filename.empty()) ? 1 : 0; 1155 cnt += (!patched_image_location.empty()) ? 1 : 0; 1156 if (cnt > 1) { 1157 Usage("Only one of --base-offset/--orig-base-offset, --base-offset-delta, " 1158 "--patched-image-filename or --patched-image-location may be used."); 1159 } else if (cnt == 0) { 1160 Usage("Must specify --base-offset-delta, --base-offset and --orig-base-offset, " 1161 "--patched-image-location or --patched-image-file"); 1162 } 1163 } 1164 1165 if (have_input_oat != have_output_oat) { 1166 Usage("Either both input and output oat must be supplied or niether must be."); 1167 } 1168 1169 if ((!input_image_location.empty()) != have_output_image) { 1170 Usage("Either both input and output image must be supplied or niether must be."); 1171 } 1172 1173 // We know we have both the input and output so rename for clarity. 1174 bool have_image_files = have_output_image; 1175 bool have_oat_files = have_output_oat; 1176 1177 if (!have_oat_files) { 1178 if (have_image_files) { 1179 Usage("Cannot patch an image file without an oat file"); 1180 } else { 1181 Usage("Must be patching either an oat file or an image file with an oat file."); 1182 } 1183 } 1184 1185 if (!have_oat_files && !isa_set) { 1186 Usage("Must include ISA if patching an image file without an oat file."); 1187 } 1188 1189 if (!input_oat_location.empty()) { 1190 if (!isa_set) { 1191 Usage("specifying a location requires specifying an instruction set"); 1192 } 1193 if (!LocationToFilename(input_oat_location, isa, &input_oat_filename)) { 1194 Usage("Unable to find filename for input oat location %s", input_oat_location.c_str()); 1195 } 1196 if (debug) { 1197 LOG(INFO) << "Using input-oat-file " << input_oat_filename; 1198 } 1199 } 1200 if (!patched_image_location.empty()) { 1201 if (!isa_set) { 1202 Usage("specifying a location requires specifying an instruction set"); 1203 } 1204 std::string system_filename; 1205 bool has_system = false; 1206 std::string cache_filename; 1207 bool has_cache = false; 1208 bool has_android_data_unused = false; 1209 bool is_global_cache = false; 1210 if (!gc::space::ImageSpace::FindImageFilename(patched_image_location.c_str(), isa, 1211 &system_filename, &has_system, &cache_filename, 1212 &has_android_data_unused, &has_cache, 1213 &is_global_cache)) { 1214 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 1215 } 1216 if (has_cache) { 1217 patched_image_filename = cache_filename; 1218 } else if (has_system) { 1219 LOG(WARNING) << "Only image file found was in /system for image location " 1220 << patched_image_location; 1221 patched_image_filename = system_filename; 1222 } else { 1223 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 1224 } 1225 if (debug) { 1226 LOG(INFO) << "Using patched-image-file " << patched_image_filename; 1227 } 1228 } 1229 1230 if (!base_delta_set) { 1231 if (orig_base_offset_set && base_offset_set) { 1232 base_delta_set = true; 1233 base_delta = base_offset - orig_base_offset; 1234 } else if (!patched_image_filename.empty()) { 1235 if (have_image_files) { 1236 Usage("--patched-image-location should not be used when patching other images"); 1237 } 1238 base_delta_set = true; 1239 match_delta = true; 1240 std::string error_msg; 1241 if (!ReadBaseDelta(patched_image_filename.c_str(), &base_delta, &error_msg)) { 1242 Usage(error_msg.c_str(), patched_image_filename.c_str()); 1243 } 1244 } else { 1245 if (base_offset_set) { 1246 Usage("Unable to determine original base offset."); 1247 } else { 1248 Usage("Must supply a desired new offset or delta."); 1249 } 1250 } 1251 } 1252 1253 if (!IsAligned<kPageSize>(base_delta)) { 1254 Usage("Base offset/delta must be alligned to a pagesize (0x%08x) boundary.", kPageSize); 1255 } 1256 1257 // Do we need to cleanup output files if we fail? 1258 bool new_image_out = false; 1259 bool new_oat_out = false; 1260 1261 std::unique_ptr<File> input_oat; 1262 std::unique_ptr<File> output_oat; 1263 std::unique_ptr<File> output_image; 1264 1265 if (have_image_files) { 1266 CHECK(!input_image_location.empty()); 1267 1268 if (output_image_fd != -1) { 1269 if (output_image_filename.empty()) { 1270 output_image_filename = "output-image-file"; 1271 } 1272 output_image.reset(new File(output_image_fd, output_image_filename, true)); 1273 } else { 1274 CHECK(!output_image_filename.empty()); 1275 output_image.reset(CreateOrOpen(output_image_filename.c_str(), &new_image_out)); 1276 } 1277 } else { 1278 CHECK(output_image_filename.empty() && output_image_fd == -1 && input_image_location.empty()); 1279 } 1280 1281 if (have_oat_files) { 1282 if (input_oat_fd != -1) { 1283 if (input_oat_filename.empty()) { 1284 input_oat_filename = "input-oat-file"; 1285 } 1286 input_oat.reset(new File(input_oat_fd, input_oat_filename, false)); 1287 if (input_oat_fd == output_oat_fd) { 1288 input_oat.get()->DisableAutoClose(); 1289 } 1290 if (input_oat == nullptr) { 1291 // Unlikely, but ensure exhaustive logging in non-0 exit code case 1292 LOG(ERROR) << "Failed to open input oat file by its FD" << input_oat_fd; 1293 } 1294 } else { 1295 CHECK(!input_oat_filename.empty()); 1296 input_oat.reset(OS::OpenFileForReading(input_oat_filename.c_str())); 1297 if (input_oat == nullptr) { 1298 int err = errno; 1299 LOG(ERROR) << "Failed to open input oat file " << input_oat_filename 1300 << ": " << strerror(err) << "(" << err << ")"; 1301 } 1302 } 1303 1304 if (output_oat_fd != -1) { 1305 if (output_oat_filename.empty()) { 1306 output_oat_filename = "output-oat-file"; 1307 } 1308 output_oat.reset(new File(output_oat_fd, output_oat_filename, true)); 1309 if (output_oat == nullptr) { 1310 // Unlikely, but ensure exhaustive logging in non-0 exit code case 1311 LOG(ERROR) << "Failed to open output oat file by its FD" << output_oat_fd; 1312 } 1313 } else { 1314 CHECK(!output_oat_filename.empty()); 1315 output_oat.reset(CreateOrOpen(output_oat_filename.c_str(), &new_oat_out)); 1316 if (output_oat == nullptr) { 1317 int err = errno; 1318 LOG(ERROR) << "Failed to open output oat file " << output_oat_filename 1319 << ": " << strerror(err) << "(" << err << ")"; 1320 } 1321 } 1322 } 1323 1324 // TODO: get rid of this. 1325 auto cleanup = [&output_image_filename, &output_oat_filename, 1326 &new_oat_out, &new_image_out, &timings, &dump_timings](bool success) { 1327 timings.EndTiming(); 1328 if (!success) { 1329 if (new_oat_out) { 1330 CHECK(!output_oat_filename.empty()); 1331 TEMP_FAILURE_RETRY(unlink(output_oat_filename.c_str())); 1332 } 1333 if (new_image_out) { 1334 CHECK(!output_image_filename.empty()); 1335 TEMP_FAILURE_RETRY(unlink(output_image_filename.c_str())); 1336 } 1337 } 1338 if (dump_timings) { 1339 LOG(INFO) << Dumpable<TimingLogger>(timings); 1340 } 1341 1342 if (kIsDebugBuild) { 1343 LOG(INFO) << "Cleaning up.. success? " << success; 1344 } 1345 }; 1346 1347 if (have_oat_files && (input_oat.get() == nullptr || output_oat.get() == nullptr)) { 1348 LOG(ERROR) << "Failed to open input/output oat files"; 1349 cleanup(false); 1350 return EXIT_FAILURE; 1351 } else if (have_image_files && output_image.get() == nullptr) { 1352 LOG(ERROR) << "Failed to open output image file"; 1353 cleanup(false); 1354 return EXIT_FAILURE; 1355 } 1356 1357 if (match_delta) { 1358 CHECK(!have_image_files); // We will not do this with images. 1359 std::string error_msg; 1360 // Figure out what the current delta is so we can match it to the desired delta. 1361 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat.get(), PROT_READ, MAP_PRIVATE, 1362 &error_msg)); 1363 off_t current_delta = 0; 1364 if (elf.get() == nullptr) { 1365 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg; 1366 cleanup(false); 1367 return EXIT_FAILURE; 1368 } else if (!ReadOatPatchDelta(elf.get(), ¤t_delta, &error_msg)) { 1369 LOG(ERROR) << "Unable to get current delta: " << error_msg; 1370 cleanup(false); 1371 return EXIT_FAILURE; 1372 } 1373 // Before this line base_delta is the desired final delta. We need it to be the actual amount to 1374 // change everything by. We subtract the current delta from it to make it this. 1375 base_delta -= current_delta; 1376 if (!IsAligned<kPageSize>(base_delta)) { 1377 LOG(ERROR) << "Given image file was relocated by an illegal delta"; 1378 cleanup(false); 1379 return false; 1380 } 1381 } 1382 1383 if (debug) { 1384 LOG(INFO) << "moving offset by " << base_delta 1385 << " (0x" << std::hex << base_delta << ") bytes or " 1386 << std::dec << (base_delta/kPageSize) << " pages."; 1387 } 1388 1389 // TODO: is it going to be promatic to unlink a file that was flock-ed? 1390 ScopedFlock output_oat_lock; 1391 if (lock_output) { 1392 std::string error_msg; 1393 if (have_oat_files && !output_oat_lock.Init(output_oat.get(), &error_msg)) { 1394 LOG(ERROR) << "Unable to lock output oat " << output_image->GetPath() << ": " << error_msg; 1395 cleanup(false); 1396 return EXIT_FAILURE; 1397 } 1398 } 1399 1400 bool ret; 1401 if (have_image_files && have_oat_files) { 1402 TimingLogger::ScopedTiming pt("patch image and oat", &timings); 1403 ret = PatchOat::Patch(input_oat.get(), input_image_location, base_delta, 1404 output_oat.get(), output_image.get(), isa, &timings, 1405 output_oat_fd >= 0, // was it opened from FD? 1406 new_oat_out); 1407 // The order here doesn't matter. If the first one is successfully saved and the second one 1408 // erased, ImageSpace will still detect a problem and not use the files. 1409 ret = FinishFile(output_image.get(), ret); 1410 ret = FinishFile(output_oat.get(), ret); 1411 } else if (have_oat_files) { 1412 TimingLogger::ScopedTiming pt("patch oat", &timings); 1413 ret = PatchOat::Patch(input_oat.get(), base_delta, output_oat.get(), &timings, 1414 output_oat_fd >= 0, // was it opened from FD? 1415 new_oat_out); 1416 ret = FinishFile(output_oat.get(), ret); 1417 } else { 1418 CHECK(false); 1419 ret = true; 1420 } 1421 1422 if (kIsDebugBuild) { 1423 LOG(INFO) << "Exiting with return ... " << ret; 1424 } 1425 cleanup(ret); 1426 return (ret) ? EXIT_SUCCESS : EXIT_FAILURE; 1427} 1428 1429} // namespace art 1430 1431int main(int argc, char **argv) { 1432 return art::patchoat(argc, argv); 1433} 1434