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