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