blob: 0f0e33c8ba391e322f53f5ad1b3bf49c70516c3b [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
2 * Copyright (C) 2011 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 */
Brian Carlstrome24fa612011-09-29 00:53:55 -070016
17#include "oat_file.h"
18
Brian Carlstrom700c8d32012-11-05 10:42:02 -080019#include <dlfcn.h>
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070020#include <sstream>
Calin Juravle4e1d5792014-07-15 23:56:47 +010021#include <string.h>
Andreas Gampedaab38c2014-09-12 18:38:24 -070022#include <unistd.h>
Brian Carlstrom700c8d32012-11-05 10:42:02 -080023
Brian Carlstromba150c32013-08-27 17:31:03 -070024#include "base/bit_vector.h"
Elliott Hughes1aa246d2012-12-13 09:29:36 -080025#include "base/stl_util.h"
Elliott Hughes76160052012-12-12 16:31:20 -080026#include "base/unix_file/fd_file.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080027#include "elf_file.h"
Alex Light84d76052014-08-22 17:49:35 -070028#include "elf_utils.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080029#include "oat.h"
Brian Carlstromea46f952013-07-30 01:26:50 -070030#include "mirror/art_method.h"
31#include "mirror/art_method-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080032#include "mirror/class.h"
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070033#include "mirror/object-inl.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070034#include "os.h"
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070035#include "runtime.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080036#include "utils.h"
Ian Rogers1809a722013-08-09 22:05:32 -070037#include "vmap_table.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070038
39namespace art {
40
Brian Carlstrom700c8d32012-11-05 10:42:02 -080041void OatFile::CheckLocation(const std::string& location) {
Brian Carlstrom7a967b32012-03-28 15:23:10 -070042 CHECK(!location.empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -080043}
44
Alex Light84d76052014-08-22 17:49:35 -070045OatFile* OatFile::OpenWithElfFile(ElfFile* elf_file,
46 const std::string& location,
47 std::string* error_msg) {
48 std::unique_ptr<OatFile> oat_file(new OatFile(location, false));
49 oat_file->elf_file_.reset(elf_file);
Tong Shen62d1ca32014-09-03 17:24:56 -070050 uint64_t offset, size;
51 bool has_section = elf_file->GetSectionOffsetAndSize(".rodata", &offset, &size);
52 CHECK(has_section);
53 oat_file->begin_ = elf_file->Begin() + offset;
54 oat_file->end_ = elf_file->Begin() + size + offset;
Alex Light84d76052014-08-22 17:49:35 -070055 return oat_file->Setup(error_msg) ? oat_file.release() : nullptr;
56}
57
Brian Carlstrom265091e2013-01-30 14:08:26 -080058OatFile* OatFile::OpenMemory(std::vector<uint8_t>& oat_contents,
Ian Rogers8d31bbd2013-10-13 10:44:14 -070059 const std::string& location,
60 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -080061 CHECK(!oat_contents.empty()) << location;
62 CheckLocation(location);
Alex Light9dcc4572014-08-14 14:16:26 -070063 std::unique_ptr<OatFile> oat_file(new OatFile(location, false));
Brian Carlstrom700c8d32012-11-05 10:42:02 -080064 oat_file->begin_ = &oat_contents[0];
65 oat_file->end_ = &oat_contents[oat_contents.size()];
Ian Rogers8d31bbd2013-10-13 10:44:14 -070066 return oat_file->Setup(error_msg) ? oat_file.release() : nullptr;
Brian Carlstrom700c8d32012-11-05 10:42:02 -080067}
68
69OatFile* OatFile::Open(const std::string& filename,
70 const std::string& location,
Ian Rogers13735952014-10-08 12:43:28 -070071 uint8_t* requested_base,
Ian Rogers8d31bbd2013-10-13 10:44:14 -070072 bool executable,
73 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -080074 CHECK(!filename.empty()) << location;
Andreas Gampe7ba64962014-10-23 11:37:40 -070075 CheckLocation(location);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070076 std::unique_ptr<OatFile> ret;
77 if (kUsePortableCompiler && executable) {
Ian Rogersef7d42f2014-01-06 12:55:46 -080078 // If we are using PORTABLE, use dlopen to deal with relocations.
79 //
80 // We use our own ELF loader for Quick to deal with legacy apps that
81 // open a generated dex file by name, remove the file, then open
82 // another generated dex file with the same name. http://b/10614658
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070083 ret.reset(OpenDlopen(filename, location, requested_base, error_msg));
84 } else {
85 // If we aren't trying to execute, we just use our own ElfFile loader for a couple reasons:
86 //
87 // On target, dlopen may fail when compiling due to selinux restrictions on installd.
88 //
89 // On host, dlopen is expected to fail when cross compiling, so fall back to OpenElfFile.
90 // This won't work for portable runtime execution because it doesn't process relocations.
91 std::unique_ptr<File> file(OS::OpenFileForReading(filename.c_str()));
92 if (file.get() == NULL) {
93 *error_msg = StringPrintf("Failed to open oat filename for reading: %s", strerror(errno));
94 return nullptr;
Ian Rogersef7d42f2014-01-06 12:55:46 -080095 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070096 ret.reset(OpenElfFile(file.get(), location, requested_base, false, executable, error_msg));
Andreas Gampedaab38c2014-09-12 18:38:24 -070097
Andreas Gampe9ef2b6c2014-09-15 22:25:24 -070098 // It would be nice to unlink here. But we might have opened the file created by the
99 // ScopedLock, which we better not delete to avoid races. TODO: Investigate how to fix the API
100 // to allow removal when we know the ELF must be borked.
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800101 }
Dave Allison69dfe512014-07-11 17:11:58 +0000102 return ret.release();
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800103}
104
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700105OatFile* OatFile::OpenWritable(File* file, const std::string& location, std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800106 CheckLocation(location);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700107 return OpenElfFile(file, location, NULL, true, false, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800108}
109
Alex Lighta59dd802014-07-02 16:28:08 -0700110OatFile* OatFile::OpenReadable(File* file, const std::string& location, std::string* error_msg) {
111 CheckLocation(location);
112 return OpenElfFile(file, location, NULL, false, false, error_msg);
113}
114
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800115OatFile* OatFile::OpenDlopen(const std::string& elf_filename,
116 const std::string& location,
Ian Rogers13735952014-10-08 12:43:28 -0700117 uint8_t* requested_base,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700118 std::string* error_msg) {
Alex Light9dcc4572014-08-14 14:16:26 -0700119 std::unique_ptr<OatFile> oat_file(new OatFile(location, true));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700120 bool success = oat_file->Dlopen(elf_filename, requested_base, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800121 if (!success) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700122 return nullptr;
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800123 }
124 return oat_file.release();
125}
126
127OatFile* OatFile::OpenElfFile(File* file,
128 const std::string& location,
Ian Rogers13735952014-10-08 12:43:28 -0700129 uint8_t* requested_base,
Brian Carlstromf1d34552013-07-12 20:22:23 -0700130 bool writable,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700131 bool executable,
132 std::string* error_msg) {
Alex Light9dcc4572014-08-14 14:16:26 -0700133 std::unique_ptr<OatFile> oat_file(new OatFile(location, executable));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700134 bool success = oat_file->ElfFileOpen(file, requested_base, writable, executable, error_msg);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700135 if (!success) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700136 CHECK(!error_msg->empty());
137 return nullptr;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700138 }
139 return oat_file.release();
140}
141
Alex Light9dcc4572014-08-14 14:16:26 -0700142OatFile::OatFile(const std::string& location, bool is_executable)
143 : location_(location), begin_(NULL), end_(NULL), is_executable_(is_executable),
144 dlopen_handle_(NULL),
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100145 secondary_lookup_lock_("OatFile secondary lookup lock", kOatFileSecondaryLookupLock) {
Brian Carlstroma004aa92012-02-08 18:05:09 -0800146 CHECK(!location_.empty());
147}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700148
149OatFile::~OatFile() {
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100150 STLDeleteElements(&oat_dex_files_storage_);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800151 if (dlopen_handle_ != NULL) {
152 dlclose(dlopen_handle_);
153 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700154}
155
Ian Rogers13735952014-10-08 12:43:28 -0700156bool OatFile::Dlopen(const std::string& elf_filename, uint8_t* requested_base,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700157 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800158 char* absolute_path = realpath(elf_filename.c_str(), NULL);
159 if (absolute_path == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700160 *error_msg = StringPrintf("Failed to find absolute path for '%s'", elf_filename.c_str());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700161 return false;
162 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800163 dlopen_handle_ = dlopen(absolute_path, RTLD_NOW);
164 free(absolute_path);
165 if (dlopen_handle_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700166 *error_msg = StringPrintf("Failed to dlopen '%s': %s", elf_filename.c_str(), dlerror());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700167 return false;
168 }
Ian Rogers13735952014-10-08 12:43:28 -0700169 begin_ = reinterpret_cast<uint8_t*>(dlsym(dlopen_handle_, "oatdata"));
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800170 if (begin_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700171 *error_msg = StringPrintf("Failed to find oatdata symbol in '%s': %s", elf_filename.c_str(),
172 dlerror());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800173 return false;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700174 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800175 if (requested_base != NULL && begin_ != requested_base) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700176 *error_msg = StringPrintf("Failed to find oatdata symbol at expected address: "
177 "oatdata=%p != expected=%p /proc/self/maps:\n",
178 begin_, requested_base);
179 ReadFileToString("/proc/self/maps", error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800180 return false;
181 }
Ian Rogers13735952014-10-08 12:43:28 -0700182 end_ = reinterpret_cast<uint8_t*>(dlsym(dlopen_handle_, "oatlastword"));
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800183 if (end_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700184 *error_msg = StringPrintf("Failed to find oatlastword symbol in '%s': %s", elf_filename.c_str(),
185 dlerror());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800186 return false;
187 }
188 // Readjust to be non-inclusive upper bound.
189 end_ += sizeof(uint32_t);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700190 return Setup(error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800191}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700192
Ian Rogers13735952014-10-08 12:43:28 -0700193bool OatFile::ElfFileOpen(File* file, uint8_t* requested_base, bool writable, bool executable,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700194 std::string* error_msg) {
195 elf_file_.reset(ElfFile::Open(file, writable, true, error_msg));
196 if (elf_file_.get() == nullptr) {
197 DCHECK(!error_msg->empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800198 return false;
199 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700200 bool loaded = elf_file_->Load(executable, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800201 if (!loaded) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700202 DCHECK(!error_msg->empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800203 return false;
204 }
205 begin_ = elf_file_->FindDynamicSymbolAddress("oatdata");
206 if (begin_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700207 *error_msg = StringPrintf("Failed to find oatdata symbol in '%s'", file->GetPath().c_str());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800208 return false;
209 }
210 if (requested_base != NULL && begin_ != requested_base) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700211 *error_msg = StringPrintf("Failed to find oatdata symbol at expected address: "
212 "oatdata=%p != expected=%p /proc/self/maps:\n",
213 begin_, requested_base);
214 ReadFileToString("/proc/self/maps", error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800215 return false;
216 }
217 end_ = elf_file_->FindDynamicSymbolAddress("oatlastword");
218 if (end_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700219 *error_msg = StringPrintf("Failed to find oatlastword symbol in '%s'", file->GetPath().c_str());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800220 return false;
221 }
222 // Readjust to be non-inclusive upper bound.
223 end_ += sizeof(uint32_t);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700224 return Setup(error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800225}
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800226
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700227bool OatFile::Setup(std::string* error_msg) {
Brian Carlstromf1b30302013-03-28 10:35:32 -0700228 if (!GetOatHeader().IsValid()) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700229 *error_msg = StringPrintf("Invalid oat magic for '%s'", GetLocation().c_str());
Brian Carlstromf1b30302013-03-28 10:35:32 -0700230 return false;
231 }
Ian Rogers13735952014-10-08 12:43:28 -0700232 const uint8_t* oat = Begin();
Brian Carlstrome24fa612011-09-29 00:53:55 -0700233 oat += sizeof(OatHeader);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700234 if (oat > End()) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700235 *error_msg = StringPrintf("In oat file '%s' found truncated OatHeader", GetLocation().c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700236 return false;
237 }
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700238
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700239 oat += GetOatHeader().GetKeyValueStoreSize();
Brian Carlstromfb331d72013-07-25 22:00:16 -0700240 if (oat > End()) {
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700241 *error_msg = StringPrintf("In oat file '%s' found truncated variable-size data: "
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700242 "%p + %zd + %ud <= %p", GetLocation().c_str(),
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700243 Begin(), sizeof(OatHeader), GetOatHeader().GetKeyValueStoreSize(),
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700244 End());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700245 return false;
246 }
247
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100248 uint32_t dex_file_count = GetOatHeader().GetDexFileCount();
249 oat_dex_files_storage_.reserve(dex_file_count);
250 for (size_t i = 0; i < dex_file_count; i++) {
Dmitry Petrochenko83bef922014-02-03 12:34:59 +0700251 uint32_t dex_file_location_size = *reinterpret_cast<const uint32_t*>(oat);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700252 if (UNLIKELY(dex_file_location_size == 0U)) {
253 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd with empty location name",
254 GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700255 return false;
256 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700257 oat += sizeof(dex_file_location_size);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700258 if (UNLIKELY(oat > End())) {
259 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd truncated after dex file "
260 "location size", GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700261 return false;
262 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700263
264 const char* dex_file_location_data = reinterpret_cast<const char*>(oat);
265 oat += dex_file_location_size;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700266 if (UNLIKELY(oat > End())) {
267 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd with truncated dex file "
268 "location", GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700269 return false;
270 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700271
272 std::string dex_file_location(dex_file_location_data, dex_file_location_size);
273
274 uint32_t dex_file_checksum = *reinterpret_cast<const uint32_t*>(oat);
275 oat += sizeof(dex_file_checksum);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700276 if (UNLIKELY(oat > End())) {
277 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' truncated after "
278 "dex file checksum", GetLocation().c_str(), i,
279 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700280 return false;
281 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700282
Brian Carlstrom89521892011-12-07 22:05:07 -0800283 uint32_t dex_file_offset = *reinterpret_cast<const uint32_t*>(oat);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700284 if (UNLIKELY(dex_file_offset == 0U)) {
285 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with zero dex "
286 "file offset", GetLocation().c_str(), i, dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700287 return false;
288 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700289 if (UNLIKELY(dex_file_offset > Size())) {
290 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with dex file "
291 "offset %ud > %zd", GetLocation().c_str(), i,
292 dex_file_location.c_str(), dex_file_offset, Size());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700293 return false;
294 }
Brian Carlstrom89521892011-12-07 22:05:07 -0800295 oat += sizeof(dex_file_offset);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700296 if (UNLIKELY(oat > End())) {
297 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' truncated "
298 " after dex file offsets", GetLocation().c_str(), i,
299 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700300 return false;
301 }
Brian Carlstrom89521892011-12-07 22:05:07 -0800302
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800303 const uint8_t* dex_file_pointer = Begin() + dex_file_offset;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700304 if (UNLIKELY(!DexFile::IsMagicValid(dex_file_pointer))) {
305 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with invalid "
306 " dex file magic '%s'", GetLocation().c_str(), i,
307 dex_file_location.c_str(), dex_file_pointer);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700308 return false;
309 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700310 if (UNLIKELY(!DexFile::IsVersionValid(dex_file_pointer))) {
311 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with invalid "
312 " dex file version '%s'", GetLocation().c_str(), i,
313 dex_file_location.c_str(), dex_file_pointer);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700314 return false;
315 }
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800316 const DexFile::Header* header = reinterpret_cast<const DexFile::Header*>(dex_file_pointer);
317 const uint32_t* methods_offsets_pointer = reinterpret_cast<const uint32_t*>(oat);
Brian Carlstrom89521892011-12-07 22:05:07 -0800318
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800319 oat += (sizeof(*methods_offsets_pointer) * header->class_defs_size_);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700320 if (UNLIKELY(oat > End())) {
321 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with truncated "
322 " method offsets", GetLocation().c_str(), i,
323 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700324 return false;
325 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700326
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100327 std::string canonical_location = DexFile::GetDexCanonicalLocation(dex_file_location.c_str());
328
329 // Create the OatDexFile and add it to the owning container.
Vladimir Marko539690a2014-06-05 18:36:42 +0100330 OatDexFile* oat_dex_file = new OatDexFile(this,
331 dex_file_location,
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100332 canonical_location,
Vladimir Marko539690a2014-06-05 18:36:42 +0100333 dex_file_checksum,
334 dex_file_pointer,
335 methods_offsets_pointer);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100336 oat_dex_files_storage_.push_back(oat_dex_file);
337
338 // Add the location and canonical location (if different) to the oat_dex_files_ table.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100339 StringPiece key(oat_dex_file->GetDexFileLocation());
Vladimir Marko539690a2014-06-05 18:36:42 +0100340 oat_dex_files_.Put(key, oat_dex_file);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100341 if (canonical_location != dex_file_location) {
342 StringPiece canonical_key(oat_dex_file->GetCanonicalDexFileLocation());
343 oat_dex_files_.Put(canonical_key, oat_dex_file);
344 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700345 }
Brian Carlstromf1b30302013-03-28 10:35:32 -0700346 return true;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700347}
348
349const OatHeader& OatFile::GetOatHeader() const {
Ian Rogers30fab402012-01-23 15:43:46 -0800350 return *reinterpret_cast<const OatHeader*>(Begin());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700351}
352
Ian Rogers13735952014-10-08 12:43:28 -0700353const uint8_t* OatFile::Begin() const {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800354 CHECK(begin_ != NULL);
355 return begin_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700356}
357
Ian Rogers13735952014-10-08 12:43:28 -0700358const uint8_t* OatFile::End() const {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800359 CHECK(end_ != NULL);
360 return end_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700361}
362
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700363const OatFile::OatDexFile* OatFile::GetOatDexFile(const char* dex_location,
364 const uint32_t* dex_location_checksum,
Ian Rogers7fe2c692011-12-06 16:35:59 -0800365 bool warn_if_not_found) const {
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100366 // NOTE: We assume here that the canonical location for a given dex_location never
367 // changes. If it does (i.e. some symlink used by the filename changes) we may return
368 // an incorrect OatDexFile. As long as we have a checksum to check, we shall return
369 // an identical file or fail; otherwise we may see some unpredictable failures.
Calin Juravle4e1d5792014-07-15 23:56:47 +0100370
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100371 // TODO: Additional analysis of usage patterns to see if this can be simplified
372 // without any performance loss, for example by not doing the first lock-free lookup.
373
374 const OatFile::OatDexFile* oat_dex_file = nullptr;
375 StringPiece key(dex_location);
376 // Try to find the key cheaply in the oat_dex_files_ map which holds dex locations
377 // directly mentioned in the oat file and doesn't require locking.
378 auto primary_it = oat_dex_files_.find(key);
379 if (primary_it != oat_dex_files_.end()) {
380 oat_dex_file = primary_it->second;
381 DCHECK(oat_dex_file != nullptr);
382 } else {
383 // This dex_location is not one of the dex locations directly mentioned in the
384 // oat file. The correct lookup is via the canonical location but first see in
385 // the secondary_oat_dex_files_ whether we've looked up this location before.
386 MutexLock mu(Thread::Current(), secondary_lookup_lock_);
387 auto secondary_lb = secondary_oat_dex_files_.lower_bound(key);
388 if (secondary_lb != secondary_oat_dex_files_.end() && key == secondary_lb->first) {
389 oat_dex_file = secondary_lb->second; // May be nullptr.
390 } else {
391 // We haven't seen this dex_location before, we must check the canonical location.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100392 std::string dex_canonical_location = DexFile::GetDexCanonicalLocation(dex_location);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100393 if (dex_canonical_location != dex_location) {
394 StringPiece canonical_key(dex_canonical_location);
395 auto canonical_it = oat_dex_files_.find(canonical_key);
396 if (canonical_it != oat_dex_files_.end()) {
397 oat_dex_file = canonical_it->second;
398 } // else keep nullptr.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100399 } // else keep nullptr.
400
401 // Copy the key to the string_cache_ and store the result in secondary map.
402 string_cache_.emplace_back(key.data(), key.length());
403 StringPiece key_copy(string_cache_.back());
404 secondary_oat_dex_files_.PutBefore(secondary_lb, key_copy, oat_dex_file);
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700405 }
406 }
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100407 if (oat_dex_file != nullptr &&
408 (dex_location_checksum == nullptr ||
409 oat_dex_file->GetDexFileLocationChecksum() == *dex_location_checksum)) {
410 return oat_dex_file;
411 }
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700412
413 if (warn_if_not_found) {
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100414 std::string dex_canonical_location = DexFile::GetDexCanonicalLocation(dex_location);
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800415 std::string checksum("<unspecified>");
416 if (dex_location_checksum != NULL) {
417 checksum = StringPrintf("0x%08x", *dex_location_checksum);
418 }
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700419 LOG(WARNING) << "Failed to find OatDexFile for DexFile " << dex_location
Calin Juravle4e1d5792014-07-15 23:56:47 +0100420 << " ( canonical path " << dex_canonical_location << ")"
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800421 << " with checksum " << checksum << " in OatFile " << GetLocation();
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700422 if (kIsDebugBuild) {
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100423 for (const OatDexFile* odf : oat_dex_files_storage_) {
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700424 LOG(WARNING) << "OatFile " << GetLocation()
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100425 << " contains OatDexFile " << odf->GetDexFileLocation()
426 << " (canonical path " << odf->GetCanonicalDexFileLocation() << ")"
427 << " with checksum 0x" << std::hex << odf->GetDexFileLocationChecksum();
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700428 }
Ian Rogers7fe2c692011-12-06 16:35:59 -0800429 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700430 }
Calin Juravle4e1d5792014-07-15 23:56:47 +0100431
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700432 return NULL;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700433}
434
Brian Carlstrome24fa612011-09-29 00:53:55 -0700435OatFile::OatDexFile::OatDexFile(const OatFile* oat_file,
Elliott Hughesaa6a5882012-01-13 19:39:16 -0800436 const std::string& dex_file_location,
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100437 const std::string& canonical_dex_file_location,
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800438 uint32_t dex_file_location_checksum,
Ian Rogers13735952014-10-08 12:43:28 -0700439 const uint8_t* dex_file_pointer,
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800440 const uint32_t* oat_class_offsets_pointer)
Brian Carlstrome24fa612011-09-29 00:53:55 -0700441 : oat_file_(oat_file),
442 dex_file_location_(dex_file_location),
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100443 canonical_dex_file_location_(canonical_dex_file_location),
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800444 dex_file_location_checksum_(dex_file_location_checksum),
Brian Carlstrom89521892011-12-07 22:05:07 -0800445 dex_file_pointer_(dex_file_pointer),
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800446 oat_class_offsets_pointer_(oat_class_offsets_pointer) {}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700447
448OatFile::OatDexFile::~OatDexFile() {}
449
Ian Rogers05f28c62012-10-23 18:12:13 -0700450size_t OatFile::OatDexFile::FileSize() const {
451 return reinterpret_cast<const DexFile::Header*>(dex_file_pointer_)->file_size_;
452}
453
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700454const DexFile* OatFile::OatDexFile::OpenDexFile(std::string* error_msg) const {
Ian Rogers05f28c62012-10-23 18:12:13 -0700455 return DexFile::Open(dex_file_pointer_, FileSize(), dex_file_location_,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700456 dex_file_location_checksum_, error_msg);
Brian Carlstrom89521892011-12-07 22:05:07 -0800457}
458
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700459uint32_t OatFile::OatDexFile::GetOatClassOffset(uint16_t class_def_index) const {
460 return oat_class_offsets_pointer_[class_def_index];
461}
462
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100463OatFile::OatClass OatFile::OatDexFile::GetOatClass(uint16_t class_def_index) const {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700464 uint32_t oat_class_offset = GetOatClassOffset(class_def_index);
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800465
Ian Rogers13735952014-10-08 12:43:28 -0700466 const uint8_t* oat_class_pointer = oat_file_->Begin() + oat_class_offset;
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700467 CHECK_LT(oat_class_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800468
Ian Rogers13735952014-10-08 12:43:28 -0700469 const uint8_t* status_pointer = oat_class_pointer;
Brian Carlstromba150c32013-08-27 17:31:03 -0700470 CHECK_LT(status_pointer, oat_file_->End()) << oat_file_->GetLocation();
471 mirror::Class::Status status =
472 static_cast<mirror::Class::Status>(*reinterpret_cast<const int16_t*>(status_pointer));
473 CHECK_LT(status, mirror::Class::kStatusMax);
474
Ian Rogers13735952014-10-08 12:43:28 -0700475 const uint8_t* type_pointer = status_pointer + sizeof(uint16_t);
Brian Carlstromba150c32013-08-27 17:31:03 -0700476 CHECK_LT(type_pointer, oat_file_->End()) << oat_file_->GetLocation();
477 OatClassType type = static_cast<OatClassType>(*reinterpret_cast<const uint16_t*>(type_pointer));
478 CHECK_LT(type, kOatClassMax);
479
Ian Rogers13735952014-10-08 12:43:28 -0700480 const uint8_t* after_type_pointer = type_pointer + sizeof(int16_t);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800481 CHECK_LE(after_type_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstromba150c32013-08-27 17:31:03 -0700482
Brian Carlstromcd937a92014-03-04 22:53:23 -0800483 uint32_t bitmap_size = 0;
Ian Rogers13735952014-10-08 12:43:28 -0700484 const uint8_t* bitmap_pointer = nullptr;
485 const uint8_t* methods_pointer = nullptr;
Ian Rogers97b52f82014-08-14 11:34:07 -0700486 if (type != kOatClassNoneCompiled) {
487 if (type == kOatClassSomeCompiled) {
488 bitmap_size = static_cast<uint32_t>(*reinterpret_cast<const uint32_t*>(after_type_pointer));
489 bitmap_pointer = after_type_pointer + sizeof(bitmap_size);
490 CHECK_LE(bitmap_pointer, oat_file_->End()) << oat_file_->GetLocation();
491 methods_pointer = bitmap_pointer + bitmap_size;
492 } else {
493 methods_pointer = after_type_pointer;
494 }
495 CHECK_LE(methods_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstromcd937a92014-03-04 22:53:23 -0800496 }
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800497
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100498 return OatClass(oat_file_,
499 status,
500 type,
501 bitmap_size,
502 reinterpret_cast<const uint32_t*>(bitmap_pointer),
503 reinterpret_cast<const OatMethodOffsets*>(methods_pointer));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700504}
505
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800506OatFile::OatClass::OatClass(const OatFile* oat_file,
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800507 mirror::Class::Status status,
Brian Carlstromba150c32013-08-27 17:31:03 -0700508 OatClassType type,
509 uint32_t bitmap_size,
510 const uint32_t* bitmap_pointer,
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800511 const OatMethodOffsets* methods_pointer)
Brian Carlstromba150c32013-08-27 17:31:03 -0700512 : oat_file_(oat_file), status_(status), type_(type),
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100513 bitmap_(bitmap_pointer), methods_pointer_(methods_pointer) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700514 switch (type_) {
515 case kOatClassAllCompiled: {
516 CHECK_EQ(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800517 CHECK(bitmap_pointer == nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700518 CHECK(methods_pointer != nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700519 break;
520 }
521 case kOatClassSomeCompiled: {
522 CHECK_NE(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800523 CHECK(bitmap_pointer != nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700524 CHECK(methods_pointer != nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700525 break;
526 }
527 case kOatClassNoneCompiled: {
528 CHECK_EQ(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800529 CHECK(bitmap_pointer == nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700530 CHECK(methods_pointer_ == nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700531 break;
532 }
533 case kOatClassMax: {
534 LOG(FATAL) << "Invalid OatClassType " << type_;
535 break;
536 }
537 }
538}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700539
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700540uint32_t OatFile::OatClass::GetOatMethodOffsetsOffset(uint32_t method_index) const {
541 const OatMethodOffsets* oat_method_offsets = GetOatMethodOffsets(method_index);
542 if (oat_method_offsets == nullptr) {
543 return 0u;
544 }
545 return reinterpret_cast<const uint8_t*>(oat_method_offsets) - oat_file_->Begin();
546}
547
548const OatMethodOffsets* OatFile::OatClass::GetOatMethodOffsets(uint32_t method_index) const {
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100549 // NOTE: We don't keep the number of methods and cannot do a bounds check for method_index.
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700550 if (methods_pointer_ == nullptr) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700551 CHECK_EQ(kOatClassNoneCompiled, type_);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700552 return nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -0700553 }
554 size_t methods_pointer_index;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700555 if (bitmap_ == nullptr) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700556 CHECK_EQ(kOatClassAllCompiled, type_);
557 methods_pointer_index = method_index;
558 } else {
559 CHECK_EQ(kOatClassSomeCompiled, type_);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100560 if (!BitVector::IsBitSet(bitmap_, method_index)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700561 return nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -0700562 }
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100563 size_t num_set_bits = BitVector::NumSetBits(bitmap_, method_index);
564 methods_pointer_index = num_set_bits;
Brian Carlstromba150c32013-08-27 17:31:03 -0700565 }
566 const OatMethodOffsets& oat_method_offsets = methods_pointer_[methods_pointer_index];
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700567 return &oat_method_offsets;
568}
569
570const OatFile::OatMethod OatFile::OatClass::GetOatMethod(uint32_t method_index) const {
571 const OatMethodOffsets* oat_method_offsets = GetOatMethodOffsets(method_index);
572 if (oat_method_offsets == nullptr) {
573 return OatMethod(nullptr, 0, 0);
574 }
575 if (oat_file_->IsExecutable() ||
576 Runtime::Current() == nullptr || // This case applies for oatdump.
577 Runtime::Current()->IsCompiler()) {
Alex Light9dcc4572014-08-14 14:16:26 -0700578 return OatMethod(
579 oat_file_->Begin(),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700580 oat_method_offsets->code_offset_,
581 oat_method_offsets->gc_map_offset_);
Alex Light9dcc4572014-08-14 14:16:26 -0700582 } else {
583 // We aren't allowed to use the compiled code. We just force it down the interpreted version.
584 return OatMethod(oat_file_->Begin(), 0, 0);
585 }
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700586}
587
Brian Carlstromea46f952013-07-30 01:26:50 -0700588void OatFile::OatMethod::LinkMethod(mirror::ArtMethod* method) const {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700589 CHECK(method != NULL);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800590 method->SetEntryPointFromPortableCompiledCode(GetPortableCode());
591 method->SetEntryPointFromQuickCompiledCode(GetQuickCode());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700592 method->SetNativeGcMap(GetNativeGcMap()); // Used by native methods in work around JNI mode.
Brian Carlstromae826982011-11-09 01:33:42 -0800593}
594
Andreas Gampe7ba64962014-10-23 11:37:40 -0700595bool OatFile::IsPic() const {
596 const char* pic_string = GetOatHeader().GetStoreValueByKey(OatHeader::kPicKey);
597 return (pic_string != nullptr && strncmp(pic_string, "true", 5) == 0);
598 // TODO: Check against oat_patches. b/18144996
599}
600
Brian Carlstrome24fa612011-09-29 00:53:55 -0700601} // namespace art