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