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