blob: 91e571b7c36bc47b86df9bfb25382b1b34df41cd [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,
Igor Murashkin46774762014-10-22 11:37:02 -070072 uint8_t* oat_file_begin,
Ian Rogers8d31bbd2013-10-13 10:44:14 -070073 bool executable,
74 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -080075 CHECK(!filename.empty()) << location;
Andreas Gampe7ba64962014-10-23 11:37:40 -070076 CheckLocation(location);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070077 std::unique_ptr<OatFile> ret;
78 if (kUsePortableCompiler && executable) {
Ian Rogersef7d42f2014-01-06 12:55:46 -080079 // If we are using PORTABLE, use dlopen to deal with relocations.
80 //
81 // We use our own ELF loader for Quick to deal with legacy apps that
82 // open a generated dex file by name, remove the file, then open
83 // another generated dex file with the same name. http://b/10614658
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070084 ret.reset(OpenDlopen(filename, location, requested_base, error_msg));
85 } else {
86 // If we aren't trying to execute, we just use our own ElfFile loader for a couple reasons:
87 //
88 // On target, dlopen may fail when compiling due to selinux restrictions on installd.
89 //
90 // On host, dlopen is expected to fail when cross compiling, so fall back to OpenElfFile.
91 // This won't work for portable runtime execution because it doesn't process relocations.
92 std::unique_ptr<File> file(OS::OpenFileForReading(filename.c_str()));
93 if (file.get() == NULL) {
94 *error_msg = StringPrintf("Failed to open oat filename for reading: %s", strerror(errno));
95 return nullptr;
Ian Rogersef7d42f2014-01-06 12:55:46 -080096 }
Igor Murashkin46774762014-10-22 11:37:02 -070097 ret.reset(OpenElfFile(file.get(), location, requested_base, oat_file_begin, false, executable,
98 error_msg));
Andreas Gampedaab38c2014-09-12 18:38:24 -070099
Andreas Gampe9ef2b6c2014-09-15 22:25:24 -0700100 // It would be nice to unlink here. But we might have opened the file created by the
101 // ScopedLock, which we better not delete to avoid races. TODO: Investigate how to fix the API
102 // to allow removal when we know the ELF must be borked.
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800103 }
Dave Allison69dfe512014-07-11 17:11:58 +0000104 return ret.release();
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800105}
106
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700107OatFile* OatFile::OpenWritable(File* file, const std::string& location, std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800108 CheckLocation(location);
Igor Murashkin46774762014-10-22 11:37:02 -0700109 return OpenElfFile(file, location, nullptr, nullptr, true, false, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800110}
111
Alex Lighta59dd802014-07-02 16:28:08 -0700112OatFile* OatFile::OpenReadable(File* file, const std::string& location, std::string* error_msg) {
113 CheckLocation(location);
Igor Murashkin46774762014-10-22 11:37:02 -0700114 return OpenElfFile(file, location, nullptr, nullptr, false, false, error_msg);
Alex Lighta59dd802014-07-02 16:28:08 -0700115}
116
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800117OatFile* OatFile::OpenDlopen(const std::string& elf_filename,
118 const std::string& location,
Ian Rogers13735952014-10-08 12:43:28 -0700119 uint8_t* requested_base,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700120 std::string* error_msg) {
Alex Light9dcc4572014-08-14 14:16:26 -0700121 std::unique_ptr<OatFile> oat_file(new OatFile(location, true));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700122 bool success = oat_file->Dlopen(elf_filename, requested_base, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800123 if (!success) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700124 return nullptr;
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800125 }
126 return oat_file.release();
127}
128
129OatFile* OatFile::OpenElfFile(File* file,
130 const std::string& location,
Ian Rogers13735952014-10-08 12:43:28 -0700131 uint8_t* requested_base,
Igor Murashkin46774762014-10-22 11:37:02 -0700132 uint8_t* oat_file_begin,
Brian Carlstromf1d34552013-07-12 20:22:23 -0700133 bool writable,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700134 bool executable,
135 std::string* error_msg) {
Alex Light9dcc4572014-08-14 14:16:26 -0700136 std::unique_ptr<OatFile> oat_file(new OatFile(location, executable));
Igor Murashkin46774762014-10-22 11:37:02 -0700137 bool success = oat_file->ElfFileOpen(file, requested_base, oat_file_begin, writable, executable,
138 error_msg);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700139 if (!success) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700140 CHECK(!error_msg->empty());
141 return nullptr;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700142 }
143 return oat_file.release();
144}
145
Alex Light9dcc4572014-08-14 14:16:26 -0700146OatFile::OatFile(const std::string& location, bool is_executable)
147 : location_(location), begin_(NULL), end_(NULL), is_executable_(is_executable),
148 dlopen_handle_(NULL),
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100149 secondary_lookup_lock_("OatFile secondary lookup lock", kOatFileSecondaryLookupLock) {
Brian Carlstroma004aa92012-02-08 18:05:09 -0800150 CHECK(!location_.empty());
151}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700152
153OatFile::~OatFile() {
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100154 STLDeleteElements(&oat_dex_files_storage_);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800155 if (dlopen_handle_ != NULL) {
156 dlclose(dlopen_handle_);
157 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700158}
159
Ian Rogers13735952014-10-08 12:43:28 -0700160bool OatFile::Dlopen(const std::string& elf_filename, uint8_t* requested_base,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700161 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800162 char* absolute_path = realpath(elf_filename.c_str(), NULL);
163 if (absolute_path == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700164 *error_msg = StringPrintf("Failed to find absolute path for '%s'", elf_filename.c_str());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700165 return false;
166 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800167 dlopen_handle_ = dlopen(absolute_path, RTLD_NOW);
168 free(absolute_path);
169 if (dlopen_handle_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700170 *error_msg = StringPrintf("Failed to dlopen '%s': %s", elf_filename.c_str(), dlerror());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700171 return false;
172 }
Ian Rogers13735952014-10-08 12:43:28 -0700173 begin_ = reinterpret_cast<uint8_t*>(dlsym(dlopen_handle_, "oatdata"));
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800174 if (begin_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700175 *error_msg = StringPrintf("Failed to find oatdata symbol in '%s': %s", elf_filename.c_str(),
176 dlerror());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800177 return false;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700178 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800179 if (requested_base != NULL && begin_ != requested_base) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700180 *error_msg = StringPrintf("Failed to find oatdata symbol at expected address: "
181 "oatdata=%p != expected=%p /proc/self/maps:\n",
182 begin_, requested_base);
183 ReadFileToString("/proc/self/maps", error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800184 return false;
185 }
Ian Rogers13735952014-10-08 12:43:28 -0700186 end_ = reinterpret_cast<uint8_t*>(dlsym(dlopen_handle_, "oatlastword"));
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800187 if (end_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700188 *error_msg = StringPrintf("Failed to find oatlastword symbol in '%s': %s", elf_filename.c_str(),
189 dlerror());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800190 return false;
191 }
192 // Readjust to be non-inclusive upper bound.
193 end_ += sizeof(uint32_t);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700194 return Setup(error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800195}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700196
Igor Murashkin46774762014-10-22 11:37:02 -0700197bool OatFile::ElfFileOpen(File* file, uint8_t* requested_base, uint8_t* oat_file_begin,
198 bool writable, bool executable,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700199 std::string* error_msg) {
Igor Murashkin46774762014-10-22 11:37:02 -0700200 // TODO: rename requested_base to oat_data_begin
201 elf_file_.reset(ElfFile::Open(file, writable, /*program_header_only*/true, error_msg,
202 oat_file_begin));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700203 if (elf_file_.get() == nullptr) {
204 DCHECK(!error_msg->empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800205 return false;
206 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700207 bool loaded = elf_file_->Load(executable, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800208 if (!loaded) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700209 DCHECK(!error_msg->empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800210 return false;
211 }
212 begin_ = elf_file_->FindDynamicSymbolAddress("oatdata");
213 if (begin_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700214 *error_msg = StringPrintf("Failed to find oatdata symbol in '%s'", file->GetPath().c_str());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800215 return false;
216 }
217 if (requested_base != NULL && begin_ != requested_base) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700218 *error_msg = StringPrintf("Failed to find oatdata symbol at expected address: "
219 "oatdata=%p != expected=%p /proc/self/maps:\n",
220 begin_, requested_base);
221 ReadFileToString("/proc/self/maps", error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800222 return false;
223 }
224 end_ = elf_file_->FindDynamicSymbolAddress("oatlastword");
225 if (end_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700226 *error_msg = StringPrintf("Failed to find oatlastword symbol in '%s'", file->GetPath().c_str());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800227 return false;
228 }
229 // Readjust to be non-inclusive upper bound.
230 end_ += sizeof(uint32_t);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700231 return Setup(error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800232}
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800233
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700234bool OatFile::Setup(std::string* error_msg) {
Brian Carlstromf1b30302013-03-28 10:35:32 -0700235 if (!GetOatHeader().IsValid()) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700236 *error_msg = StringPrintf("Invalid oat magic for '%s'", GetLocation().c_str());
Brian Carlstromf1b30302013-03-28 10:35:32 -0700237 return false;
238 }
Ian Rogers13735952014-10-08 12:43:28 -0700239 const uint8_t* oat = Begin();
Brian Carlstrome24fa612011-09-29 00:53:55 -0700240 oat += sizeof(OatHeader);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700241 if (oat > End()) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700242 *error_msg = StringPrintf("In oat file '%s' found truncated OatHeader", GetLocation().c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700243 return false;
244 }
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700245
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700246 oat += GetOatHeader().GetKeyValueStoreSize();
Brian Carlstromfb331d72013-07-25 22:00:16 -0700247 if (oat > End()) {
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700248 *error_msg = StringPrintf("In oat file '%s' found truncated variable-size data: "
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700249 "%p + %zd + %ud <= %p", GetLocation().c_str(),
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700250 Begin(), sizeof(OatHeader), GetOatHeader().GetKeyValueStoreSize(),
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700251 End());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700252 return false;
253 }
254
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100255 uint32_t dex_file_count = GetOatHeader().GetDexFileCount();
256 oat_dex_files_storage_.reserve(dex_file_count);
257 for (size_t i = 0; i < dex_file_count; i++) {
Dmitry Petrochenko83bef922014-02-03 12:34:59 +0700258 uint32_t dex_file_location_size = *reinterpret_cast<const uint32_t*>(oat);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700259 if (UNLIKELY(dex_file_location_size == 0U)) {
260 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd with empty location name",
261 GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700262 return false;
263 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700264 oat += sizeof(dex_file_location_size);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700265 if (UNLIKELY(oat > End())) {
266 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd truncated after dex file "
267 "location size", GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700268 return false;
269 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700270
271 const char* dex_file_location_data = reinterpret_cast<const char*>(oat);
272 oat += dex_file_location_size;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700273 if (UNLIKELY(oat > End())) {
274 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd with truncated dex file "
275 "location", GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700276 return false;
277 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700278
279 std::string dex_file_location(dex_file_location_data, dex_file_location_size);
280
281 uint32_t dex_file_checksum = *reinterpret_cast<const uint32_t*>(oat);
282 oat += sizeof(dex_file_checksum);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700283 if (UNLIKELY(oat > End())) {
284 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' truncated after "
285 "dex file checksum", GetLocation().c_str(), i,
286 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700287 return false;
288 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700289
Brian Carlstrom89521892011-12-07 22:05:07 -0800290 uint32_t dex_file_offset = *reinterpret_cast<const uint32_t*>(oat);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700291 if (UNLIKELY(dex_file_offset == 0U)) {
292 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with zero dex "
293 "file offset", GetLocation().c_str(), i, dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700294 return false;
295 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700296 if (UNLIKELY(dex_file_offset > Size())) {
297 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with dex file "
298 "offset %ud > %zd", GetLocation().c_str(), i,
299 dex_file_location.c_str(), dex_file_offset, Size());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700300 return false;
301 }
Brian Carlstrom89521892011-12-07 22:05:07 -0800302 oat += sizeof(dex_file_offset);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700303 if (UNLIKELY(oat > End())) {
304 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' truncated "
Brian Carlstrom37628b72014-10-28 13:54:26 -0700305 "after dex file offsets", GetLocation().c_str(), i,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700306 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700307 return false;
308 }
Brian Carlstrom89521892011-12-07 22:05:07 -0800309
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800310 const uint8_t* dex_file_pointer = Begin() + dex_file_offset;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700311 if (UNLIKELY(!DexFile::IsMagicValid(dex_file_pointer))) {
312 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with invalid "
Brian Carlstrom37628b72014-10-28 13:54:26 -0700313 "dex file magic '%s'", GetLocation().c_str(), i,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700314 dex_file_location.c_str(), dex_file_pointer);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700315 return false;
316 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700317 if (UNLIKELY(!DexFile::IsVersionValid(dex_file_pointer))) {
318 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with invalid "
Brian Carlstrom37628b72014-10-28 13:54:26 -0700319 "dex file version '%s'", GetLocation().c_str(), i,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700320 dex_file_location.c_str(), dex_file_pointer);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700321 return false;
322 }
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800323 const DexFile::Header* header = reinterpret_cast<const DexFile::Header*>(dex_file_pointer);
324 const uint32_t* methods_offsets_pointer = reinterpret_cast<const uint32_t*>(oat);
Brian Carlstrom89521892011-12-07 22:05:07 -0800325
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800326 oat += (sizeof(*methods_offsets_pointer) * header->class_defs_size_);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700327 if (UNLIKELY(oat > End())) {
328 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with truncated "
Brian Carlstrom37628b72014-10-28 13:54:26 -0700329 "method offsets", GetLocation().c_str(), i,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700330 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700331 return false;
332 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700333
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100334 std::string canonical_location = DexFile::GetDexCanonicalLocation(dex_file_location.c_str());
335
336 // Create the OatDexFile and add it to the owning container.
Vladimir Marko539690a2014-06-05 18:36:42 +0100337 OatDexFile* oat_dex_file = new OatDexFile(this,
338 dex_file_location,
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100339 canonical_location,
Vladimir Marko539690a2014-06-05 18:36:42 +0100340 dex_file_checksum,
341 dex_file_pointer,
342 methods_offsets_pointer);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100343 oat_dex_files_storage_.push_back(oat_dex_file);
344
345 // Add the location and canonical location (if different) to the oat_dex_files_ table.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100346 StringPiece key(oat_dex_file->GetDexFileLocation());
Vladimir Marko539690a2014-06-05 18:36:42 +0100347 oat_dex_files_.Put(key, oat_dex_file);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100348 if (canonical_location != dex_file_location) {
349 StringPiece canonical_key(oat_dex_file->GetCanonicalDexFileLocation());
350 oat_dex_files_.Put(canonical_key, oat_dex_file);
351 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700352 }
Brian Carlstromf1b30302013-03-28 10:35:32 -0700353 return true;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700354}
355
356const OatHeader& OatFile::GetOatHeader() const {
Ian Rogers30fab402012-01-23 15:43:46 -0800357 return *reinterpret_cast<const OatHeader*>(Begin());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700358}
359
Ian Rogers13735952014-10-08 12:43:28 -0700360const uint8_t* OatFile::Begin() const {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800361 CHECK(begin_ != NULL);
362 return begin_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700363}
364
Ian Rogers13735952014-10-08 12:43:28 -0700365const uint8_t* OatFile::End() const {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800366 CHECK(end_ != NULL);
367 return end_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700368}
369
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700370const OatFile::OatDexFile* OatFile::GetOatDexFile(const char* dex_location,
371 const uint32_t* dex_location_checksum,
Ian Rogers7fe2c692011-12-06 16:35:59 -0800372 bool warn_if_not_found) const {
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100373 // NOTE: We assume here that the canonical location for a given dex_location never
374 // changes. If it does (i.e. some symlink used by the filename changes) we may return
375 // an incorrect OatDexFile. As long as we have a checksum to check, we shall return
376 // an identical file or fail; otherwise we may see some unpredictable failures.
Calin Juravle4e1d5792014-07-15 23:56:47 +0100377
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100378 // TODO: Additional analysis of usage patterns to see if this can be simplified
379 // without any performance loss, for example by not doing the first lock-free lookup.
380
381 const OatFile::OatDexFile* oat_dex_file = nullptr;
382 StringPiece key(dex_location);
383 // Try to find the key cheaply in the oat_dex_files_ map which holds dex locations
384 // directly mentioned in the oat file and doesn't require locking.
385 auto primary_it = oat_dex_files_.find(key);
386 if (primary_it != oat_dex_files_.end()) {
387 oat_dex_file = primary_it->second;
388 DCHECK(oat_dex_file != nullptr);
389 } else {
390 // This dex_location is not one of the dex locations directly mentioned in the
391 // oat file. The correct lookup is via the canonical location but first see in
392 // the secondary_oat_dex_files_ whether we've looked up this location before.
393 MutexLock mu(Thread::Current(), secondary_lookup_lock_);
394 auto secondary_lb = secondary_oat_dex_files_.lower_bound(key);
395 if (secondary_lb != secondary_oat_dex_files_.end() && key == secondary_lb->first) {
396 oat_dex_file = secondary_lb->second; // May be nullptr.
397 } else {
398 // We haven't seen this dex_location before, we must check the canonical location.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100399 std::string dex_canonical_location = DexFile::GetDexCanonicalLocation(dex_location);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100400 if (dex_canonical_location != dex_location) {
401 StringPiece canonical_key(dex_canonical_location);
402 auto canonical_it = oat_dex_files_.find(canonical_key);
403 if (canonical_it != oat_dex_files_.end()) {
404 oat_dex_file = canonical_it->second;
405 } // else keep nullptr.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100406 } // else keep nullptr.
407
408 // Copy the key to the string_cache_ and store the result in secondary map.
409 string_cache_.emplace_back(key.data(), key.length());
410 StringPiece key_copy(string_cache_.back());
411 secondary_oat_dex_files_.PutBefore(secondary_lb, key_copy, oat_dex_file);
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700412 }
413 }
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100414 if (oat_dex_file != nullptr &&
415 (dex_location_checksum == nullptr ||
416 oat_dex_file->GetDexFileLocationChecksum() == *dex_location_checksum)) {
417 return oat_dex_file;
418 }
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700419
420 if (warn_if_not_found) {
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100421 std::string dex_canonical_location = DexFile::GetDexCanonicalLocation(dex_location);
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800422 std::string checksum("<unspecified>");
423 if (dex_location_checksum != NULL) {
424 checksum = StringPrintf("0x%08x", *dex_location_checksum);
425 }
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700426 LOG(WARNING) << "Failed to find OatDexFile for DexFile " << dex_location
Calin Juravle4e1d5792014-07-15 23:56:47 +0100427 << " ( canonical path " << dex_canonical_location << ")"
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800428 << " with checksum " << checksum << " in OatFile " << GetLocation();
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700429 if (kIsDebugBuild) {
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100430 for (const OatDexFile* odf : oat_dex_files_storage_) {
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700431 LOG(WARNING) << "OatFile " << GetLocation()
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100432 << " contains OatDexFile " << odf->GetDexFileLocation()
433 << " (canonical path " << odf->GetCanonicalDexFileLocation() << ")"
434 << " with checksum 0x" << std::hex << odf->GetDexFileLocationChecksum();
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700435 }
Ian Rogers7fe2c692011-12-06 16:35:59 -0800436 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700437 }
Calin Juravle4e1d5792014-07-15 23:56:47 +0100438
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700439 return NULL;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700440}
441
Brian Carlstrome24fa612011-09-29 00:53:55 -0700442OatFile::OatDexFile::OatDexFile(const OatFile* oat_file,
Elliott Hughesaa6a5882012-01-13 19:39:16 -0800443 const std::string& dex_file_location,
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100444 const std::string& canonical_dex_file_location,
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800445 uint32_t dex_file_location_checksum,
Ian Rogers13735952014-10-08 12:43:28 -0700446 const uint8_t* dex_file_pointer,
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800447 const uint32_t* oat_class_offsets_pointer)
Brian Carlstrome24fa612011-09-29 00:53:55 -0700448 : oat_file_(oat_file),
449 dex_file_location_(dex_file_location),
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100450 canonical_dex_file_location_(canonical_dex_file_location),
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800451 dex_file_location_checksum_(dex_file_location_checksum),
Brian Carlstrom89521892011-12-07 22:05:07 -0800452 dex_file_pointer_(dex_file_pointer),
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800453 oat_class_offsets_pointer_(oat_class_offsets_pointer) {}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700454
455OatFile::OatDexFile::~OatDexFile() {}
456
Ian Rogers05f28c62012-10-23 18:12:13 -0700457size_t OatFile::OatDexFile::FileSize() const {
458 return reinterpret_cast<const DexFile::Header*>(dex_file_pointer_)->file_size_;
459}
460
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700461const DexFile* OatFile::OatDexFile::OpenDexFile(std::string* error_msg) const {
Ian Rogers05f28c62012-10-23 18:12:13 -0700462 return DexFile::Open(dex_file_pointer_, FileSize(), dex_file_location_,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700463 dex_file_location_checksum_, error_msg);
Brian Carlstrom89521892011-12-07 22:05:07 -0800464}
465
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700466uint32_t OatFile::OatDexFile::GetOatClassOffset(uint16_t class_def_index) const {
467 return oat_class_offsets_pointer_[class_def_index];
468}
469
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100470OatFile::OatClass OatFile::OatDexFile::GetOatClass(uint16_t class_def_index) const {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700471 uint32_t oat_class_offset = GetOatClassOffset(class_def_index);
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800472
Ian Rogers13735952014-10-08 12:43:28 -0700473 const uint8_t* oat_class_pointer = oat_file_->Begin() + oat_class_offset;
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700474 CHECK_LT(oat_class_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800475
Ian Rogers13735952014-10-08 12:43:28 -0700476 const uint8_t* status_pointer = oat_class_pointer;
Brian Carlstromba150c32013-08-27 17:31:03 -0700477 CHECK_LT(status_pointer, oat_file_->End()) << oat_file_->GetLocation();
478 mirror::Class::Status status =
479 static_cast<mirror::Class::Status>(*reinterpret_cast<const int16_t*>(status_pointer));
480 CHECK_LT(status, mirror::Class::kStatusMax);
481
Ian Rogers13735952014-10-08 12:43:28 -0700482 const uint8_t* type_pointer = status_pointer + sizeof(uint16_t);
Brian Carlstromba150c32013-08-27 17:31:03 -0700483 CHECK_LT(type_pointer, oat_file_->End()) << oat_file_->GetLocation();
484 OatClassType type = static_cast<OatClassType>(*reinterpret_cast<const uint16_t*>(type_pointer));
485 CHECK_LT(type, kOatClassMax);
486
Ian Rogers13735952014-10-08 12:43:28 -0700487 const uint8_t* after_type_pointer = type_pointer + sizeof(int16_t);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800488 CHECK_LE(after_type_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstromba150c32013-08-27 17:31:03 -0700489
Brian Carlstromcd937a92014-03-04 22:53:23 -0800490 uint32_t bitmap_size = 0;
Ian Rogers13735952014-10-08 12:43:28 -0700491 const uint8_t* bitmap_pointer = nullptr;
492 const uint8_t* methods_pointer = nullptr;
Ian Rogers97b52f82014-08-14 11:34:07 -0700493 if (type != kOatClassNoneCompiled) {
494 if (type == kOatClassSomeCompiled) {
495 bitmap_size = static_cast<uint32_t>(*reinterpret_cast<const uint32_t*>(after_type_pointer));
496 bitmap_pointer = after_type_pointer + sizeof(bitmap_size);
497 CHECK_LE(bitmap_pointer, oat_file_->End()) << oat_file_->GetLocation();
498 methods_pointer = bitmap_pointer + bitmap_size;
499 } else {
500 methods_pointer = after_type_pointer;
501 }
502 CHECK_LE(methods_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstromcd937a92014-03-04 22:53:23 -0800503 }
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800504
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100505 return OatClass(oat_file_,
506 status,
507 type,
508 bitmap_size,
509 reinterpret_cast<const uint32_t*>(bitmap_pointer),
510 reinterpret_cast<const OatMethodOffsets*>(methods_pointer));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700511}
512
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800513OatFile::OatClass::OatClass(const OatFile* oat_file,
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800514 mirror::Class::Status status,
Brian Carlstromba150c32013-08-27 17:31:03 -0700515 OatClassType type,
516 uint32_t bitmap_size,
517 const uint32_t* bitmap_pointer,
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800518 const OatMethodOffsets* methods_pointer)
Brian Carlstromba150c32013-08-27 17:31:03 -0700519 : oat_file_(oat_file), status_(status), type_(type),
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100520 bitmap_(bitmap_pointer), methods_pointer_(methods_pointer) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700521 switch (type_) {
522 case kOatClassAllCompiled: {
523 CHECK_EQ(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800524 CHECK(bitmap_pointer == nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700525 CHECK(methods_pointer != nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700526 break;
527 }
528 case kOatClassSomeCompiled: {
529 CHECK_NE(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800530 CHECK(bitmap_pointer != nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700531 CHECK(methods_pointer != nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700532 break;
533 }
534 case kOatClassNoneCompiled: {
535 CHECK_EQ(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800536 CHECK(bitmap_pointer == nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700537 CHECK(methods_pointer_ == nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700538 break;
539 }
540 case kOatClassMax: {
541 LOG(FATAL) << "Invalid OatClassType " << type_;
542 break;
543 }
544 }
545}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700546
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700547uint32_t OatFile::OatClass::GetOatMethodOffsetsOffset(uint32_t method_index) const {
548 const OatMethodOffsets* oat_method_offsets = GetOatMethodOffsets(method_index);
549 if (oat_method_offsets == nullptr) {
550 return 0u;
551 }
552 return reinterpret_cast<const uint8_t*>(oat_method_offsets) - oat_file_->Begin();
553}
554
555const OatMethodOffsets* OatFile::OatClass::GetOatMethodOffsets(uint32_t method_index) const {
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100556 // 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 -0700557 if (methods_pointer_ == nullptr) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700558 CHECK_EQ(kOatClassNoneCompiled, type_);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700559 return nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -0700560 }
561 size_t methods_pointer_index;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700562 if (bitmap_ == nullptr) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700563 CHECK_EQ(kOatClassAllCompiled, type_);
564 methods_pointer_index = method_index;
565 } else {
566 CHECK_EQ(kOatClassSomeCompiled, type_);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100567 if (!BitVector::IsBitSet(bitmap_, method_index)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700568 return nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -0700569 }
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100570 size_t num_set_bits = BitVector::NumSetBits(bitmap_, method_index);
571 methods_pointer_index = num_set_bits;
Brian Carlstromba150c32013-08-27 17:31:03 -0700572 }
573 const OatMethodOffsets& oat_method_offsets = methods_pointer_[methods_pointer_index];
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700574 return &oat_method_offsets;
575}
576
577const OatFile::OatMethod OatFile::OatClass::GetOatMethod(uint32_t method_index) const {
578 const OatMethodOffsets* oat_method_offsets = GetOatMethodOffsets(method_index);
579 if (oat_method_offsets == nullptr) {
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800580 return OatMethod(nullptr, 0);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700581 }
582 if (oat_file_->IsExecutable() ||
583 Runtime::Current() == nullptr || // This case applies for oatdump.
584 Runtime::Current()->IsCompiler()) {
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800585 return OatMethod(oat_file_->Begin(), oat_method_offsets->code_offset_);
Alex Light9dcc4572014-08-14 14:16:26 -0700586 } else {
587 // We aren't allowed to use the compiled code. We just force it down the interpreted version.
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800588 return OatMethod(oat_file_->Begin(), 0);
Alex Light9dcc4572014-08-14 14:16:26 -0700589 }
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700590}
591
Brian Carlstromea46f952013-07-30 01:26:50 -0700592void OatFile::OatMethod::LinkMethod(mirror::ArtMethod* method) const {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700593 CHECK(method != NULL);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800594 method->SetEntryPointFromPortableCompiledCode(GetPortableCode());
595 method->SetEntryPointFromQuickCompiledCode(GetQuickCode());
Brian Carlstromae826982011-11-09 01:33:42 -0800596}
597
Andreas Gampe7ba64962014-10-23 11:37:40 -0700598bool OatFile::IsPic() const {
Igor Murashkin46774762014-10-22 11:37:02 -0700599 return GetOatHeader().IsPic();
Andreas Gampe7ba64962014-10-23 11:37:40 -0700600 // TODO: Check against oat_patches. b/18144996
601}
602
Brian Carlstrome24fa612011-09-29 00:53:55 -0700603} // namespace art