blob: 68fd15bc20e09e35903402bd52de682e4336af4b [file] [log] [blame]
Alex Light53cb16b2014-06-12 11:26:29 -07001/*
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>
Alex Lighta59dd802014-07-02 16:28:08 -070020#include <sys/file.h>
Alex Light53cb16b2014-06-12 11:26:29 -070021#include <sys/stat.h>
Alex Lighta59dd802014-07-02 16:28:08 -070022#include <unistd.h>
Alex Light53cb16b2014-06-12 11:26:29 -070023
24#include <string>
25#include <vector>
26
Ian Rogersc7dd2952014-10-21 23:31:19 -070027#include "base/dumpable.h"
Alex Lighta59dd802014-07-02 16:28:08 -070028#include "base/scoped_flock.h"
Alex Light53cb16b2014-06-12 11:26:29 -070029#include "base/stringpiece.h"
30#include "base/stringprintf.h"
Ian Rogersd4c4d952014-10-16 20:31:53 -070031#include "base/unix_file/fd_file.h"
Alex Light53cb16b2014-06-12 11:26:29 -070032#include "elf_utils.h"
33#include "elf_file.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070034#include "elf_file_impl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070035#include "gc/space/image_space.h"
Alex Light53cb16b2014-06-12 11:26:29 -070036#include "image.h"
Alex Light53cb16b2014-06-12 11:26:29 -070037#include "mirror/art_field-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070038#include "mirror/art_method-inl.h"
Alex Light53cb16b2014-06-12 11:26:29 -070039#include "mirror/object-inl.h"
40#include "mirror/reference.h"
41#include "noop_compiler_callbacks.h"
42#include "offsets.h"
43#include "os.h"
44#include "runtime.h"
45#include "scoped_thread_state_change.h"
46#include "thread.h"
47#include "utils.h"
48
49namespace art {
50
51static InstructionSet ElfISAToInstructionSet(Elf32_Word isa) {
52 switch (isa) {
53 case EM_ARM:
54 return kArm;
55 case EM_AARCH64:
56 return kArm64;
57 case EM_386:
58 return kX86;
59 case EM_X86_64:
60 return kX86_64;
61 case EM_MIPS:
62 return kMips;
63 default:
64 return kNone;
65 }
66}
67
Alex Lightcf4bf382014-07-24 11:29:14 -070068static bool LocationToFilename(const std::string& location, InstructionSet isa,
69 std::string* filename) {
70 bool has_system = false;
71 bool has_cache = false;
72 // image_location = /system/framework/boot.art
Igor Murashkin46774762014-10-22 11:37:02 -070073 // system_image_filename = /system/framework/<image_isa>/boot.art
Alex Lightcf4bf382014-07-24 11:29:14 -070074 std::string system_filename(GetSystemImageFilename(location.c_str(), isa));
75 if (OS::FileExists(system_filename.c_str())) {
76 has_system = true;
77 }
78
79 bool have_android_data = false;
80 bool dalvik_cache_exists = false;
Andreas Gampe3c13a792014-09-18 20:56:04 -070081 bool is_global_cache = false;
Alex Lightcf4bf382014-07-24 11:29:14 -070082 std::string dalvik_cache;
83 GetDalvikCache(GetInstructionSetString(isa), false, &dalvik_cache,
Andreas Gampe3c13a792014-09-18 20:56:04 -070084 &have_android_data, &dalvik_cache_exists, &is_global_cache);
Alex Lightcf4bf382014-07-24 11:29:14 -070085
86 std::string cache_filename;
87 if (have_android_data && dalvik_cache_exists) {
88 // Always set output location even if it does not exist,
89 // so that the caller knows where to create the image.
90 //
91 // image_location = /system/framework/boot.art
92 // *image_filename = /data/dalvik-cache/<image_isa>/boot.art
93 std::string error_msg;
94 if (GetDalvikCacheFilename(location.c_str(), dalvik_cache.c_str(),
95 &cache_filename, &error_msg)) {
96 has_cache = true;
97 }
98 }
99 if (has_system) {
100 *filename = system_filename;
101 return true;
102 } else if (has_cache) {
103 *filename = cache_filename;
104 return true;
105 } else {
106 return false;
107 }
108}
109
Alex Light53cb16b2014-06-12 11:26:29 -0700110bool PatchOat::Patch(const std::string& image_location, off_t delta,
111 File* output_image, InstructionSet isa,
Alex Lighteefbe392014-07-08 09:53:18 -0700112 TimingLogger* timings) {
Alex Light53cb16b2014-06-12 11:26:29 -0700113 CHECK(Runtime::Current() == nullptr);
114 CHECK(output_image != nullptr);
115 CHECK_GE(output_image->Fd(), 0);
116 CHECK(!image_location.empty()) << "image file must have a filename.";
117 CHECK_NE(isa, kNone);
118
Alex Lighteefbe392014-07-08 09:53:18 -0700119 TimingLogger::ScopedTiming t("Runtime Setup", timings);
Alex Light53cb16b2014-06-12 11:26:29 -0700120 const char *isa_name = GetInstructionSetString(isa);
Alex Lightcf4bf382014-07-24 11:29:14 -0700121 std::string image_filename;
122 if (!LocationToFilename(image_location, isa, &image_filename)) {
123 LOG(ERROR) << "Unable to find image at location " << image_location;
124 return false;
125 }
Alex Light53cb16b2014-06-12 11:26:29 -0700126 std::unique_ptr<File> input_image(OS::OpenFileForReading(image_filename.c_str()));
127 if (input_image.get() == nullptr) {
Alex Lightcf4bf382014-07-24 11:29:14 -0700128 LOG(ERROR) << "unable to open input image file at " << image_filename
129 << " for location " << image_location;
Alex Light53cb16b2014-06-12 11:26:29 -0700130 return false;
131 }
Igor Murashkin46774762014-10-22 11:37:02 -0700132
Alex Light53cb16b2014-06-12 11:26:29 -0700133 int64_t image_len = input_image->GetLength();
134 if (image_len < 0) {
135 LOG(ERROR) << "Error while getting image length";
136 return false;
137 }
138 ImageHeader image_header;
139 if (sizeof(image_header) != input_image->Read(reinterpret_cast<char*>(&image_header),
140 sizeof(image_header), 0)) {
141 LOG(ERROR) << "Unable to read image header from image file " << input_image->GetPath();
142 return false;
143 }
144
Igor Murashkin46774762014-10-22 11:37:02 -0700145 /*bool is_image_pic = */IsImagePic(image_header, input_image->GetPath());
146 // Nothing special to do right now since the image always needs to get patched.
147 // Perhaps in some far-off future we may have images with relative addresses that are true-PIC.
148
Alex Light53cb16b2014-06-12 11:26:29 -0700149 // Set up the runtime
Ian Rogerse63db272014-07-15 15:36:11 -0700150 RuntimeOptions options;
Alex Light53cb16b2014-06-12 11:26:29 -0700151 NoopCompilerCallbacks callbacks;
152 options.push_back(std::make_pair("compilercallbacks", &callbacks));
153 std::string img = "-Ximage:" + image_location;
154 options.push_back(std::make_pair(img.c_str(), nullptr));
155 options.push_back(std::make_pair("imageinstructionset", reinterpret_cast<const void*>(isa_name)));
156 if (!Runtime::Create(options, false)) {
157 LOG(ERROR) << "Unable to initialize runtime";
158 return false;
159 }
160 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
161 // give it away now and then switch to a more manageable ScopedObjectAccess.
162 Thread::Current()->TransitionFromRunnableToSuspended(kNative);
163 ScopedObjectAccess soa(Thread::Current());
164
165 t.NewTiming("Image and oat Patching setup");
166 // Create the map where we will write the image patches to.
Alex Lighteefbe392014-07-08 09:53:18 -0700167 std::string error_msg;
Alex Light53cb16b2014-06-12 11:26:29 -0700168 std::unique_ptr<MemMap> image(MemMap::MapFile(image_len, PROT_READ | PROT_WRITE, MAP_PRIVATE,
169 input_image->Fd(), 0,
170 input_image->GetPath().c_str(),
171 &error_msg));
172 if (image.get() == nullptr) {
173 LOG(ERROR) << "unable to map image file " << input_image->GetPath() << " : " << error_msg;
174 return false;
175 }
176 gc::space::ImageSpace* ispc = Runtime::Current()->GetHeap()->GetImageSpace();
177
Mathieu Chartier2d721012014-11-10 11:08:06 -0800178 PatchOat p(isa, image.release(), ispc->GetLiveBitmap(), ispc->GetMemMap(),
Alex Light53cb16b2014-06-12 11:26:29 -0700179 delta, timings);
180 t.NewTiming("Patching files");
181 if (!p.PatchImage()) {
Alex Lighta59dd802014-07-02 16:28:08 -0700182 LOG(ERROR) << "Failed to patch image file " << input_image->GetPath();
Alex Light53cb16b2014-06-12 11:26:29 -0700183 return false;
184 }
185
186 t.NewTiming("Writing files");
187 if (!p.WriteImage(output_image)) {
188 return false;
189 }
190 return true;
191}
192
Igor Murashkin46774762014-10-22 11:37:02 -0700193bool PatchOat::Patch(File* input_oat, const std::string& image_location, off_t delta,
Alex Light53cb16b2014-06-12 11:26:29 -0700194 File* output_oat, File* output_image, InstructionSet isa,
Igor Murashkin46774762014-10-22 11:37:02 -0700195 TimingLogger* timings,
196 bool output_oat_opened_from_fd,
197 bool new_oat_out) {
Alex Light53cb16b2014-06-12 11:26:29 -0700198 CHECK(Runtime::Current() == nullptr);
199 CHECK(output_image != nullptr);
200 CHECK_GE(output_image->Fd(), 0);
201 CHECK(input_oat != nullptr);
202 CHECK(output_oat != nullptr);
203 CHECK_GE(input_oat->Fd(), 0);
204 CHECK_GE(output_oat->Fd(), 0);
205 CHECK(!image_location.empty()) << "image file must have a filename.";
206
Alex Lighteefbe392014-07-08 09:53:18 -0700207 TimingLogger::ScopedTiming t("Runtime Setup", timings);
Alex Light53cb16b2014-06-12 11:26:29 -0700208
209 if (isa == kNone) {
210 Elf32_Ehdr elf_hdr;
211 if (sizeof(elf_hdr) != input_oat->Read(reinterpret_cast<char*>(&elf_hdr), sizeof(elf_hdr), 0)) {
212 LOG(ERROR) << "unable to read elf header";
213 return false;
214 }
215 isa = ElfISAToInstructionSet(elf_hdr.e_machine);
216 }
217 const char* isa_name = GetInstructionSetString(isa);
Alex Lightcf4bf382014-07-24 11:29:14 -0700218 std::string image_filename;
219 if (!LocationToFilename(image_location, isa, &image_filename)) {
220 LOG(ERROR) << "Unable to find image at location " << image_location;
221 return false;
222 }
Alex Light53cb16b2014-06-12 11:26:29 -0700223 std::unique_ptr<File> input_image(OS::OpenFileForReading(image_filename.c_str()));
224 if (input_image.get() == nullptr) {
Alex Lightcf4bf382014-07-24 11:29:14 -0700225 LOG(ERROR) << "unable to open input image file at " << image_filename
226 << " for location " << image_location;
Alex Light53cb16b2014-06-12 11:26:29 -0700227 return false;
228 }
229 int64_t image_len = input_image->GetLength();
230 if (image_len < 0) {
231 LOG(ERROR) << "Error while getting image length";
232 return false;
233 }
234 ImageHeader image_header;
235 if (sizeof(image_header) != input_image->Read(reinterpret_cast<char*>(&image_header),
236 sizeof(image_header), 0)) {
237 LOG(ERROR) << "Unable to read image header from image file " << input_image->GetPath();
238 }
239
Igor Murashkin46774762014-10-22 11:37:02 -0700240 /*bool is_image_pic = */IsImagePic(image_header, input_image->GetPath());
241 // Nothing special to do right now since the image always needs to get patched.
242 // Perhaps in some far-off future we may have images with relative addresses that are true-PIC.
243
Alex Light53cb16b2014-06-12 11:26:29 -0700244 // Set up the runtime
Ian Rogerse63db272014-07-15 15:36:11 -0700245 RuntimeOptions options;
Alex Light53cb16b2014-06-12 11:26:29 -0700246 NoopCompilerCallbacks callbacks;
247 options.push_back(std::make_pair("compilercallbacks", &callbacks));
248 std::string img = "-Ximage:" + image_location;
249 options.push_back(std::make_pair(img.c_str(), nullptr));
250 options.push_back(std::make_pair("imageinstructionset", reinterpret_cast<const void*>(isa_name)));
251 if (!Runtime::Create(options, false)) {
252 LOG(ERROR) << "Unable to initialize runtime";
253 return false;
254 }
255 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
256 // give it away now and then switch to a more manageable ScopedObjectAccess.
257 Thread::Current()->TransitionFromRunnableToSuspended(kNative);
258 ScopedObjectAccess soa(Thread::Current());
259
260 t.NewTiming("Image and oat Patching setup");
261 // Create the map where we will write the image patches to.
Alex Lighteefbe392014-07-08 09:53:18 -0700262 std::string error_msg;
Alex Light53cb16b2014-06-12 11:26:29 -0700263 std::unique_ptr<MemMap> image(MemMap::MapFile(image_len, PROT_READ | PROT_WRITE, MAP_PRIVATE,
264 input_image->Fd(), 0,
265 input_image->GetPath().c_str(),
266 &error_msg));
267 if (image.get() == nullptr) {
268 LOG(ERROR) << "unable to map image file " << input_image->GetPath() << " : " << error_msg;
269 return false;
270 }
271 gc::space::ImageSpace* ispc = Runtime::Current()->GetHeap()->GetImageSpace();
272
Igor Murashkin46774762014-10-22 11:37:02 -0700273 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat,
Alex Light53cb16b2014-06-12 11:26:29 -0700274 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg));
275 if (elf.get() == nullptr) {
276 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg;
277 return false;
278 }
279
Igor Murashkin46774762014-10-22 11:37:02 -0700280 bool skip_patching_oat = false;
281 MaybePic is_oat_pic = IsOatPic(elf.get());
282 if (is_oat_pic >= ERROR_FIRST) {
283 // Error logged by IsOatPic
284 return false;
285 } else if (is_oat_pic == PIC) {
286 // Do not need to do ELF-file patching. Create a symlink and skip the ELF patching.
287 if (!ReplaceOatFileWithSymlink(input_oat->GetPath(),
288 output_oat->GetPath(),
289 output_oat_opened_from_fd,
290 new_oat_out)) {
291 // Errors already logged by above call.
292 return false;
293 }
294 // Don't patch the OAT, since we just symlinked it. Image still needs patching.
295 skip_patching_oat = true;
296 } else {
297 CHECK(is_oat_pic == NOT_PIC);
298 }
299
Mathieu Chartier2d721012014-11-10 11:08:06 -0800300 PatchOat p(isa, elf.release(), image.release(), ispc->GetLiveBitmap(), ispc->GetMemMap(),
Alex Light53cb16b2014-06-12 11:26:29 -0700301 delta, timings);
302 t.NewTiming("Patching files");
Igor Murashkin46774762014-10-22 11:37:02 -0700303 if (!skip_patching_oat && !p.PatchElf()) {
Alex Lighta59dd802014-07-02 16:28:08 -0700304 LOG(ERROR) << "Failed to patch oat file " << input_oat->GetPath();
Alex Light53cb16b2014-06-12 11:26:29 -0700305 return false;
306 }
307 if (!p.PatchImage()) {
Alex Lighta59dd802014-07-02 16:28:08 -0700308 LOG(ERROR) << "Failed to patch image file " << input_image->GetPath();
Alex Light53cb16b2014-06-12 11:26:29 -0700309 return false;
310 }
311
312 t.NewTiming("Writing files");
Igor Murashkin46774762014-10-22 11:37:02 -0700313 if (!skip_patching_oat && !p.WriteElf(output_oat)) {
314 LOG(ERROR) << "Failed to write oat file " << input_oat->GetPath();
Alex Light53cb16b2014-06-12 11:26:29 -0700315 return false;
316 }
317 if (!p.WriteImage(output_image)) {
Igor Murashkin46774762014-10-22 11:37:02 -0700318 LOG(ERROR) << "Failed to write image file " << input_image->GetPath();
Alex Light53cb16b2014-06-12 11:26:29 -0700319 return false;
320 }
321 return true;
322}
323
324bool PatchOat::WriteElf(File* out) {
Alex Lighteefbe392014-07-08 09:53:18 -0700325 TimingLogger::ScopedTiming t("Writing Elf File", timings_);
Alex Lighta59dd802014-07-02 16:28:08 -0700326
Alex Light53cb16b2014-06-12 11:26:29 -0700327 CHECK(oat_file_.get() != nullptr);
328 CHECK(out != nullptr);
329 size_t expect = oat_file_->Size();
330 if (out->WriteFully(reinterpret_cast<char*>(oat_file_->Begin()), expect) &&
331 out->SetLength(expect) == 0) {
332 return true;
333 } else {
334 LOG(ERROR) << "Writing to oat file " << out->GetPath() << " failed.";
335 return false;
336 }
337}
338
339bool PatchOat::WriteImage(File* out) {
Alex Lighteefbe392014-07-08 09:53:18 -0700340 TimingLogger::ScopedTiming t("Writing image File", timings_);
Alex Lighta59dd802014-07-02 16:28:08 -0700341 std::string error_msg;
342
Alex Lightcf4bf382014-07-24 11:29:14 -0700343 ScopedFlock img_flock;
344 img_flock.Init(out, &error_msg);
Alex Lighta59dd802014-07-02 16:28:08 -0700345
Alex Light53cb16b2014-06-12 11:26:29 -0700346 CHECK(image_ != nullptr);
347 CHECK(out != nullptr);
348 size_t expect = image_->Size();
349 if (out->WriteFully(reinterpret_cast<char*>(image_->Begin()), expect) &&
350 out->SetLength(expect) == 0) {
351 return true;
352 } else {
353 LOG(ERROR) << "Writing to image file " << out->GetPath() << " failed.";
354 return false;
355 }
356}
357
Igor Murashkin46774762014-10-22 11:37:02 -0700358bool PatchOat::IsImagePic(const ImageHeader& image_header, const std::string& image_path) {
359 if (!image_header.CompilePic()) {
360 if (kIsDebugBuild) {
361 LOG(INFO) << "image at location " << image_path << " was *not* compiled pic";
362 }
363 return false;
364 }
365
366 if (kIsDebugBuild) {
367 LOG(INFO) << "image at location " << image_path << " was compiled PIC";
368 }
369
370 return true;
371}
372
373PatchOat::MaybePic PatchOat::IsOatPic(const ElfFile* oat_in) {
374 if (oat_in == nullptr) {
375 LOG(ERROR) << "No ELF input oat fie available";
376 return ERROR_OAT_FILE;
377 }
378
379 const std::string& file_path = oat_in->GetFile().GetPath();
380
381 const OatHeader* oat_header = GetOatHeader(oat_in);
382 if (oat_header == nullptr) {
383 LOG(ERROR) << "Failed to find oat header in oat file " << file_path;
384 return ERROR_OAT_FILE;
385 }
386
387 if (!oat_header->IsValid()) {
388 LOG(ERROR) << "Elf file " << file_path << " has an invalid oat header";
389 return ERROR_OAT_FILE;
390 }
391
392 bool is_pic = oat_header->IsPic();
393 if (kIsDebugBuild) {
394 LOG(INFO) << "Oat file at " << file_path << " is " << (is_pic ? "PIC" : "not pic");
395 }
396
397 return is_pic ? PIC : NOT_PIC;
398}
399
400bool PatchOat::ReplaceOatFileWithSymlink(const std::string& input_oat_filename,
401 const std::string& output_oat_filename,
402 bool output_oat_opened_from_fd,
403 bool new_oat_out) {
404 // Need a file when we are PIC, since we symlink over it. Refusing to symlink into FD.
405 if (output_oat_opened_from_fd) {
406 // TODO: installd uses --output-oat-fd. Should we change class linking logic for PIC?
407 LOG(ERROR) << "No output oat filename specified, needs filename for when we are PIC";
408 return false;
409 }
410
411 // Image was PIC. Create symlink where the oat is supposed to go.
412 if (!new_oat_out) {
413 LOG(ERROR) << "Oat file " << output_oat_filename << " already exists, refusing to overwrite";
414 return false;
415 }
416
417 // Delete the original file, since we won't need it.
418 TEMP_FAILURE_RETRY(unlink(output_oat_filename.c_str()));
419
420 // Create a symlink from the old oat to the new oat
421 if (symlink(input_oat_filename.c_str(), output_oat_filename.c_str()) < 0) {
422 int err = errno;
423 LOG(ERROR) << "Failed to create symlink at " << output_oat_filename
424 << " error(" << err << "): " << strerror(err);
425 return false;
426 }
427
428 if (kIsDebugBuild) {
429 LOG(INFO) << "Created symlink " << output_oat_filename << " -> " << input_oat_filename;
430 }
431
432 return true;
433}
434
Alex Light53cb16b2014-06-12 11:26:29 -0700435bool PatchOat::PatchImage() {
436 ImageHeader* image_header = reinterpret_cast<ImageHeader*>(image_->Begin());
437 CHECK_GT(image_->Size(), sizeof(ImageHeader));
438 // These are the roots from the original file.
439 mirror::Object* img_roots = image_header->GetImageRoots();
440 image_header->RelocateImage(delta_);
441
442 VisitObject(img_roots);
443 if (!image_header->IsValid()) {
444 LOG(ERROR) << "reloction renders image header invalid";
445 return false;
446 }
447
448 {
Alex Lighteefbe392014-07-08 09:53:18 -0700449 TimingLogger::ScopedTiming t("Walk Bitmap", timings_);
Alex Light53cb16b2014-06-12 11:26:29 -0700450 // Walk the bitmap.
451 WriterMutexLock mu(Thread::Current(), *Locks::heap_bitmap_lock_);
452 bitmap_->Walk(PatchOat::BitmapCallback, this);
453 }
454 return true;
455}
456
457bool PatchOat::InHeap(mirror::Object* o) {
458 uintptr_t begin = reinterpret_cast<uintptr_t>(heap_->Begin());
459 uintptr_t end = reinterpret_cast<uintptr_t>(heap_->End());
460 uintptr_t obj = reinterpret_cast<uintptr_t>(o);
461 return o == nullptr || (begin <= obj && obj < end);
462}
463
464void PatchOat::PatchVisitor::operator() (mirror::Object* obj, MemberOffset off,
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700465 bool is_static_unused ATTRIBUTE_UNUSED) const {
Alex Light53cb16b2014-06-12 11:26:29 -0700466 mirror::Object* referent = obj->GetFieldObject<mirror::Object, kVerifyNone>(off);
467 DCHECK(patcher_->InHeap(referent)) << "Referent is not in the heap.";
468 mirror::Object* moved_object = patcher_->RelocatedAddressOf(referent);
469 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object);
470}
471
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700472void PatchOat::PatchVisitor::operator() (mirror::Class* cls ATTRIBUTE_UNUSED,
473 mirror::Reference* ref) const {
Alex Light53cb16b2014-06-12 11:26:29 -0700474 MemberOffset off = mirror::Reference::ReferentOffset();
475 mirror::Object* referent = ref->GetReferent();
476 DCHECK(patcher_->InHeap(referent)) << "Referent is not in the heap.";
477 mirror::Object* moved_object = patcher_->RelocatedAddressOf(referent);
478 copy_->SetFieldObjectWithoutWriteBarrier<false, true, kVerifyNone>(off, moved_object);
479}
480
481mirror::Object* PatchOat::RelocatedCopyOf(mirror::Object* obj) {
482 if (obj == nullptr) {
483 return nullptr;
484 }
485 DCHECK_GT(reinterpret_cast<uintptr_t>(obj), reinterpret_cast<uintptr_t>(heap_->Begin()));
486 DCHECK_LT(reinterpret_cast<uintptr_t>(obj), reinterpret_cast<uintptr_t>(heap_->End()));
487 uintptr_t heap_off =
488 reinterpret_cast<uintptr_t>(obj) - reinterpret_cast<uintptr_t>(heap_->Begin());
489 DCHECK_LT(heap_off, image_->Size());
490 return reinterpret_cast<mirror::Object*>(image_->Begin() + heap_off);
491}
492
493mirror::Object* PatchOat::RelocatedAddressOf(mirror::Object* obj) {
494 if (obj == nullptr) {
495 return nullptr;
496 } else {
Ian Rogers13735952014-10-08 12:43:28 -0700497 return reinterpret_cast<mirror::Object*>(reinterpret_cast<uint8_t*>(obj) + delta_);
Alex Light53cb16b2014-06-12 11:26:29 -0700498 }
499}
500
Igor Murashkin46774762014-10-22 11:37:02 -0700501const OatHeader* PatchOat::GetOatHeader(const ElfFile* elf_file) {
502 if (elf_file->Is64Bit()) {
503 return GetOatHeader<ElfFileImpl64>(elf_file->GetImpl64());
504 } else {
505 return GetOatHeader<ElfFileImpl32>(elf_file->GetImpl32());
506 }
507}
508
509template <typename ElfFileImpl>
510const OatHeader* PatchOat::GetOatHeader(const ElfFileImpl* elf_file) {
511 auto rodata_sec = elf_file->FindSectionByName(".rodata");
512 if (rodata_sec == nullptr) {
513 return nullptr;
514 }
515
516 OatHeader* oat_header = reinterpret_cast<OatHeader*>(elf_file->Begin() + rodata_sec->sh_offset);
517 return oat_header;
518}
519
Alex Light53cb16b2014-06-12 11:26:29 -0700520// Called by BitmapCallback
521void PatchOat::VisitObject(mirror::Object* object) {
522 mirror::Object* copy = RelocatedCopyOf(object);
523 CHECK(copy != nullptr);
524 if (kUseBakerOrBrooksReadBarrier) {
525 object->AssertReadBarrierPointer();
526 if (kUseBrooksReadBarrier) {
527 mirror::Object* moved_to = RelocatedAddressOf(object);
528 copy->SetReadBarrierPointer(moved_to);
529 DCHECK_EQ(copy->GetReadBarrierPointer(), moved_to);
530 }
531 }
532 PatchOat::PatchVisitor visitor(this, copy);
533 object->VisitReferences<true, kVerifyNone>(visitor, visitor);
534 if (object->IsArtMethod<kVerifyNone>()) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800535 FixupMethod(down_cast<mirror::ArtMethod*>(object), down_cast<mirror::ArtMethod*>(copy));
Alex Light53cb16b2014-06-12 11:26:29 -0700536 }
537}
538
539void PatchOat::FixupMethod(mirror::ArtMethod* object, mirror::ArtMethod* copy) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800540 const size_t pointer_size = InstructionSetPointerSize(isa_);
Alex Light53cb16b2014-06-12 11:26:29 -0700541 // Just update the entry points if it looks like we should.
Alex Lighteefbe392014-07-08 09:53:18 -0700542 // TODO: sanity check all the pointers' values
Alex Light53cb16b2014-06-12 11:26:29 -0700543 uintptr_t portable = reinterpret_cast<uintptr_t>(
Mathieu Chartier2d721012014-11-10 11:08:06 -0800544 object->GetEntryPointFromPortableCompiledCodePtrSize<kVerifyNone>(pointer_size));
Alex Light53cb16b2014-06-12 11:26:29 -0700545 if (portable != 0) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800546 copy->SetEntryPointFromPortableCompiledCodePtrSize(reinterpret_cast<void*>(portable + delta_),
547 pointer_size);
Alex Light53cb16b2014-06-12 11:26:29 -0700548 }
549 uintptr_t quick= reinterpret_cast<uintptr_t>(
Mathieu Chartier2d721012014-11-10 11:08:06 -0800550 object->GetEntryPointFromQuickCompiledCodePtrSize<kVerifyNone>(pointer_size));
Alex Light53cb16b2014-06-12 11:26:29 -0700551 if (quick != 0) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800552 copy->SetEntryPointFromQuickCompiledCodePtrSize(reinterpret_cast<void*>(quick + delta_),
553 pointer_size);
Alex Light53cb16b2014-06-12 11:26:29 -0700554 }
555 uintptr_t interpreter = reinterpret_cast<uintptr_t>(
Mathieu Chartier2d721012014-11-10 11:08:06 -0800556 object->GetEntryPointFromInterpreterPtrSize<kVerifyNone>(pointer_size));
Alex Light53cb16b2014-06-12 11:26:29 -0700557 if (interpreter != 0) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800558 copy->SetEntryPointFromInterpreterPtrSize(
559 reinterpret_cast<mirror::EntryPointFromInterpreter*>(interpreter + delta_), pointer_size);
Alex Light53cb16b2014-06-12 11:26:29 -0700560 }
561
Mathieu Chartier2d721012014-11-10 11:08:06 -0800562 uintptr_t native_method = reinterpret_cast<uintptr_t>(
563 object->GetEntryPointFromJniPtrSize(pointer_size));
Alex Light53cb16b2014-06-12 11:26:29 -0700564 if (native_method != 0) {
Mathieu Chartier2d721012014-11-10 11:08:06 -0800565 copy->SetEntryPointFromJniPtrSize(reinterpret_cast<void*>(native_method + delta_),
566 pointer_size);
Alex Light53cb16b2014-06-12 11:26:29 -0700567 }
Alex Light53cb16b2014-06-12 11:26:29 -0700568}
569
Igor Murashkin46774762014-10-22 11:37:02 -0700570bool PatchOat::Patch(File* input_oat, off_t delta, File* output_oat, TimingLogger* timings,
571 bool output_oat_opened_from_fd, bool new_oat_out) {
Alex Light53cb16b2014-06-12 11:26:29 -0700572 CHECK(input_oat != nullptr);
573 CHECK(output_oat != nullptr);
574 CHECK_GE(input_oat->Fd(), 0);
575 CHECK_GE(output_oat->Fd(), 0);
Alex Lighteefbe392014-07-08 09:53:18 -0700576 TimingLogger::ScopedTiming t("Setup Oat File Patching", timings);
Alex Light53cb16b2014-06-12 11:26:29 -0700577
578 std::string error_msg;
Igor Murashkin46774762014-10-22 11:37:02 -0700579 std::unique_ptr<ElfFile> elf(ElfFile::Open(input_oat,
Alex Light53cb16b2014-06-12 11:26:29 -0700580 PROT_READ | PROT_WRITE, MAP_PRIVATE, &error_msg));
581 if (elf.get() == nullptr) {
582 LOG(ERROR) << "unable to open oat file " << input_oat->GetPath() << " : " << error_msg;
583 return false;
584 }
585
Igor Murashkin46774762014-10-22 11:37:02 -0700586 MaybePic is_oat_pic = IsOatPic(elf.get());
587 if (is_oat_pic >= ERROR_FIRST) {
588 // Error logged by IsOatPic
589 return false;
590 } else if (is_oat_pic == PIC) {
591 // Do not need to do ELF-file patching. Create a symlink and skip the rest.
592 // Any errors will be logged by the function call.
593 return ReplaceOatFileWithSymlink(input_oat->GetPath(),
594 output_oat->GetPath(),
595 output_oat_opened_from_fd,
596 new_oat_out);
597 } else {
598 CHECK(is_oat_pic == NOT_PIC);
599 }
600
Alex Light53cb16b2014-06-12 11:26:29 -0700601 PatchOat p(elf.release(), delta, timings);
602 t.NewTiming("Patch Oat file");
603 if (!p.PatchElf()) {
604 return false;
605 }
606
607 t.NewTiming("Writing oat file");
608 if (!p.WriteElf(output_oat)) {
609 return false;
610 }
611 return true;
612}
613
Tong Shen62d1ca32014-09-03 17:24:56 -0700614template <typename ElfFileImpl, typename ptr_t>
615bool PatchOat::CheckOatFile(ElfFileImpl* oat_file) {
616 auto patches_sec = oat_file->FindSectionByName(".oat_patches");
617 if (patches_sec->sh_type != SHT_OAT_PATCH) {
Alex Light53cb16b2014-06-12 11:26:29 -0700618 return false;
619 }
Tong Shen62d1ca32014-09-03 17:24:56 -0700620 ptr_t* patches = reinterpret_cast<ptr_t*>(oat_file->Begin() + patches_sec->sh_offset);
621 ptr_t* patches_end = patches + (patches_sec->sh_size / sizeof(ptr_t));
622 auto oat_data_sec = oat_file->FindSectionByName(".rodata");
623 auto oat_text_sec = oat_file->FindSectionByName(".text");
Alex Light53cb16b2014-06-12 11:26:29 -0700624 if (oat_data_sec == nullptr) {
625 return false;
626 }
627 if (oat_text_sec == nullptr) {
628 return false;
629 }
630 if (oat_text_sec->sh_offset <= oat_data_sec->sh_offset) {
631 return false;
632 }
633
634 for (; patches < patches_end; patches++) {
635 if (oat_text_sec->sh_size <= *patches) {
636 return false;
637 }
638 }
639
640 return true;
641}
642
Tong Shen62d1ca32014-09-03 17:24:56 -0700643template <typename ElfFileImpl>
644bool PatchOat::PatchOatHeader(ElfFileImpl* oat_file) {
645 auto rodata_sec = oat_file->FindSectionByName(".rodata");
Alex Lighta59dd802014-07-02 16:28:08 -0700646 if (rodata_sec == nullptr) {
647 return false;
648 }
Tong Shen62d1ca32014-09-03 17:24:56 -0700649 OatHeader* oat_header = reinterpret_cast<OatHeader*>(oat_file->Begin() + rodata_sec->sh_offset);
Alex Lighta59dd802014-07-02 16:28:08 -0700650 if (!oat_header->IsValid()) {
Tong Shen62d1ca32014-09-03 17:24:56 -0700651 LOG(ERROR) << "Elf file " << oat_file->GetFile().GetPath() << " has an invalid oat header";
Alex Lighta59dd802014-07-02 16:28:08 -0700652 return false;
653 }
654 oat_header->RelocateOat(delta_);
655 return true;
656}
657
Alex Light53cb16b2014-06-12 11:26:29 -0700658bool PatchOat::PatchElf() {
Ian Rogersd4c4d952014-10-16 20:31:53 -0700659 if (oat_file_->Is64Bit())
Tong Shen62d1ca32014-09-03 17:24:56 -0700660 return PatchElf<ElfFileImpl64>(oat_file_->GetImpl64());
661 else
662 return PatchElf<ElfFileImpl32>(oat_file_->GetImpl32());
663}
664
665template <typename ElfFileImpl>
666bool PatchOat::PatchElf(ElfFileImpl* oat_file) {
Alex Lighta59dd802014-07-02 16:28:08 -0700667 TimingLogger::ScopedTiming t("Fixup Elf Text Section", timings_);
Tong Shen62d1ca32014-09-03 17:24:56 -0700668 if (!PatchTextSection<ElfFileImpl>(oat_file)) {
Alex Lighta59dd802014-07-02 16:28:08 -0700669 return false;
670 }
671
Tong Shen62d1ca32014-09-03 17:24:56 -0700672 if (!PatchOatHeader<ElfFileImpl>(oat_file)) {
Alex Lighta59dd802014-07-02 16:28:08 -0700673 return false;
674 }
675
676 bool need_fixup = false;
Ian Rogersd4c4d952014-10-16 20:31:53 -0700677 for (unsigned int i = 0; i < oat_file->GetProgramHeaderNum(); ++i) {
Tong Shen62d1ca32014-09-03 17:24:56 -0700678 auto hdr = oat_file->GetProgramHeader(i);
Ian Rogersd4c4d952014-10-16 20:31:53 -0700679 if ((hdr->p_vaddr != 0 && hdr->p_vaddr != hdr->p_offset) ||
680 (hdr->p_paddr != 0 && hdr->p_paddr != hdr->p_offset)) {
Alex Lighta59dd802014-07-02 16:28:08 -0700681 need_fixup = true;
Ian Rogersd4c4d952014-10-16 20:31:53 -0700682 break;
Alex Light53cb16b2014-06-12 11:26:29 -0700683 }
684 }
Alex Lighta59dd802014-07-02 16:28:08 -0700685 if (!need_fixup) {
686 // This was never passed through ElfFixup so all headers/symbols just have their offset as
687 // their addr. Therefore we do not need to update these parts.
688 return true;
689 }
Tong Shen62d1ca32014-09-03 17:24:56 -0700690
691 t.NewTiming("Fixup Elf Headers");
692 // Fixup Phdr's
693 oat_file->FixupProgramHeaders(delta_);
694
Alex Lighta59dd802014-07-02 16:28:08 -0700695 t.NewTiming("Fixup Section Headers");
Tong Shen62d1ca32014-09-03 17:24:56 -0700696 // Fixup Shdr's
697 oat_file->FixupSectionHeaders(delta_);
Alex Light53cb16b2014-06-12 11:26:29 -0700698
Alex Lighta59dd802014-07-02 16:28:08 -0700699 t.NewTiming("Fixup Dynamics");
Tong Shen62d1ca32014-09-03 17:24:56 -0700700 oat_file->FixupDynamic(delta_);
Alex Light53cb16b2014-06-12 11:26:29 -0700701
702 t.NewTiming("Fixup Elf Symbols");
703 // Fixup dynsym
Tong Shen62d1ca32014-09-03 17:24:56 -0700704 if (!oat_file->FixupSymbols(delta_, true)) {
Alex Light53cb16b2014-06-12 11:26:29 -0700705 return false;
706 }
Alex Light53cb16b2014-06-12 11:26:29 -0700707 // Fixup symtab
Tong Shen62d1ca32014-09-03 17:24:56 -0700708 if (!oat_file->FixupSymbols(delta_, false)) {
709 return false;
Alex Light53cb16b2014-06-12 11:26:29 -0700710 }
711
Yevgeny Roubane3ea8382014-08-08 16:29:38 +0700712 t.NewTiming("Fixup Debug Sections");
Tong Shen62d1ca32014-09-03 17:24:56 -0700713 if (!oat_file->FixupDebugSections(delta_)) {
Yevgeny Roubane3ea8382014-08-08 16:29:38 +0700714 return false;
715 }
716
Alex Light53cb16b2014-06-12 11:26:29 -0700717 return true;
718}
719
Tong Shen62d1ca32014-09-03 17:24:56 -0700720template <typename ElfFileImpl>
721bool PatchOat::PatchTextSection(ElfFileImpl* oat_file) {
722 auto patches_sec = oat_file->FindSectionByName(".oat_patches");
Alex Light53cb16b2014-06-12 11:26:29 -0700723 if (patches_sec == nullptr) {
Alex Lighta59dd802014-07-02 16:28:08 -0700724 LOG(ERROR) << ".oat_patches section not found. Aborting patch";
Alex Light53cb16b2014-06-12 11:26:29 -0700725 return false;
726 }
Alex Light4b0d2d92014-08-06 13:37:23 -0700727 if (patches_sec->sh_type != SHT_OAT_PATCH) {
728 LOG(ERROR) << "Unexpected type of .oat_patches";
729 return false;
730 }
731
732 switch (patches_sec->sh_entsize) {
733 case sizeof(uint32_t):
Tong Shen62d1ca32014-09-03 17:24:56 -0700734 return PatchTextSection<ElfFileImpl, uint32_t>(oat_file);
Alex Light4b0d2d92014-08-06 13:37:23 -0700735 case sizeof(uint64_t):
Tong Shen62d1ca32014-09-03 17:24:56 -0700736 return PatchTextSection<ElfFileImpl, uint64_t>(oat_file);
Alex Light4b0d2d92014-08-06 13:37:23 -0700737 default:
738 LOG(ERROR) << ".oat_patches Entsize of " << patches_sec->sh_entsize << "bits "
739 << "is not valid";
740 return false;
741 }
742}
743
Tong Shen62d1ca32014-09-03 17:24:56 -0700744template <typename ElfFileImpl, typename patch_loc_t>
745bool PatchOat::PatchTextSection(ElfFileImpl* oat_file) {
746 bool oat_file_valid = CheckOatFile<ElfFileImpl, patch_loc_t>(oat_file);
747 CHECK(oat_file_valid) << "Oat file invalid";
748 auto patches_sec = oat_file->FindSectionByName(".oat_patches");
749 patch_loc_t* patches = reinterpret_cast<patch_loc_t*>(oat_file->Begin() + patches_sec->sh_offset);
750 patch_loc_t* patches_end = patches + (patches_sec->sh_size / sizeof(patch_loc_t));
751 auto oat_text_sec = oat_file->FindSectionByName(".text");
Alex Light53cb16b2014-06-12 11:26:29 -0700752 CHECK(oat_text_sec != nullptr);
Ian Rogers13735952014-10-08 12:43:28 -0700753 uint8_t* to_patch = oat_file->Begin() + oat_text_sec->sh_offset;
Alex Light53cb16b2014-06-12 11:26:29 -0700754 uintptr_t to_patch_end = reinterpret_cast<uintptr_t>(to_patch) + oat_text_sec->sh_size;
755
756 for (; patches < patches_end; patches++) {
757 CHECK_LT(*patches, oat_text_sec->sh_size) << "Bad Patch";
758 uint32_t* patch_loc = reinterpret_cast<uint32_t*>(to_patch + *patches);
759 CHECK_LT(reinterpret_cast<uintptr_t>(patch_loc), to_patch_end);
760 *patch_loc += delta_;
761 }
Alex Light53cb16b2014-06-12 11:26:29 -0700762 return true;
763}
764
765static int orig_argc;
766static char** orig_argv;
767
768static std::string CommandLine() {
769 std::vector<std::string> command;
770 for (int i = 0; i < orig_argc; ++i) {
771 command.push_back(orig_argv[i]);
772 }
773 return Join(command, ' ');
774}
775
776static void UsageErrorV(const char* fmt, va_list ap) {
777 std::string error;
778 StringAppendV(&error, fmt, ap);
779 LOG(ERROR) << error;
780}
781
782static void UsageError(const char* fmt, ...) {
783 va_list ap;
784 va_start(ap, fmt);
785 UsageErrorV(fmt, ap);
786 va_end(ap);
787}
788
Ian Rogers7223d442014-10-10 20:05:39 -0700789[[noreturn]] static void Usage(const char *fmt, ...) {
Alex Light53cb16b2014-06-12 11:26:29 -0700790 va_list ap;
791 va_start(ap, fmt);
792 UsageErrorV(fmt, ap);
793 va_end(ap);
794
795 UsageError("Command: %s", CommandLine().c_str());
796 UsageError("Usage: patchoat [options]...");
797 UsageError("");
798 UsageError(" --instruction-set=<isa>: Specifies the instruction set the patched code is");
799 UsageError(" compiled for. Required if you use --input-oat-location");
800 UsageError("");
801 UsageError(" --input-oat-file=<file.oat>: Specifies the exact filename of the oat file to be");
802 UsageError(" patched.");
803 UsageError("");
804 UsageError(" --input-oat-fd=<file-descriptor>: Specifies the file-descriptor of the oat file");
805 UsageError(" to be patched.");
806 UsageError("");
807 UsageError(" --input-oat-location=<file.oat>: Specifies the 'location' to read the patched");
808 UsageError(" oat file from. If used one must also supply the --instruction-set");
809 UsageError("");
810 UsageError(" --input-image-location=<file.art>: Specifies the 'location' of the image file to");
811 UsageError(" be patched. If --instruction-set is not given it will use the instruction set");
812 UsageError(" extracted from the --input-oat-file.");
813 UsageError("");
814 UsageError(" --output-oat-file=<file.oat>: Specifies the exact file to write the patched oat");
815 UsageError(" file to.");
816 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700817 UsageError(" --output-oat-fd=<file-descriptor>: Specifies the file-descriptor to write the");
818 UsageError(" the patched oat file to.");
819 UsageError("");
820 UsageError(" --output-image-file=<file.art>: Specifies the exact file to write the patched");
821 UsageError(" image file to.");
822 UsageError("");
823 UsageError(" --output-image-fd=<file-descriptor>: Specifies the file-descriptor to write the");
824 UsageError(" the patched image file to.");
825 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700826 UsageError(" --orig-base-offset=<original-base-offset>: Specify the base offset the input file");
827 UsageError(" was compiled with. This is needed if one is specifying a --base-offset");
828 UsageError("");
829 UsageError(" --base-offset=<new-base-offset>: Specify the base offset we will repatch the");
830 UsageError(" given files to use. This requires that --orig-base-offset is also given.");
831 UsageError("");
832 UsageError(" --base-offset-delta=<delta>: Specify the amount to change the old base-offset by.");
833 UsageError(" This value may be negative.");
834 UsageError("");
835 UsageError(" --patched-image-file=<file.art>: Use the same patch delta as was used to patch");
836 UsageError(" the given image file.");
837 UsageError("");
838 UsageError(" --patched-image-location=<file.art>: Use the same patch delta as was used to");
839 UsageError(" patch the given image location. If used one must also specify the");
Alex Lighta59dd802014-07-02 16:28:08 -0700840 UsageError(" --instruction-set flag. It will search for this image in the same way that");
841 UsageError(" is done when loading one.");
Alex Light53cb16b2014-06-12 11:26:29 -0700842 UsageError("");
Alex Lightcf4bf382014-07-24 11:29:14 -0700843 UsageError(" --lock-output: Obtain a flock on output oat file before starting.");
844 UsageError("");
845 UsageError(" --no-lock-output: Do not attempt to obtain a flock on output oat file.");
846 UsageError("");
Alex Light53cb16b2014-06-12 11:26:29 -0700847 UsageError(" --dump-timings: dump out patch timing information");
848 UsageError("");
849 UsageError(" --no-dump-timings: do not dump out patch timing information");
850 UsageError("");
851
852 exit(EXIT_FAILURE);
853}
854
Alex Lighteefbe392014-07-08 09:53:18 -0700855static bool ReadBaseDelta(const char* name, off_t* delta, std::string* error_msg) {
Alex Light53cb16b2014-06-12 11:26:29 -0700856 CHECK(name != nullptr);
857 CHECK(delta != nullptr);
858 std::unique_ptr<File> file;
859 if (OS::FileExists(name)) {
860 file.reset(OS::OpenFileForReading(name));
861 if (file.get() == nullptr) {
Alex Lighteefbe392014-07-08 09:53:18 -0700862 *error_msg = "Failed to open file %s for reading";
Alex Light53cb16b2014-06-12 11:26:29 -0700863 return false;
864 }
865 } else {
Alex Lighteefbe392014-07-08 09:53:18 -0700866 *error_msg = "File %s does not exist";
Alex Light53cb16b2014-06-12 11:26:29 -0700867 return false;
868 }
869 CHECK(file.get() != nullptr);
870 ImageHeader hdr;
871 if (sizeof(hdr) != file->Read(reinterpret_cast<char*>(&hdr), sizeof(hdr), 0)) {
Alex Lighteefbe392014-07-08 09:53:18 -0700872 *error_msg = "Failed to read file %s";
Alex Light53cb16b2014-06-12 11:26:29 -0700873 return false;
874 }
875 if (!hdr.IsValid()) {
Alex Lighteefbe392014-07-08 09:53:18 -0700876 *error_msg = "%s does not contain a valid image header.";
Alex Light53cb16b2014-06-12 11:26:29 -0700877 return false;
878 }
879 *delta = hdr.GetPatchDelta();
880 return true;
881}
882
883static File* CreateOrOpen(const char* name, bool* created) {
884 if (OS::FileExists(name)) {
885 *created = false;
886 return OS::OpenFileReadWrite(name);
887 } else {
888 *created = true;
Alex Lightcf4bf382014-07-24 11:29:14 -0700889 std::unique_ptr<File> f(OS::CreateEmptyFile(name));
890 if (f.get() != nullptr) {
891 if (fchmod(f->Fd(), 0644) != 0) {
892 PLOG(ERROR) << "Unable to make " << name << " world readable";
Brian Carlstrom8c52a3f2014-09-30 16:18:01 -0700893 TEMP_FAILURE_RETRY(unlink(name));
Alex Lightcf4bf382014-07-24 11:29:14 -0700894 return nullptr;
895 }
896 }
897 return f.release();
Alex Light53cb16b2014-06-12 11:26:29 -0700898 }
899}
900
Andreas Gampe4303ba92014-11-06 01:00:46 -0800901// Either try to close the file (close=true), or erase it.
902static bool FinishFile(File* file, bool close) {
903 if (close) {
904 if (file->FlushCloseOrErase() != 0) {
905 PLOG(ERROR) << "Failed to flush and close file.";
906 return false;
907 }
908 return true;
909 } else {
910 file->Erase();
911 return false;
912 }
913}
914
Alex Lighteefbe392014-07-08 09:53:18 -0700915static int patchoat(int argc, char **argv) {
Alex Light53cb16b2014-06-12 11:26:29 -0700916 InitLogging(argv);
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700917 MemMap::Init();
Alex Light53cb16b2014-06-12 11:26:29 -0700918 const bool debug = kIsDebugBuild;
919 orig_argc = argc;
920 orig_argv = argv;
921 TimingLogger timings("patcher", false, false);
922
923 InitLogging(argv);
924
925 // Skip over the command name.
926 argv++;
927 argc--;
928
929 if (argc == 0) {
930 Usage("No arguments specified");
931 }
932
933 timings.StartTiming("Patchoat");
934
935 // cmd line args
936 bool isa_set = false;
937 InstructionSet isa = kNone;
938 std::string input_oat_filename;
939 std::string input_oat_location;
940 int input_oat_fd = -1;
941 bool have_input_oat = false;
942 std::string input_image_location;
943 std::string output_oat_filename;
Alex Light53cb16b2014-06-12 11:26:29 -0700944 int output_oat_fd = -1;
945 bool have_output_oat = false;
946 std::string output_image_filename;
Alex Light53cb16b2014-06-12 11:26:29 -0700947 int output_image_fd = -1;
948 bool have_output_image = false;
949 uintptr_t base_offset = 0;
950 bool base_offset_set = false;
951 uintptr_t orig_base_offset = 0;
952 bool orig_base_offset_set = false;
953 off_t base_delta = 0;
954 bool base_delta_set = false;
955 std::string patched_image_filename;
956 std::string patched_image_location;
957 bool dump_timings = kIsDebugBuild;
Alex Lightcf4bf382014-07-24 11:29:14 -0700958 bool lock_output = true;
Alex Light53cb16b2014-06-12 11:26:29 -0700959
Ian Rogersd4c4d952014-10-16 20:31:53 -0700960 for (int i = 0; i < argc; ++i) {
Alex Light53cb16b2014-06-12 11:26:29 -0700961 const StringPiece option(argv[i]);
962 const bool log_options = false;
963 if (log_options) {
964 LOG(INFO) << "patchoat: option[" << i << "]=" << argv[i];
965 }
Alex Light53cb16b2014-06-12 11:26:29 -0700966 if (option.starts_with("--instruction-set=")) {
967 isa_set = true;
968 const char* isa_str = option.substr(strlen("--instruction-set=")).data();
Andreas Gampe20c89302014-08-19 17:28:06 -0700969 isa = GetInstructionSetFromString(isa_str);
970 if (isa == kNone) {
971 Usage("Unknown or invalid instruction set %s", isa_str);
Alex Light53cb16b2014-06-12 11:26:29 -0700972 }
973 } else if (option.starts_with("--input-oat-location=")) {
974 if (have_input_oat) {
975 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used.");
976 }
977 have_input_oat = true;
978 input_oat_location = option.substr(strlen("--input-oat-location=")).data();
979 } else if (option.starts_with("--input-oat-file=")) {
980 if (have_input_oat) {
981 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used.");
982 }
983 have_input_oat = true;
984 input_oat_filename = option.substr(strlen("--input-oat-file=")).data();
985 } else if (option.starts_with("--input-oat-fd=")) {
986 if (have_input_oat) {
987 Usage("Only one of --input-oat-file, --input-oat-location and --input-oat-fd may be used.");
988 }
989 have_input_oat = true;
990 const char* oat_fd_str = option.substr(strlen("--input-oat-fd=")).data();
991 if (!ParseInt(oat_fd_str, &input_oat_fd)) {
992 Usage("Failed to parse --input-oat-fd argument '%s' as an integer", oat_fd_str);
993 }
994 if (input_oat_fd < 0) {
995 Usage("--input-oat-fd pass a negative value %d", input_oat_fd);
996 }
997 } else if (option.starts_with("--input-image-location=")) {
998 input_image_location = option.substr(strlen("--input-image-location=")).data();
Alex Light53cb16b2014-06-12 11:26:29 -0700999 } else if (option.starts_with("--output-oat-file=")) {
1000 if (have_output_oat) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001001 Usage("Only one of --output-oat-file, and --output-oat-fd may be used.");
Alex Light53cb16b2014-06-12 11:26:29 -07001002 }
1003 have_output_oat = true;
1004 output_oat_filename = option.substr(strlen("--output-oat-file=")).data();
1005 } else if (option.starts_with("--output-oat-fd=")) {
1006 if (have_output_oat) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001007 Usage("Only one of --output-oat-file, --output-oat-fd may be used.");
Alex Light53cb16b2014-06-12 11:26:29 -07001008 }
1009 have_output_oat = true;
1010 const char* oat_fd_str = option.substr(strlen("--output-oat-fd=")).data();
1011 if (!ParseInt(oat_fd_str, &output_oat_fd)) {
1012 Usage("Failed to parse --output-oat-fd argument '%s' as an integer", oat_fd_str);
1013 }
1014 if (output_oat_fd < 0) {
1015 Usage("--output-oat-fd pass a negative value %d", output_oat_fd);
1016 }
Alex Light53cb16b2014-06-12 11:26:29 -07001017 } else if (option.starts_with("--output-image-file=")) {
1018 if (have_output_image) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001019 Usage("Only one of --output-image-file, and --output-image-fd may be used.");
Alex Light53cb16b2014-06-12 11:26:29 -07001020 }
1021 have_output_image = true;
1022 output_image_filename = option.substr(strlen("--output-image-file=")).data();
1023 } else if (option.starts_with("--output-image-fd=")) {
1024 if (have_output_image) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001025 Usage("Only one of --output-image-file, and --output-image-fd may be used.");
Alex Light53cb16b2014-06-12 11:26:29 -07001026 }
1027 have_output_image = true;
1028 const char* image_fd_str = option.substr(strlen("--output-image-fd=")).data();
1029 if (!ParseInt(image_fd_str, &output_image_fd)) {
1030 Usage("Failed to parse --output-image-fd argument '%s' as an integer", image_fd_str);
1031 }
1032 if (output_image_fd < 0) {
1033 Usage("--output-image-fd pass a negative value %d", output_image_fd);
1034 }
1035 } else if (option.starts_with("--orig-base-offset=")) {
1036 const char* orig_base_offset_str = option.substr(strlen("--orig-base-offset=")).data();
1037 orig_base_offset_set = true;
1038 if (!ParseUint(orig_base_offset_str, &orig_base_offset)) {
1039 Usage("Failed to parse --orig-base-offset argument '%s' as an uintptr_t",
1040 orig_base_offset_str);
1041 }
1042 } else if (option.starts_with("--base-offset=")) {
1043 const char* base_offset_str = option.substr(strlen("--base-offset=")).data();
1044 base_offset_set = true;
1045 if (!ParseUint(base_offset_str, &base_offset)) {
1046 Usage("Failed to parse --base-offset argument '%s' as an uintptr_t", base_offset_str);
1047 }
1048 } else if (option.starts_with("--base-offset-delta=")) {
1049 const char* base_delta_str = option.substr(strlen("--base-offset-delta=")).data();
1050 base_delta_set = true;
1051 if (!ParseInt(base_delta_str, &base_delta)) {
1052 Usage("Failed to parse --base-offset-delta argument '%s' as an off_t", base_delta_str);
1053 }
1054 } else if (option.starts_with("--patched-image-location=")) {
1055 patched_image_location = option.substr(strlen("--patched-image-location=")).data();
1056 } else if (option.starts_with("--patched-image-file=")) {
1057 patched_image_filename = option.substr(strlen("--patched-image-file=")).data();
Alex Lightcf4bf382014-07-24 11:29:14 -07001058 } else if (option == "--lock-output") {
1059 lock_output = true;
1060 } else if (option == "--no-lock-output") {
1061 lock_output = false;
Alex Light53cb16b2014-06-12 11:26:29 -07001062 } else if (option == "--dump-timings") {
1063 dump_timings = true;
1064 } else if (option == "--no-dump-timings") {
1065 dump_timings = false;
1066 } else {
1067 Usage("Unknown argument %s", option.data());
1068 }
1069 }
1070
1071 {
1072 // Only 1 of these may be set.
1073 uint32_t cnt = 0;
1074 cnt += (base_delta_set) ? 1 : 0;
1075 cnt += (base_offset_set && orig_base_offset_set) ? 1 : 0;
1076 cnt += (!patched_image_filename.empty()) ? 1 : 0;
1077 cnt += (!patched_image_location.empty()) ? 1 : 0;
1078 if (cnt > 1) {
1079 Usage("Only one of --base-offset/--orig-base-offset, --base-offset-delta, "
1080 "--patched-image-filename or --patched-image-location may be used.");
1081 } else if (cnt == 0) {
1082 Usage("Must specify --base-offset-delta, --base-offset and --orig-base-offset, "
1083 "--patched-image-location or --patched-image-file");
1084 }
1085 }
1086
1087 if (have_input_oat != have_output_oat) {
1088 Usage("Either both input and output oat must be supplied or niether must be.");
1089 }
1090
1091 if ((!input_image_location.empty()) != have_output_image) {
1092 Usage("Either both input and output image must be supplied or niether must be.");
1093 }
1094
1095 // We know we have both the input and output so rename for clarity.
1096 bool have_image_files = have_output_image;
1097 bool have_oat_files = have_output_oat;
1098
1099 if (!have_oat_files && !have_image_files) {
1100 Usage("Must be patching either an oat or an image file or both.");
1101 }
1102
1103 if (!have_oat_files && !isa_set) {
1104 Usage("Must include ISA if patching an image file without an oat file.");
1105 }
1106
1107 if (!input_oat_location.empty()) {
1108 if (!isa_set) {
1109 Usage("specifying a location requires specifying an instruction set");
1110 }
Alex Lightcf4bf382014-07-24 11:29:14 -07001111 if (!LocationToFilename(input_oat_location, isa, &input_oat_filename)) {
1112 Usage("Unable to find filename for input oat location %s", input_oat_location.c_str());
1113 }
Alex Light53cb16b2014-06-12 11:26:29 -07001114 if (debug) {
1115 LOG(INFO) << "Using input-oat-file " << input_oat_filename;
1116 }
1117 }
Alex Light53cb16b2014-06-12 11:26:29 -07001118 if (!patched_image_location.empty()) {
1119 if (!isa_set) {
1120 Usage("specifying a location requires specifying an instruction set");
1121 }
Alex Lighta59dd802014-07-02 16:28:08 -07001122 std::string system_filename;
1123 bool has_system = false;
1124 std::string cache_filename;
1125 bool has_cache = false;
1126 bool has_android_data_unused = false;
Andreas Gampe3c13a792014-09-18 20:56:04 -07001127 bool is_global_cache = false;
Alex Lighta59dd802014-07-02 16:28:08 -07001128 if (!gc::space::ImageSpace::FindImageFilename(patched_image_location.c_str(), isa,
1129 &system_filename, &has_system, &cache_filename,
Andreas Gampe3c13a792014-09-18 20:56:04 -07001130 &has_android_data_unused, &has_cache,
1131 &is_global_cache)) {
Alex Lighta59dd802014-07-02 16:28:08 -07001132 Usage("Unable to determine image file for location %s", patched_image_location.c_str());
1133 }
1134 if (has_cache) {
1135 patched_image_filename = cache_filename;
1136 } else if (has_system) {
1137 LOG(WARNING) << "Only image file found was in /system for image location "
1138 << patched_image_location;
1139 patched_image_filename = system_filename;
1140 } else {
1141 Usage("Unable to determine image file for location %s", patched_image_location.c_str());
1142 }
Alex Light53cb16b2014-06-12 11:26:29 -07001143 if (debug) {
1144 LOG(INFO) << "Using patched-image-file " << patched_image_filename;
1145 }
1146 }
1147
1148 if (!base_delta_set) {
1149 if (orig_base_offset_set && base_offset_set) {
1150 base_delta_set = true;
1151 base_delta = base_offset - orig_base_offset;
1152 } else if (!patched_image_filename.empty()) {
1153 base_delta_set = true;
1154 std::string error_msg;
Alex Lighteefbe392014-07-08 09:53:18 -07001155 if (!ReadBaseDelta(patched_image_filename.c_str(), &base_delta, &error_msg)) {
Alex Light53cb16b2014-06-12 11:26:29 -07001156 Usage(error_msg.c_str(), patched_image_filename.c_str());
1157 }
1158 } else {
1159 if (base_offset_set) {
1160 Usage("Unable to determine original base offset.");
1161 } else {
1162 Usage("Must supply a desired new offset or delta.");
1163 }
1164 }
1165 }
1166
1167 if (!IsAligned<kPageSize>(base_delta)) {
1168 Usage("Base offset/delta must be alligned to a pagesize (0x%08x) boundary.", kPageSize);
1169 }
1170
1171 // Do we need to cleanup output files if we fail?
1172 bool new_image_out = false;
1173 bool new_oat_out = false;
1174
1175 std::unique_ptr<File> input_oat;
1176 std::unique_ptr<File> output_oat;
1177 std::unique_ptr<File> output_image;
1178
1179 if (have_image_files) {
1180 CHECK(!input_image_location.empty());
1181
1182 if (output_image_fd != -1) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001183 if (output_image_filename.empty()) {
1184 output_image_filename = "output-image-file";
1185 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001186 output_image.reset(new File(output_image_fd, output_image_filename, true));
Alex Light53cb16b2014-06-12 11:26:29 -07001187 } else {
1188 CHECK(!output_image_filename.empty());
1189 output_image.reset(CreateOrOpen(output_image_filename.c_str(), &new_image_out));
1190 }
1191 } else {
1192 CHECK(output_image_filename.empty() && output_image_fd == -1 && input_image_location.empty());
1193 }
1194
1195 if (have_oat_files) {
1196 if (input_oat_fd != -1) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001197 if (input_oat_filename.empty()) {
1198 input_oat_filename = "input-oat-file";
1199 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001200 input_oat.reset(new File(input_oat_fd, input_oat_filename, false));
Igor Murashkin46774762014-10-22 11:37:02 -07001201 if (input_oat == nullptr) {
1202 // Unlikely, but ensure exhaustive logging in non-0 exit code case
1203 LOG(ERROR) << "Failed to open input oat file by its FD" << input_oat_fd;
1204 }
Alex Light53cb16b2014-06-12 11:26:29 -07001205 } else {
1206 CHECK(!input_oat_filename.empty());
1207 input_oat.reset(OS::OpenFileForReading(input_oat_filename.c_str()));
Igor Murashkin46774762014-10-22 11:37:02 -07001208 if (input_oat == nullptr) {
1209 int err = errno;
1210 LOG(ERROR) << "Failed to open input oat file " << input_oat_filename
1211 << ": " << strerror(err) << "(" << err << ")";
Andreas Gampe1c83cbc2014-07-22 18:52:29 -07001212 }
Alex Light53cb16b2014-06-12 11:26:29 -07001213 }
1214
1215 if (output_oat_fd != -1) {
Alex Lightcf4bf382014-07-24 11:29:14 -07001216 if (output_oat_filename.empty()) {
1217 output_oat_filename = "output-oat-file";
Alex Lighta59dd802014-07-02 16:28:08 -07001218 }
Andreas Gampe4303ba92014-11-06 01:00:46 -08001219 output_oat.reset(new File(output_oat_fd, output_oat_filename, true));
Igor Murashkin46774762014-10-22 11:37:02 -07001220 if (output_oat == nullptr) {
1221 // Unlikely, but ensure exhaustive logging in non-0 exit code case
1222 LOG(ERROR) << "Failed to open output oat file by its FD" << output_oat_fd;
1223 }
Alex Light53cb16b2014-06-12 11:26:29 -07001224 } else {
1225 CHECK(!output_oat_filename.empty());
1226 output_oat.reset(CreateOrOpen(output_oat_filename.c_str(), &new_oat_out));
Igor Murashkin46774762014-10-22 11:37:02 -07001227 if (output_oat == nullptr) {
1228 int err = errno;
1229 LOG(ERROR) << "Failed to open output oat file " << output_oat_filename
1230 << ": " << strerror(err) << "(" << err << ")";
1231 }
Alex Light53cb16b2014-06-12 11:26:29 -07001232 }
1233 }
1234
Igor Murashkin46774762014-10-22 11:37:02 -07001235 // TODO: get rid of this.
Alex Light53cb16b2014-06-12 11:26:29 -07001236 auto cleanup = [&output_image_filename, &output_oat_filename,
1237 &new_oat_out, &new_image_out, &timings, &dump_timings](bool success) {
1238 timings.EndTiming();
1239 if (!success) {
1240 if (new_oat_out) {
1241 CHECK(!output_oat_filename.empty());
Brian Carlstrom8c52a3f2014-09-30 16:18:01 -07001242 TEMP_FAILURE_RETRY(unlink(output_oat_filename.c_str()));
Alex Light53cb16b2014-06-12 11:26:29 -07001243 }
1244 if (new_image_out) {
1245 CHECK(!output_image_filename.empty());
Brian Carlstrom8c52a3f2014-09-30 16:18:01 -07001246 TEMP_FAILURE_RETRY(unlink(output_image_filename.c_str()));
Alex Light53cb16b2014-06-12 11:26:29 -07001247 }
1248 }
1249 if (dump_timings) {
1250 LOG(INFO) << Dumpable<TimingLogger>(timings);
1251 }
Igor Murashkin46774762014-10-22 11:37:02 -07001252
1253 if (kIsDebugBuild) {
1254 LOG(INFO) << "Cleaning up.. success? " << success;
1255 }
Alex Light53cb16b2014-06-12 11:26:29 -07001256 };
1257
Igor Murashkin46774762014-10-22 11:37:02 -07001258 if (have_oat_files && (input_oat.get() == nullptr || output_oat.get() == nullptr)) {
1259 LOG(ERROR) << "Failed to open input/output oat files";
1260 cleanup(false);
1261 return EXIT_FAILURE;
1262 } else if (have_image_files && output_image.get() == nullptr) {
1263 LOG(ERROR) << "Failed to open output image file";
Alex Lightcf4bf382014-07-24 11:29:14 -07001264 cleanup(false);
1265 return EXIT_FAILURE;
1266 }
1267
Igor Murashkin46774762014-10-22 11:37:02 -07001268 if (debug) {
1269 LOG(INFO) << "moving offset by " << base_delta
1270 << " (0x" << std::hex << base_delta << ") bytes or "
1271 << std::dec << (base_delta/kPageSize) << " pages.";
1272 }
1273
1274 // TODO: is it going to be promatic to unlink a file that was flock-ed?
Alex Lightcf4bf382014-07-24 11:29:14 -07001275 ScopedFlock output_oat_lock;
1276 if (lock_output) {
1277 std::string error_msg;
1278 if (have_oat_files && !output_oat_lock.Init(output_oat.get(), &error_msg)) {
1279 LOG(ERROR) << "Unable to lock output oat " << output_image->GetPath() << ": " << error_msg;
1280 cleanup(false);
1281 return EXIT_FAILURE;
1282 }
1283 }
1284
Alex Light53cb16b2014-06-12 11:26:29 -07001285 bool ret;
1286 if (have_image_files && have_oat_files) {
1287 TimingLogger::ScopedTiming pt("patch image and oat", &timings);
1288 ret = PatchOat::Patch(input_oat.get(), input_image_location, base_delta,
Igor Murashkin46774762014-10-22 11:37:02 -07001289 output_oat.get(), output_image.get(), isa, &timings,
1290 output_oat_fd >= 0, // was it opened from FD?
1291 new_oat_out);
Andreas Gampe4303ba92014-11-06 01:00:46 -08001292 // The order here doesn't matter. If the first one is successfully saved and the second one
1293 // erased, ImageSpace will still detect a problem and not use the files.
1294 ret = ret && FinishFile(output_image.get(), ret);
1295 ret = ret && FinishFile(output_oat.get(), ret);
Alex Light53cb16b2014-06-12 11:26:29 -07001296 } else if (have_oat_files) {
1297 TimingLogger::ScopedTiming pt("patch oat", &timings);
Igor Murashkin46774762014-10-22 11:37:02 -07001298 ret = PatchOat::Patch(input_oat.get(), base_delta, output_oat.get(), &timings,
1299 output_oat_fd >= 0, // was it opened from FD?
1300 new_oat_out);
Andreas Gampe4303ba92014-11-06 01:00:46 -08001301 ret = ret && FinishFile(output_oat.get(), ret);
Igor Murashkin46774762014-10-22 11:37:02 -07001302 } else if (have_image_files) {
Alex Light53cb16b2014-06-12 11:26:29 -07001303 TimingLogger::ScopedTiming pt("patch image", &timings);
Alex Lighteefbe392014-07-08 09:53:18 -07001304 ret = PatchOat::Patch(input_image_location, base_delta, output_image.get(), isa, &timings);
Andreas Gampe4303ba92014-11-06 01:00:46 -08001305 ret = ret && FinishFile(output_image.get(), ret);
Igor Murashkin46774762014-10-22 11:37:02 -07001306 } else {
1307 CHECK(false);
1308 ret = true;
1309 }
1310
1311 if (kIsDebugBuild) {
1312 LOG(INFO) << "Exiting with return ... " << ret;
Alex Light53cb16b2014-06-12 11:26:29 -07001313 }
1314 cleanup(ret);
Alex Light53cb16b2014-06-12 11:26:29 -07001315 return (ret) ? EXIT_SUCCESS : EXIT_FAILURE;
1316}
1317
1318} // namespace art
1319
1320int main(int argc, char **argv) {
1321 return art::patchoat(argc, argv);
1322}