patchoat.cc revision 58c3f6a0d15a4340c0a11ab7fbc8c4b990c64b77
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/dex_cache.h" 41#include "mirror/executable.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-inl.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->GetFilePath(); 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 PatchOat::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( 508 patch_oat_->RelocatedAddressOfPointer(field->GetDeclaringClass().Ptr())); 509 } 510 511 private: 512 PatchOat* const patch_oat_; 513}; 514 515void PatchOat::PatchArtFields(const ImageHeader* image_header) { 516 PatchOatArtFieldVisitor visitor(this); 517 image_header->VisitPackedArtFields(&visitor, heap_->Begin()); 518} 519 520class PatchOat::PatchOatArtMethodVisitor : public ArtMethodVisitor { 521 public: 522 explicit PatchOatArtMethodVisitor(PatchOat* patch_oat) : patch_oat_(patch_oat) {} 523 524 void Visit(ArtMethod* method) OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 525 ArtMethod* const dest = patch_oat_->RelocatedCopyOf(method); 526 patch_oat_->FixupMethod(method, dest); 527 } 528 529 private: 530 PatchOat* const patch_oat_; 531}; 532 533void PatchOat::PatchArtMethods(const ImageHeader* image_header) { 534 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 535 PatchOatArtMethodVisitor visitor(this); 536 image_header->VisitPackedArtMethods(&visitor, heap_->Begin(), pointer_size); 537} 538 539void PatchOat::PatchImTables(const ImageHeader* image_header) { 540 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 541 // We can safely walk target image since the conflict tables are independent. 542 image_header->VisitPackedImTables( 543 [this](ArtMethod* method) { 544 return RelocatedAddressOfPointer(method); 545 }, 546 image_->Begin(), 547 pointer_size); 548} 549 550void PatchOat::PatchImtConflictTables(const ImageHeader* image_header) { 551 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 552 // We can safely walk target image since the conflict tables are independent. 553 image_header->VisitPackedImtConflictTables( 554 [this](ArtMethod* method) { 555 return RelocatedAddressOfPointer(method); 556 }, 557 image_->Begin(), 558 pointer_size); 559} 560 561class PatchOat::FixupRootVisitor : public RootVisitor { 562 public: 563 explicit FixupRootVisitor(const PatchOat* patch_oat) : patch_oat_(patch_oat) { 564 } 565 566 void VisitRoots(mirror::Object*** roots, size_t count, const RootInfo& info ATTRIBUTE_UNUSED) 567 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 568 for (size_t i = 0; i < count; ++i) { 569 *roots[i] = patch_oat_->RelocatedAddressOfPointer(*roots[i]); 570 } 571 } 572 573 void VisitRoots(mirror::CompressedReference<mirror::Object>** roots, size_t count, 574 const RootInfo& info ATTRIBUTE_UNUSED) 575 OVERRIDE REQUIRES_SHARED(Locks::mutator_lock_) { 576 for (size_t i = 0; i < count; ++i) { 577 roots[i]->Assign(patch_oat_->RelocatedAddressOfPointer(roots[i]->AsMirrorPtr())); 578 } 579 } 580 581 private: 582 const PatchOat* const patch_oat_; 583}; 584 585void PatchOat::PatchInternedStrings(const ImageHeader* image_header) { 586 const auto& section = image_header->GetImageSection(ImageHeader::kSectionInternedStrings); 587 InternTable temp_table; 588 // Note that we require that ReadFromMemory does not make an internal copy of the elements. 589 // This also relies on visit roots not doing any verification which could fail after we update 590 // the roots to be the image addresses. 591 temp_table.AddTableFromMemory(image_->Begin() + section.Offset()); 592 FixupRootVisitor visitor(this); 593 temp_table.VisitRoots(&visitor, kVisitRootFlagAllRoots); 594} 595 596void PatchOat::PatchClassTable(const ImageHeader* image_header) { 597 const auto& section = image_header->GetImageSection(ImageHeader::kSectionClassTable); 598 if (section.Size() == 0) { 599 return; 600 } 601 // Note that we require that ReadFromMemory does not make an internal copy of the elements. 602 // This also relies on visit roots not doing any verification which could fail after we update 603 // the roots to be the image addresses. 604 WriterMutexLock mu(Thread::Current(), *Locks::classlinker_classes_lock_); 605 ClassTable temp_table; 606 temp_table.ReadFromMemory(image_->Begin() + section.Offset()); 607 FixupRootVisitor visitor(this); 608 temp_table.VisitRoots(UnbufferedRootVisitor(&visitor, RootInfo(kRootUnknown))); 609} 610 611 612class PatchOat::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 mirror::MethodTypeDexCacheType* orig_method_types = orig_dex_cache->GetResolvedMethodTypes(); 680 mirror::MethodTypeDexCacheType* relocated_method_types = 681 RelocatedAddressOfPointer(orig_method_types); 682 copy_dex_cache->SetField64<false>( 683 mirror::DexCache::ResolvedMethodTypesOffset(), 684 static_cast<int64_t>(reinterpret_cast<uintptr_t>(relocated_method_types))); 685 if (orig_method_types != nullptr) { 686 orig_dex_cache->FixupResolvedMethodTypes(RelocatedCopyOf(orig_method_types), 687 RelocatedPointerVisitor(this)); 688 } 689 } 690} 691 692bool PatchOat::PatchImage(bool primary_image) { 693 ImageHeader* image_header = reinterpret_cast<ImageHeader*>(image_->Begin()); 694 CHECK_GT(image_->Size(), sizeof(ImageHeader)); 695 // These are the roots from the original file. 696 auto* img_roots = image_header->GetImageRoots(); 697 image_header->RelocateImage(delta_); 698 699 PatchArtFields(image_header); 700 PatchArtMethods(image_header); 701 PatchImTables(image_header); 702 PatchImtConflictTables(image_header); 703 PatchInternedStrings(image_header); 704 PatchClassTable(image_header); 705 // Patch dex file int/long arrays which point to ArtFields. 706 PatchDexFileArrays(img_roots); 707 708 if (primary_image) { 709 VisitObject(img_roots); 710 } 711 712 if (!image_header->IsValid()) { 713 LOG(ERROR) << "relocation renders image header invalid"; 714 return false; 715 } 716 717 { 718 TimingLogger::ScopedTiming t("Walk Bitmap", timings_); 719 // Walk the bitmap. 720 WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_); 721 bitmap_->Walk(PatchOat::BitmapCallback, this); 722 } 723 return true; 724} 725 726 727void PatchOat::PatchVisitor::operator() (ObjPtr<mirror::Object> obj, 728 MemberOffset off, 729 bool is_static_unused ATTRIBUTE_UNUSED) const { 730 mirror::Object* referent = obj->GetFieldObject<mirror::Object, kVerifyNone>(off); 731 mirror::Object* moved_object = patcher_->RelocatedAddressOfPointer(referent); 732 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 733} 734 735void PatchOat::PatchVisitor::operator() (ObjPtr<mirror::Class> cls ATTRIBUTE_UNUSED, 736 ObjPtr<mirror::Reference> ref) const { 737 MemberOffset off = mirror::Reference::ReferentOffset(); 738 mirror::Object* referent = ref->GetReferent(); 739 DCHECK(referent == nullptr || 740 Runtime::Current()->GetHeap()->ObjectIsInBootImageSpace(referent)) << referent; 741 mirror::Object* moved_object = patcher_->RelocatedAddressOfPointer(referent); 742 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 743} 744 745// Called by BitmapCallback 746void PatchOat::VisitObject(mirror::Object* object) { 747 mirror::Object* copy = RelocatedCopyOf(object); 748 CHECK(copy != nullptr); 749 if (kUseBakerReadBarrier) { 750 object->AssertReadBarrierState(); 751 } 752 PatchOat::PatchVisitor visitor(this, copy); 753 object->VisitReferences<kVerifyNone>(visitor, visitor); 754 if (object->IsClass<kVerifyNone>()) { 755 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 756 mirror::Class* klass = object->AsClass(); 757 mirror::Class* copy_klass = down_cast<mirror::Class*>(copy); 758 RelocatedPointerVisitor native_visitor(this); 759 klass->FixupNativePointers(copy_klass, pointer_size, native_visitor); 760 auto* vtable = klass->GetVTable(); 761 if (vtable != nullptr) { 762 vtable->Fixup(RelocatedCopyOfFollowImages(vtable), pointer_size, native_visitor); 763 } 764 mirror::IfTable* iftable = klass->GetIfTable(); 765 for (int32_t i = 0; i < klass->GetIfTableCount(); ++i) { 766 if (iftable->GetMethodArrayCount(i) > 0) { 767 auto* method_array = iftable->GetMethodArray(i); 768 CHECK(method_array != nullptr); 769 method_array->Fixup(RelocatedCopyOfFollowImages(method_array), 770 pointer_size, 771 native_visitor); 772 } 773 } 774 } else if (object->GetClass() == mirror::Method::StaticClass() || 775 object->GetClass() == mirror::Constructor::StaticClass()) { 776 // Need to go update the ArtMethod. 777 auto* dest = down_cast<mirror::Executable*>(copy); 778 auto* src = down_cast<mirror::Executable*>(object); 779 dest->SetArtMethod(RelocatedAddressOfPointer(src->GetArtMethod())); 780 } 781} 782 783void PatchOat::FixupMethod(ArtMethod* object, ArtMethod* copy) { 784 const PointerSize pointer_size = InstructionSetPointerSize(isa_); 785 copy->CopyFrom(object, pointer_size); 786 // Just update the entry points if it looks like we should. 787 // TODO: sanity check all the pointers' values 788 copy->SetDeclaringClass(RelocatedAddressOfPointer(object->GetDeclaringClass())); 789 copy->SetDexCacheResolvedMethods( 790 RelocatedAddressOfPointer(object->GetDexCacheResolvedMethods(pointer_size)), pointer_size); 791 copy->SetDexCacheResolvedTypes( 792 RelocatedAddressOfPointer(object->GetDexCacheResolvedTypes(pointer_size)), pointer_size); 793 copy->SetEntryPointFromQuickCompiledCodePtrSize(RelocatedAddressOfPointer( 794 object->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size)), pointer_size); 795 // No special handling for IMT conflict table since all pointers are moved by the same offset. 796 copy->SetDataPtrSize(RelocatedAddressOfPointer( 797 object->GetDataPtrSize(pointer_size)), pointer_size); 798} 799 800bool PatchOat::Patch(File* input_oat, off_t delta, File* output_oat, TimingLogger* timings, 801 bool output_oat_opened_from_fd, bool new_oat_out) { 802 CHECK(input_oat != nullptr); 803 CHECK(output_oat != nullptr); 804 CHECK_GE(input_oat->Fd(), 0); 805 CHECK_GE(output_oat->Fd(), 0); 806 TimingLogger::ScopedTiming t("Setup Oat File Patching", timings); 807 808 std::string error_msg; 809 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat, 810 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg)); 811 if (elf.get() == nullptr) { 812 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg; 813 return false; 814 } 815 816 MaybePic is_oat_pic = IsOatPic(elf.get()); 817 if (is_oat_pic >= ERROR_FIRST) { 818 // Error logged by IsOatPic 819 return false; 820 } else if (is_oat_pic == PIC) { 821 // Do not need to do ELF-file patching. Create a symlink and skip the rest. 822 // Any errors will be logged by the function call. 823 return ReplaceOatFileWithSymlink(input_oat->GetPath(), 824 output_oat->GetPath(), 825 output_oat_opened_from_fd, 826 new_oat_out); 827 } else { 828 CHECK(is_oat_pic == NOT_PIC); 829 } 830 831 PatchOat p(elf.release(), delta, timings); 832 t.NewTiming("Patch Oat file"); 833 if (!p.PatchElf()) { 834 return false; 835 } 836 837 t.NewTiming("Writing oat file"); 838 if (!p.WriteElf(output_oat)) { 839 return false; 840 } 841 return true; 842} 843 844template <typename ElfFileImpl> 845bool PatchOat::PatchOatHeader(ElfFileImpl* oat_file) { 846 auto rodata_sec = oat_file->FindSectionByName(".rodata"); 847 if (rodata_sec == nullptr) { 848 return false; 849 } 850 OatHeader* oat_header = reinterpret_cast<OatHeader*>(oat_file->Begin() + rodata_sec->sh_offset); 851 if (!oat_header->IsValid()) { 852 LOG(ERROR) << "Elf file " << oat_file->GetFilePath() << " has an invalid oat header"; 853 return false; 854 } 855 oat_header->RelocateOat(delta_); 856 return true; 857} 858 859bool PatchOat::PatchElf() { 860 if (oat_file_->Is64Bit()) { 861 return PatchElf<ElfFileImpl64>(oat_file_->GetImpl64()); 862 } else { 863 return PatchElf<ElfFileImpl32>(oat_file_->GetImpl32()); 864 } 865} 866 867template <typename ElfFileImpl> 868bool PatchOat::PatchElf(ElfFileImpl* oat_file) { 869 TimingLogger::ScopedTiming t("Fixup Elf Text Section", timings_); 870 871 // Fix up absolute references to locations within the boot image. 872 if (!oat_file->ApplyOatPatchesTo(".text", delta_)) { 873 return false; 874 } 875 876 // Update the OatHeader fields referencing the boot image. 877 if (!PatchOatHeader<ElfFileImpl>(oat_file)) { 878 return false; 879 } 880 881 bool need_boot_oat_fixup = true; 882 for (unsigned int i = 0; i < oat_file->GetProgramHeaderNum(); ++i) { 883 auto hdr = oat_file->GetProgramHeader(i); 884 if (hdr->p_type == PT_LOAD && hdr->p_vaddr == 0u) { 885 need_boot_oat_fixup = false; 886 break; 887 } 888 } 889 if (!need_boot_oat_fixup) { 890 // This is an app oat file that can be loaded at an arbitrary address in memory. 891 // Boot image references were patched above and there's nothing else to do. 892 return true; 893 } 894 895 // This is a boot oat file that's loaded at a particular address and we need 896 // to patch all absolute addresses, starting with ELF program headers. 897 898 t.NewTiming("Fixup Elf Headers"); 899 // Fixup Phdr's 900 oat_file->FixupProgramHeaders(delta_); 901 902 t.NewTiming("Fixup Section Headers"); 903 // Fixup Shdr's 904 oat_file->FixupSectionHeaders(delta_); 905 906 t.NewTiming("Fixup Dynamics"); 907 oat_file->FixupDynamic(delta_); 908 909 t.NewTiming("Fixup Elf Symbols"); 910 // Fixup dynsym 911 if (!oat_file->FixupSymbols(delta_, true)) { 912 return false; 913 } 914 // Fixup symtab 915 if (!oat_file->FixupSymbols(delta_, false)) { 916 return false; 917 } 918 919 t.NewTiming("Fixup Debug Sections"); 920 if (!oat_file->FixupDebugSections(delta_)) { 921 return false; 922 } 923 924 return true; 925} 926 927static int orig_argc; 928static char** orig_argv; 929 930static std::string CommandLine() { 931 std::vector<std::string> command; 932 for (int i = 0; i < orig_argc; ++i) { 933 command.push_back(orig_argv[i]); 934 } 935 return Join(command, ' '); 936} 937 938static void UsageErrorV(const char* fmt, va_list ap) { 939 std::string error; 940 StringAppendV(&error, fmt, ap); 941 LOG(ERROR) << error; 942} 943 944static void UsageError(const char* fmt, ...) { 945 va_list ap; 946 va_start(ap, fmt); 947 UsageErrorV(fmt, ap); 948 va_end(ap); 949} 950 951NO_RETURN static void Usage(const char *fmt, ...) { 952 va_list ap; 953 va_start(ap, fmt); 954 UsageErrorV(fmt, ap); 955 va_end(ap); 956 957 UsageError("Command: %s", CommandLine().c_str()); 958 UsageError("Usage: patchoat [options]..."); 959 UsageError(""); 960 UsageError(" --instruction-set=<isa>: Specifies the instruction set the patched code is"); 961 UsageError(" compiled for. Required if you use --input-oat-location"); 962 UsageError(""); 963 UsageError(" --input-oat-file=<file.oat>: Specifies the exact filename of the oat file to be"); 964 UsageError(" patched."); 965 UsageError(""); 966 UsageError(" --input-oat-fd=<file-descriptor>: Specifies the file-descriptor of the oat file"); 967 UsageError(" to be patched."); 968 UsageError(""); 969 UsageError(" --input-vdex-fd=<file-descriptor>: Specifies the file-descriptor of the vdex file"); 970 UsageError(" associated with the oat file."); 971 UsageError(""); 972 UsageError(" --input-oat-location=<file.oat>: Specifies the 'location' to read the patched"); 973 UsageError(" oat file from. If used one must also supply the --instruction-set"); 974 UsageError(""); 975 UsageError(" --input-image-location=<file.art>: Specifies the 'location' of the image file to"); 976 UsageError(" be patched. If --instruction-set is not given it will use the instruction set"); 977 UsageError(" extracted from the --input-oat-file."); 978 UsageError(""); 979 UsageError(" --output-oat-file=<file.oat>: Specifies the exact file to write the patched oat"); 980 UsageError(" file to."); 981 UsageError(""); 982 UsageError(" --output-oat-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 983 UsageError(" patched oat file to."); 984 UsageError(""); 985 UsageError(" --output-vdex-fd=<file-descriptor>: Specifies the file-descriptor to copy the"); 986 UsageError(" the vdex file associated with the patch oat file to."); 987 UsageError(""); 988 UsageError(" --output-image-file=<file.art>: Specifies the exact file to write the patched"); 989 UsageError(" image file to."); 990 UsageError(""); 991 UsageError(" --base-offset-delta=<delta>: Specify the amount to change the old base-offset by."); 992 UsageError(" This value may be negative."); 993 UsageError(""); 994 UsageError(" --patched-image-location=<file.art>: Relocate the oat file to be the same as the"); 995 UsageError(" image at the given location. If used one must also specify the"); 996 UsageError(" --instruction-set flag. It will search for this image in the same way that"); 997 UsageError(" is done when loading one."); 998 UsageError(""); 999 UsageError(" --lock-output: Obtain a flock on output oat file before starting."); 1000 UsageError(""); 1001 UsageError(" --no-lock-output: Do not attempt to obtain a flock on output oat file."); 1002 UsageError(""); 1003 UsageError(" --dump-timings: dump out patch timing information"); 1004 UsageError(""); 1005 UsageError(" --no-dump-timings: do not dump out patch timing information"); 1006 UsageError(""); 1007 1008 exit(EXIT_FAILURE); 1009} 1010 1011static bool ReadBaseDelta(const char* name, off_t* delta, std::string* error_msg) { 1012 CHECK(name != nullptr); 1013 CHECK(delta != nullptr); 1014 std::unique_ptr<File> file; 1015 if (OS::FileExists(name)) { 1016 file.reset(OS::OpenFileForReading(name)); 1017 if (file.get() == nullptr) { 1018 *error_msg = "Failed to open file %s for reading"; 1019 return false; 1020 } 1021 } else { 1022 *error_msg = "File %s does not exist"; 1023 return false; 1024 } 1025 CHECK(file.get() != nullptr); 1026 ImageHeader hdr; 1027 if (sizeof(hdr) != file->Read(reinterpret_cast<char*>(&hdr), sizeof(hdr), 0)) { 1028 *error_msg = "Failed to read file %s"; 1029 return false; 1030 } 1031 if (!hdr.IsValid()) { 1032 *error_msg = "%s does not contain a valid image header."; 1033 return false; 1034 } 1035 *delta = hdr.GetPatchDelta(); 1036 return true; 1037} 1038 1039static int patchoat_image(TimingLogger& timings, 1040 InstructionSet isa, 1041 const std::string& input_image_location, 1042 const std::string& output_image_filename, 1043 off_t base_delta, 1044 bool base_delta_set, 1045 bool debug) { 1046 CHECK(!input_image_location.empty()); 1047 if (output_image_filename.empty()) { 1048 Usage("Image patching requires --output-image-file"); 1049 } 1050 1051 if (!base_delta_set) { 1052 Usage("Must supply a desired new offset or delta."); 1053 } 1054 1055 if (!IsAligned<kPageSize>(base_delta)) { 1056 Usage("Base offset/delta must be aligned to a pagesize (0x%08x) boundary.", kPageSize); 1057 } 1058 1059 if (debug) { 1060 LOG(INFO) << "moving offset by " << base_delta 1061 << " (0x" << std::hex << base_delta << ") bytes or " 1062 << std::dec << (base_delta/kPageSize) << " pages."; 1063 } 1064 1065 TimingLogger::ScopedTiming pt("patch image and oat", &timings); 1066 1067 std::string output_directory = 1068 output_image_filename.substr(0, output_image_filename.find_last_of('/')); 1069 bool ret = PatchOat::Patch(input_image_location, base_delta, output_directory, isa, &timings); 1070 1071 if (kIsDebugBuild) { 1072 LOG(INFO) << "Exiting with return ... " << ret; 1073 } 1074 return ret ? EXIT_SUCCESS : EXIT_FAILURE; 1075} 1076 1077static int patchoat_oat(TimingLogger& timings, 1078 InstructionSet isa, 1079 const std::string& patched_image_location, 1080 off_t base_delta, 1081 bool base_delta_set, 1082 int input_oat_fd, 1083 int input_vdex_fd, 1084 const std::string& input_oat_location, 1085 std::string input_oat_filename, 1086 bool have_input_oat, 1087 int output_oat_fd, 1088 int output_vdex_fd, 1089 std::string output_oat_filename, 1090 bool have_output_oat, 1091 bool lock_output, 1092 bool debug) { 1093 { 1094 // Only 1 of these may be set. 1095 uint32_t cnt = 0; 1096 cnt += (base_delta_set) ? 1 : 0; 1097 cnt += (!patched_image_location.empty()) ? 1 : 0; 1098 if (cnt > 1) { 1099 Usage("Only one of --base-offset-delta or --patched-image-location may be used."); 1100 } else if (cnt == 0) { 1101 Usage("Must specify --base-offset-delta or --patched-image-location."); 1102 } 1103 } 1104 1105 if (!have_input_oat || !have_output_oat) { 1106 Usage("Both input and output oat must be supplied to patch an app odex."); 1107 } 1108 1109 if (!input_oat_location.empty()) { 1110 if (!LocationToFilename(input_oat_location, isa, &input_oat_filename)) { 1111 Usage("Unable to find filename for input oat location %s", input_oat_location.c_str()); 1112 } 1113 if (debug) { 1114 LOG(INFO) << "Using input-oat-file " << input_oat_filename; 1115 } 1116 } 1117 1118 if ((input_oat_fd == -1) != (input_vdex_fd == -1)) { 1119 Usage("Either both input oat and vdex have to be passed as file descriptors or none of them"); 1120 } else if ((output_oat_fd == -1) != (output_vdex_fd == -1)) { 1121 Usage("Either both output oat and vdex have to be passed as file descriptors or none of them"); 1122 } 1123 1124 bool match_delta = false; 1125 if (!patched_image_location.empty()) { 1126 std::string system_filename; 1127 bool has_system = false; 1128 std::string cache_filename; 1129 bool has_cache = false; 1130 bool has_android_data_unused = false; 1131 bool is_global_cache = false; 1132 if (!gc::space::ImageSpace::FindImageFilename(patched_image_location.c_str(), isa, 1133 &system_filename, &has_system, &cache_filename, 1134 &has_android_data_unused, &has_cache, 1135 &is_global_cache)) { 1136 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 1137 } 1138 std::string patched_image_filename; 1139 if (has_cache) { 1140 patched_image_filename = cache_filename; 1141 } else if (has_system) { 1142 LOG(WARNING) << "Only image file found was in /system for image location " 1143 << patched_image_location; 1144 patched_image_filename = system_filename; 1145 } else { 1146 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 1147 } 1148 if (debug) { 1149 LOG(INFO) << "Using patched-image-file " << patched_image_filename; 1150 } 1151 1152 base_delta_set = true; 1153 match_delta = true; 1154 std::string error_msg; 1155 if (!ReadBaseDelta(patched_image_filename.c_str(), &base_delta, &error_msg)) { 1156 Usage(error_msg.c_str(), patched_image_filename.c_str()); 1157 } 1158 } 1159 1160 if (!IsAligned<kPageSize>(base_delta)) { 1161 Usage("Base offset/delta must be alligned to a pagesize (0x%08x) boundary.", kPageSize); 1162 } 1163 1164 // We can symlink VDEX only if we have both input and output specified as filenames. 1165 // Store that piece of information before we possibly create bogus filenames for 1166 // files passed as file descriptors. 1167 bool symlink_vdex = !input_oat_filename.empty() && !output_oat_filename.empty(); 1168 1169 // Infer names of VDEX files. 1170 std::string input_vdex_filename; 1171 std::string output_vdex_filename; 1172 if (!input_oat_filename.empty()) { 1173 input_vdex_filename = ReplaceFileExtension(input_oat_filename, "vdex"); 1174 } 1175 if (!output_oat_filename.empty()) { 1176 output_vdex_filename = ReplaceFileExtension(output_oat_filename, "vdex"); 1177 } 1178 1179 // Do we need to cleanup output files if we fail? 1180 bool new_oat_out = false; 1181 bool new_vdex_out = false; 1182 1183 std::unique_ptr<File> input_oat; 1184 std::unique_ptr<File> output_oat; 1185 1186 if (input_oat_fd != -1) { 1187 if (input_oat_filename.empty()) { 1188 input_oat_filename = "input-oat-file"; 1189 } 1190 input_oat.reset(new File(input_oat_fd, input_oat_filename, false)); 1191 if (input_oat_fd == output_oat_fd) { 1192 input_oat.get()->DisableAutoClose(); 1193 } 1194 if (input_oat == nullptr) { 1195 // Unlikely, but ensure exhaustive logging in non-0 exit code case 1196 LOG(ERROR) << "Failed to open input oat file by its FD" << input_oat_fd; 1197 return EXIT_FAILURE; 1198 } 1199 } else { 1200 CHECK(!input_oat_filename.empty()); 1201 input_oat.reset(OS::OpenFileForReading(input_oat_filename.c_str())); 1202 if (input_oat == nullptr) { 1203 int err = errno; 1204 LOG(ERROR) << "Failed to open input oat file " << input_oat_filename 1205 << ": " << strerror(err) << "(" << err << ")"; 1206 return EXIT_FAILURE; 1207 } 1208 } 1209 1210 std::string error_msg; 1211 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat.get(), PROT_READ, MAP_PRIVATE, &error_msg)); 1212 if (elf.get() == nullptr) { 1213 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg; 1214 return EXIT_FAILURE; 1215 } 1216 if (!elf->HasSection(".text.oat_patches")) { 1217 LOG(ERROR) << "missing oat patch section in input oat file " << input_oat->GetPath(); 1218 return EXIT_FAILURE; 1219 } 1220 1221 if (output_oat_fd != -1) { 1222 if (output_oat_filename.empty()) { 1223 output_oat_filename = "output-oat-file"; 1224 } 1225 output_oat.reset(new File(output_oat_fd, output_oat_filename, true)); 1226 if (output_oat == nullptr) { 1227 // Unlikely, but ensure exhaustive logging in non-0 exit code case 1228 LOG(ERROR) << "Failed to open output oat file by its FD" << output_oat_fd; 1229 } 1230 } else { 1231 CHECK(!output_oat_filename.empty()); 1232 output_oat.reset(CreateOrOpen(output_oat_filename.c_str(), &new_oat_out)); 1233 if (output_oat == nullptr) { 1234 int err = errno; 1235 LOG(ERROR) << "Failed to open output oat file " << output_oat_filename 1236 << ": " << strerror(err) << "(" << err << ")"; 1237 } 1238 } 1239 1240 // Open VDEX files if we are not symlinking them. 1241 std::unique_ptr<File> input_vdex; 1242 std::unique_ptr<File> output_vdex; 1243 if (symlink_vdex) { 1244 new_vdex_out = !OS::FileExists(output_vdex_filename.c_str()); 1245 } else { 1246 if (input_vdex_fd != -1) { 1247 input_vdex.reset(new File(input_vdex_fd, input_vdex_filename, true)); 1248 if (input_vdex == nullptr) { 1249 // Unlikely, but ensure exhaustive logging in non-0 exit code case 1250 LOG(ERROR) << "Failed to open input vdex file by its FD" << input_vdex_fd; 1251 } 1252 } else { 1253 input_vdex.reset(OS::OpenFileForReading(input_vdex_filename.c_str())); 1254 if (input_vdex == nullptr) { 1255 PLOG(ERROR) << "Failed to open input vdex file " << input_vdex_filename; 1256 return EXIT_FAILURE; 1257 } 1258 } 1259 if (output_vdex_fd != -1) { 1260 output_vdex.reset(new File(output_vdex_fd, output_vdex_filename, true)); 1261 if (output_vdex == nullptr) { 1262 // Unlikely, but ensure exhaustive logging in non-0 exit code case 1263 LOG(ERROR) << "Failed to open output vdex file by its FD" << output_vdex_fd; 1264 } 1265 } else { 1266 output_vdex.reset(CreateOrOpen(output_vdex_filename.c_str(), &new_vdex_out)); 1267 if (output_vdex == nullptr) { 1268 PLOG(ERROR) << "Failed to open output vdex file " << output_vdex_filename; 1269 return EXIT_FAILURE; 1270 } 1271 } 1272 } 1273 1274 // TODO: get rid of this. 1275 auto cleanup = [&output_oat_filename, &output_vdex_filename, &new_oat_out, &new_vdex_out] 1276 (bool success) { 1277 if (!success) { 1278 if (new_oat_out) { 1279 CHECK(!output_oat_filename.empty()); 1280 unlink(output_oat_filename.c_str()); 1281 } 1282 if (new_vdex_out) { 1283 CHECK(!output_vdex_filename.empty()); 1284 unlink(output_vdex_filename.c_str()); 1285 } 1286 } 1287 1288 if (kIsDebugBuild) { 1289 LOG(INFO) << "Cleaning up.. success? " << success; 1290 } 1291 }; 1292 1293 if (output_oat.get() == nullptr) { 1294 cleanup(false); 1295 return EXIT_FAILURE; 1296 } 1297 1298 if (match_delta) { 1299 // Figure out what the current delta is so we can match it to the desired delta. 1300 off_t current_delta = 0; 1301 if (!ReadOatPatchDelta(elf.get(), ¤t_delta, &error_msg)) { 1302 LOG(ERROR) << "Unable to get current delta: " << error_msg; 1303 cleanup(false); 1304 return EXIT_FAILURE; 1305 } 1306 // Before this line base_delta is the desired final delta. We need it to be the actual amount to 1307 // change everything by. We subtract the current delta from it to make it this. 1308 base_delta -= current_delta; 1309 if (!IsAligned<kPageSize>(base_delta)) { 1310 LOG(ERROR) << "Given image file was relocated by an illegal delta"; 1311 cleanup(false); 1312 return false; 1313 } 1314 } 1315 1316 if (debug) { 1317 LOG(INFO) << "moving offset by " << base_delta 1318 << " (0x" << std::hex << base_delta << ") bytes or " 1319 << std::dec << (base_delta/kPageSize) << " pages."; 1320 } 1321 1322 ScopedFlock output_oat_lock; 1323 if (lock_output) { 1324 if (!output_oat_lock.Init(output_oat.get(), &error_msg)) { 1325 LOG(ERROR) << "Unable to lock output oat " << output_oat->GetPath() << ": " << error_msg; 1326 cleanup(false); 1327 return EXIT_FAILURE; 1328 } 1329 } 1330 1331 TimingLogger::ScopedTiming pt("patch oat", &timings); 1332 bool ret = PatchOat::Patch(input_oat.get(), base_delta, output_oat.get(), &timings, 1333 output_oat_fd >= 0, // was it opened from FD? 1334 new_oat_out); 1335 ret = FinishFile(output_oat.get(), ret); 1336 1337 if (ret) { 1338 if (symlink_vdex) { 1339 ret = SymlinkFile(input_vdex_filename, output_vdex_filename); 1340 } else { 1341 ret = unix_file::CopyFile(*input_vdex.get(), output_vdex.get()); 1342 } 1343 } 1344 1345 if (kIsDebugBuild) { 1346 LOG(INFO) << "Exiting with return ... " << ret; 1347 } 1348 cleanup(ret); 1349 return ret ? EXIT_SUCCESS : EXIT_FAILURE; 1350} 1351 1352static int ParseFd(const StringPiece& option, const char* cmdline_arg) { 1353 int fd; 1354 const char* fd_str = option.substr(strlen(cmdline_arg)).data(); 1355 if (!ParseInt(fd_str, &fd)) { 1356 Usage("Failed to parse %d argument '%s' as an integer", cmdline_arg, fd_str); 1357 } 1358 if (fd < 0) { 1359 Usage("%s pass a negative value %d", cmdline_arg, fd); 1360 } 1361 return fd; 1362} 1363 1364static int patchoat(int argc, char **argv) { 1365 InitLogging(argv, Runtime::Aborter); 1366 MemMap::Init(); 1367 const bool debug = kIsDebugBuild; 1368 orig_argc = argc; 1369 orig_argv = argv; 1370 TimingLogger timings("patcher", false, false); 1371 1372 // Skip over the command name. 1373 argv++; 1374 argc--; 1375 1376 if (argc == 0) { 1377 Usage("No arguments specified"); 1378 } 1379 1380 timings.StartTiming("Patchoat"); 1381 1382 // cmd line args 1383 bool isa_set = false; 1384 InstructionSet isa = kNone; 1385 std::string input_oat_filename; 1386 std::string input_oat_location; 1387 int input_oat_fd = -1; 1388 int input_vdex_fd = -1; 1389 bool have_input_oat = false; 1390 std::string input_image_location; 1391 std::string output_oat_filename; 1392 int output_oat_fd = -1; 1393 int output_vdex_fd = -1; 1394 bool have_output_oat = false; 1395 std::string output_image_filename; 1396 off_t base_delta = 0; 1397 bool base_delta_set = false; 1398 std::string patched_image_filename; 1399 std::string patched_image_location; 1400 bool dump_timings = kIsDebugBuild; 1401 bool lock_output = true; 1402 1403 for (int i = 0; i < argc; ++i) { 1404 const StringPiece option(argv[i]); 1405 const bool log_options = false; 1406 if (log_options) { 1407 LOG(INFO) << "patchoat: option[" << i << "]=" << argv[i]; 1408 } 1409 if (option.starts_with("--instruction-set=")) { 1410 isa_set = true; 1411 const char* isa_str = option.substr(strlen("--instruction-set=")).data(); 1412 isa = GetInstructionSetFromString(isa_str); 1413 if (isa == kNone) { 1414 Usage("Unknown or invalid instruction set %s", isa_str); 1415 } 1416 } else if (option.starts_with("--input-oat-location=")) { 1417 if (have_input_oat) { 1418 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 1419 } 1420 have_input_oat = true; 1421 input_oat_location = option.substr(strlen("--input-oat-location=")).data(); 1422 } else if (option.starts_with("--input-oat-file=")) { 1423 if (have_input_oat) { 1424 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 1425 } 1426 have_input_oat = true; 1427 input_oat_filename = option.substr(strlen("--input-oat-file=")).data(); 1428 } else if (option.starts_with("--input-oat-fd=")) { 1429 if (have_input_oat) { 1430 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 1431 } 1432 have_input_oat = true; 1433 input_oat_fd = ParseFd(option, "--input-oat-fd="); 1434 } else if (option.starts_with("--input-vdex-fd=")) { 1435 input_vdex_fd = ParseFd(option, "--input-vdex-fd="); 1436 } else if (option.starts_with("--input-image-location=")) { 1437 input_image_location = option.substr(strlen("--input-image-location=")).data(); 1438 } else if (option.starts_with("--output-oat-file=")) { 1439 if (have_output_oat) { 1440 Usage("Only one of --output-oat-file, and --output-oat-fd may be used."); 1441 } 1442 have_output_oat = true; 1443 output_oat_filename = option.substr(strlen("--output-oat-file=")).data(); 1444 } else if (option.starts_with("--output-oat-fd=")) { 1445 if (have_output_oat) { 1446 Usage("Only one of --output-oat-file, --output-oat-fd may be used."); 1447 } 1448 have_output_oat = true; 1449 output_oat_fd = ParseFd(option, "--output-oat-fd="); 1450 } else if (option.starts_with("--output-vdex-fd=")) { 1451 output_vdex_fd = ParseFd(option, "--output-vdex-fd="); 1452 } else if (option.starts_with("--output-image-file=")) { 1453 output_image_filename = option.substr(strlen("--output-image-file=")).data(); 1454 } else if (option.starts_with("--base-offset-delta=")) { 1455 const char* base_delta_str = option.substr(strlen("--base-offset-delta=")).data(); 1456 base_delta_set = true; 1457 if (!ParseInt(base_delta_str, &base_delta)) { 1458 Usage("Failed to parse --base-offset-delta argument '%s' as an off_t", base_delta_str); 1459 } 1460 } else if (option.starts_with("--patched-image-location=")) { 1461 patched_image_location = option.substr(strlen("--patched-image-location=")).data(); 1462 } else if (option == "--lock-output") { 1463 lock_output = true; 1464 } else if (option == "--no-lock-output") { 1465 lock_output = false; 1466 } else if (option == "--dump-timings") { 1467 dump_timings = true; 1468 } else if (option == "--no-dump-timings") { 1469 dump_timings = false; 1470 } else { 1471 Usage("Unknown argument %s", option.data()); 1472 } 1473 } 1474 1475 // The instruction set is mandatory. This simplifies things... 1476 if (!isa_set) { 1477 Usage("Instruction set must be set."); 1478 } 1479 1480 int ret; 1481 if (!input_image_location.empty()) { 1482 ret = patchoat_image(timings, 1483 isa, 1484 input_image_location, 1485 output_image_filename, 1486 base_delta, 1487 base_delta_set, 1488 debug); 1489 } else { 1490 ret = patchoat_oat(timings, 1491 isa, 1492 patched_image_location, 1493 base_delta, 1494 base_delta_set, 1495 input_oat_fd, 1496 input_vdex_fd, 1497 input_oat_location, 1498 input_oat_filename, 1499 have_input_oat, 1500 output_oat_fd, 1501 output_vdex_fd, 1502 output_oat_filename, 1503 have_output_oat, 1504 lock_output, 1505 debug); 1506 } 1507 1508 timings.EndTiming(); 1509 if (dump_timings) { 1510 LOG(INFO) << Dumpable<TimingLogger>(timings); 1511 } 1512 1513 return ret; 1514} 1515 1516} // namespace art 1517 1518int main(int argc, char **argv) { 1519 return art::patchoat(argc, argv); 1520} 1521