blob: a896f3eeceeff72fce18d92159421f07f0a5196e [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);
50 Elf32_Shdr* hdr = elf_file->FindSectionByName(".rodata");
51 oat_file->begin_ = elf_file->Begin() + hdr->sh_offset;
52 oat_file->end_ = elf_file->Begin() + hdr->sh_size + hdr->sh_offset;
53 return oat_file->Setup(error_msg) ? oat_file.release() : nullptr;
54}
55
Brian Carlstrom265091e2013-01-30 14:08:26 -080056OatFile* OatFile::OpenMemory(std::vector<uint8_t>& oat_contents,
Ian Rogers8d31bbd2013-10-13 10:44:14 -070057 const std::string& location,
58 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -080059 CHECK(!oat_contents.empty()) << location;
60 CheckLocation(location);
Alex Light9dcc4572014-08-14 14:16:26 -070061 std::unique_ptr<OatFile> oat_file(new OatFile(location, false));
Brian Carlstrom700c8d32012-11-05 10:42:02 -080062 oat_file->begin_ = &oat_contents[0];
63 oat_file->end_ = &oat_contents[oat_contents.size()];
Ian Rogers8d31bbd2013-10-13 10:44:14 -070064 return oat_file->Setup(error_msg) ? oat_file.release() : nullptr;
Brian Carlstrom700c8d32012-11-05 10:42:02 -080065}
66
67OatFile* OatFile::Open(const std::string& filename,
68 const std::string& location,
Brian Carlstromf1d34552013-07-12 20:22:23 -070069 byte* requested_base,
Ian Rogers8d31bbd2013-10-13 10:44:14 -070070 bool executable,
71 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -080072 CHECK(!filename.empty()) << location;
Brian Carlstrom30e2ea42013-06-19 23:25:37 -070073 CheckLocation(filename);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070074 std::unique_ptr<OatFile> ret;
75 if (kUsePortableCompiler && executable) {
Ian Rogersef7d42f2014-01-06 12:55:46 -080076 // If we are using PORTABLE, use dlopen to deal with relocations.
77 //
78 // We use our own ELF loader for Quick to deal with legacy apps that
79 // open a generated dex file by name, remove the file, then open
80 // another generated dex file with the same name. http://b/10614658
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070081 ret.reset(OpenDlopen(filename, location, requested_base, error_msg));
82 } else {
83 // If we aren't trying to execute, we just use our own ElfFile loader for a couple reasons:
84 //
85 // On target, dlopen may fail when compiling due to selinux restrictions on installd.
86 //
87 // On host, dlopen is expected to fail when cross compiling, so fall back to OpenElfFile.
88 // This won't work for portable runtime execution because it doesn't process relocations.
89 std::unique_ptr<File> file(OS::OpenFileForReading(filename.c_str()));
90 if (file.get() == NULL) {
91 *error_msg = StringPrintf("Failed to open oat filename for reading: %s", strerror(errno));
92 return nullptr;
Ian Rogersef7d42f2014-01-06 12:55:46 -080093 }
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070094 ret.reset(OpenElfFile(file.get(), location, requested_base, false, executable, error_msg));
Andreas Gampedaab38c2014-09-12 18:38:24 -070095
Andreas Gampe9ef2b6c2014-09-15 22:25:24 -070096 // It would be nice to unlink here. But we might have opened the file created by the
97 // ScopedLock, which we better not delete to avoid races. TODO: Investigate how to fix the API
98 // to allow removal when we know the ELF must be borked.
Brian Carlstrom700c8d32012-11-05 10:42:02 -080099 }
Dave Allison69dfe512014-07-11 17:11:58 +0000100 return ret.release();
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800101}
102
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700103OatFile* OatFile::OpenWritable(File* file, const std::string& location, std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800104 CheckLocation(location);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700105 return OpenElfFile(file, location, NULL, true, false, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800106}
107
Alex Lighta59dd802014-07-02 16:28:08 -0700108OatFile* OatFile::OpenReadable(File* file, const std::string& location, std::string* error_msg) {
109 CheckLocation(location);
110 return OpenElfFile(file, location, NULL, false, false, error_msg);
111}
112
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800113OatFile* OatFile::OpenDlopen(const std::string& elf_filename,
114 const std::string& location,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700115 byte* requested_base,
116 std::string* error_msg) {
Alex Light9dcc4572014-08-14 14:16:26 -0700117 std::unique_ptr<OatFile> oat_file(new OatFile(location, true));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700118 bool success = oat_file->Dlopen(elf_filename, requested_base, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800119 if (!success) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700120 return nullptr;
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800121 }
122 return oat_file.release();
123}
124
125OatFile* OatFile::OpenElfFile(File* file,
126 const std::string& location,
127 byte* requested_base,
Brian Carlstromf1d34552013-07-12 20:22:23 -0700128 bool writable,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700129 bool executable,
130 std::string* error_msg) {
Alex Light9dcc4572014-08-14 14:16:26 -0700131 std::unique_ptr<OatFile> oat_file(new OatFile(location, executable));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700132 bool success = oat_file->ElfFileOpen(file, requested_base, writable, executable, error_msg);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700133 if (!success) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700134 CHECK(!error_msg->empty());
135 return nullptr;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700136 }
137 return oat_file.release();
138}
139
Alex Light9dcc4572014-08-14 14:16:26 -0700140OatFile::OatFile(const std::string& location, bool is_executable)
141 : location_(location), begin_(NULL), end_(NULL), is_executable_(is_executable),
142 dlopen_handle_(NULL),
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100143 secondary_lookup_lock_("OatFile secondary lookup lock", kOatFileSecondaryLookupLock) {
Brian Carlstroma004aa92012-02-08 18:05:09 -0800144 CHECK(!location_.empty());
145}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700146
147OatFile::~OatFile() {
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100148 STLDeleteElements(&oat_dex_files_storage_);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800149 if (dlopen_handle_ != NULL) {
150 dlclose(dlopen_handle_);
151 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700152}
153
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700154bool OatFile::Dlopen(const std::string& elf_filename, byte* requested_base,
155 std::string* error_msg) {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800156 char* absolute_path = realpath(elf_filename.c_str(), NULL);
157 if (absolute_path == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700158 *error_msg = StringPrintf("Failed to find absolute path for '%s'", elf_filename.c_str());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700159 return false;
160 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800161 dlopen_handle_ = dlopen(absolute_path, RTLD_NOW);
162 free(absolute_path);
163 if (dlopen_handle_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700164 *error_msg = StringPrintf("Failed to dlopen '%s': %s", elf_filename.c_str(), dlerror());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700165 return false;
166 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800167 begin_ = reinterpret_cast<byte*>(dlsym(dlopen_handle_, "oatdata"));
168 if (begin_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700169 *error_msg = StringPrintf("Failed to find oatdata symbol in '%s': %s", elf_filename.c_str(),
170 dlerror());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800171 return false;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700172 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800173 if (requested_base != NULL && begin_ != requested_base) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700174 *error_msg = StringPrintf("Failed to find oatdata symbol at expected address: "
175 "oatdata=%p != expected=%p /proc/self/maps:\n",
176 begin_, requested_base);
177 ReadFileToString("/proc/self/maps", error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800178 return false;
179 }
180 end_ = reinterpret_cast<byte*>(dlsym(dlopen_handle_, "oatlastword"));
181 if (end_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700182 *error_msg = StringPrintf("Failed to find oatlastword symbol in '%s': %s", elf_filename.c_str(),
183 dlerror());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800184 return false;
185 }
186 // Readjust to be non-inclusive upper bound.
187 end_ += sizeof(uint32_t);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700188 return Setup(error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800189}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700190
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700191bool OatFile::ElfFileOpen(File* file, byte* requested_base, bool writable, bool executable,
192 std::string* error_msg) {
193 elf_file_.reset(ElfFile::Open(file, writable, true, error_msg));
194 if (elf_file_.get() == nullptr) {
195 DCHECK(!error_msg->empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800196 return false;
197 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700198 bool loaded = elf_file_->Load(executable, error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800199 if (!loaded) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700200 DCHECK(!error_msg->empty());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800201 return false;
202 }
203 begin_ = elf_file_->FindDynamicSymbolAddress("oatdata");
204 if (begin_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700205 *error_msg = StringPrintf("Failed to find oatdata symbol in '%s'", file->GetPath().c_str());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800206 return false;
207 }
208 if (requested_base != NULL && begin_ != requested_base) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700209 *error_msg = StringPrintf("Failed to find oatdata symbol at expected address: "
210 "oatdata=%p != expected=%p /proc/self/maps:\n",
211 begin_, requested_base);
212 ReadFileToString("/proc/self/maps", error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800213 return false;
214 }
215 end_ = elf_file_->FindDynamicSymbolAddress("oatlastword");
216 if (end_ == NULL) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700217 *error_msg = StringPrintf("Failed to find oatlastword symbol in '%s'", file->GetPath().c_str());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800218 return false;
219 }
220 // Readjust to be non-inclusive upper bound.
221 end_ += sizeof(uint32_t);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700222 return Setup(error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800223}
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800224
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700225bool OatFile::Setup(std::string* error_msg) {
Brian Carlstromf1b30302013-03-28 10:35:32 -0700226 if (!GetOatHeader().IsValid()) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700227 *error_msg = StringPrintf("Invalid oat magic for '%s'", GetLocation().c_str());
Brian Carlstromf1b30302013-03-28 10:35:32 -0700228 return false;
229 }
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800230 const byte* oat = Begin();
Brian Carlstrome24fa612011-09-29 00:53:55 -0700231 oat += sizeof(OatHeader);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700232 if (oat > End()) {
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700233 *error_msg = StringPrintf("In oat file '%s' found truncated OatHeader", GetLocation().c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700234 return false;
235 }
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700236
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700237 oat += GetOatHeader().GetKeyValueStoreSize();
Brian Carlstromfb331d72013-07-25 22:00:16 -0700238 if (oat > End()) {
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700239 *error_msg = StringPrintf("In oat file '%s' found truncated variable-size data: "
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700240 "%p + %zd + %ud <= %p", GetLocation().c_str(),
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700241 Begin(), sizeof(OatHeader), GetOatHeader().GetKeyValueStoreSize(),
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700242 End());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700243 return false;
244 }
245
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100246 uint32_t dex_file_count = GetOatHeader().GetDexFileCount();
247 oat_dex_files_storage_.reserve(dex_file_count);
248 for (size_t i = 0; i < dex_file_count; i++) {
Dmitry Petrochenko83bef922014-02-03 12:34:59 +0700249 uint32_t dex_file_location_size = *reinterpret_cast<const uint32_t*>(oat);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700250 if (UNLIKELY(dex_file_location_size == 0U)) {
251 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd with empty location name",
252 GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700253 return false;
254 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700255 oat += sizeof(dex_file_location_size);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700256 if (UNLIKELY(oat > End())) {
257 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd truncated after dex file "
258 "location size", GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700259 return false;
260 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700261
262 const char* dex_file_location_data = reinterpret_cast<const char*>(oat);
263 oat += dex_file_location_size;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700264 if (UNLIKELY(oat > End())) {
265 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd with truncated dex file "
266 "location", GetLocation().c_str(), i);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700267 return false;
268 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700269
270 std::string dex_file_location(dex_file_location_data, dex_file_location_size);
271
272 uint32_t dex_file_checksum = *reinterpret_cast<const uint32_t*>(oat);
273 oat += sizeof(dex_file_checksum);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700274 if (UNLIKELY(oat > End())) {
275 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' truncated after "
276 "dex file checksum", GetLocation().c_str(), i,
277 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700278 return false;
279 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700280
Brian Carlstrom89521892011-12-07 22:05:07 -0800281 uint32_t dex_file_offset = *reinterpret_cast<const uint32_t*>(oat);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700282 if (UNLIKELY(dex_file_offset == 0U)) {
283 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with zero dex "
284 "file offset", GetLocation().c_str(), i, dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700285 return false;
286 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700287 if (UNLIKELY(dex_file_offset > Size())) {
288 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with dex file "
289 "offset %ud > %zd", GetLocation().c_str(), i,
290 dex_file_location.c_str(), dex_file_offset, Size());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700291 return false;
292 }
Brian Carlstrom89521892011-12-07 22:05:07 -0800293 oat += sizeof(dex_file_offset);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700294 if (UNLIKELY(oat > End())) {
295 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' truncated "
296 " after dex file offsets", GetLocation().c_str(), i,
297 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700298 return false;
299 }
Brian Carlstrom89521892011-12-07 22:05:07 -0800300
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800301 const uint8_t* dex_file_pointer = Begin() + dex_file_offset;
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700302 if (UNLIKELY(!DexFile::IsMagicValid(dex_file_pointer))) {
303 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with invalid "
304 " dex file magic '%s'", GetLocation().c_str(), i,
305 dex_file_location.c_str(), dex_file_pointer);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700306 return false;
307 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700308 if (UNLIKELY(!DexFile::IsVersionValid(dex_file_pointer))) {
309 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with invalid "
310 " dex file version '%s'", GetLocation().c_str(), i,
311 dex_file_location.c_str(), dex_file_pointer);
Brian Carlstromfb331d72013-07-25 22:00:16 -0700312 return false;
313 }
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800314 const DexFile::Header* header = reinterpret_cast<const DexFile::Header*>(dex_file_pointer);
315 const uint32_t* methods_offsets_pointer = reinterpret_cast<const uint32_t*>(oat);
Brian Carlstrom89521892011-12-07 22:05:07 -0800316
Brian Carlstrom6e3b1d92012-01-11 01:36:32 -0800317 oat += (sizeof(*methods_offsets_pointer) * header->class_defs_size_);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700318 if (UNLIKELY(oat > End())) {
319 *error_msg = StringPrintf("In oat file '%s' found OatDexFile #%zd for '%s' with truncated "
320 " method offsets", GetLocation().c_str(), i,
321 dex_file_location.c_str());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700322 return false;
323 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700324
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100325 std::string canonical_location = DexFile::GetDexCanonicalLocation(dex_file_location.c_str());
326
327 // Create the OatDexFile and add it to the owning container.
Vladimir Marko539690a2014-06-05 18:36:42 +0100328 OatDexFile* oat_dex_file = new OatDexFile(this,
329 dex_file_location,
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100330 canonical_location,
Vladimir Marko539690a2014-06-05 18:36:42 +0100331 dex_file_checksum,
332 dex_file_pointer,
333 methods_offsets_pointer);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100334 oat_dex_files_storage_.push_back(oat_dex_file);
335
336 // Add the location and canonical location (if different) to the oat_dex_files_ table.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100337 StringPiece key(oat_dex_file->GetDexFileLocation());
Vladimir Marko539690a2014-06-05 18:36:42 +0100338 oat_dex_files_.Put(key, oat_dex_file);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100339 if (canonical_location != dex_file_location) {
340 StringPiece canonical_key(oat_dex_file->GetCanonicalDexFileLocation());
341 oat_dex_files_.Put(canonical_key, oat_dex_file);
342 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700343 }
Brian Carlstromf1b30302013-03-28 10:35:32 -0700344 return true;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700345}
346
347const OatHeader& OatFile::GetOatHeader() const {
Ian Rogers30fab402012-01-23 15:43:46 -0800348 return *reinterpret_cast<const OatHeader*>(Begin());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700349}
350
Ian Rogers30fab402012-01-23 15:43:46 -0800351const byte* OatFile::Begin() const {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800352 CHECK(begin_ != NULL);
353 return begin_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700354}
355
Ian Rogers30fab402012-01-23 15:43:46 -0800356const byte* OatFile::End() const {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800357 CHECK(end_ != NULL);
358 return end_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700359}
360
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700361const OatFile::OatDexFile* OatFile::GetOatDexFile(const char* dex_location,
362 const uint32_t* dex_location_checksum,
Ian Rogers7fe2c692011-12-06 16:35:59 -0800363 bool warn_if_not_found) const {
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100364 // NOTE: We assume here that the canonical location for a given dex_location never
365 // changes. If it does (i.e. some symlink used by the filename changes) we may return
366 // an incorrect OatDexFile. As long as we have a checksum to check, we shall return
367 // an identical file or fail; otherwise we may see some unpredictable failures.
Calin Juravle4e1d5792014-07-15 23:56:47 +0100368
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100369 // TODO: Additional analysis of usage patterns to see if this can be simplified
370 // without any performance loss, for example by not doing the first lock-free lookup.
371
372 const OatFile::OatDexFile* oat_dex_file = nullptr;
373 StringPiece key(dex_location);
374 // Try to find the key cheaply in the oat_dex_files_ map which holds dex locations
375 // directly mentioned in the oat file and doesn't require locking.
376 auto primary_it = oat_dex_files_.find(key);
377 if (primary_it != oat_dex_files_.end()) {
378 oat_dex_file = primary_it->second;
379 DCHECK(oat_dex_file != nullptr);
380 } else {
381 // This dex_location is not one of the dex locations directly mentioned in the
382 // oat file. The correct lookup is via the canonical location but first see in
383 // the secondary_oat_dex_files_ whether we've looked up this location before.
384 MutexLock mu(Thread::Current(), secondary_lookup_lock_);
385 auto secondary_lb = secondary_oat_dex_files_.lower_bound(key);
386 if (secondary_lb != secondary_oat_dex_files_.end() && key == secondary_lb->first) {
387 oat_dex_file = secondary_lb->second; // May be nullptr.
388 } else {
389 // We haven't seen this dex_location before, we must check the canonical location.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100390 std::string dex_canonical_location = DexFile::GetDexCanonicalLocation(dex_location);
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100391 if (dex_canonical_location != dex_location) {
392 StringPiece canonical_key(dex_canonical_location);
393 auto canonical_it = oat_dex_files_.find(canonical_key);
394 if (canonical_it != oat_dex_files_.end()) {
395 oat_dex_file = canonical_it->second;
396 } // else keep nullptr.
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100397 } // else keep nullptr.
398
399 // Copy the key to the string_cache_ and store the result in secondary map.
400 string_cache_.emplace_back(key.data(), key.length());
401 StringPiece key_copy(string_cache_.back());
402 secondary_oat_dex_files_.PutBefore(secondary_lb, key_copy, oat_dex_file);
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700403 }
404 }
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100405 if (oat_dex_file != nullptr &&
406 (dex_location_checksum == nullptr ||
407 oat_dex_file->GetDexFileLocationChecksum() == *dex_location_checksum)) {
408 return oat_dex_file;
409 }
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700410
411 if (warn_if_not_found) {
Vladimir Marko3f5838d2014-08-07 18:07:18 +0100412 std::string dex_canonical_location = DexFile::GetDexCanonicalLocation(dex_location);
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800413 std::string checksum("<unspecified>");
414 if (dex_location_checksum != NULL) {
415 checksum = StringPrintf("0x%08x", *dex_location_checksum);
416 }
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700417 LOG(WARNING) << "Failed to find OatDexFile for DexFile " << dex_location
Calin Juravle4e1d5792014-07-15 23:56:47 +0100418 << " ( canonical path " << dex_canonical_location << ")"
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800419 << " with checksum " << checksum << " in OatFile " << GetLocation();
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700420 if (kIsDebugBuild) {
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100421 for (const OatDexFile* odf : oat_dex_files_storage_) {
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700422 LOG(WARNING) << "OatFile " << GetLocation()
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100423 << " contains OatDexFile " << odf->GetDexFileLocation()
424 << " (canonical path " << odf->GetCanonicalDexFileLocation() << ")"
425 << " with checksum 0x" << std::hex << odf->GetDexFileLocationChecksum();
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700426 }
Ian Rogers7fe2c692011-12-06 16:35:59 -0800427 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700428 }
Calin Juravle4e1d5792014-07-15 23:56:47 +0100429
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700430 return NULL;
Brian Carlstromaded5f72011-10-07 17:15:04 -0700431}
432
Brian Carlstrome24fa612011-09-29 00:53:55 -0700433OatFile::OatDexFile::OatDexFile(const OatFile* oat_file,
Elliott Hughesaa6a5882012-01-13 19:39:16 -0800434 const std::string& dex_file_location,
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100435 const std::string& canonical_dex_file_location,
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800436 uint32_t dex_file_location_checksum,
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800437 const byte* dex_file_pointer,
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800438 const uint32_t* oat_class_offsets_pointer)
Brian Carlstrome24fa612011-09-29 00:53:55 -0700439 : oat_file_(oat_file),
440 dex_file_location_(dex_file_location),
Vladimir Markoaa4497d2014-09-05 14:01:17 +0100441 canonical_dex_file_location_(canonical_dex_file_location),
Brian Carlstrom5b332c82012-02-01 15:02:31 -0800442 dex_file_location_checksum_(dex_file_location_checksum),
Brian Carlstrom89521892011-12-07 22:05:07 -0800443 dex_file_pointer_(dex_file_pointer),
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800444 oat_class_offsets_pointer_(oat_class_offsets_pointer) {}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700445
446OatFile::OatDexFile::~OatDexFile() {}
447
Ian Rogers05f28c62012-10-23 18:12:13 -0700448size_t OatFile::OatDexFile::FileSize() const {
449 return reinterpret_cast<const DexFile::Header*>(dex_file_pointer_)->file_size_;
450}
451
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700452const DexFile* OatFile::OatDexFile::OpenDexFile(std::string* error_msg) const {
Ian Rogers05f28c62012-10-23 18:12:13 -0700453 return DexFile::Open(dex_file_pointer_, FileSize(), dex_file_location_,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700454 dex_file_location_checksum_, error_msg);
Brian Carlstrom89521892011-12-07 22:05:07 -0800455}
456
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700457uint32_t OatFile::OatDexFile::GetOatClassOffset(uint16_t class_def_index) const {
458 return oat_class_offsets_pointer_[class_def_index];
459}
460
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100461OatFile::OatClass OatFile::OatDexFile::GetOatClass(uint16_t class_def_index) const {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700462 uint32_t oat_class_offset = GetOatClassOffset(class_def_index);
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800463
Ian Rogers30fab402012-01-23 15:43:46 -0800464 const byte* oat_class_pointer = oat_file_->Begin() + oat_class_offset;
Brian Carlstrom7571e8b2013-08-12 17:04:14 -0700465 CHECK_LT(oat_class_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800466
Brian Carlstromba150c32013-08-27 17:31:03 -0700467 const byte* status_pointer = oat_class_pointer;
468 CHECK_LT(status_pointer, oat_file_->End()) << oat_file_->GetLocation();
469 mirror::Class::Status status =
470 static_cast<mirror::Class::Status>(*reinterpret_cast<const int16_t*>(status_pointer));
471 CHECK_LT(status, mirror::Class::kStatusMax);
472
473 const byte* type_pointer = status_pointer + sizeof(uint16_t);
474 CHECK_LT(type_pointer, oat_file_->End()) << oat_file_->GetLocation();
475 OatClassType type = static_cast<OatClassType>(*reinterpret_cast<const uint16_t*>(type_pointer));
476 CHECK_LT(type, kOatClassMax);
477
Brian Carlstromcd937a92014-03-04 22:53:23 -0800478 const byte* after_type_pointer = type_pointer + sizeof(int16_t);
479 CHECK_LE(after_type_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstromba150c32013-08-27 17:31:03 -0700480
Brian Carlstromcd937a92014-03-04 22:53:23 -0800481 uint32_t bitmap_size = 0;
482 const byte* bitmap_pointer = nullptr;
483 const byte* methods_pointer = nullptr;
Ian Rogers97b52f82014-08-14 11:34:07 -0700484 if (type != kOatClassNoneCompiled) {
485 if (type == kOatClassSomeCompiled) {
486 bitmap_size = static_cast<uint32_t>(*reinterpret_cast<const uint32_t*>(after_type_pointer));
487 bitmap_pointer = after_type_pointer + sizeof(bitmap_size);
488 CHECK_LE(bitmap_pointer, oat_file_->End()) << oat_file_->GetLocation();
489 methods_pointer = bitmap_pointer + bitmap_size;
490 } else {
491 methods_pointer = after_type_pointer;
492 }
493 CHECK_LE(methods_pointer, oat_file_->End()) << oat_file_->GetLocation();
Brian Carlstromcd937a92014-03-04 22:53:23 -0800494 }
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800495
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100496 return OatClass(oat_file_,
497 status,
498 type,
499 bitmap_size,
500 reinterpret_cast<const uint32_t*>(bitmap_pointer),
501 reinterpret_cast<const OatMethodOffsets*>(methods_pointer));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700502}
503
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800504OatFile::OatClass::OatClass(const OatFile* oat_file,
Ian Rogers2dd0e2c2013-01-24 12:42:14 -0800505 mirror::Class::Status status,
Brian Carlstromba150c32013-08-27 17:31:03 -0700506 OatClassType type,
507 uint32_t bitmap_size,
508 const uint32_t* bitmap_pointer,
Brian Carlstrom0755ec52012-01-11 15:19:46 -0800509 const OatMethodOffsets* methods_pointer)
Brian Carlstromba150c32013-08-27 17:31:03 -0700510 : oat_file_(oat_file), status_(status), type_(type),
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100511 bitmap_(bitmap_pointer), methods_pointer_(methods_pointer) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700512 switch (type_) {
513 case kOatClassAllCompiled: {
514 CHECK_EQ(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800515 CHECK(bitmap_pointer == nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700516 CHECK(methods_pointer != nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700517 break;
518 }
519 case kOatClassSomeCompiled: {
520 CHECK_NE(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800521 CHECK(bitmap_pointer != nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700522 CHECK(methods_pointer != nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700523 break;
524 }
525 case kOatClassNoneCompiled: {
526 CHECK_EQ(0U, bitmap_size);
Brian Carlstromcd937a92014-03-04 22:53:23 -0800527 CHECK(bitmap_pointer == nullptr);
Ian Rogers97b52f82014-08-14 11:34:07 -0700528 CHECK(methods_pointer_ == nullptr);
Brian Carlstromba150c32013-08-27 17:31:03 -0700529 break;
530 }
531 case kOatClassMax: {
532 LOG(FATAL) << "Invalid OatClassType " << type_;
533 break;
534 }
535 }
536}
Brian Carlstrome24fa612011-09-29 00:53:55 -0700537
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700538uint32_t OatFile::OatClass::GetOatMethodOffsetsOffset(uint32_t method_index) const {
539 const OatMethodOffsets* oat_method_offsets = GetOatMethodOffsets(method_index);
540 if (oat_method_offsets == nullptr) {
541 return 0u;
542 }
543 return reinterpret_cast<const uint8_t*>(oat_method_offsets) - oat_file_->Begin();
544}
545
546const OatMethodOffsets* OatFile::OatClass::GetOatMethodOffsets(uint32_t method_index) const {
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100547 // 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 -0700548 if (methods_pointer_ == nullptr) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700549 CHECK_EQ(kOatClassNoneCompiled, type_);
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700550 return nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -0700551 }
552 size_t methods_pointer_index;
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700553 if (bitmap_ == nullptr) {
Brian Carlstromba150c32013-08-27 17:31:03 -0700554 CHECK_EQ(kOatClassAllCompiled, type_);
555 methods_pointer_index = method_index;
556 } else {
557 CHECK_EQ(kOatClassSomeCompiled, type_);
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100558 if (!BitVector::IsBitSet(bitmap_, method_index)) {
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700559 return nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -0700560 }
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100561 size_t num_set_bits = BitVector::NumSetBits(bitmap_, method_index);
562 methods_pointer_index = num_set_bits;
Brian Carlstromba150c32013-08-27 17:31:03 -0700563 }
564 const OatMethodOffsets& oat_method_offsets = methods_pointer_[methods_pointer_index];
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700565 return &oat_method_offsets;
566}
567
568const OatFile::OatMethod OatFile::OatClass::GetOatMethod(uint32_t method_index) const {
569 const OatMethodOffsets* oat_method_offsets = GetOatMethodOffsets(method_index);
570 if (oat_method_offsets == nullptr) {
571 return OatMethod(nullptr, 0, 0);
572 }
573 if (oat_file_->IsExecutable() ||
574 Runtime::Current() == nullptr || // This case applies for oatdump.
575 Runtime::Current()->IsCompiler()) {
Alex Light9dcc4572014-08-14 14:16:26 -0700576 return OatMethod(
577 oat_file_->Begin(),
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -0700578 oat_method_offsets->code_offset_,
579 oat_method_offsets->gc_map_offset_);
Alex Light9dcc4572014-08-14 14:16:26 -0700580 } else {
581 // We aren't allowed to use the compiled code. We just force it down the interpreted version.
582 return OatMethod(oat_file_->Begin(), 0, 0);
583 }
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700584}
585
Brian Carlstromea46f952013-07-30 01:26:50 -0700586void OatFile::OatMethod::LinkMethod(mirror::ArtMethod* method) const {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700587 CHECK(method != NULL);
Ian Rogersef7d42f2014-01-06 12:55:46 -0800588 method->SetEntryPointFromPortableCompiledCode(GetPortableCode());
589 method->SetEntryPointFromQuickCompiledCode(GetQuickCode());
Brian Carlstromfb331d72013-07-25 22:00:16 -0700590 method->SetNativeGcMap(GetNativeGcMap()); // Used by native methods in work around JNI mode.
Brian Carlstromae826982011-11-09 01:33:42 -0800591}
592
Brian Carlstrome24fa612011-09-29 00:53:55 -0700593} // namespace art