patchoat.cc revision 4b0d2d99b596eebd6da45679896d3af54bc5a935
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 "base/scoped_flock.h" 28#include "base/stringpiece.h" 29#include "base/stringprintf.h" 30#include "elf_utils.h" 31#include "elf_file.h" 32#include "gc/space/image_space.h" 33#include "image.h" 34#include "instruction_set.h" 35#include "mirror/art_field.h" 36#include "mirror/art_field-inl.h" 37#include "mirror/art_method.h" 38#include "mirror/art_method-inl.h" 39#include "mirror/object.h" 40#include "mirror/object-inl.h" 41#include "mirror/reference.h" 42#include "noop_compiler_callbacks.h" 43#include "offsets.h" 44#include "os.h" 45#include "runtime.h" 46#include "scoped_thread_state_change.h" 47#include "thread.h" 48#include "utils.h" 49 50namespace art { 51 52static InstructionSet ElfISAToInstructionSet(Elf32_Word isa) { 53 switch (isa) { 54 case EM_ARM: 55 return kArm; 56 case EM_AARCH64: 57 return kArm64; 58 case EM_386: 59 return kX86; 60 case EM_X86_64: 61 return kX86_64; 62 case EM_MIPS: 63 return kMips; 64 default: 65 return kNone; 66 } 67} 68 69static bool LocationToFilename(const std::string& location, InstructionSet isa, 70 std::string* filename) { 71 bool has_system = false; 72 bool has_cache = false; 73 // image_location = /system/framework/boot.art 74 // system_image_location = /system/framework/<image_isa>/boot.art 75 std::string system_filename(GetSystemImageFilename(location.c_str(), isa)); 76 if (OS::FileExists(system_filename.c_str())) { 77 has_system = true; 78 } 79 80 bool have_android_data = false; 81 bool dalvik_cache_exists = false; 82 std::string dalvik_cache; 83 GetDalvikCache(GetInstructionSetString(isa), false, &dalvik_cache, 84 &have_android_data, &dalvik_cache_exists); 85 86 std::string cache_filename; 87 if (have_android_data && dalvik_cache_exists) { 88 // Always set output location even if it does not exist, 89 // so that the caller knows where to create the image. 90 // 91 // image_location = /system/framework/boot.art 92 // *image_filename = /data/dalvik-cache/<image_isa>/boot.art 93 std::string error_msg; 94 if (GetDalvikCacheFilename(location.c_str(), dalvik_cache.c_str(), 95 &cache_filename, &error_msg)) { 96 has_cache = true; 97 } 98 } 99 if (has_system) { 100 *filename = system_filename; 101 return true; 102 } else if (has_cache) { 103 *filename = cache_filename; 104 return true; 105 } else { 106 return false; 107 } 108} 109 110bool PatchOat::Patch(const std::string& image_location, off_t delta, 111 File* output_image, InstructionSet isa, 112 TimingLogger* timings) { 113 CHECK(Runtime::Current() == nullptr); 114 CHECK(output_image != nullptr); 115 CHECK_GE(output_image->Fd(), 0); 116 CHECK(!image_location.empty()) << "image file must have a filename."; 117 CHECK_NE(isa, kNone); 118 119 TimingLogger::ScopedTiming t("Runtime Setup", timings); 120 const char *isa_name = GetInstructionSetString(isa); 121 std::string image_filename; 122 if (!LocationToFilename(image_location, isa, &image_filename)) { 123 LOG(ERROR) << "Unable to find image at location " << image_location; 124 return false; 125 } 126 std::unique_ptr<File> input_image(OS::OpenFileForReading(image_filename.c_str())); 127 if (input_image.get() == nullptr) { 128 LOG(ERROR) << "unable to open input image file at " << image_filename 129 << " for location " << image_location; 130 return false; 131 } 132 int64_t image_len = input_image->GetLength(); 133 if (image_len < 0) { 134 LOG(ERROR) << "Error while getting image length"; 135 return false; 136 } 137 ImageHeader image_header; 138 if (sizeof(image_header) != input_image->Read(reinterpret_cast<char*>(&image_header), 139 sizeof(image_header), 0)) { 140 LOG(ERROR) << "Unable to read image header from image file " << input_image->GetPath(); 141 return false; 142 } 143 144 // Set up the runtime 145 RuntimeOptions options; 146 NoopCompilerCallbacks callbacks; 147 options.push_back(std::make_pair("compilercallbacks", &callbacks)); 148 std::string img = "-Ximage:" + image_location; 149 options.push_back(std::make_pair(img.c_str(), nullptr)); 150 options.push_back(std::make_pair("imageinstructionset", reinterpret_cast<const void*>(isa_name))); 151 if (!Runtime::Create(options, false)) { 152 LOG(ERROR) << "Unable to initialize runtime"; 153 return false; 154 } 155 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 156 // give it away now and then switch to a more manageable ScopedObjectAccess. 157 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 158 ScopedObjectAccess soa(Thread::Current()); 159 160 t.NewTiming("Image and oat Patching setup"); 161 // Create the map where we will write the image patches to. 162 std::string error_msg; 163 std::unique_ptr<MemMap> image(MemMap::MapFile(image_len, PROT_READ | PROT_WRITE, MAP_PRIVATE, 164 input_image->Fd(), 0, 165 input_image->GetPath().c_str(), 166 &error_msg)); 167 if (image.get() == nullptr) { 168 LOG(ERROR) << "unable to map image file " << input_image->GetPath() << " : " << error_msg; 169 return false; 170 } 171 gc::space::ImageSpace* ispc = Runtime::Current()->GetHeap()->GetImageSpace(); 172 173 PatchOat p(image.release(), ispc->GetLiveBitmap(), ispc->GetMemMap(), 174 delta, timings); 175 t.NewTiming("Patching files"); 176 if (!p.PatchImage()) { 177 LOG(ERROR) << "Failed to patch image file " << input_image->GetPath(); 178 return false; 179 } 180 181 t.NewTiming("Writing files"); 182 if (!p.WriteImage(output_image)) { 183 return false; 184 } 185 return true; 186} 187 188bool PatchOat::Patch(const File* input_oat, const std::string& image_location, off_t delta, 189 File* output_oat, File* output_image, InstructionSet isa, 190 TimingLogger* timings) { 191 CHECK(Runtime::Current() == nullptr); 192 CHECK(output_image != nullptr); 193 CHECK_GE(output_image->Fd(), 0); 194 CHECK(input_oat != nullptr); 195 CHECK(output_oat != nullptr); 196 CHECK_GE(input_oat->Fd(), 0); 197 CHECK_GE(output_oat->Fd(), 0); 198 CHECK(!image_location.empty()) << "image file must have a filename."; 199 200 TimingLogger::ScopedTiming t("Runtime Setup", timings); 201 202 if (isa == kNone) { 203 Elf32_Ehdr elf_hdr; 204 if (sizeof(elf_hdr) != input_oat->Read(reinterpret_cast<char*>(&elf_hdr), sizeof(elf_hdr), 0)) { 205 LOG(ERROR) << "unable to read elf header"; 206 return false; 207 } 208 isa = ElfISAToInstructionSet(elf_hdr.e_machine); 209 } 210 const char* isa_name = GetInstructionSetString(isa); 211 std::string image_filename; 212 if (!LocationToFilename(image_location, isa, &image_filename)) { 213 LOG(ERROR) << "Unable to find image at location " << image_location; 214 return false; 215 } 216 std::unique_ptr<File> input_image(OS::OpenFileForReading(image_filename.c_str())); 217 if (input_image.get() == nullptr) { 218 LOG(ERROR) << "unable to open input image file at " << image_filename 219 << " for location " << image_location; 220 return false; 221 } 222 int64_t image_len = input_image->GetLength(); 223 if (image_len < 0) { 224 LOG(ERROR) << "Error while getting image length"; 225 return false; 226 } 227 ImageHeader image_header; 228 if (sizeof(image_header) != input_image->Read(reinterpret_cast<char*>(&image_header), 229 sizeof(image_header), 0)) { 230 LOG(ERROR) << "Unable to read image header from image file " << input_image->GetPath(); 231 } 232 233 // Set up the runtime 234 RuntimeOptions options; 235 NoopCompilerCallbacks callbacks; 236 options.push_back(std::make_pair("compilercallbacks", &callbacks)); 237 std::string img = "-Ximage:" + image_location; 238 options.push_back(std::make_pair(img.c_str(), nullptr)); 239 options.push_back(std::make_pair("imageinstructionset", reinterpret_cast<const void*>(isa_name))); 240 if (!Runtime::Create(options, false)) { 241 LOG(ERROR) << "Unable to initialize runtime"; 242 return false; 243 } 244 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start, 245 // give it away now and then switch to a more manageable ScopedObjectAccess. 246 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 247 ScopedObjectAccess soa(Thread::Current()); 248 249 t.NewTiming("Image and oat Patching setup"); 250 // Create the map where we will write the image patches to. 251 std::string error_msg; 252 std::unique_ptr<MemMap> image(MemMap::MapFile(image_len, PROT_READ | PROT_WRITE, MAP_PRIVATE, 253 input_image->Fd(), 0, 254 input_image->GetPath().c_str(), 255 &error_msg)); 256 if (image.get() == nullptr) { 257 LOG(ERROR) << "unable to map image file " << input_image->GetPath() << " : " << error_msg; 258 return false; 259 } 260 gc::space::ImageSpace* ispc = Runtime::Current()->GetHeap()->GetImageSpace(); 261 262 std::unique_ptr<ElfFile> elf(ElfFile::Open(const_cast<File*>(input_oat), 263 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg)); 264 if (elf.get() == nullptr) { 265 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg; 266 return false; 267 } 268 269 PatchOat p(elf.release(), image.release(), ispc->GetLiveBitmap(), ispc->GetMemMap(), 270 delta, timings); 271 t.NewTiming("Patching files"); 272 if (!p.PatchElf()) { 273 LOG(ERROR) << "Failed to patch oat file " << input_oat->GetPath(); 274 return false; 275 } 276 if (!p.PatchImage()) { 277 LOG(ERROR) << "Failed to patch image file " << input_image->GetPath(); 278 return false; 279 } 280 281 t.NewTiming("Writing files"); 282 if (!p.WriteElf(output_oat)) { 283 return false; 284 } 285 if (!p.WriteImage(output_image)) { 286 return false; 287 } 288 return true; 289} 290 291bool PatchOat::WriteElf(File* out) { 292 TimingLogger::ScopedTiming t("Writing Elf File", timings_); 293 294 CHECK(oat_file_.get() != nullptr); 295 CHECK(out != nullptr); 296 size_t expect = oat_file_->Size(); 297 if (out->WriteFully(reinterpret_cast<char*>(oat_file_->Begin()), expect) && 298 out->SetLength(expect) == 0) { 299 return true; 300 } else { 301 LOG(ERROR) << "Writing to oat file " << out->GetPath() << " failed."; 302 return false; 303 } 304} 305 306bool PatchOat::WriteImage(File* out) { 307 TimingLogger::ScopedTiming t("Writing image File", timings_); 308 std::string error_msg; 309 310 ScopedFlock img_flock; 311 img_flock.Init(out, &error_msg); 312 313 CHECK(image_ != nullptr); 314 CHECK(out != nullptr); 315 size_t expect = image_->Size(); 316 if (out->WriteFully(reinterpret_cast<char*>(image_->Begin()), expect) && 317 out->SetLength(expect) == 0) { 318 return true; 319 } else { 320 LOG(ERROR) << "Writing to image file " << out->GetPath() << " failed."; 321 return false; 322 } 323} 324 325bool PatchOat::PatchImage() { 326 ImageHeader* image_header = reinterpret_cast<ImageHeader*>(image_->Begin()); 327 CHECK_GT(image_->Size(), sizeof(ImageHeader)); 328 // These are the roots from the original file. 329 mirror::Object* img_roots = image_header->GetImageRoots(); 330 image_header->RelocateImage(delta_); 331 332 VisitObject(img_roots); 333 if (!image_header->IsValid()) { 334 LOG(ERROR) << "reloction renders image header invalid"; 335 return false; 336 } 337 338 { 339 TimingLogger::ScopedTiming t("Walk Bitmap", timings_); 340 // Walk the bitmap. 341 WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_); 342 bitmap_->Walk(PatchOat::BitmapCallback, this); 343 } 344 return true; 345} 346 347bool PatchOat::InHeap(mirror::Object* o) { 348 uintptr_t begin = reinterpret_cast<uintptr_t>(heap_->Begin()); 349 uintptr_t end = reinterpret_cast<uintptr_t>(heap_->End()); 350 uintptr_t obj = reinterpret_cast<uintptr_t>(o); 351 return o == nullptr || (begin <= obj && obj < end); 352} 353 354void PatchOat::PatchVisitor::operator() (mirror::Object* obj, MemberOffset off, 355 bool is_static_unused) const { 356 mirror::Object* referent = obj->GetFieldObject<mirror::Object, kVerifyNone>(off); 357 DCHECK(patcher_->InHeap(referent)) << "Referent is not in the heap."; 358 mirror::Object* moved_object = patcher_->RelocatedAddressOf(referent); 359 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 360} 361 362void PatchOat::PatchVisitor::operator() (mirror::Class* cls, mirror::Reference* ref) const { 363 MemberOffset off = mirror::Reference::ReferentOffset(); 364 mirror::Object* referent = ref->GetReferent(); 365 DCHECK(patcher_->InHeap(referent)) << "Referent is not in the heap."; 366 mirror::Object* moved_object = patcher_->RelocatedAddressOf(referent); 367 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object); 368} 369 370mirror::Object* PatchOat::RelocatedCopyOf(mirror::Object* obj) { 371 if (obj == nullptr) { 372 return nullptr; 373 } 374 DCHECK_GT(reinterpret_cast<uintptr_t>(obj), reinterpret_cast<uintptr_t>(heap_->Begin())); 375 DCHECK_LT(reinterpret_cast<uintptr_t>(obj), reinterpret_cast<uintptr_t>(heap_->End())); 376 uintptr_t heap_off = 377 reinterpret_cast<uintptr_t>(obj) - reinterpret_cast<uintptr_t>(heap_->Begin()); 378 DCHECK_LT(heap_off, image_->Size()); 379 return reinterpret_cast<mirror::Object*>(image_->Begin() + heap_off); 380} 381 382mirror::Object* PatchOat::RelocatedAddressOf(mirror::Object* obj) { 383 if (obj == nullptr) { 384 return nullptr; 385 } else { 386 return reinterpret_cast<mirror::Object*>(reinterpret_cast<byte*>(obj) + delta_); 387 } 388} 389 390// Called by BitmapCallback 391void PatchOat::VisitObject(mirror::Object* object) { 392 mirror::Object* copy = RelocatedCopyOf(object); 393 CHECK(copy != nullptr); 394 if (kUseBakerOrBrooksReadBarrier) { 395 object->AssertReadBarrierPointer(); 396 if (kUseBrooksReadBarrier) { 397 mirror::Object* moved_to = RelocatedAddressOf(object); 398 copy->SetReadBarrierPointer(moved_to); 399 DCHECK_EQ(copy->GetReadBarrierPointer(), moved_to); 400 } 401 } 402 PatchOat::PatchVisitor visitor(this, copy); 403 object->VisitReferences<true, kVerifyNone>(visitor, visitor); 404 if (object->IsArtMethod<kVerifyNone>()) { 405 FixupMethod(static_cast<mirror::ArtMethod*>(object), 406 static_cast<mirror::ArtMethod*>(copy)); 407 } 408} 409 410void PatchOat::FixupMethod(mirror::ArtMethod* object, mirror::ArtMethod* copy) { 411 // Just update the entry points if it looks like we should. 412 // TODO: sanity check all the pointers' values 413 uintptr_t portable = reinterpret_cast<uintptr_t>( 414 object->GetEntryPointFromPortableCompiledCode<kVerifyNone>()); 415 if (portable != 0) { 416 copy->SetEntryPointFromPortableCompiledCode(reinterpret_cast<void*>(portable + delta_)); 417 } 418 uintptr_t quick= reinterpret_cast<uintptr_t>( 419 object->GetEntryPointFromQuickCompiledCode<kVerifyNone>()); 420 if (quick != 0) { 421 copy->SetEntryPointFromQuickCompiledCode(reinterpret_cast<void*>(quick + delta_)); 422 } 423 uintptr_t interpreter = reinterpret_cast<uintptr_t>( 424 object->GetEntryPointFromInterpreter<kVerifyNone>()); 425 if (interpreter != 0) { 426 copy->SetEntryPointFromInterpreter( 427 reinterpret_cast<mirror::EntryPointFromInterpreter*>(interpreter + delta_)); 428 } 429 430 uintptr_t native_method = reinterpret_cast<uintptr_t>(object->GetNativeMethod()); 431 if (native_method != 0) { 432 copy->SetNativeMethod(reinterpret_cast<void*>(native_method + delta_)); 433 } 434 435 uintptr_t native_gc_map = reinterpret_cast<uintptr_t>(object->GetNativeGcMap()); 436 if (native_gc_map != 0) { 437 copy->SetNativeGcMap(reinterpret_cast<uint8_t*>(native_gc_map + delta_)); 438 } 439} 440 441bool PatchOat::Patch(File* input_oat, off_t delta, File* output_oat, TimingLogger* timings) { 442 CHECK(input_oat != nullptr); 443 CHECK(output_oat != nullptr); 444 CHECK_GE(input_oat->Fd(), 0); 445 CHECK_GE(output_oat->Fd(), 0); 446 TimingLogger::ScopedTiming t("Setup Oat File Patching", timings); 447 448 std::string error_msg; 449 std::unique_ptr<ElfFile> elf(ElfFile::Open(const_cast<File*>(input_oat), 450 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg)); 451 if (elf.get() == nullptr) { 452 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg; 453 return false; 454 } 455 456 PatchOat p(elf.release(), delta, timings); 457 t.NewTiming("Patch Oat file"); 458 if (!p.PatchElf()) { 459 return false; 460 } 461 462 t.NewTiming("Writing oat file"); 463 if (!p.WriteElf(output_oat)) { 464 return false; 465 } 466 return true; 467} 468 469template <typename ptr_t> 470bool PatchOat::CheckOatFile(const Elf32_Shdr& patches_sec) { 471 if (patches_sec.sh_type != SHT_OAT_PATCH) { 472 return false; 473 } 474 ptr_t* patches = reinterpret_cast<ptr_t*>(oat_file_->Begin() + patches_sec.sh_offset); 475 ptr_t* patches_end = patches + (patches_sec.sh_size / sizeof(ptr_t)); 476 Elf32_Shdr* oat_data_sec = oat_file_->FindSectionByName(".rodata"); 477 Elf32_Shdr* oat_text_sec = oat_file_->FindSectionByName(".text"); 478 if (oat_data_sec == nullptr) { 479 return false; 480 } 481 if (oat_text_sec == nullptr) { 482 return false; 483 } 484 if (oat_text_sec->sh_offset <= oat_data_sec->sh_offset) { 485 return false; 486 } 487 488 for (; patches < patches_end; patches++) { 489 if (oat_text_sec->sh_size <= *patches) { 490 return false; 491 } 492 } 493 494 return true; 495} 496 497bool PatchOat::PatchOatHeader() { 498 Elf32_Shdr *rodata_sec = oat_file_->FindSectionByName(".rodata"); 499 if (rodata_sec == nullptr) { 500 return false; 501 } 502 OatHeader* oat_header = reinterpret_cast<OatHeader*>(oat_file_->Begin() + rodata_sec->sh_offset); 503 if (!oat_header->IsValid()) { 504 LOG(ERROR) << "Elf file " << oat_file_->GetFile().GetPath() << " has an invalid oat header"; 505 return false; 506 } 507 oat_header->RelocateOat(delta_); 508 return true; 509} 510 511bool PatchOat::PatchElf() { 512 TimingLogger::ScopedTiming t("Fixup Elf Text Section", timings_); 513 if (!PatchTextSection()) { 514 return false; 515 } 516 517 if (!PatchOatHeader()) { 518 return false; 519 } 520 521 bool need_fixup = false; 522 t.NewTiming("Fixup Elf Headers"); 523 // Fixup Phdr's 524 for (unsigned int i = 0; i < oat_file_->GetProgramHeaderNum(); i++) { 525 Elf32_Phdr& hdr = oat_file_->GetProgramHeader(i); 526 if (hdr.p_vaddr != 0 && hdr.p_vaddr != hdr.p_offset) { 527 need_fixup = true; 528 hdr.p_vaddr += delta_; 529 } 530 if (hdr.p_paddr != 0 && hdr.p_paddr != hdr.p_offset) { 531 need_fixup = true; 532 hdr.p_paddr += delta_; 533 } 534 } 535 if (!need_fixup) { 536 // This was never passed through ElfFixup so all headers/symbols just have their offset as 537 // their addr. Therefore we do not need to update these parts. 538 return true; 539 } 540 t.NewTiming("Fixup Section Headers"); 541 for (unsigned int i = 0; i < oat_file_->GetSectionHeaderNum(); i++) { 542 Elf32_Shdr& hdr = oat_file_->GetSectionHeader(i); 543 if (hdr.sh_addr != 0) { 544 hdr.sh_addr += delta_; 545 } 546 } 547 548 t.NewTiming("Fixup Dynamics"); 549 for (Elf32_Word i = 0; i < oat_file_->GetDynamicNum(); i++) { 550 Elf32_Dyn& dyn = oat_file_->GetDynamic(i); 551 if (IsDynamicSectionPointer(dyn.d_tag, oat_file_->GetHeader().e_machine)) { 552 dyn.d_un.d_ptr += delta_; 553 } 554 } 555 556 t.NewTiming("Fixup Elf Symbols"); 557 // Fixup dynsym 558 Elf32_Shdr* dynsym_sec = oat_file_->FindSectionByName(".dynsym"); 559 CHECK(dynsym_sec != nullptr); 560 if (!PatchSymbols(dynsym_sec)) { 561 return false; 562 } 563 564 // Fixup symtab 565 Elf32_Shdr* symtab_sec = oat_file_->FindSectionByName(".symtab"); 566 if (symtab_sec != nullptr) { 567 if (!PatchSymbols(symtab_sec)) { 568 return false; 569 } 570 } 571 572 return true; 573} 574 575bool PatchOat::PatchSymbols(Elf32_Shdr* section) { 576 Elf32_Sym* syms = reinterpret_cast<Elf32_Sym*>(oat_file_->Begin() + section->sh_offset); 577 const Elf32_Sym* last_sym = 578 reinterpret_cast<Elf32_Sym*>(oat_file_->Begin() + section->sh_offset + section->sh_size); 579 CHECK_EQ(section->sh_size % sizeof(Elf32_Sym), 0u) 580 << "Symtab section size is not multiple of symbol size"; 581 for (; syms < last_sym; syms++) { 582 uint8_t sttype = ELF32_ST_TYPE(syms->st_info); 583 Elf32_Word shndx = syms->st_shndx; 584 if (shndx != SHN_ABS && shndx != SHN_COMMON && shndx != SHN_UNDEF && 585 (sttype == STT_FUNC || sttype == STT_OBJECT)) { 586 CHECK_NE(syms->st_value, 0u); 587 syms->st_value += delta_; 588 } 589 } 590 return true; 591} 592 593bool PatchOat::PatchTextSection() { 594 Elf32_Shdr* patches_sec = oat_file_->FindSectionByName(".oat_patches"); 595 if (patches_sec == nullptr) { 596 LOG(ERROR) << ".oat_patches section not found. Aborting patch"; 597 return false; 598 } 599 if (patches_sec->sh_type != SHT_OAT_PATCH) { 600 LOG(ERROR) << "Unexpected type of .oat_patches"; 601 return false; 602 } 603 604 switch (patches_sec->sh_entsize) { 605 case sizeof(uint32_t): 606 return PatchTextSection<uint32_t>(*patches_sec); 607 case sizeof(uint64_t): 608 return PatchTextSection<uint64_t>(*patches_sec); 609 default: 610 LOG(ERROR) << ".oat_patches Entsize of " << patches_sec->sh_entsize << "bits " 611 << "is not valid"; 612 return false; 613 } 614} 615 616template <typename ptr_t> 617bool PatchOat::PatchTextSection(const Elf32_Shdr& patches_sec) { 618 DCHECK(CheckOatFile<ptr_t>(patches_sec)) << "Oat file invalid"; 619 ptr_t* patches = reinterpret_cast<ptr_t*>(oat_file_->Begin() + patches_sec.sh_offset); 620 ptr_t* patches_end = patches + (patches_sec.sh_size / sizeof(ptr_t)); 621 Elf32_Shdr* oat_text_sec = oat_file_->FindSectionByName(".text"); 622 CHECK(oat_text_sec != nullptr); 623 byte* to_patch = oat_file_->Begin() + oat_text_sec->sh_offset; 624 uintptr_t to_patch_end = reinterpret_cast<uintptr_t>(to_patch) + oat_text_sec->sh_size; 625 626 for (; patches < patches_end; patches++) { 627 CHECK_LT(*patches, oat_text_sec->sh_size) << "Bad Patch"; 628 uint32_t* patch_loc = reinterpret_cast<uint32_t*>(to_patch + *patches); 629 CHECK_LT(reinterpret_cast<uintptr_t>(patch_loc), to_patch_end); 630 *patch_loc += delta_; 631 } 632 return true; 633} 634 635static int orig_argc; 636static char** orig_argv; 637 638static std::string CommandLine() { 639 std::vector<std::string> command; 640 for (int i = 0; i < orig_argc; ++i) { 641 command.push_back(orig_argv[i]); 642 } 643 return Join(command, ' '); 644} 645 646static void UsageErrorV(const char* fmt, va_list ap) { 647 std::string error; 648 StringAppendV(&error, fmt, ap); 649 LOG(ERROR) << error; 650} 651 652static void UsageError(const char* fmt, ...) { 653 va_list ap; 654 va_start(ap, fmt); 655 UsageErrorV(fmt, ap); 656 va_end(ap); 657} 658 659static void Usage(const char *fmt, ...) { 660 va_list ap; 661 va_start(ap, fmt); 662 UsageErrorV(fmt, ap); 663 va_end(ap); 664 665 UsageError("Command: %s", CommandLine().c_str()); 666 UsageError("Usage: patchoat [options]..."); 667 UsageError(""); 668 UsageError(" --instruction-set=<isa>: Specifies the instruction set the patched code is"); 669 UsageError(" compiled for. Required if you use --input-oat-location"); 670 UsageError(""); 671 UsageError(" --input-oat-file=<file.oat>: Specifies the exact filename of the oat file to be"); 672 UsageError(" patched."); 673 UsageError(""); 674 UsageError(" --input-oat-fd=<file-descriptor>: Specifies the file-descriptor of the oat file"); 675 UsageError(" to be patched."); 676 UsageError(""); 677 UsageError(" --input-oat-location=<file.oat>: Specifies the 'location' to read the patched"); 678 UsageError(" oat file from. If used one must also supply the --instruction-set"); 679 UsageError(""); 680 UsageError(" --input-image-location=<file.art>: Specifies the 'location' of the image file to"); 681 UsageError(" be patched. If --instruction-set is not given it will use the instruction set"); 682 UsageError(" extracted from the --input-oat-file."); 683 UsageError(""); 684 UsageError(" --output-oat-file=<file.oat>: Specifies the exact file to write the patched oat"); 685 UsageError(" file to."); 686 UsageError(""); 687 UsageError(" --output-oat-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 688 UsageError(" the patched oat file to."); 689 UsageError(""); 690 UsageError(" --output-image-file=<file.art>: Specifies the exact file to write the patched"); 691 UsageError(" image file to."); 692 UsageError(""); 693 UsageError(" --output-image-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 694 UsageError(" the patched image file to."); 695 UsageError(""); 696 UsageError(" --orig-base-offset=<original-base-offset>: Specify the base offset the input file"); 697 UsageError(" was compiled with. This is needed if one is specifying a --base-offset"); 698 UsageError(""); 699 UsageError(" --base-offset=<new-base-offset>: Specify the base offset we will repatch the"); 700 UsageError(" given files to use. This requires that --orig-base-offset is also given."); 701 UsageError(""); 702 UsageError(" --base-offset-delta=<delta>: Specify the amount to change the old base-offset by."); 703 UsageError(" This value may be negative."); 704 UsageError(""); 705 UsageError(" --patched-image-file=<file.art>: Use the same patch delta as was used to patch"); 706 UsageError(" the given image file."); 707 UsageError(""); 708 UsageError(" --patched-image-location=<file.art>: Use the same patch delta as was used to"); 709 UsageError(" patch the given image location. If used one must also specify the"); 710 UsageError(" --instruction-set flag. It will search for this image in the same way that"); 711 UsageError(" is done when loading one."); 712 UsageError(""); 713 UsageError(" --lock-output: Obtain a flock on output oat file before starting."); 714 UsageError(""); 715 UsageError(" --no-lock-output: Do not attempt to obtain a flock on output oat file."); 716 UsageError(""); 717 UsageError(" --dump-timings: dump out patch timing information"); 718 UsageError(""); 719 UsageError(" --no-dump-timings: do not dump out patch timing information"); 720 UsageError(""); 721 722 exit(EXIT_FAILURE); 723} 724 725static bool ReadBaseDelta(const char* name, off_t* delta, std::string* error_msg) { 726 CHECK(name != nullptr); 727 CHECK(delta != nullptr); 728 std::unique_ptr<File> file; 729 if (OS::FileExists(name)) { 730 file.reset(OS::OpenFileForReading(name)); 731 if (file.get() == nullptr) { 732 *error_msg = "Failed to open file %s for reading"; 733 return false; 734 } 735 } else { 736 *error_msg = "File %s does not exist"; 737 return false; 738 } 739 CHECK(file.get() != nullptr); 740 ImageHeader hdr; 741 if (sizeof(hdr) != file->Read(reinterpret_cast<char*>(&hdr), sizeof(hdr), 0)) { 742 *error_msg = "Failed to read file %s"; 743 return false; 744 } 745 if (!hdr.IsValid()) { 746 *error_msg = "%s does not contain a valid image header."; 747 return false; 748 } 749 *delta = hdr.GetPatchDelta(); 750 return true; 751} 752 753static File* CreateOrOpen(const char* name, bool* created) { 754 if (OS::FileExists(name)) { 755 *created = false; 756 return OS::OpenFileReadWrite(name); 757 } else { 758 *created = true; 759 std::unique_ptr<File> f(OS::CreateEmptyFile(name)); 760 if (f.get() != nullptr) { 761 if (fchmod(f->Fd(), 0644) != 0) { 762 PLOG(ERROR) << "Unable to make " << name << " world readable"; 763 unlink(name); 764 return nullptr; 765 } 766 } 767 return f.release(); 768 } 769} 770 771static int patchoat(int argc, char **argv) { 772 InitLogging(argv); 773 const bool debug = kIsDebugBuild; 774 orig_argc = argc; 775 orig_argv = argv; 776 TimingLogger timings("patcher", false, false); 777 778 InitLogging(argv); 779 780 // Skip over the command name. 781 argv++; 782 argc--; 783 784 if (argc == 0) { 785 Usage("No arguments specified"); 786 } 787 788 timings.StartTiming("Patchoat"); 789 790 // cmd line args 791 bool isa_set = false; 792 InstructionSet isa = kNone; 793 std::string input_oat_filename; 794 std::string input_oat_location; 795 int input_oat_fd = -1; 796 bool have_input_oat = false; 797 std::string input_image_location; 798 std::string output_oat_filename; 799 int output_oat_fd = -1; 800 bool have_output_oat = false; 801 std::string output_image_filename; 802 int output_image_fd = -1; 803 bool have_output_image = false; 804 uintptr_t base_offset = 0; 805 bool base_offset_set = false; 806 uintptr_t orig_base_offset = 0; 807 bool orig_base_offset_set = false; 808 off_t base_delta = 0; 809 bool base_delta_set = false; 810 std::string patched_image_filename; 811 std::string patched_image_location; 812 bool dump_timings = kIsDebugBuild; 813 bool lock_output = true; 814 815 for (int i = 0; i < argc; i++) { 816 const StringPiece option(argv[i]); 817 const bool log_options = false; 818 if (log_options) { 819 LOG(INFO) << "patchoat: option[" << i << "]=" << argv[i]; 820 } 821 // TODO: GetInstructionSetFromString shouldn't LOG(FATAL). 822 if (option.starts_with("--instruction-set=")) { 823 isa_set = true; 824 const char* isa_str = option.substr(strlen("--instruction-set=")).data(); 825 if (!strcmp("arm", isa_str)) { 826 isa = kArm; 827 } else if (!strcmp("arm64", isa_str)) { 828 isa = kArm64; 829 } else if (!strcmp("x86", isa_str)) { 830 isa = kX86; 831 } else if (!strcmp("x86_64", isa_str)) { 832 isa = kX86_64; 833 } else if (!strcmp("mips", isa_str)) { 834 isa = kMips; 835 } else { 836 Usage("Unknown instruction set %s", isa_str); 837 } 838 } else if (option.starts_with("--input-oat-location=")) { 839 if (have_input_oat) { 840 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 841 } 842 have_input_oat = true; 843 input_oat_location = option.substr(strlen("--input-oat-location=")).data(); 844 } else if (option.starts_with("--input-oat-file=")) { 845 if (have_input_oat) { 846 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 847 } 848 have_input_oat = true; 849 input_oat_filename = option.substr(strlen("--input-oat-file=")).data(); 850 } else if (option.starts_with("--input-oat-fd=")) { 851 if (have_input_oat) { 852 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 853 } 854 have_input_oat = true; 855 const char* oat_fd_str = option.substr(strlen("--input-oat-fd=")).data(); 856 if (!ParseInt(oat_fd_str, &input_oat_fd)) { 857 Usage("Failed to parse --input-oat-fd argument '%s' as an integer", oat_fd_str); 858 } 859 if (input_oat_fd < 0) { 860 Usage("--input-oat-fd pass a negative value %d", input_oat_fd); 861 } 862 } else if (option.starts_with("--input-image-location=")) { 863 input_image_location = option.substr(strlen("--input-image-location=")).data(); 864 } else if (option.starts_with("--output-oat-file=")) { 865 if (have_output_oat) { 866 Usage("Only one of --output-oat-file, and --output-oat-fd may be used."); 867 } 868 have_output_oat = true; 869 output_oat_filename = option.substr(strlen("--output-oat-file=")).data(); 870 } else if (option.starts_with("--output-oat-fd=")) { 871 if (have_output_oat) { 872 Usage("Only one of --output-oat-file, --output-oat-fd may be used."); 873 } 874 have_output_oat = true; 875 const char* oat_fd_str = option.substr(strlen("--output-oat-fd=")).data(); 876 if (!ParseInt(oat_fd_str, &output_oat_fd)) { 877 Usage("Failed to parse --output-oat-fd argument '%s' as an integer", oat_fd_str); 878 } 879 if (output_oat_fd < 0) { 880 Usage("--output-oat-fd pass a negative value %d", output_oat_fd); 881 } 882 } else if (option.starts_with("--output-image-file=")) { 883 if (have_output_image) { 884 Usage("Only one of --output-image-file, and --output-image-fd may be used."); 885 } 886 have_output_image = true; 887 output_image_filename = option.substr(strlen("--output-image-file=")).data(); 888 } else if (option.starts_with("--output-image-fd=")) { 889 if (have_output_image) { 890 Usage("Only one of --output-image-file, and --output-image-fd may be used."); 891 } 892 have_output_image = true; 893 const char* image_fd_str = option.substr(strlen("--output-image-fd=")).data(); 894 if (!ParseInt(image_fd_str, &output_image_fd)) { 895 Usage("Failed to parse --output-image-fd argument '%s' as an integer", image_fd_str); 896 } 897 if (output_image_fd < 0) { 898 Usage("--output-image-fd pass a negative value %d", output_image_fd); 899 } 900 } else if (option.starts_with("--orig-base-offset=")) { 901 const char* orig_base_offset_str = option.substr(strlen("--orig-base-offset=")).data(); 902 orig_base_offset_set = true; 903 if (!ParseUint(orig_base_offset_str, &orig_base_offset)) { 904 Usage("Failed to parse --orig-base-offset argument '%s' as an uintptr_t", 905 orig_base_offset_str); 906 } 907 } else if (option.starts_with("--base-offset=")) { 908 const char* base_offset_str = option.substr(strlen("--base-offset=")).data(); 909 base_offset_set = true; 910 if (!ParseUint(base_offset_str, &base_offset)) { 911 Usage("Failed to parse --base-offset argument '%s' as an uintptr_t", base_offset_str); 912 } 913 } else if (option.starts_with("--base-offset-delta=")) { 914 const char* base_delta_str = option.substr(strlen("--base-offset-delta=")).data(); 915 base_delta_set = true; 916 if (!ParseInt(base_delta_str, &base_delta)) { 917 Usage("Failed to parse --base-offset-delta argument '%s' as an off_t", base_delta_str); 918 } 919 } else if (option.starts_with("--patched-image-location=")) { 920 patched_image_location = option.substr(strlen("--patched-image-location=")).data(); 921 } else if (option.starts_with("--patched-image-file=")) { 922 patched_image_filename = option.substr(strlen("--patched-image-file=")).data(); 923 } else if (option == "--lock-output") { 924 lock_output = true; 925 } else if (option == "--no-lock-output") { 926 lock_output = false; 927 } else if (option == "--dump-timings") { 928 dump_timings = true; 929 } else if (option == "--no-dump-timings") { 930 dump_timings = false; 931 } else { 932 Usage("Unknown argument %s", option.data()); 933 } 934 } 935 936 { 937 // Only 1 of these may be set. 938 uint32_t cnt = 0; 939 cnt += (base_delta_set) ? 1 : 0; 940 cnt += (base_offset_set && orig_base_offset_set) ? 1 : 0; 941 cnt += (!patched_image_filename.empty()) ? 1 : 0; 942 cnt += (!patched_image_location.empty()) ? 1 : 0; 943 if (cnt > 1) { 944 Usage("Only one of --base-offset/--orig-base-offset, --base-offset-delta, " 945 "--patched-image-filename or --patched-image-location may be used."); 946 } else if (cnt == 0) { 947 Usage("Must specify --base-offset-delta, --base-offset and --orig-base-offset, " 948 "--patched-image-location or --patched-image-file"); 949 } 950 } 951 952 if (have_input_oat != have_output_oat) { 953 Usage("Either both input and output oat must be supplied or niether must be."); 954 } 955 956 if ((!input_image_location.empty()) != have_output_image) { 957 Usage("Either both input and output image must be supplied or niether must be."); 958 } 959 960 // We know we have both the input and output so rename for clarity. 961 bool have_image_files = have_output_image; 962 bool have_oat_files = have_output_oat; 963 964 if (!have_oat_files && !have_image_files) { 965 Usage("Must be patching either an oat or an image file or both."); 966 } 967 968 if (!have_oat_files && !isa_set) { 969 Usage("Must include ISA if patching an image file without an oat file."); 970 } 971 972 if (!input_oat_location.empty()) { 973 if (!isa_set) { 974 Usage("specifying a location requires specifying an instruction set"); 975 } 976 if (!LocationToFilename(input_oat_location, isa, &input_oat_filename)) { 977 Usage("Unable to find filename for input oat location %s", input_oat_location.c_str()); 978 } 979 if (debug) { 980 LOG(INFO) << "Using input-oat-file " << input_oat_filename; 981 } 982 } 983 if (!patched_image_location.empty()) { 984 if (!isa_set) { 985 Usage("specifying a location requires specifying an instruction set"); 986 } 987 std::string system_filename; 988 bool has_system = false; 989 std::string cache_filename; 990 bool has_cache = false; 991 bool has_android_data_unused = false; 992 if (!gc::space::ImageSpace::FindImageFilename(patched_image_location.c_str(), isa, 993 &system_filename, &has_system, &cache_filename, 994 &has_android_data_unused, &has_cache)) { 995 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 996 } 997 if (has_cache) { 998 patched_image_filename = cache_filename; 999 } else if (has_system) { 1000 LOG(WARNING) << "Only image file found was in /system for image location " 1001 << patched_image_location; 1002 patched_image_filename = system_filename; 1003 } else { 1004 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 1005 } 1006 if (debug) { 1007 LOG(INFO) << "Using patched-image-file " << patched_image_filename; 1008 } 1009 } 1010 1011 if (!base_delta_set) { 1012 if (orig_base_offset_set && base_offset_set) { 1013 base_delta_set = true; 1014 base_delta = base_offset - orig_base_offset; 1015 } else if (!patched_image_filename.empty()) { 1016 base_delta_set = true; 1017 std::string error_msg; 1018 if (!ReadBaseDelta(patched_image_filename.c_str(), &base_delta, &error_msg)) { 1019 Usage(error_msg.c_str(), patched_image_filename.c_str()); 1020 } 1021 } else { 1022 if (base_offset_set) { 1023 Usage("Unable to determine original base offset."); 1024 } else { 1025 Usage("Must supply a desired new offset or delta."); 1026 } 1027 } 1028 } 1029 1030 if (!IsAligned<kPageSize>(base_delta)) { 1031 Usage("Base offset/delta must be alligned to a pagesize (0x%08x) boundary.", kPageSize); 1032 } 1033 1034 // Do we need to cleanup output files if we fail? 1035 bool new_image_out = false; 1036 bool new_oat_out = false; 1037 1038 std::unique_ptr<File> input_oat; 1039 std::unique_ptr<File> output_oat; 1040 std::unique_ptr<File> output_image; 1041 1042 if (have_image_files) { 1043 CHECK(!input_image_location.empty()); 1044 1045 if (output_image_fd != -1) { 1046 if (output_image_filename.empty()) { 1047 output_image_filename = "output-image-file"; 1048 } 1049 output_image.reset(new File(output_image_fd, output_image_filename)); 1050 } else { 1051 CHECK(!output_image_filename.empty()); 1052 output_image.reset(CreateOrOpen(output_image_filename.c_str(), &new_image_out)); 1053 } 1054 } else { 1055 CHECK(output_image_filename.empty() && output_image_fd == -1 && input_image_location.empty()); 1056 } 1057 1058 if (have_oat_files) { 1059 if (input_oat_fd != -1) { 1060 if (input_oat_filename.empty()) { 1061 input_oat_filename = "input-oat-file"; 1062 } 1063 input_oat.reset(new File(input_oat_fd, input_oat_filename)); 1064 } else { 1065 CHECK(!input_oat_filename.empty()); 1066 input_oat.reset(OS::OpenFileForReading(input_oat_filename.c_str())); 1067 if (input_oat.get() == nullptr) { 1068 LOG(ERROR) << "Could not open input oat file: " << strerror(errno); 1069 } 1070 } 1071 1072 if (output_oat_fd != -1) { 1073 if (output_oat_filename.empty()) { 1074 output_oat_filename = "output-oat-file"; 1075 } 1076 output_oat.reset(new File(output_oat_fd, output_oat_filename)); 1077 } else { 1078 CHECK(!output_oat_filename.empty()); 1079 output_oat.reset(CreateOrOpen(output_oat_filename.c_str(), &new_oat_out)); 1080 } 1081 } 1082 1083 auto cleanup = [&output_image_filename, &output_oat_filename, 1084 &new_oat_out, &new_image_out, &timings, &dump_timings](bool success) { 1085 timings.EndTiming(); 1086 if (!success) { 1087 if (new_oat_out) { 1088 CHECK(!output_oat_filename.empty()); 1089 unlink(output_oat_filename.c_str()); 1090 } 1091 if (new_image_out) { 1092 CHECK(!output_image_filename.empty()); 1093 unlink(output_image_filename.c_str()); 1094 } 1095 } 1096 if (dump_timings) { 1097 LOG(INFO) << Dumpable<TimingLogger>(timings); 1098 } 1099 }; 1100 1101 if ((have_oat_files && (input_oat.get() == nullptr || output_oat.get() == nullptr)) || 1102 (have_image_files && output_image.get() == nullptr)) { 1103 cleanup(false); 1104 return EXIT_FAILURE; 1105 } 1106 1107 ScopedFlock output_oat_lock; 1108 if (lock_output) { 1109 std::string error_msg; 1110 if (have_oat_files && !output_oat_lock.Init(output_oat.get(), &error_msg)) { 1111 LOG(ERROR) << "Unable to lock output oat " << output_image->GetPath() << ": " << error_msg; 1112 cleanup(false); 1113 return EXIT_FAILURE; 1114 } 1115 } 1116 1117 if (debug) { 1118 LOG(INFO) << "moving offset by " << base_delta 1119 << " (0x" << std::hex << base_delta << ") bytes or " 1120 << std::dec << (base_delta/kPageSize) << " pages."; 1121 } 1122 1123 bool ret; 1124 if (have_image_files && have_oat_files) { 1125 TimingLogger::ScopedTiming pt("patch image and oat", &timings); 1126 ret = PatchOat::Patch(input_oat.get(), input_image_location, base_delta, 1127 output_oat.get(), output_image.get(), isa, &timings); 1128 } else if (have_oat_files) { 1129 TimingLogger::ScopedTiming pt("patch oat", &timings); 1130 ret = PatchOat::Patch(input_oat.get(), base_delta, output_oat.get(), &timings); 1131 } else { 1132 TimingLogger::ScopedTiming pt("patch image", &timings); 1133 CHECK(have_image_files); 1134 ret = PatchOat::Patch(input_image_location, base_delta, output_image.get(), isa, &timings); 1135 } 1136 cleanup(ret); 1137 return (ret) ? EXIT_SUCCESS : EXIT_FAILURE; 1138} 1139 1140} // namespace art 1141 1142int main(int argc, char **argv) { 1143 return art::patchoat(argc, argv); 1144} 1145