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