patchoat.cc revision aabbb2066a715b3fd8e752291f74c6d77b970450
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 469bool PatchOat::CheckOatFile() { 470 Elf32_Shdr* patches_sec = oat_file_->FindSectionByName(".oat_patches"); 471 if (patches_sec == nullptr) { 472 return false; 473 } 474 if (patches_sec->sh_type != SHT_OAT_PATCH) { 475 return false; 476 } 477 uintptr_t* patches = reinterpret_cast<uintptr_t*>(oat_file_->Begin() + patches_sec->sh_offset); 478 uintptr_t* patches_end = patches + (patches_sec->sh_size/sizeof(uintptr_t)); 479 Elf32_Shdr* oat_data_sec = oat_file_->FindSectionByName(".rodata"); 480 Elf32_Shdr* oat_text_sec = oat_file_->FindSectionByName(".text"); 481 if (oat_data_sec == nullptr) { 482 return false; 483 } 484 if (oat_text_sec == nullptr) { 485 return false; 486 } 487 if (oat_text_sec->sh_offset <= oat_data_sec->sh_offset) { 488 return false; 489 } 490 491 for (; patches < patches_end; patches++) { 492 if (oat_text_sec->sh_size <= *patches) { 493 return false; 494 } 495 } 496 497 return true; 498} 499 500bool PatchOat::PatchOatHeader() { 501 Elf32_Shdr *rodata_sec = oat_file_->FindSectionByName(".rodata"); 502 if (rodata_sec == nullptr) { 503 return false; 504 } 505 OatHeader* oat_header = reinterpret_cast<OatHeader*>(oat_file_->Begin() + rodata_sec->sh_offset); 506 if (!oat_header->IsValid()) { 507 LOG(ERROR) << "Elf file " << oat_file_->GetFile().GetPath() << " has an invalid oat header"; 508 return false; 509 } 510 oat_header->RelocateOat(delta_); 511 return true; 512} 513 514bool PatchOat::PatchElf() { 515 TimingLogger::ScopedTiming t("Fixup Elf Text Section", timings_); 516 if (!PatchTextSection()) { 517 return false; 518 } 519 520 if (!PatchOatHeader()) { 521 return false; 522 } 523 524 bool need_fixup = false; 525 t.NewTiming("Fixup Elf Headers"); 526 // Fixup Phdr's 527 for (unsigned int i = 0; i < oat_file_->GetProgramHeaderNum(); i++) { 528 Elf32_Phdr& hdr = oat_file_->GetProgramHeader(i); 529 if (hdr.p_vaddr != 0 && hdr.p_vaddr != hdr.p_offset) { 530 need_fixup = true; 531 hdr.p_vaddr += delta_; 532 } 533 if (hdr.p_paddr != 0 && hdr.p_paddr != hdr.p_offset) { 534 need_fixup = true; 535 hdr.p_paddr += delta_; 536 } 537 } 538 if (!need_fixup) { 539 // This was never passed through ElfFixup so all headers/symbols just have their offset as 540 // their addr. Therefore we do not need to update these parts. 541 return true; 542 } 543 t.NewTiming("Fixup Section Headers"); 544 for (unsigned int i = 0; i < oat_file_->GetSectionHeaderNum(); i++) { 545 Elf32_Shdr& hdr = oat_file_->GetSectionHeader(i); 546 if (hdr.sh_addr != 0) { 547 hdr.sh_addr += delta_; 548 } 549 } 550 551 t.NewTiming("Fixup Dynamics"); 552 for (Elf32_Word i = 0; i < oat_file_->GetDynamicNum(); i++) { 553 Elf32_Dyn& dyn = oat_file_->GetDynamic(i); 554 if (IsDynamicSectionPointer(dyn.d_tag, oat_file_->GetHeader().e_machine)) { 555 dyn.d_un.d_ptr += delta_; 556 } 557 } 558 559 t.NewTiming("Fixup Elf Symbols"); 560 // Fixup dynsym 561 Elf32_Shdr* dynsym_sec = oat_file_->FindSectionByName(".dynsym"); 562 CHECK(dynsym_sec != nullptr); 563 if (!PatchSymbols(dynsym_sec)) { 564 return false; 565 } 566 567 // Fixup symtab 568 Elf32_Shdr* symtab_sec = oat_file_->FindSectionByName(".symtab"); 569 if (symtab_sec != nullptr) { 570 if (!PatchSymbols(symtab_sec)) { 571 return false; 572 } 573 } 574 575 return true; 576} 577 578bool PatchOat::PatchSymbols(Elf32_Shdr* section) { 579 Elf32_Sym* syms = reinterpret_cast<Elf32_Sym*>(oat_file_->Begin() + section->sh_offset); 580 const Elf32_Sym* last_sym = 581 reinterpret_cast<Elf32_Sym*>(oat_file_->Begin() + section->sh_offset + section->sh_size); 582 CHECK_EQ(section->sh_size % sizeof(Elf32_Sym), 0u) 583 << "Symtab section size is not multiple of symbol size"; 584 for (; syms < last_sym; syms++) { 585 uint8_t sttype = ELF32_ST_TYPE(syms->st_info); 586 Elf32_Word shndx = syms->st_shndx; 587 if (shndx != SHN_ABS && shndx != SHN_COMMON && shndx != SHN_UNDEF && 588 (sttype == STT_FUNC || sttype == STT_OBJECT)) { 589 CHECK_NE(syms->st_value, 0u); 590 syms->st_value += delta_; 591 } 592 } 593 return true; 594} 595 596bool PatchOat::PatchTextSection() { 597 Elf32_Shdr* patches_sec = oat_file_->FindSectionByName(".oat_patches"); 598 if (patches_sec == nullptr) { 599 LOG(ERROR) << ".oat_patches section not found. Aborting patch"; 600 return false; 601 } 602 DCHECK(CheckOatFile()) << "Oat file invalid"; 603 CHECK_EQ(patches_sec->sh_type, SHT_OAT_PATCH) << "Unexpected type of .oat_patches"; 604 uintptr_t* patches = reinterpret_cast<uintptr_t*>(oat_file_->Begin() + patches_sec->sh_offset); 605 uintptr_t* patches_end = patches + (patches_sec->sh_size/sizeof(uintptr_t)); 606 Elf32_Shdr* oat_text_sec = oat_file_->FindSectionByName(".text"); 607 CHECK(oat_text_sec != nullptr); 608 byte* to_patch = oat_file_->Begin() + oat_text_sec->sh_offset; 609 uintptr_t to_patch_end = reinterpret_cast<uintptr_t>(to_patch) + oat_text_sec->sh_size; 610 611 for (; patches < patches_end; patches++) { 612 CHECK_LT(*patches, oat_text_sec->sh_size) << "Bad Patch"; 613 uint32_t* patch_loc = reinterpret_cast<uint32_t*>(to_patch + *patches); 614 CHECK_LT(reinterpret_cast<uintptr_t>(patch_loc), to_patch_end); 615 *patch_loc += delta_; 616 } 617 618 return true; 619} 620 621static int orig_argc; 622static char** orig_argv; 623 624static std::string CommandLine() { 625 std::vector<std::string> command; 626 for (int i = 0; i < orig_argc; ++i) { 627 command.push_back(orig_argv[i]); 628 } 629 return Join(command, ' '); 630} 631 632static void UsageErrorV(const char* fmt, va_list ap) { 633 std::string error; 634 StringAppendV(&error, fmt, ap); 635 LOG(ERROR) << error; 636} 637 638static void UsageError(const char* fmt, ...) { 639 va_list ap; 640 va_start(ap, fmt); 641 UsageErrorV(fmt, ap); 642 va_end(ap); 643} 644 645static void Usage(const char *fmt, ...) { 646 va_list ap; 647 va_start(ap, fmt); 648 UsageErrorV(fmt, ap); 649 va_end(ap); 650 651 UsageError("Command: %s", CommandLine().c_str()); 652 UsageError("Usage: patchoat [options]..."); 653 UsageError(""); 654 UsageError(" --instruction-set=<isa>: Specifies the instruction set the patched code is"); 655 UsageError(" compiled for. Required if you use --input-oat-location"); 656 UsageError(""); 657 UsageError(" --input-oat-file=<file.oat>: Specifies the exact filename of the oat file to be"); 658 UsageError(" patched."); 659 UsageError(""); 660 UsageError(" --input-oat-fd=<file-descriptor>: Specifies the file-descriptor of the oat file"); 661 UsageError(" to be patched."); 662 UsageError(""); 663 UsageError(" --input-oat-location=<file.oat>: Specifies the 'location' to read the patched"); 664 UsageError(" oat file from. If used one must also supply the --instruction-set"); 665 UsageError(""); 666 UsageError(" --input-image-location=<file.art>: Specifies the 'location' of the image file to"); 667 UsageError(" be patched. If --instruction-set is not given it will use the instruction set"); 668 UsageError(" extracted from the --input-oat-file."); 669 UsageError(""); 670 UsageError(" --output-oat-file=<file.oat>: Specifies the exact file to write the patched oat"); 671 UsageError(" file to."); 672 UsageError(""); 673 UsageError(" --output-oat-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 674 UsageError(" the patched oat file to."); 675 UsageError(""); 676 UsageError(" --output-image-file=<file.art>: Specifies the exact file to write the patched"); 677 UsageError(" image file to."); 678 UsageError(""); 679 UsageError(" --output-image-fd=<file-descriptor>: Specifies the file-descriptor to write the"); 680 UsageError(" the patched image file to."); 681 UsageError(""); 682 UsageError(" --orig-base-offset=<original-base-offset>: Specify the base offset the input file"); 683 UsageError(" was compiled with. This is needed if one is specifying a --base-offset"); 684 UsageError(""); 685 UsageError(" --base-offset=<new-base-offset>: Specify the base offset we will repatch the"); 686 UsageError(" given files to use. This requires that --orig-base-offset is also given."); 687 UsageError(""); 688 UsageError(" --base-offset-delta=<delta>: Specify the amount to change the old base-offset by."); 689 UsageError(" This value may be negative."); 690 UsageError(""); 691 UsageError(" --patched-image-file=<file.art>: Use the same patch delta as was used to patch"); 692 UsageError(" the given image file."); 693 UsageError(""); 694 UsageError(" --patched-image-location=<file.art>: Use the same patch delta as was used to"); 695 UsageError(" patch the given image location. If used one must also specify the"); 696 UsageError(" --instruction-set flag. It will search for this image in the same way that"); 697 UsageError(" is done when loading one."); 698 UsageError(""); 699 UsageError(" --lock-output: Obtain a flock on output oat file before starting."); 700 UsageError(""); 701 UsageError(" --no-lock-output: Do not attempt to obtain a flock on output oat file."); 702 UsageError(""); 703 UsageError(" --dump-timings: dump out patch timing information"); 704 UsageError(""); 705 UsageError(" --no-dump-timings: do not dump out patch timing information"); 706 UsageError(""); 707 708 exit(EXIT_FAILURE); 709} 710 711static bool ReadBaseDelta(const char* name, off_t* delta, std::string* error_msg) { 712 CHECK(name != nullptr); 713 CHECK(delta != nullptr); 714 std::unique_ptr<File> file; 715 if (OS::FileExists(name)) { 716 file.reset(OS::OpenFileForReading(name)); 717 if (file.get() == nullptr) { 718 *error_msg = "Failed to open file %s for reading"; 719 return false; 720 } 721 } else { 722 *error_msg = "File %s does not exist"; 723 return false; 724 } 725 CHECK(file.get() != nullptr); 726 ImageHeader hdr; 727 if (sizeof(hdr) != file->Read(reinterpret_cast<char*>(&hdr), sizeof(hdr), 0)) { 728 *error_msg = "Failed to read file %s"; 729 return false; 730 } 731 if (!hdr.IsValid()) { 732 *error_msg = "%s does not contain a valid image header."; 733 return false; 734 } 735 *delta = hdr.GetPatchDelta(); 736 return true; 737} 738 739static File* CreateOrOpen(const char* name, bool* created) { 740 if (OS::FileExists(name)) { 741 *created = false; 742 return OS::OpenFileReadWrite(name); 743 } else { 744 *created = true; 745 std::unique_ptr<File> f(OS::CreateEmptyFile(name)); 746 if (f.get() != nullptr) { 747 if (fchmod(f->Fd(), 0644) != 0) { 748 PLOG(ERROR) << "Unable to make " << name << " world readable"; 749 unlink(name); 750 return nullptr; 751 } 752 } 753 return f.release(); 754 } 755} 756 757static int patchoat(int argc, char **argv) { 758 InitLogging(argv); 759 const bool debug = kIsDebugBuild; 760 orig_argc = argc; 761 orig_argv = argv; 762 TimingLogger timings("patcher", false, false); 763 764 InitLogging(argv); 765 766 // Skip over the command name. 767 argv++; 768 argc--; 769 770 if (argc == 0) { 771 Usage("No arguments specified"); 772 } 773 774 timings.StartTiming("Patchoat"); 775 776 // cmd line args 777 bool isa_set = false; 778 InstructionSet isa = kNone; 779 std::string input_oat_filename; 780 std::string input_oat_location; 781 int input_oat_fd = -1; 782 bool have_input_oat = false; 783 std::string input_image_location; 784 std::string output_oat_filename; 785 int output_oat_fd = -1; 786 bool have_output_oat = false; 787 std::string output_image_filename; 788 int output_image_fd = -1; 789 bool have_output_image = false; 790 uintptr_t base_offset = 0; 791 bool base_offset_set = false; 792 uintptr_t orig_base_offset = 0; 793 bool orig_base_offset_set = false; 794 off_t base_delta = 0; 795 bool base_delta_set = false; 796 std::string patched_image_filename; 797 std::string patched_image_location; 798 bool dump_timings = kIsDebugBuild; 799 bool lock_output = true; 800 801 for (int i = 0; i < argc; i++) { 802 const StringPiece option(argv[i]); 803 const bool log_options = false; 804 if (log_options) { 805 LOG(INFO) << "patchoat: option[" << i << "]=" << argv[i]; 806 } 807 if (option.starts_with("--instruction-set=")) { 808 isa_set = true; 809 const char* isa_str = option.substr(strlen("--instruction-set=")).data(); 810 isa = GetInstructionSetFromString(isa_str); 811 if (isa == kNone) { 812 Usage("Unknown or invalid instruction set %s", isa_str); 813 } 814 } else if (option.starts_with("--input-oat-location=")) { 815 if (have_input_oat) { 816 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 817 } 818 have_input_oat = true; 819 input_oat_location = option.substr(strlen("--input-oat-location=")).data(); 820 } else if (option.starts_with("--input-oat-file=")) { 821 if (have_input_oat) { 822 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 823 } 824 have_input_oat = true; 825 input_oat_filename = option.substr(strlen("--input-oat-file=")).data(); 826 } else if (option.starts_with("--input-oat-fd=")) { 827 if (have_input_oat) { 828 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used."); 829 } 830 have_input_oat = true; 831 const char* oat_fd_str = option.substr(strlen("--input-oat-fd=")).data(); 832 if (!ParseInt(oat_fd_str, &input_oat_fd)) { 833 Usage("Failed to parse --input-oat-fd argument '%s' as an integer", oat_fd_str); 834 } 835 if (input_oat_fd < 0) { 836 Usage("--input-oat-fd pass a negative value %d", input_oat_fd); 837 } 838 } else if (option.starts_with("--input-image-location=")) { 839 input_image_location = option.substr(strlen("--input-image-location=")).data(); 840 } else if (option.starts_with("--output-oat-file=")) { 841 if (have_output_oat) { 842 Usage("Only one of --output-oat-file, and --output-oat-fd may be used."); 843 } 844 have_output_oat = true; 845 output_oat_filename = option.substr(strlen("--output-oat-file=")).data(); 846 } else if (option.starts_with("--output-oat-fd=")) { 847 if (have_output_oat) { 848 Usage("Only one of --output-oat-file, --output-oat-fd may be used."); 849 } 850 have_output_oat = true; 851 const char* oat_fd_str = option.substr(strlen("--output-oat-fd=")).data(); 852 if (!ParseInt(oat_fd_str, &output_oat_fd)) { 853 Usage("Failed to parse --output-oat-fd argument '%s' as an integer", oat_fd_str); 854 } 855 if (output_oat_fd < 0) { 856 Usage("--output-oat-fd pass a negative value %d", output_oat_fd); 857 } 858 } else if (option.starts_with("--output-image-file=")) { 859 if (have_output_image) { 860 Usage("Only one of --output-image-file, and --output-image-fd may be used."); 861 } 862 have_output_image = true; 863 output_image_filename = option.substr(strlen("--output-image-file=")).data(); 864 } else if (option.starts_with("--output-image-fd=")) { 865 if (have_output_image) { 866 Usage("Only one of --output-image-file, and --output-image-fd may be used."); 867 } 868 have_output_image = true; 869 const char* image_fd_str = option.substr(strlen("--output-image-fd=")).data(); 870 if (!ParseInt(image_fd_str, &output_image_fd)) { 871 Usage("Failed to parse --output-image-fd argument '%s' as an integer", image_fd_str); 872 } 873 if (output_image_fd < 0) { 874 Usage("--output-image-fd pass a negative value %d", output_image_fd); 875 } 876 } else if (option.starts_with("--orig-base-offset=")) { 877 const char* orig_base_offset_str = option.substr(strlen("--orig-base-offset=")).data(); 878 orig_base_offset_set = true; 879 if (!ParseUint(orig_base_offset_str, &orig_base_offset)) { 880 Usage("Failed to parse --orig-base-offset argument '%s' as an uintptr_t", 881 orig_base_offset_str); 882 } 883 } else if (option.starts_with("--base-offset=")) { 884 const char* base_offset_str = option.substr(strlen("--base-offset=")).data(); 885 base_offset_set = true; 886 if (!ParseUint(base_offset_str, &base_offset)) { 887 Usage("Failed to parse --base-offset argument '%s' as an uintptr_t", base_offset_str); 888 } 889 } else if (option.starts_with("--base-offset-delta=")) { 890 const char* base_delta_str = option.substr(strlen("--base-offset-delta=")).data(); 891 base_delta_set = true; 892 if (!ParseInt(base_delta_str, &base_delta)) { 893 Usage("Failed to parse --base-offset-delta argument '%s' as an off_t", base_delta_str); 894 } 895 } else if (option.starts_with("--patched-image-location=")) { 896 patched_image_location = option.substr(strlen("--patched-image-location=")).data(); 897 } else if (option.starts_with("--patched-image-file=")) { 898 patched_image_filename = option.substr(strlen("--patched-image-file=")).data(); 899 } else if (option == "--lock-output") { 900 lock_output = true; 901 } else if (option == "--no-lock-output") { 902 lock_output = false; 903 } else if (option == "--dump-timings") { 904 dump_timings = true; 905 } else if (option == "--no-dump-timings") { 906 dump_timings = false; 907 } else { 908 Usage("Unknown argument %s", option.data()); 909 } 910 } 911 912 { 913 // Only 1 of these may be set. 914 uint32_t cnt = 0; 915 cnt += (base_delta_set) ? 1 : 0; 916 cnt += (base_offset_set && orig_base_offset_set) ? 1 : 0; 917 cnt += (!patched_image_filename.empty()) ? 1 : 0; 918 cnt += (!patched_image_location.empty()) ? 1 : 0; 919 if (cnt > 1) { 920 Usage("Only one of --base-offset/--orig-base-offset, --base-offset-delta, " 921 "--patched-image-filename or --patched-image-location may be used."); 922 } else if (cnt == 0) { 923 Usage("Must specify --base-offset-delta, --base-offset and --orig-base-offset, " 924 "--patched-image-location or --patched-image-file"); 925 } 926 } 927 928 if (have_input_oat != have_output_oat) { 929 Usage("Either both input and output oat must be supplied or niether must be."); 930 } 931 932 if ((!input_image_location.empty()) != have_output_image) { 933 Usage("Either both input and output image must be supplied or niether must be."); 934 } 935 936 // We know we have both the input and output so rename for clarity. 937 bool have_image_files = have_output_image; 938 bool have_oat_files = have_output_oat; 939 940 if (!have_oat_files && !have_image_files) { 941 Usage("Must be patching either an oat or an image file or both."); 942 } 943 944 if (!have_oat_files && !isa_set) { 945 Usage("Must include ISA if patching an image file without an oat file."); 946 } 947 948 if (!input_oat_location.empty()) { 949 if (!isa_set) { 950 Usage("specifying a location requires specifying an instruction set"); 951 } 952 if (!LocationToFilename(input_oat_location, isa, &input_oat_filename)) { 953 Usage("Unable to find filename for input oat location %s", input_oat_location.c_str()); 954 } 955 if (debug) { 956 LOG(INFO) << "Using input-oat-file " << input_oat_filename; 957 } 958 } 959 if (!patched_image_location.empty()) { 960 if (!isa_set) { 961 Usage("specifying a location requires specifying an instruction set"); 962 } 963 std::string system_filename; 964 bool has_system = false; 965 std::string cache_filename; 966 bool has_cache = false; 967 bool has_android_data_unused = false; 968 if (!gc::space::ImageSpace::FindImageFilename(patched_image_location.c_str(), isa, 969 &system_filename, &has_system, &cache_filename, 970 &has_android_data_unused, &has_cache)) { 971 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 972 } 973 if (has_cache) { 974 patched_image_filename = cache_filename; 975 } else if (has_system) { 976 LOG(WARNING) << "Only image file found was in /system for image location " 977 << patched_image_location; 978 patched_image_filename = system_filename; 979 } else { 980 Usage("Unable to determine image file for location %s", patched_image_location.c_str()); 981 } 982 if (debug) { 983 LOG(INFO) << "Using patched-image-file " << patched_image_filename; 984 } 985 } 986 987 if (!base_delta_set) { 988 if (orig_base_offset_set && base_offset_set) { 989 base_delta_set = true; 990 base_delta = base_offset - orig_base_offset; 991 } else if (!patched_image_filename.empty()) { 992 base_delta_set = true; 993 std::string error_msg; 994 if (!ReadBaseDelta(patched_image_filename.c_str(), &base_delta, &error_msg)) { 995 Usage(error_msg.c_str(), patched_image_filename.c_str()); 996 } 997 } else { 998 if (base_offset_set) { 999 Usage("Unable to determine original base offset."); 1000 } else { 1001 Usage("Must supply a desired new offset or delta."); 1002 } 1003 } 1004 } 1005 1006 if (!IsAligned<kPageSize>(base_delta)) { 1007 Usage("Base offset/delta must be alligned to a pagesize (0x%08x) boundary.", kPageSize); 1008 } 1009 1010 // Do we need to cleanup output files if we fail? 1011 bool new_image_out = false; 1012 bool new_oat_out = false; 1013 1014 std::unique_ptr<File> input_oat; 1015 std::unique_ptr<File> output_oat; 1016 std::unique_ptr<File> output_image; 1017 1018 if (have_image_files) { 1019 CHECK(!input_image_location.empty()); 1020 1021 if (output_image_fd != -1) { 1022 if (output_image_filename.empty()) { 1023 output_image_filename = "output-image-file"; 1024 } 1025 output_image.reset(new File(output_image_fd, output_image_filename)); 1026 } else { 1027 CHECK(!output_image_filename.empty()); 1028 output_image.reset(CreateOrOpen(output_image_filename.c_str(), &new_image_out)); 1029 } 1030 } else { 1031 CHECK(output_image_filename.empty() && output_image_fd == -1 && input_image_location.empty()); 1032 } 1033 1034 if (have_oat_files) { 1035 if (input_oat_fd != -1) { 1036 if (input_oat_filename.empty()) { 1037 input_oat_filename = "input-oat-file"; 1038 } 1039 input_oat.reset(new File(input_oat_fd, input_oat_filename)); 1040 } else { 1041 CHECK(!input_oat_filename.empty()); 1042 input_oat.reset(OS::OpenFileForReading(input_oat_filename.c_str())); 1043 if (input_oat.get() == nullptr) { 1044 LOG(ERROR) << "Could not open input oat file: " << strerror(errno); 1045 } 1046 } 1047 1048 if (output_oat_fd != -1) { 1049 if (output_oat_filename.empty()) { 1050 output_oat_filename = "output-oat-file"; 1051 } 1052 output_oat.reset(new File(output_oat_fd, output_oat_filename)); 1053 } else { 1054 CHECK(!output_oat_filename.empty()); 1055 output_oat.reset(CreateOrOpen(output_oat_filename.c_str(), &new_oat_out)); 1056 } 1057 } 1058 1059 auto cleanup = [&output_image_filename, &output_oat_filename, 1060 &new_oat_out, &new_image_out, &timings, &dump_timings](bool success) { 1061 timings.EndTiming(); 1062 if (!success) { 1063 if (new_oat_out) { 1064 CHECK(!output_oat_filename.empty()); 1065 unlink(output_oat_filename.c_str()); 1066 } 1067 if (new_image_out) { 1068 CHECK(!output_image_filename.empty()); 1069 unlink(output_image_filename.c_str()); 1070 } 1071 } 1072 if (dump_timings) { 1073 LOG(INFO) << Dumpable<TimingLogger>(timings); 1074 } 1075 }; 1076 1077 if ((have_oat_files && (input_oat.get() == nullptr || output_oat.get() == nullptr)) || 1078 (have_image_files && output_image.get() == nullptr)) { 1079 cleanup(false); 1080 return EXIT_FAILURE; 1081 } 1082 1083 ScopedFlock output_oat_lock; 1084 if (lock_output) { 1085 std::string error_msg; 1086 if (have_oat_files && !output_oat_lock.Init(output_oat.get(), &error_msg)) { 1087 LOG(ERROR) << "Unable to lock output oat " << output_image->GetPath() << ": " << error_msg; 1088 cleanup(false); 1089 return EXIT_FAILURE; 1090 } 1091 } 1092 1093 if (debug) { 1094 LOG(INFO) << "moving offset by " << base_delta 1095 << " (0x" << std::hex << base_delta << ") bytes or " 1096 << std::dec << (base_delta/kPageSize) << " pages."; 1097 } 1098 1099 bool ret; 1100 if (have_image_files && have_oat_files) { 1101 TimingLogger::ScopedTiming pt("patch image and oat", &timings); 1102 ret = PatchOat::Patch(input_oat.get(), input_image_location, base_delta, 1103 output_oat.get(), output_image.get(), isa, &timings); 1104 } else if (have_oat_files) { 1105 TimingLogger::ScopedTiming pt("patch oat", &timings); 1106 ret = PatchOat::Patch(input_oat.get(), base_delta, output_oat.get(), &timings); 1107 } else { 1108 TimingLogger::ScopedTiming pt("patch image", &timings); 1109 CHECK(have_image_files); 1110 ret = PatchOat::Patch(input_image_location, base_delta, output_image.get(), isa, &timings); 1111 } 1112 cleanup(ret); 1113 return (ret) ? EXIT_SUCCESS : EXIT_FAILURE; 1114} 1115 1116} // namespace art 1117 1118int main(int argc, char **argv) { 1119 return art::patchoat(argc, argv); 1120} 1121