blob: 2c96c116aaaa231ab944f6574df4375a2f5916df [file] [log] [blame]
Richard Uhler66d874d2015-01-15 09:37:19 -08001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "oat_file_assistant.h"
18
Richard Uhler46cc64f2016-11-14 14:53:55 +000019#include <sstream>
20
Richard Uhler66d874d2015-01-15 09:37:19 -080021#include <sys/stat.h>
Andreas Gampe9186ced2016-12-12 14:28:21 -080022
Andreas Gampec15a2f42017-04-21 12:09:39 -070023#include "android-base/stringprintf.h"
Andreas Gampe9186ced2016-12-12 14:28:21 -080024#include "android-base/strings.h"
25
David Sehr891a50e2017-10-27 17:01:07 -070026#include "base/file_utils.h"
Andreas Gampe57943812017-12-06 21:39:13 -080027#include "base/logging.h" // For VLOG.
Andreas Gampe85615452018-03-15 17:45:03 -070028#include "base/macros.h"
David Sehr8f4b0562018-03-02 12:01:51 -080029#include "base/os.h"
Andreas Gampe5678db52017-06-08 14:11:18 -070030#include "base/stl_util.h"
David Sehr8f4b0562018-03-02 12:01:51 -080031#include "base/utils.h"
Richard Uhler66d874d2015-01-15 09:37:19 -080032#include "class_linker.h"
Andreas Gampe8cf9cb32017-07-19 09:28:38 -070033#include "compiler_filter.h"
David Sehr013fd802018-01-11 22:55:24 -080034#include "dex/art_dex_file_loader.h"
David Sehr9e734c72018-01-04 17:56:19 -080035#include "dex/dex_file_loader.h"
David Sehr97c381e2017-02-01 15:09:58 -080036#include "exec_utils.h"
Richard Uhler66d874d2015-01-15 09:37:19 -080037#include "gc/heap.h"
38#include "gc/space/image_space.h"
David Brazdil4fe044c2018-05-14 15:24:34 +010039#include "hidden_api.h"
Richard Uhler66d874d2015-01-15 09:37:19 -080040#include "image.h"
41#include "oat.h"
Richard Uhler66d874d2015-01-15 09:37:19 -080042#include "runtime.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070043#include "scoped_thread_state_change-inl.h"
Richard Uhler2f27abd2017-01-31 14:02:34 +000044#include "vdex_file.h"
Calin Juravle27e0d1f2017-07-26 00:16:07 -070045#include "class_loader_context.h"
Richard Uhler66d874d2015-01-15 09:37:19 -080046
47namespace art {
48
Richard Uhler69bcf2c2017-01-24 10:25:21 +000049using android::base::StringPrintf;
50
Narayan Kamath8943c1d2016-05-02 13:14:48 +010051std::ostream& operator << (std::ostream& stream, const OatFileAssistant::OatStatus status) {
52 switch (status) {
Richard Uhler03bc6592016-11-22 09:42:04 +000053 case OatFileAssistant::kOatCannotOpen:
54 stream << "kOatCannotOpen";
55 break;
56 case OatFileAssistant::kOatDexOutOfDate:
57 stream << "kOatDexOutOfDate";
58 break;
59 case OatFileAssistant::kOatBootImageOutOfDate:
60 stream << "kOatBootImageOutOfDate";
61 break;
62 case OatFileAssistant::kOatRelocationOutOfDate:
63 stream << "kOatRelocationOutOfDate";
Narayan Kamath8943c1d2016-05-02 13:14:48 +010064 break;
65 case OatFileAssistant::kOatUpToDate:
66 stream << "kOatUpToDate";
67 break;
Narayan Kamath8943c1d2016-05-02 13:14:48 +010068 default:
69 UNREACHABLE();
70 }
71
72 return stream;
73}
74
Richard Uhler66d874d2015-01-15 09:37:19 -080075OatFileAssistant::OatFileAssistant(const char* dex_location,
76 const InstructionSet isa,
Nicolas Geoffray29742602017-12-14 10:09:03 +000077 bool load_executable,
78 bool only_load_system_executable)
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -070079 : OatFileAssistant(dex_location,
Nicolas Geoffray29742602017-12-14 10:09:03 +000080 isa,
81 load_executable,
82 only_load_system_executable,
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -070083 -1 /* vdex_fd */,
84 -1 /* oat_fd */,
85 -1 /* zip_fd */) {}
86
87
88OatFileAssistant::OatFileAssistant(const char* dex_location,
89 const InstructionSet isa,
Shubham Ajmerab22dea02017-10-04 18:36:41 -070090 bool load_executable,
Nicolas Geoffray29742602017-12-14 10:09:03 +000091 bool only_load_system_executable,
Shubham Ajmerab22dea02017-10-04 18:36:41 -070092 int vdex_fd,
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -070093 int oat_fd,
94 int zip_fd)
Richard Uhler88bc6732016-11-14 14:38:03 +000095 : isa_(isa),
96 load_executable_(load_executable),
Nicolas Geoffray29742602017-12-14 10:09:03 +000097 only_load_system_executable_(only_load_system_executable),
Richard Uhler88bc6732016-11-14 14:38:03 +000098 odex_(this, /*is_oat_location*/ false),
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -070099 oat_(this, /*is_oat_location*/ true),
100 zip_fd_(zip_fd) {
Richard Uhler740eec92015-10-15 15:12:23 -0700101 CHECK(dex_location != nullptr) << "OatFileAssistant: null dex location";
Calin Juravle357c66d2017-05-04 01:57:17 +0000102
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700103 if (zip_fd < 0) {
104 CHECK_LE(oat_fd, 0) << "zip_fd must be provided with valid oat_fd. zip_fd=" << zip_fd
105 << " oat_fd=" << oat_fd;
106 CHECK_LE(vdex_fd, 0) << "zip_fd must be provided with valid vdex_fd. zip_fd=" << zip_fd
107 << " vdex_fd=" << vdex_fd;;
108 }
109
Calin Juravle099f8d62017-09-05 19:04:04 -0700110 dex_location_.assign(dex_location);
Richard Uhler740eec92015-10-15 15:12:23 -0700111
Richard Uhler66d874d2015-01-15 09:37:19 -0800112 if (load_executable_ && isa != kRuntimeISA) {
113 LOG(WARNING) << "OatFileAssistant: Load executable specified, "
114 << "but isa is not kRuntimeISA. Will not attempt to load executable.";
115 load_executable_ = false;
116 }
117
Richard Uhler743bf362016-04-19 15:39:37 -0700118 // Get the odex filename.
Richard Uhlerd684f522016-04-19 13:24:41 -0700119 std::string error_msg;
Richard Uhler743bf362016-04-19 15:39:37 -0700120 std::string odex_file_name;
121 if (DexLocationToOdexFilename(dex_location_, isa_, &odex_file_name, &error_msg)) {
Nicolas Geoffray96dca1c2018-04-19 14:43:29 +0100122 odex_.Reset(odex_file_name, UseFdToReadFiles(), zip_fd, vdex_fd, oat_fd);
Richard Uhler743bf362016-04-19 15:39:37 -0700123 } else {
Richard Uhlerd684f522016-04-19 13:24:41 -0700124 LOG(WARNING) << "Failed to determine odex file name: " << error_msg;
125 }
126
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700127 if (!UseFdToReadFiles()) {
128 // Get the oat filename.
129 std::string oat_file_name;
130 if (DexLocationToOatFilename(dex_location_, isa_, &oat_file_name, &error_msg)) {
131 oat_.Reset(oat_file_name, false /* use_fd */);
132 } else {
133 LOG(WARNING) << "Failed to determine oat file name for dex location "
134 << dex_location_ << ": " << error_msg;
135 }
Calin Juravle357c66d2017-05-04 01:57:17 +0000136 }
137
138 // Check if the dex directory is writable.
139 // This will be needed in most uses of OatFileAssistant and so it's OK to
140 // compute it eagerly. (the only use which will not make use of it is
141 // OatFileAssistant::GetStatusDump())
142 size_t pos = dex_location_.rfind('/');
143 if (pos == std::string::npos) {
144 LOG(WARNING) << "Failed to determine dex file parent directory: " << dex_location_;
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700145 } else if (!UseFdToReadFiles()) {
146 // We cannot test for parent access when using file descriptors. That's ok
147 // because in this case we will always pick the odex file anyway.
Calin Juravle357c66d2017-05-04 01:57:17 +0000148 std::string parent = dex_location_.substr(0, pos);
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700149 if (access(parent.c_str(), W_OK) == 0) {
Calin Juravle357c66d2017-05-04 01:57:17 +0000150 dex_parent_writable_ = true;
151 } else {
152 VLOG(oat) << "Dex parent of " << dex_location_ << " is not writable: " << strerror(errno);
Richard Uhlerd684f522016-04-19 13:24:41 -0700153 }
Richard Uhler66d874d2015-01-15 09:37:19 -0800154 }
Richard Uhler66d874d2015-01-15 09:37:19 -0800155}
156
157OatFileAssistant::~OatFileAssistant() {
158 // Clean up the lock file.
Narayan Kamatha3d27eb2017-05-11 13:50:59 +0100159 if (flock_.get() != nullptr) {
160 unlink(flock_->GetPath().c_str());
Richard Uhler66d874d2015-01-15 09:37:19 -0800161 }
162}
163
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700164bool OatFileAssistant::UseFdToReadFiles() {
165 return zip_fd_ >= 0;
166}
167
Richard Uhler66d874d2015-01-15 09:37:19 -0800168bool OatFileAssistant::IsInBootClassPath() {
169 // Note: We check the current boot class path, regardless of the ISA
170 // specified by the user. This is okay, because the boot class path should
171 // be the same for all ISAs.
172 // TODO: Can we verify the boot class path is the same for all ISAs?
173 Runtime* runtime = Runtime::Current();
174 ClassLinker* class_linker = runtime->GetClassLinker();
175 const auto& boot_class_path = class_linker->GetBootClassPath();
176 for (size_t i = 0; i < boot_class_path.size(); i++) {
Richard Uhler740eec92015-10-15 15:12:23 -0700177 if (boot_class_path[i]->GetLocation() == dex_location_) {
Richard Uhler66d874d2015-01-15 09:37:19 -0800178 VLOG(oat) << "Dex location " << dex_location_ << " is in boot class path";
179 return true;
180 }
181 }
182 return false;
183}
184
185bool OatFileAssistant::Lock(std::string* error_msg) {
186 CHECK(error_msg != nullptr);
Narayan Kamatha3d27eb2017-05-11 13:50:59 +0100187 CHECK(flock_.get() == nullptr) << "OatFileAssistant::Lock already acquired";
Richard Uhler66d874d2015-01-15 09:37:19 -0800188
Calin Juravle357c66d2017-05-04 01:57:17 +0000189 // Note the lock will only succeed for secondary dex files and in test
190 // environment.
191 //
192 // The lock *will fail* for all primary apks in a production environment.
193 // The app does not have permissions to create locks next to its dex location
194 // (be it system, data or vendor parition). We also cannot use the odex or
195 // oat location for the same reasoning.
196 //
197 // This is best effort and if it fails it's unlikely that we will be able
198 // to generate oat files anyway.
199 std::string lock_file_name = dex_location_ + "." + GetInstructionSetString(isa_) + ".flock";
Richard Uhler66d874d2015-01-15 09:37:19 -0800200
Narayan Kamatha3d27eb2017-05-11 13:50:59 +0100201 flock_ = LockedFile::Open(lock_file_name.c_str(), error_msg);
202 if (flock_.get() == nullptr) {
Vladimir Marko66fdcbd2016-04-05 14:19:08 +0100203 unlink(lock_file_name.c_str());
Richard Uhler66d874d2015-01-15 09:37:19 -0800204 return false;
205 }
206 return true;
207}
208
Shubham Ajmerae4e812a2017-05-25 20:09:58 -0700209int OatFileAssistant::GetDexOptNeeded(CompilerFilter::Filter target,
210 bool profile_changed,
Calin Juravle44e5efa2017-09-12 00:54:26 -0700211 bool downgrade,
212 ClassLoaderContext* class_loader_context) {
Richard Uhler88bc6732016-11-14 14:38:03 +0000213 OatFileInfo& info = GetBestInfo();
Calin Juravle44e5efa2017-09-12 00:54:26 -0700214 DexOptNeeded dexopt_needed = info.GetDexOptNeeded(target,
215 profile_changed,
216 downgrade,
217 class_loader_context);
Richard Uhler7225a8d2016-11-22 10:12:03 +0000218 if (info.IsOatLocation() || dexopt_needed == kDex2OatFromScratch) {
219 return dexopt_needed;
Richard Uhler66d874d2015-01-15 09:37:19 -0800220 }
Richard Uhler7225a8d2016-11-22 10:12:03 +0000221 return -dexopt_needed;
Richard Uhler66d874d2015-01-15 09:37:19 -0800222}
223
Richard Uhlerf4b34872016-04-13 11:03:46 -0700224// Figure out the currently specified compile filter option in the runtime.
225// Returns true on success, false if the compiler filter is invalid, in which
226// case error_msg describes the problem.
227static bool GetRuntimeCompilerFilterOption(CompilerFilter::Filter* filter,
228 std::string* error_msg) {
229 CHECK(filter != nullptr);
230 CHECK(error_msg != nullptr);
231
Calin Juravle357c66d2017-05-04 01:57:17 +0000232 *filter = OatFileAssistant::kDefaultCompilerFilterForDexLoading;
Richard Uhlerf4b34872016-04-13 11:03:46 -0700233 for (StringPiece option : Runtime::Current()->GetCompilerOptions()) {
234 if (option.starts_with("--compiler-filter=")) {
235 const char* compiler_filter_string = option.substr(strlen("--compiler-filter=")).data();
236 if (!CompilerFilter::ParseCompilerFilter(compiler_filter_string, filter)) {
237 *error_msg = std::string("Unknown --compiler-filter value: ")
238 + std::string(compiler_filter_string);
239 return false;
240 }
241 }
242 }
243 return true;
244}
245
Richard Uhler01be6812016-05-17 10:34:52 -0700246bool OatFileAssistant::IsUpToDate() {
Richard Uhler88bc6732016-11-14 14:38:03 +0000247 return GetBestInfo().Status() == kOatUpToDate;
Richard Uhler01be6812016-05-17 10:34:52 -0700248}
249
Richard Uhler1e860612016-03-30 12:17:55 -0700250OatFileAssistant::ResultOfAttemptToUpdate
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700251OatFileAssistant::MakeUpToDate(bool profile_changed,
Calin Juravle44e5efa2017-09-12 00:54:26 -0700252 ClassLoaderContext* class_loader_context,
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700253 std::string* error_msg) {
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700254 // The method doesn't use zip_fd_ and directly opens dex files at dex_locations_.
255 CHECK_EQ(-1, zip_fd_) << "MakeUpToDate should not be called with zip_fd";
256
Richard Uhlerf4b34872016-04-13 11:03:46 -0700257 CompilerFilter::Filter target;
258 if (!GetRuntimeCompilerFilterOption(&target, error_msg)) {
259 return kUpdateNotAttempted;
260 }
261
Richard Uhler88bc6732016-11-14 14:38:03 +0000262 OatFileInfo& info = GetBestInfo();
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700263 // TODO(calin, jeffhao): the context should really be passed to GetDexOptNeeded: b/62269291.
264 // This is actually not trivial in the current logic as it will interact with the collision
265 // check:
266 // - currently, if the context does not match but we have no collisions we still accept the
267 // oat file.
268 // - if GetDexOptNeeded would return kDex2OatFromScratch for a context mismatch and we make
269 // the oat code up to date the collision check becomes useless.
270 // - however, MakeUpToDate will not always succeed (e.g. for primary apks, or for dex files
271 // loaded in other processes). So it boils down to how far do we want to complicate
272 // the logic in order to enable the use of oat files. Maybe its time to try simplify it.
Calin Juravle44e5efa2017-09-12 00:54:26 -0700273 switch (info.GetDexOptNeeded(
274 target, profile_changed, /*downgrade*/ false, class_loader_context)) {
Richard Uhler7225a8d2016-11-22 10:12:03 +0000275 case kNoDexOptNeeded:
276 return kUpdateSucceeded;
Richard Uhler88bc6732016-11-14 14:38:03 +0000277
Richard Uhler7225a8d2016-11-22 10:12:03 +0000278 // TODO: For now, don't bother with all the different ways we can call
279 // dex2oat to generate the oat file. Always generate the oat file as if it
280 // were kDex2OatFromScratch.
281 case kDex2OatFromScratch:
282 case kDex2OatForBootImage:
283 case kDex2OatForRelocation:
284 case kDex2OatForFilter:
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700285 return GenerateOatFileNoChecks(info, target, class_loader_context, error_msg);
Richard Uhler66d874d2015-01-15 09:37:19 -0800286 }
287 UNREACHABLE();
288}
289
290std::unique_ptr<OatFile> OatFileAssistant::GetBestOatFile() {
Richard Uhler88bc6732016-11-14 14:38:03 +0000291 return GetBestInfo().ReleaseFileForUse();
Richard Uhler66d874d2015-01-15 09:37:19 -0800292}
293
Richard Uhler46cc64f2016-11-14 14:53:55 +0000294std::string OatFileAssistant::GetStatusDump() {
295 std::ostringstream status;
296 bool oat_file_exists = false;
297 bool odex_file_exists = false;
Richard Uhler03bc6592016-11-22 09:42:04 +0000298 if (oat_.Status() != kOatCannotOpen) {
Richard Uhler2f27abd2017-01-31 14:02:34 +0000299 // If we can open the file, Filename should not return null.
Richard Uhler03bc6592016-11-22 09:42:04 +0000300 CHECK(oat_.Filename() != nullptr);
Richard Uhler03bc6592016-11-22 09:42:04 +0000301
Richard Uhler46cc64f2016-11-14 14:53:55 +0000302 oat_file_exists = true;
Richard Uhler2f27abd2017-01-31 14:02:34 +0000303 status << *oat_.Filename() << "[status=" << oat_.Status() << ", ";
304 const OatFile* file = oat_.GetFile();
305 if (file == nullptr) {
306 // If the file is null even though the status is not kOatCannotOpen, it
307 // means we must have a vdex file with no corresponding oat file. In
308 // this case we cannot determine the compilation filter. Indicate that
309 // we have only the vdex file instead.
310 status << "vdex-only";
311 } else {
312 status << "compilation_filter=" << CompilerFilter::NameOfFilter(file->GetCompilerFilter());
313 }
Richard Uhler46cc64f2016-11-14 14:53:55 +0000314 }
315
Richard Uhler03bc6592016-11-22 09:42:04 +0000316 if (odex_.Status() != kOatCannotOpen) {
Richard Uhler2f27abd2017-01-31 14:02:34 +0000317 // If we can open the file, Filename should not return null.
Richard Uhler03bc6592016-11-22 09:42:04 +0000318 CHECK(odex_.Filename() != nullptr);
Richard Uhler03bc6592016-11-22 09:42:04 +0000319
Richard Uhler46cc64f2016-11-14 14:53:55 +0000320 odex_file_exists = true;
321 if (oat_file_exists) {
322 status << "] ";
323 }
Richard Uhler2f27abd2017-01-31 14:02:34 +0000324 status << *odex_.Filename() << "[status=" << odex_.Status() << ", ";
325 const OatFile* file = odex_.GetFile();
326 if (file == nullptr) {
327 status << "vdex-only";
328 } else {
329 status << "compilation_filter=" << CompilerFilter::NameOfFilter(file->GetCompilerFilter());
330 }
Richard Uhler46cc64f2016-11-14 14:53:55 +0000331 }
332
333 if (!oat_file_exists && !odex_file_exists) {
334 status << "invalid[";
335 }
336
337 status << "]";
338 return status.str();
339}
340
Richard Uhler66d874d2015-01-15 09:37:19 -0800341std::vector<std::unique_ptr<const DexFile>> OatFileAssistant::LoadDexFiles(
Calin Juravle87e2cb62017-06-13 21:48:45 -0700342 const OatFile &oat_file, const char *dex_location) {
Richard Uhler66d874d2015-01-15 09:37:19 -0800343 std::vector<std::unique_ptr<const DexFile>> dex_files;
Calin Juravle87e2cb62017-06-13 21:48:45 -0700344 if (LoadDexFiles(oat_file, dex_location, &dex_files)) {
345 return dex_files;
346 } else {
347 return std::vector<std::unique_ptr<const DexFile>>();
348 }
349}
Richard Uhler66d874d2015-01-15 09:37:19 -0800350
Calin Juravle87e2cb62017-06-13 21:48:45 -0700351bool OatFileAssistant::LoadDexFiles(
352 const OatFile &oat_file,
353 const std::string& dex_location,
354 std::vector<std::unique_ptr<const DexFile>>* out_dex_files) {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000355 // Load the main dex file.
Richard Uhler66d874d2015-01-15 09:37:19 -0800356 std::string error_msg;
357 const OatFile::OatDexFile* oat_dex_file = oat_file.GetOatDexFile(
Calin Juravle87e2cb62017-06-13 21:48:45 -0700358 dex_location.c_str(), nullptr, &error_msg);
Richard Uhler66d874d2015-01-15 09:37:19 -0800359 if (oat_dex_file == nullptr) {
Richard Uhler9a37efc2016-08-05 16:32:55 -0700360 LOG(WARNING) << error_msg;
Calin Juravle87e2cb62017-06-13 21:48:45 -0700361 return false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800362 }
363
Igor Murashkinb1d8c312015-08-04 11:18:43 -0700364 std::unique_ptr<const DexFile> dex_file = oat_dex_file->OpenDexFile(&error_msg);
Richard Uhler66d874d2015-01-15 09:37:19 -0800365 if (dex_file.get() == nullptr) {
366 LOG(WARNING) << "Failed to open dex file from oat dex file: " << error_msg;
Calin Juravle87e2cb62017-06-13 21:48:45 -0700367 return false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800368 }
Calin Juravle87e2cb62017-06-13 21:48:45 -0700369 out_dex_files->push_back(std::move(dex_file));
Richard Uhler66d874d2015-01-15 09:37:19 -0800370
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000371 // Load the rest of the multidex entries
Calin Juravle87e2cb62017-06-13 21:48:45 -0700372 for (size_t i = 1;; i++) {
Mathieu Chartier79c87da2017-10-10 11:54:29 -0700373 std::string multidex_dex_location = DexFileLoader::GetMultiDexLocation(i, dex_location.c_str());
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000374 oat_dex_file = oat_file.GetOatDexFile(multidex_dex_location.c_str(), nullptr);
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700375 if (oat_dex_file == nullptr) {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000376 // There are no more multidex entries to load.
Richard Uhler66d874d2015-01-15 09:37:19 -0800377 break;
378 }
379
Igor Murashkinb1d8c312015-08-04 11:18:43 -0700380 dex_file = oat_dex_file->OpenDexFile(&error_msg);
Richard Uhler66d874d2015-01-15 09:37:19 -0800381 if (dex_file.get() == nullptr) {
382 LOG(WARNING) << "Failed to open dex file from oat dex file: " << error_msg;
Calin Juravle87e2cb62017-06-13 21:48:45 -0700383 return false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800384 }
Calin Juravle87e2cb62017-06-13 21:48:45 -0700385 out_dex_files->push_back(std::move(dex_file));
Richard Uhler66d874d2015-01-15 09:37:19 -0800386 }
Calin Juravle87e2cb62017-06-13 21:48:45 -0700387 return true;
Richard Uhler66d874d2015-01-15 09:37:19 -0800388}
389
Richard Uhler9b994ea2015-06-24 08:44:19 -0700390bool OatFileAssistant::HasOriginalDexFiles() {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000391 // Ensure GetRequiredDexChecksums has been run so that
Richard Uhler9b994ea2015-06-24 08:44:19 -0700392 // has_original_dex_files_ is initialized. We don't care about the result of
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000393 // GetRequiredDexChecksums.
394 GetRequiredDexChecksums();
Richard Uhler9b994ea2015-06-24 08:44:19 -0700395 return has_original_dex_files_;
396}
397
Richard Uhler95abd042015-03-24 09:51:28 -0700398OatFileAssistant::OatStatus OatFileAssistant::OdexFileStatus() {
Richard Uhler743bf362016-04-19 15:39:37 -0700399 return odex_.Status();
Richard Uhler66d874d2015-01-15 09:37:19 -0800400}
401
Richard Uhler95abd042015-03-24 09:51:28 -0700402OatFileAssistant::OatStatus OatFileAssistant::OatFileStatus() {
Richard Uhler743bf362016-04-19 15:39:37 -0700403 return oat_.Status();
Richard Uhler66d874d2015-01-15 09:37:19 -0800404}
405
Richard Uhler2f27abd2017-01-31 14:02:34 +0000406bool OatFileAssistant::DexChecksumUpToDate(const VdexFile& file, std::string* error_msg) {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000407 const std::vector<uint32_t>* required_dex_checksums = GetRequiredDexChecksums();
408 if (required_dex_checksums == nullptr) {
409 LOG(WARNING) << "Required dex checksums not found. Assuming dex checksums are up to date.";
410 return true;
411 }
412
Nicolas Geoffrayc334f832018-03-02 10:52:16 +0000413 uint32_t number_of_dex_files = file.GetVerifierDepsHeader().GetNumberOfDexFiles();
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000414 if (required_dex_checksums->size() != number_of_dex_files) {
415 *error_msg = StringPrintf("expected %zu dex files but found %u",
416 required_dex_checksums->size(),
417 number_of_dex_files);
Richard Uhler2f27abd2017-01-31 14:02:34 +0000418 return false;
Andreas Gampef8cd8902017-01-18 16:05:01 -0800419 }
420
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000421 for (uint32_t i = 0; i < number_of_dex_files; i++) {
422 uint32_t expected_checksum = (*required_dex_checksums)[i];
423 uint32_t actual_checksum = file.GetLocationChecksum(i);
424 if (expected_checksum != actual_checksum) {
Mathieu Chartier79c87da2017-10-10 11:54:29 -0700425 std::string dex = DexFileLoader::GetMultiDexLocation(i, dex_location_.c_str());
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000426 *error_msg = StringPrintf("Dex checksum does not match for dex: %s."
427 "Expected: %u, actual: %u",
428 dex.c_str(),
429 expected_checksum,
430 actual_checksum);
Richard Uhler2f27abd2017-01-31 14:02:34 +0000431 return false;
432 }
433 }
434
Richard Uhler2f27abd2017-01-31 14:02:34 +0000435 return true;
436}
437
438bool OatFileAssistant::DexChecksumUpToDate(const OatFile& file, std::string* error_msg) {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000439 const std::vector<uint32_t>* required_dex_checksums = GetRequiredDexChecksums();
440 if (required_dex_checksums == nullptr) {
441 LOG(WARNING) << "Required dex checksums not found. Assuming dex checksums are up to date.";
442 return true;
443 }
444
445 uint32_t number_of_dex_files = file.GetOatHeader().GetDexFileCount();
446 if (required_dex_checksums->size() != number_of_dex_files) {
447 *error_msg = StringPrintf("expected %zu dex files but found %u",
448 required_dex_checksums->size(),
449 number_of_dex_files);
Richard Uhler2f27abd2017-01-31 14:02:34 +0000450 return false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800451 }
452
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000453 for (uint32_t i = 0; i < number_of_dex_files; i++) {
Mathieu Chartier79c87da2017-10-10 11:54:29 -0700454 std::string dex = DexFileLoader::GetMultiDexLocation(i, dex_location_.c_str());
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000455 uint32_t expected_checksum = (*required_dex_checksums)[i];
456 const OatFile::OatDexFile* oat_dex_file = file.GetOatDexFile(dex.c_str(), nullptr);
457 if (oat_dex_file == nullptr) {
458 *error_msg = StringPrintf("failed to find %s in %s", dex.c_str(), file.GetLocation().c_str());
459 return false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800460 }
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000461 uint32_t actual_checksum = oat_dex_file->GetDexFileLocationChecksum();
462 if (expected_checksum != actual_checksum) {
463 VLOG(oat) << "Dex checksum does not match for dex: " << dex
464 << ". Expected: " << expected_checksum
465 << ", Actual: " << actual_checksum;
466 return false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800467 }
468 }
Richard Uhler2f27abd2017-01-31 14:02:34 +0000469 return true;
470}
471
472OatFileAssistant::OatStatus OatFileAssistant::GivenOatFileStatus(const OatFile& file) {
473 // Verify the ART_USE_READ_BARRIER state.
474 // TODO: Don't fully reject files due to read barrier state. If they contain
475 // compiled code and are otherwise okay, we should return something like
476 // kOatRelocationOutOfDate. If they don't contain compiled code, the read
477 // barrier state doesn't matter.
478 const bool is_cc = file.GetOatHeader().IsConcurrentCopying();
479 constexpr bool kRuntimeIsCC = kUseReadBarrier;
480 if (is_cc != kRuntimeIsCC) {
481 return kOatCannotOpen;
482 }
483
484 // Verify the dex checksum.
485 std::string error_msg;
Nicolas Geoffray8eaa8e52017-11-13 17:47:50 +0000486 VdexFile* vdex = file.GetVdexFile();
487 if (!DexChecksumUpToDate(*vdex, &error_msg)) {
488 LOG(ERROR) << error_msg;
489 return kOatDexOutOfDate;
Richard Uhler2f27abd2017-01-31 14:02:34 +0000490 }
Richard Uhler66d874d2015-01-15 09:37:19 -0800491
Andreas Gampe29d38e72016-03-23 15:31:51 +0000492 CompilerFilter::Filter current_compiler_filter = file.GetCompilerFilter();
David Brazdilce4b0ba2016-01-28 15:05:49 +0000493
Richard Uhler66d874d2015-01-15 09:37:19 -0800494 // Verify the image checksum
Andreas Gampe29d38e72016-03-23 15:31:51 +0000495 if (CompilerFilter::DependsOnImageChecksum(current_compiler_filter)) {
496 const ImageInfo* image_info = GetImageInfo();
497 if (image_info == nullptr) {
498 VLOG(oat) << "No image for oat image checksum to match against.";
Andreas Gampe29d38e72016-03-23 15:31:51 +0000499
Richard Uhler76f5cb62016-04-04 13:30:16 -0700500 if (HasOriginalDexFiles()) {
Richard Uhler03bc6592016-11-22 09:42:04 +0000501 return kOatBootImageOutOfDate;
Richard Uhler76f5cb62016-04-04 13:30:16 -0700502 }
503
504 // If there is no original dex file to fall back to, grudgingly accept
505 // the oat file. This could technically lead to crashes, but there's no
506 // way we could find a better oat file to use for this dex location,
507 // and it's better than being stuck in a boot loop with no way out.
508 // The problem will hopefully resolve itself the next time the runtime
509 // starts up.
510 LOG(WARNING) << "Dex location " << dex_location_ << " does not seem to include dex file. "
511 << "Allow oat file use. This is potentially dangerous.";
Richard Uhler95e09672017-02-22 11:37:41 +0000512 } else if (file.GetOatHeader().GetImageFileLocationOatChecksum() != image_info->oat_checksum) {
Andreas Gampe29d38e72016-03-23 15:31:51 +0000513 VLOG(oat) << "Oat image checksum does not match image checksum.";
Richard Uhler03bc6592016-11-22 09:42:04 +0000514 return kOatBootImageOutOfDate;
Andreas Gampe29d38e72016-03-23 15:31:51 +0000515 }
516 } else {
517 VLOG(oat) << "Image checksum test skipped for compiler filter " << current_compiler_filter;
Richard Uhler66d874d2015-01-15 09:37:19 -0800518 }
519
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000520 // zip_file_only_contains_uncompressed_dex_ is only set during fetching the dex checksums.
521 DCHECK(required_dex_checksums_attempted_);
522 if (only_load_system_executable_ &&
523 !LocationIsOnSystem(file.GetLocation().c_str()) &&
524 file.ContainsDexCode() &&
525 zip_file_only_contains_uncompressed_dex_) {
526 LOG(ERROR) << "Not loading "
527 << dex_location_
528 << ": oat file has dex code, but APK has uncompressed dex code";
529 return kOatDexOutOfDate;
530 }
531
Nicolas Geoffray49cda062017-04-21 13:08:25 +0100532 if (CompilerFilter::IsAotCompilationEnabled(current_compiler_filter)) {
Andreas Gampe29d38e72016-03-23 15:31:51 +0000533 if (!file.IsPic()) {
534 const ImageInfo* image_info = GetImageInfo();
535 if (image_info == nullptr) {
536 VLOG(oat) << "No image to check oat relocation against.";
Richard Uhler03bc6592016-11-22 09:42:04 +0000537 return kOatRelocationOutOfDate;
Andreas Gampe29d38e72016-03-23 15:31:51 +0000538 }
Richard Uhlera62d2f02016-03-18 15:05:30 -0700539
Andreas Gampe29d38e72016-03-23 15:31:51 +0000540 // Verify the oat_data_begin recorded for the image in the oat file matches
541 // the actual oat_data_begin for boot.oat in the image.
542 const OatHeader& oat_header = file.GetOatHeader();
543 uintptr_t oat_data_begin = oat_header.GetImageFileLocationOatDataBegin();
544 if (oat_data_begin != image_info->oat_data_begin) {
545 VLOG(oat) << file.GetLocation() <<
546 ": Oat file image oat_data_begin (" << oat_data_begin << ")"
547 << " does not match actual image oat_data_begin ("
548 << image_info->oat_data_begin << ")";
Richard Uhler03bc6592016-11-22 09:42:04 +0000549 return kOatRelocationOutOfDate;
Andreas Gampe29d38e72016-03-23 15:31:51 +0000550 }
Richard Uhlera62d2f02016-03-18 15:05:30 -0700551
Andreas Gampe29d38e72016-03-23 15:31:51 +0000552 // Verify the oat_patch_delta recorded for the image in the oat file matches
553 // the actual oat_patch_delta for the image.
554 int32_t oat_patch_delta = oat_header.GetImagePatchDelta();
555 if (oat_patch_delta != image_info->patch_delta) {
556 VLOG(oat) << file.GetLocation() <<
557 ": Oat file image patch delta (" << oat_patch_delta << ")"
558 << " does not match actual image patch delta ("
559 << image_info->patch_delta << ")";
Richard Uhler03bc6592016-11-22 09:42:04 +0000560 return kOatRelocationOutOfDate;
Andreas Gampe29d38e72016-03-23 15:31:51 +0000561 }
562 } else {
563 // Oat files compiled in PIC mode do not require relocation.
564 VLOG(oat) << "Oat relocation test skipped for PIC oat file";
565 }
566 } else {
567 VLOG(oat) << "Oat relocation test skipped for compiler filter " << current_compiler_filter;
Richard Uhler66d874d2015-01-15 09:37:19 -0800568 }
Richard Uhlere8109f72016-04-18 10:40:50 -0700569 return kOatUpToDate;
Richard Uhler66d874d2015-01-15 09:37:19 -0800570}
571
Calin Juravle357c66d2017-05-04 01:57:17 +0000572static bool DexLocationToOdexNames(const std::string& location,
573 InstructionSet isa,
574 std::string* odex_filename,
575 std::string* oat_dir,
576 std::string* isa_dir,
577 std::string* error_msg) {
578 CHECK(odex_filename != nullptr);
579 CHECK(error_msg != nullptr);
580
581 // The odex file name is formed by replacing the dex_location extension with
582 // .odex and inserting an oat/<isa> directory. For example:
583 // location = /foo/bar/baz.jar
584 // odex_location = /foo/bar/oat/<isa>/baz.odex
585
586 // Find the directory portion of the dex location and add the oat/<isa>
587 // directory.
588 size_t pos = location.rfind('/');
589 if (pos == std::string::npos) {
590 *error_msg = "Dex location " + location + " has no directory.";
591 return false;
592 }
593 std::string dir = location.substr(0, pos+1);
594 // Add the oat directory.
595 dir += "oat";
596 if (oat_dir != nullptr) {
597 *oat_dir = dir;
598 }
599 // Add the isa directory
600 dir += "/" + std::string(GetInstructionSetString(isa));
601 if (isa_dir != nullptr) {
602 *isa_dir = dir;
603 }
604
605 // Get the base part of the file without the extension.
606 std::string file = location.substr(pos+1);
607 pos = file.rfind('.');
608 if (pos == std::string::npos) {
609 *error_msg = "Dex location " + location + " has no extension.";
610 return false;
611 }
612 std::string base = file.substr(0, pos);
613
614 *odex_filename = dir + "/" + base + ".odex";
615 return true;
616}
617
618// Prepare a subcomponent of the odex directory.
619// (i.e. create and set the expected permissions on the path `dir`).
620static bool PrepareDirectory(const std::string& dir, std::string* error_msg) {
621 struct stat dir_stat;
622 if (TEMP_FAILURE_RETRY(stat(dir.c_str(), &dir_stat)) == 0) {
623 // The directory exists. Check if it is indeed a directory.
624 if (!S_ISDIR(dir_stat.st_mode)) {
625 *error_msg = dir + " is not a dir";
626 return false;
627 } else {
628 // The dir is already on disk.
629 return true;
630 }
631 }
632
633 // Failed to stat. We need to create the directory.
634 if (errno != ENOENT) {
635 *error_msg = "Could not stat isa dir " + dir + ":" + strerror(errno);
636 return false;
637 }
638
639 mode_t mode = S_IRWXU | S_IXGRP | S_IXOTH;
640 if (mkdir(dir.c_str(), mode) != 0) {
641 *error_msg = "Could not create dir " + dir + ":" + strerror(errno);
642 return false;
643 }
644 if (chmod(dir.c_str(), mode) != 0) {
645 *error_msg = "Could not create the oat dir " + dir + ":" + strerror(errno);
646 return false;
647 }
648 return true;
649}
650
651// Prepares the odex directory for the given dex location.
652static bool PrepareOdexDirectories(const std::string& dex_location,
653 const std::string& expected_odex_location,
654 InstructionSet isa,
655 std::string* error_msg) {
656 std::string actual_odex_location;
657 std::string oat_dir;
658 std::string isa_dir;
659 if (!DexLocationToOdexNames(
660 dex_location, isa, &actual_odex_location, &oat_dir, &isa_dir, error_msg)) {
661 return false;
662 }
663 DCHECK_EQ(expected_odex_location, actual_odex_location);
664
665 if (!PrepareDirectory(oat_dir, error_msg)) {
666 return false;
667 }
668 if (!PrepareDirectory(isa_dir, error_msg)) {
669 return false;
670 }
671 return true;
672}
673
Calin Juravled4215bb2017-09-20 11:54:21 -0700674class Dex2oatFileWrapper {
675 public:
676 explicit Dex2oatFileWrapper(File* file)
677 : file_(file),
678 unlink_file_at_destruction_(true) {
679 }
680
681 ~Dex2oatFileWrapper() {
682 if (unlink_file_at_destruction_ && (file_ != nullptr)) {
683 file_->Erase(/*unlink*/ true);
684 }
685 }
686
687 File* GetFile() { return file_.get(); }
688
689 void DisableUnlinkAtDestruction() {
690 unlink_file_at_destruction_ = false;
Igor Murashkin2ffb7032017-11-08 13:35:21 -0800691 }
Calin Juravled4215bb2017-09-20 11:54:21 -0700692
693 private:
694 std::unique_ptr<File> file_;
695 bool unlink_file_at_destruction_;
696};
697
Calin Juravle357c66d2017-05-04 01:57:17 +0000698OatFileAssistant::ResultOfAttemptToUpdate OatFileAssistant::GenerateOatFileNoChecks(
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700699 OatFileAssistant::OatFileInfo& info,
700 CompilerFilter::Filter filter,
Calin Juravle44e5efa2017-09-12 00:54:26 -0700701 const ClassLoaderContext* class_loader_context,
Calin Juravle27e0d1f2017-07-26 00:16:07 -0700702 std::string* error_msg) {
Richard Uhler66d874d2015-01-15 09:37:19 -0800703 CHECK(error_msg != nullptr);
704
Richard Uhler8327cf72015-10-13 16:34:59 -0700705 Runtime* runtime = Runtime::Current();
706 if (!runtime->IsDex2OatEnabled()) {
707 *error_msg = "Generation of oat file for dex location " + dex_location_
708 + " not attempted because dex2oat is disabled.";
Richard Uhler1e860612016-03-30 12:17:55 -0700709 return kUpdateNotAttempted;
Richard Uhler8327cf72015-10-13 16:34:59 -0700710 }
711
Calin Juravle357c66d2017-05-04 01:57:17 +0000712 if (info.Filename() == nullptr) {
Richard Uhler740eec92015-10-15 15:12:23 -0700713 *error_msg = "Generation of oat file for dex location " + dex_location_
Richard Uhler66d874d2015-01-15 09:37:19 -0800714 + " not attempted because the oat file name could not be determined.";
Richard Uhler1e860612016-03-30 12:17:55 -0700715 return kUpdateNotAttempted;
Richard Uhler66d874d2015-01-15 09:37:19 -0800716 }
Calin Juravle357c66d2017-05-04 01:57:17 +0000717 const std::string& oat_file_name = *info.Filename();
Calin Juravle367b9d82017-05-15 18:18:39 -0700718 const std::string& vdex_file_name = GetVdexFilename(oat_file_name);
Richard Uhler66d874d2015-01-15 09:37:19 -0800719
Richard Uhler66d874d2015-01-15 09:37:19 -0800720 // dex2oat ignores missing dex files and doesn't report an error.
721 // Check explicitly here so we can detect the error properly.
722 // TODO: Why does dex2oat behave that way?
Calin Juravle357c66d2017-05-04 01:57:17 +0000723 struct stat dex_path_stat;
724 if (TEMP_FAILURE_RETRY(stat(dex_location_.c_str(), &dex_path_stat)) != 0) {
725 *error_msg = "Could not access dex location " + dex_location_ + ":" + strerror(errno);
Richard Uhler1e860612016-03-30 12:17:55 -0700726 return kUpdateNotAttempted;
Richard Uhler66d874d2015-01-15 09:37:19 -0800727 }
728
Calin Juravle357c66d2017-05-04 01:57:17 +0000729 // If this is the odex location, we need to create the odex file layout (../oat/isa/..)
730 if (!info.IsOatLocation()) {
731 if (!PrepareOdexDirectories(dex_location_, oat_file_name, isa_, error_msg)) {
732 return kUpdateNotAttempted;
733 }
734 }
735
736 // Set the permissions for the oat and the vdex files.
737 // The user always gets read and write while the group and others propagate
738 // the reading access of the original dex file.
739 mode_t file_mode = S_IRUSR | S_IWUSR |
740 (dex_path_stat.st_mode & S_IRGRP) |
741 (dex_path_stat.st_mode & S_IROTH);
742
Calin Juravled4215bb2017-09-20 11:54:21 -0700743 Dex2oatFileWrapper vdex_file_wrapper(OS::CreateEmptyFile(vdex_file_name.c_str()));
744 File* vdex_file = vdex_file_wrapper.GetFile();
745 if (vdex_file == nullptr) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100746 *error_msg = "Generation of oat file " + oat_file_name
747 + " not attempted because the vdex file " + vdex_file_name
748 + " could not be opened.";
749 return kUpdateNotAttempted;
750 }
751
Calin Juravle357c66d2017-05-04 01:57:17 +0000752 if (fchmod(vdex_file->Fd(), file_mode) != 0) {
David Brazdil7b49e6c2016-09-01 11:06:18 +0100753 *error_msg = "Generation of oat file " + oat_file_name
754 + " not attempted because the vdex file " + vdex_file_name
755 + " could not be made world readable.";
756 return kUpdateNotAttempted;
757 }
758
Calin Juravled4215bb2017-09-20 11:54:21 -0700759 Dex2oatFileWrapper oat_file_wrapper(OS::CreateEmptyFile(oat_file_name.c_str()));
760 File* oat_file = oat_file_wrapper.GetFile();
761 if (oat_file == nullptr) {
Richard Uhler8327cf72015-10-13 16:34:59 -0700762 *error_msg = "Generation of oat file " + oat_file_name
763 + " not attempted because the oat file could not be created.";
Richard Uhler1e860612016-03-30 12:17:55 -0700764 return kUpdateNotAttempted;
Richard Uhler8327cf72015-10-13 16:34:59 -0700765 }
766
Calin Juravle357c66d2017-05-04 01:57:17 +0000767 if (fchmod(oat_file->Fd(), file_mode) != 0) {
Richard Uhler8327cf72015-10-13 16:34:59 -0700768 *error_msg = "Generation of oat file " + oat_file_name
769 + " not attempted because the oat file could not be made world readable.";
Richard Uhler1e860612016-03-30 12:17:55 -0700770 return kUpdateNotAttempted;
Richard Uhler8327cf72015-10-13 16:34:59 -0700771 }
772
773 std::vector<std::string> args;
774 args.push_back("--dex-file=" + dex_location_);
Nicolas Geoffraya6a448a2016-11-10 10:49:40 +0000775 args.push_back("--output-vdex-fd=" + std::to_string(vdex_file->Fd()));
Richard Uhler8327cf72015-10-13 16:34:59 -0700776 args.push_back("--oat-fd=" + std::to_string(oat_file->Fd()));
777 args.push_back("--oat-location=" + oat_file_name);
Calin Juravle07c6d722017-06-07 17:06:12 +0000778 args.push_back("--compiler-filter=" + CompilerFilter::NameOfFilter(filter));
Calin Juravle44e5efa2017-09-12 00:54:26 -0700779 const std::string dex2oat_context = class_loader_context == nullptr
780 ? OatFile::kSpecialSharedLibrary
781 : class_loader_context->EncodeContextForDex2oat(/*base_dir*/ "");
782 args.push_back("--class-loader-context=" + dex2oat_context);
Richard Uhler8327cf72015-10-13 16:34:59 -0700783
Richard Uhler66d874d2015-01-15 09:37:19 -0800784 if (!Dex2Oat(args, error_msg)) {
Richard Uhler1e860612016-03-30 12:17:55 -0700785 return kUpdateFailed;
Richard Uhler8327cf72015-10-13 16:34:59 -0700786 }
787
David Brazdil7b49e6c2016-09-01 11:06:18 +0100788 if (vdex_file->FlushCloseOrErase() != 0) {
789 *error_msg = "Unable to close vdex file " + vdex_file_name;
David Brazdil7b49e6c2016-09-01 11:06:18 +0100790 return kUpdateFailed;
791 }
792
Richard Uhler8327cf72015-10-13 16:34:59 -0700793 if (oat_file->FlushCloseOrErase() != 0) {
794 *error_msg = "Unable to close oat file " + oat_file_name;
Richard Uhler1e860612016-03-30 12:17:55 -0700795 return kUpdateFailed;
Richard Uhler66d874d2015-01-15 09:37:19 -0800796 }
797
Calin Juravle357c66d2017-05-04 01:57:17 +0000798 // Mark that the odex file has changed and we should try to reload.
799 info.Reset();
Calin Juravled4215bb2017-09-20 11:54:21 -0700800 // We have compiled successfully. Disable the auto-unlink.
801 vdex_file_wrapper.DisableUnlinkAtDestruction();
802 oat_file_wrapper.DisableUnlinkAtDestruction();
803
Richard Uhler1e860612016-03-30 12:17:55 -0700804 return kUpdateSucceeded;
Richard Uhler66d874d2015-01-15 09:37:19 -0800805}
806
807bool OatFileAssistant::Dex2Oat(const std::vector<std::string>& args,
808 std::string* error_msg) {
809 Runtime* runtime = Runtime::Current();
810 std::string image_location = ImageLocation();
811 if (image_location.empty()) {
812 *error_msg = "No image location found for Dex2Oat.";
813 return false;
814 }
815
816 std::vector<std::string> argv;
817 argv.push_back(runtime->GetCompilerExecutable());
Nicolas Geoffray433b79a2017-01-30 20:54:45 +0000818 if (runtime->IsJavaDebuggable()) {
Sebastien Hertz0de11332015-05-13 12:14:05 +0200819 argv.push_back("--debuggable");
820 }
Igor Murashkinb1d8c312015-08-04 11:18:43 -0700821 runtime->AddCurrentRuntimeFeaturesAsDex2OatArguments(&argv);
Richard Uhler66d874d2015-01-15 09:37:19 -0800822
823 if (!runtime->IsVerificationEnabled()) {
824 argv.push_back("--compiler-filter=verify-none");
825 }
826
David Brazdil4fe044c2018-05-14 15:24:34 +0100827 if (runtime->GetHiddenApiEnforcementPolicy() != hiddenapi::EnforcementPolicy::kNoChecks) {
828 argv.push_back("--runtime-arg");
829 argv.push_back("-Xhidden-api-checks");
830 }
831
Richard Uhler66d874d2015-01-15 09:37:19 -0800832 if (runtime->MustRelocateIfPossible()) {
833 argv.push_back("--runtime-arg");
834 argv.push_back("-Xrelocate");
835 } else {
836 argv.push_back("--runtime-arg");
837 argv.push_back("-Xnorelocate");
838 }
839
840 if (!kIsTargetBuild) {
841 argv.push_back("--host");
842 }
843
844 argv.push_back("--boot-image=" + image_location);
845
846 std::vector<std::string> compiler_options = runtime->GetCompilerOptions();
847 argv.insert(argv.end(), compiler_options.begin(), compiler_options.end());
848
849 argv.insert(argv.end(), args.begin(), args.end());
850
Andreas Gampe9186ced2016-12-12 14:28:21 -0800851 std::string command_line(android::base::Join(argv, ' '));
Richard Uhler66d874d2015-01-15 09:37:19 -0800852 return Exec(argv, error_msg);
853}
854
Richard Uhlerb81881d2016-04-19 13:08:04 -0700855bool OatFileAssistant::DexLocationToOdexFilename(const std::string& location,
856 InstructionSet isa,
857 std::string* odex_filename,
858 std::string* error_msg) {
Calin Juravle357c66d2017-05-04 01:57:17 +0000859 return DexLocationToOdexNames(location, isa, odex_filename, nullptr, nullptr, error_msg);
Richard Uhler66d874d2015-01-15 09:37:19 -0800860}
861
Richard Uhlerb81881d2016-04-19 13:08:04 -0700862bool OatFileAssistant::DexLocationToOatFilename(const std::string& location,
863 InstructionSet isa,
864 std::string* oat_filename,
865 std::string* error_msg) {
866 CHECK(oat_filename != nullptr);
867 CHECK(error_msg != nullptr);
Richard Uhler66d874d2015-01-15 09:37:19 -0800868
Richard Uhler55b58b62016-08-12 09:05:13 -0700869 std::string cache_dir = GetDalvikCache(GetInstructionSetString(isa));
870 if (cache_dir.empty()) {
871 *error_msg = "Dalvik cache directory does not exist";
872 return false;
873 }
Richard Uhlerb81881d2016-04-19 13:08:04 -0700874
875 // TODO: The oat file assistant should be the definitive place for
876 // determining the oat file name from the dex location, not
877 // GetDalvikCacheFilename.
Richard Uhlerb81881d2016-04-19 13:08:04 -0700878 return GetDalvikCacheFilename(location.c_str(), cache_dir.c_str(), oat_filename, error_msg);
Richard Uhler66d874d2015-01-15 09:37:19 -0800879}
880
Richard Uhler66d874d2015-01-15 09:37:19 -0800881std::string OatFileAssistant::ImageLocation() {
882 Runtime* runtime = Runtime::Current();
Andreas Gampe8994a042015-12-30 19:03:17 +0000883 const std::vector<gc::space::ImageSpace*>& image_spaces =
884 runtime->GetHeap()->GetBootImageSpaces();
885 if (image_spaces.empty()) {
886 return "";
887 }
888 return image_spaces[0]->GetImageLocation();
Richard Uhler66d874d2015-01-15 09:37:19 -0800889}
890
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000891const std::vector<uint32_t>* OatFileAssistant::GetRequiredDexChecksums() {
892 if (!required_dex_checksums_attempted_) {
893 required_dex_checksums_attempted_ = true;
894 required_dex_checksums_found_ = false;
895 cached_required_dex_checksums_.clear();
Richard Uhler66d874d2015-01-15 09:37:19 -0800896 std::string error_msg;
David Sehr013fd802018-01-11 22:55:24 -0800897 const ArtDexFileLoader dex_file_loader;
898 if (dex_file_loader.GetMultiDexChecksums(dex_location_.c_str(),
899 &cached_required_dex_checksums_,
900 &error_msg,
Nicolas Geoffray66ff8a82018-02-28 13:27:55 +0000901 zip_fd_,
902 &zip_file_only_contains_uncompressed_dex_)) {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000903 required_dex_checksums_found_ = true;
Richard Uhler9b994ea2015-06-24 08:44:19 -0700904 has_original_dex_files_ = true;
Richard Uhler66d874d2015-01-15 09:37:19 -0800905 } else {
906 // This can happen if the original dex file has been stripped from the
907 // apk.
908 VLOG(oat) << "OatFileAssistant: " << error_msg;
Richard Uhler9b994ea2015-06-24 08:44:19 -0700909 has_original_dex_files_ = false;
Richard Uhler66d874d2015-01-15 09:37:19 -0800910
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000911 // Get the checksums from the odex if we can.
Richard Uhler743bf362016-04-19 15:39:37 -0700912 const OatFile* odex_file = odex_.GetFile();
Richard Uhler66d874d2015-01-15 09:37:19 -0800913 if (odex_file != nullptr) {
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000914 required_dex_checksums_found_ = true;
915 for (size_t i = 0; i < odex_file->GetOatHeader().GetDexFileCount(); i++) {
Mathieu Chartier79c87da2017-10-10 11:54:29 -0700916 std::string dex = DexFileLoader::GetMultiDexLocation(i, dex_location_.c_str());
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000917 const OatFile::OatDexFile* odex_dex_file = odex_file->GetOatDexFile(dex.c_str(), nullptr);
918 if (odex_dex_file == nullptr) {
919 required_dex_checksums_found_ = false;
920 break;
921 }
922 cached_required_dex_checksums_.push_back(odex_dex_file->GetDexFileLocationChecksum());
Richard Uhler66d874d2015-01-15 09:37:19 -0800923 }
924 }
925 }
926 }
Richard Uhler69bcf2c2017-01-24 10:25:21 +0000927 return required_dex_checksums_found_ ? &cached_required_dex_checksums_ : nullptr;
Richard Uhler66d874d2015-01-15 09:37:19 -0800928}
929
Richard Uhler95e09672017-02-22 11:37:41 +0000930std::unique_ptr<OatFileAssistant::ImageInfo>
931OatFileAssistant::ImageInfo::GetRuntimeImageInfo(InstructionSet isa, std::string* error_msg) {
932 CHECK(error_msg != nullptr);
933
Richard Uhler95e09672017-02-22 11:37:41 +0000934 Runtime* runtime = Runtime::Current();
Richard Uhler8f104862017-02-22 12:34:01 +0000935 std::unique_ptr<ImageInfo> info(new ImageInfo());
936 info->location = runtime->GetImageLocation();
937
938 std::unique_ptr<ImageHeader> image_header(
939 gc::space::ImageSpace::ReadImageHeader(info->location.c_str(), isa, error_msg));
940 if (image_header == nullptr) {
Richard Uhler95e09672017-02-22 11:37:41 +0000941 return nullptr;
942 }
943
Richard Uhler8f104862017-02-22 12:34:01 +0000944 info->oat_checksum = image_header->GetOatChecksum();
945 info->oat_data_begin = reinterpret_cast<uintptr_t>(image_header->GetOatDataBegin());
946 info->patch_delta = image_header->GetPatchDelta();
Richard Uhler95e09672017-02-22 11:37:41 +0000947 return info;
948}
949
Richard Uhler66d874d2015-01-15 09:37:19 -0800950const OatFileAssistant::ImageInfo* OatFileAssistant::GetImageInfo() {
951 if (!image_info_load_attempted_) {
952 image_info_load_attempted_ = true;
Richard Uhler95e09672017-02-22 11:37:41 +0000953 std::string error_msg;
954 cached_image_info_ = ImageInfo::GetRuntimeImageInfo(isa_, &error_msg);
955 if (cached_image_info_ == nullptr) {
956 LOG(WARNING) << "Unable to get runtime image info: " << error_msg;
Richard Uhler66d874d2015-01-15 09:37:19 -0800957 }
Richard Uhler66d874d2015-01-15 09:37:19 -0800958 }
Richard Uhler95e09672017-02-22 11:37:41 +0000959 return cached_image_info_.get();
Richard Uhler66d874d2015-01-15 09:37:19 -0800960}
961
Richard Uhler88bc6732016-11-14 14:38:03 +0000962OatFileAssistant::OatFileInfo& OatFileAssistant::GetBestInfo() {
Calin Juravle357c66d2017-05-04 01:57:17 +0000963 // TODO(calin): Document the side effects of class loading when
964 // running dalvikvm command line.
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -0700965 if (dex_parent_writable_ || UseFdToReadFiles()) {
Calin Juravle357c66d2017-05-04 01:57:17 +0000966 // If the parent of the dex file is writable it means that we can
967 // create the odex file. In this case we unconditionally pick the odex
968 // as the best oat file. This corresponds to the regular use case when
969 // apps gets installed or when they load private, secondary dex file.
970 // For apps on the system partition the odex location will not be
971 // writable and thus the oat location might be more up to date.
972 return odex_;
973 }
974
975 // We cannot write to the odex location. This must be a system app.
976
977 // If the oat location is usable take it.
978 if (oat_.IsUseable()) {
979 return oat_;
980 }
981
982 // The oat file is not usable but the odex file might be up to date.
983 // This is an indication that we are dealing with an up to date prebuilt
984 // (that doesn't need relocation).
985 if (odex_.Status() == kOatUpToDate) {
986 return odex_;
987 }
988
989 // The oat file is not usable and the odex file is not up to date.
990 // However we have access to the original dex file which means we can make
991 // the oat location up to date.
992 if (HasOriginalDexFiles()) {
993 return oat_;
994 }
995
996 // We got into the worst situation here:
997 // - the oat location is not usable
998 // - the prebuild odex location is not up to date
999 // - and we don't have the original dex file anymore (stripped).
1000 // Pick the odex if it exists, or the oat if not.
1001 return (odex_.Status() == kOatCannotOpen) ? oat_ : odex_;
Richard Uhler88bc6732016-11-14 14:38:03 +00001002}
1003
Andreas Gampea463b6a2016-08-12 21:53:32 -07001004std::unique_ptr<gc::space::ImageSpace> OatFileAssistant::OpenImageSpace(const OatFile* oat_file) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001005 DCHECK(oat_file != nullptr);
David Brazdil7b49e6c2016-09-01 11:06:18 +01001006 std::string art_file = ReplaceFileExtension(oat_file->GetLocation(), "art");
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001007 if (art_file.empty()) {
1008 return nullptr;
1009 }
1010 std::string error_msg;
1011 ScopedObjectAccess soa(Thread::Current());
Andreas Gampea463b6a2016-08-12 21:53:32 -07001012 std::unique_ptr<gc::space::ImageSpace> ret =
1013 gc::space::ImageSpace::CreateFromAppImage(art_file.c_str(), oat_file, &error_msg);
Mathieu Chartiere778fc72016-01-25 20:11:28 -08001014 if (ret == nullptr && (VLOG_IS_ON(image) || OS::FileExists(art_file.c_str()))) {
Mathieu Chartierfbc31082016-01-24 11:59:56 -08001015 LOG(INFO) << "Failed to open app image " << art_file.c_str() << " " << error_msg;
1016 }
1017 return ret;
1018}
1019
Richard Uhler88bc6732016-11-14 14:38:03 +00001020OatFileAssistant::OatFileInfo::OatFileInfo(OatFileAssistant* oat_file_assistant,
1021 bool is_oat_location)
1022 : oat_file_assistant_(oat_file_assistant), is_oat_location_(is_oat_location)
Richard Uhler743bf362016-04-19 15:39:37 -07001023{}
1024
Richard Uhler88bc6732016-11-14 14:38:03 +00001025bool OatFileAssistant::OatFileInfo::IsOatLocation() {
1026 return is_oat_location_;
1027}
1028
Richard Uhler743bf362016-04-19 15:39:37 -07001029const std::string* OatFileAssistant::OatFileInfo::Filename() {
1030 return filename_provided_ ? &filename_ : nullptr;
1031}
1032
Richard Uhler03bc6592016-11-22 09:42:04 +00001033bool OatFileAssistant::OatFileInfo::IsUseable() {
1034 switch (Status()) {
1035 case kOatCannotOpen:
1036 case kOatDexOutOfDate:
1037 case kOatBootImageOutOfDate: return false;
1038
1039 case kOatRelocationOutOfDate:
1040 case kOatUpToDate: return true;
1041 }
1042 UNREACHABLE();
Richard Uhler743bf362016-04-19 15:39:37 -07001043}
1044
1045OatFileAssistant::OatStatus OatFileAssistant::OatFileInfo::Status() {
1046 if (!status_attempted_) {
1047 status_attempted_ = true;
1048 const OatFile* file = GetFile();
1049 if (file == nullptr) {
Richard Uhler2f27abd2017-01-31 14:02:34 +00001050 // Check to see if there is a vdex file we can make use of.
1051 std::string error_msg;
Calin Juravle367b9d82017-05-15 18:18:39 -07001052 std::string vdex_filename = GetVdexFilename(filename_);
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001053 std::unique_ptr<VdexFile> vdex;
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -07001054 if (use_fd_) {
1055 if (vdex_fd_ >= 0) {
1056 struct stat s;
1057 int rc = TEMP_FAILURE_RETRY(fstat(vdex_fd_, &s));
1058 if (rc == -1) {
1059 error_msg = StringPrintf("Failed getting length of the vdex file %s.", strerror(errno));
1060 } else {
1061 vdex = VdexFile::Open(vdex_fd_,
1062 s.st_size,
1063 vdex_filename,
1064 false /*writable*/,
1065 false /*low_4gb*/,
1066 false /* unquicken */,
1067 &error_msg);
1068 }
1069 }
1070 } else {
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001071 vdex = VdexFile::Open(vdex_filename,
1072 false /*writeable*/,
1073 false /*low_4gb*/,
1074 false /*unquicken*/,
1075 &error_msg);
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001076 }
Richard Uhler2f27abd2017-01-31 14:02:34 +00001077 if (vdex == nullptr) {
1078 status_ = kOatCannotOpen;
1079 VLOG(oat) << "unable to open vdex file " << vdex_filename << ": " << error_msg;
1080 } else {
1081 if (oat_file_assistant_->DexChecksumUpToDate(*vdex, &error_msg)) {
1082 // The vdex file does not contain enough information to determine
1083 // whether it is up to date with respect to the boot image, so we
1084 // assume it is out of date.
1085 VLOG(oat) << error_msg;
1086 status_ = kOatBootImageOutOfDate;
1087 } else {
1088 status_ = kOatDexOutOfDate;
1089 }
1090 }
Richard Uhler743bf362016-04-19 15:39:37 -07001091 } else {
1092 status_ = oat_file_assistant_->GivenOatFileStatus(*file);
Richard Uhler9a37efc2016-08-05 16:32:55 -07001093 VLOG(oat) << file->GetLocation() << " is " << status_
1094 << " with filter " << file->GetCompilerFilter();
Richard Uhler743bf362016-04-19 15:39:37 -07001095 }
1096 }
1097 return status_;
1098}
1099
Richard Uhler70a84262016-11-08 16:51:51 +00001100OatFileAssistant::DexOptNeeded OatFileAssistant::OatFileInfo::GetDexOptNeeded(
Calin Juravle44e5efa2017-09-12 00:54:26 -07001101 CompilerFilter::Filter target,
1102 bool profile_changed,
1103 bool downgrade,
1104 ClassLoaderContext* context) {
1105
Nicolas Geoffray49cda062017-04-21 13:08:25 +01001106 bool compilation_desired = CompilerFilter::IsAotCompilationEnabled(target);
Shubham Ajmerae4e812a2017-05-25 20:09:58 -07001107 bool filter_okay = CompilerFilterIsOkay(target, profile_changed, downgrade);
Calin Juravle44e5efa2017-09-12 00:54:26 -07001108 bool class_loader_context_okay = ClassLoaderContextIsOkay(context);
Richard Uhler70a84262016-11-08 16:51:51 +00001109
Calin Juravle44e5efa2017-09-12 00:54:26 -07001110 // Only check the filter and relocation if the class loader context is ok.
1111 // If it is not, we will return kDex2OatFromScratch as the compilation needs to be redone.
1112 if (class_loader_context_okay) {
1113 if (filter_okay && Status() == kOatUpToDate) {
1114 // The oat file is in good shape as is.
1115 return kNoDexOptNeeded;
1116 }
Richard Uhler70a84262016-11-08 16:51:51 +00001117
Calin Juravle44e5efa2017-09-12 00:54:26 -07001118 if (filter_okay && !compilation_desired && Status() == kOatRelocationOutOfDate) {
1119 // If no compilation is desired, then it doesn't matter if the oat
1120 // file needs relocation. It's in good shape as is.
1121 return kNoDexOptNeeded;
1122 }
Richard Uhler7225a8d2016-11-22 10:12:03 +00001123
Calin Juravle44e5efa2017-09-12 00:54:26 -07001124 if (filter_okay && Status() == kOatRelocationOutOfDate) {
1125 return kDex2OatForRelocation;
1126 }
Richard Uhler7225a8d2016-11-22 10:12:03 +00001127
Calin Juravle44e5efa2017-09-12 00:54:26 -07001128 if (IsUseable()) {
1129 return kDex2OatForFilter;
1130 }
Nicolas Geoffray08e9eed2017-04-25 17:36:51 +01001131
Calin Juravle44e5efa2017-09-12 00:54:26 -07001132 if (Status() == kOatBootImageOutOfDate) {
1133 return kDex2OatForBootImage;
1134 }
Nicolas Geoffray08e9eed2017-04-25 17:36:51 +01001135 }
1136
1137 if (oat_file_assistant_->HasOriginalDexFiles()) {
1138 return kDex2OatFromScratch;
1139 } else {
1140 // Otherwise there is nothing we can do, even if we want to.
1141 return kNoDexOptNeeded;
1142 }
Richard Uhler70a84262016-11-08 16:51:51 +00001143}
1144
Richard Uhler743bf362016-04-19 15:39:37 -07001145const OatFile* OatFileAssistant::OatFileInfo::GetFile() {
1146 CHECK(!file_released_) << "GetFile called after oat file released.";
1147 if (!load_attempted_) {
1148 load_attempted_ = true;
1149 if (filename_provided_) {
Nicolas Geoffray29742602017-12-14 10:09:03 +00001150 bool executable = oat_file_assistant_->load_executable_;
1151 if (executable && oat_file_assistant_->only_load_system_executable_) {
1152 executable = LocationIsOnSystem(filename_.c_str());
1153 }
Richard Uhler743bf362016-04-19 15:39:37 -07001154 std::string error_msg;
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -07001155 if (use_fd_) {
1156 if (oat_fd_ >= 0 && vdex_fd_ >= 0) {
Nicolas Geoffray96dca1c2018-04-19 14:43:29 +01001157 file_.reset(OatFile::Open(zip_fd_,
1158 vdex_fd_,
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -07001159 oat_fd_,
1160 filename_.c_str(),
1161 nullptr,
1162 nullptr,
Nicolas Geoffray29742602017-12-14 10:09:03 +00001163 executable,
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -07001164 false /* low_4gb */,
1165 oat_file_assistant_->dex_location_.c_str(),
1166 &error_msg));
1167 }
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001168 } else {
Nicolas Geoffray96dca1c2018-04-19 14:43:29 +01001169 file_.reset(OatFile::Open(/* zip_fd */ -1,
1170 filename_.c_str(),
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001171 filename_.c_str(),
1172 nullptr,
1173 nullptr,
Nicolas Geoffray29742602017-12-14 10:09:03 +00001174 executable,
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001175 false /* low_4gb */,
1176 oat_file_assistant_->dex_location_.c_str(),
1177 &error_msg));
1178 }
Richard Uhler743bf362016-04-19 15:39:37 -07001179 if (file_.get() == nullptr) {
1180 VLOG(oat) << "OatFileAssistant test for existing oat file "
1181 << filename_ << ": " << error_msg;
1182 }
1183 }
1184 }
1185 return file_.get();
1186}
1187
1188bool OatFileAssistant::OatFileInfo::CompilerFilterIsOkay(
Shubham Ajmerae4e812a2017-05-25 20:09:58 -07001189 CompilerFilter::Filter target, bool profile_changed, bool downgrade) {
Richard Uhler743bf362016-04-19 15:39:37 -07001190 const OatFile* file = GetFile();
1191 if (file == nullptr) {
1192 return false;
1193 }
1194
1195 CompilerFilter::Filter current = file->GetCompilerFilter();
1196 if (profile_changed && CompilerFilter::DependsOnProfile(current)) {
1197 VLOG(oat) << "Compiler filter not okay because Profile changed";
1198 return false;
1199 }
Shubham Ajmerae4e812a2017-05-25 20:09:58 -07001200 return downgrade ? !CompilerFilter::IsBetter(current, target) :
1201 CompilerFilter::IsAsGoodAs(current, target);
Richard Uhler743bf362016-04-19 15:39:37 -07001202}
1203
Calin Juravle44e5efa2017-09-12 00:54:26 -07001204bool OatFileAssistant::OatFileInfo::ClassLoaderContextIsOkay(ClassLoaderContext* context) {
1205 if (context == nullptr) {
1206 VLOG(oat) << "ClassLoaderContext check ignored: null context";
1207 return true;
1208 }
1209
1210 const OatFile* file = GetFile();
1211 if (file == nullptr) {
Calin Juravle20c46442017-09-12 00:54:26 -07001212 // No oat file means we have nothing to verify.
1213 return true;
Calin Juravle44e5efa2017-09-12 00:54:26 -07001214 }
1215
Calin Juravle20c46442017-09-12 00:54:26 -07001216 size_t dir_index = oat_file_assistant_->dex_location_.rfind('/');
Calin Juravle44e5efa2017-09-12 00:54:26 -07001217 std::string classpath_dir = (dir_index != std::string::npos)
Calin Juravle20c46442017-09-12 00:54:26 -07001218 ? oat_file_assistant_->dex_location_.substr(0, dir_index)
Calin Juravle44e5efa2017-09-12 00:54:26 -07001219 : "";
1220
1221 if (!context->OpenDexFiles(oat_file_assistant_->isa_, classpath_dir)) {
1222 VLOG(oat) << "ClassLoaderContext check failed: dex files from the context could not be opened";
1223 return false;
1224 }
1225
1226 bool result = context->VerifyClassLoaderContextMatch(file->GetClassLoaderContext());
1227 if (!result) {
1228 VLOG(oat) << "ClassLoaderContext check failed. Context was "
1229 << file->GetClassLoaderContext()
1230 << ". The expected context is " << context->EncodeContextForOatFile(classpath_dir);
1231 }
1232 return result;
1233}
1234
Richard Uhler743bf362016-04-19 15:39:37 -07001235bool OatFileAssistant::OatFileInfo::IsExecutable() {
1236 const OatFile* file = GetFile();
1237 return (file != nullptr && file->IsExecutable());
1238}
1239
Richard Uhler743bf362016-04-19 15:39:37 -07001240void OatFileAssistant::OatFileInfo::Reset() {
1241 load_attempted_ = false;
1242 file_.reset();
1243 status_attempted_ = false;
1244}
1245
Nicolas Geoffray96dca1c2018-04-19 14:43:29 +01001246void OatFileAssistant::OatFileInfo::Reset(const std::string& filename,
1247 bool use_fd,
1248 int zip_fd,
1249 int vdex_fd,
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001250 int oat_fd) {
Richard Uhler743bf362016-04-19 15:39:37 -07001251 filename_provided_ = true;
1252 filename_ = filename;
Shubham Ajmerac12bf4c2017-10-24 16:59:42 -07001253 use_fd_ = use_fd;
Nicolas Geoffray96dca1c2018-04-19 14:43:29 +01001254 zip_fd_ = zip_fd;
Shubham Ajmerab22dea02017-10-04 18:36:41 -07001255 vdex_fd_ = vdex_fd;
1256 oat_fd_ = oat_fd;
Richard Uhler743bf362016-04-19 15:39:37 -07001257 Reset();
1258}
1259
1260std::unique_ptr<OatFile> OatFileAssistant::OatFileInfo::ReleaseFile() {
1261 file_released_ = true;
1262 return std::move(file_);
1263}
1264
Richard Uhler70a84262016-11-08 16:51:51 +00001265std::unique_ptr<OatFile> OatFileAssistant::OatFileInfo::ReleaseFileForUse() {
Richard Uhler3e580bc2016-11-08 16:23:07 +00001266 if (Status() == kOatUpToDate) {
Richard Uhler70a84262016-11-08 16:51:51 +00001267 return ReleaseFile();
1268 }
1269
1270 VLOG(oat) << "Oat File Assistant: No relocated oat file found,"
1271 << " attempting to fall back to interpreting oat file instead.";
1272
Richard Uhler03bc6592016-11-22 09:42:04 +00001273 if (Status() == kOatRelocationOutOfDate && !IsExecutable()) {
Richard Uhler70a84262016-11-08 16:51:51 +00001274 return ReleaseFile();
1275 }
1276
Andreas Gampeed010d42018-03-02 09:32:03 -08001277 switch (Status()) {
1278 case kOatBootImageOutOfDate:
Andreas Gampe470eaec2018-03-06 08:39:21 -08001279 // OutOfDate may be either a mismatched image, or a missing image.
Andreas Gampeed010d42018-03-02 09:32:03 -08001280 if (oat_file_assistant_->HasOriginalDexFiles()) {
Andreas Gampe470eaec2018-03-06 08:39:21 -08001281 // If there are original dex files, it is better to use them (to avoid a potential
1282 // quickening mismatch because the boot image changed).
Andreas Gampeed010d42018-03-02 09:32:03 -08001283 break;
1284 }
Andreas Gampe470eaec2018-03-06 08:39:21 -08001285 // If we do not accept the oat file, we may not have access to dex bytecode at all. Grudgingly
1286 // go forward.
Andreas Gampeed010d42018-03-02 09:32:03 -08001287 FALLTHROUGH_INTENDED;
1288
1289 case kOatRelocationOutOfDate:
1290 // We are loading an oat file for runtime use that needs relocation.
1291 // Reload the file non-executable to ensure that we interpret out of the
1292 // dex code in the oat file rather than trying to execute the unrelocated
1293 // compiled code.
1294 oat_file_assistant_->load_executable_ = false;
1295 Reset();
1296 if (IsUseable()) {
1297 CHECK(!IsExecutable());
1298 return ReleaseFile();
1299 }
1300 break;
1301
1302 case kOatUpToDate:
1303 case kOatCannotOpen:
1304 case kOatDexOutOfDate:
1305 break;
Richard Uhler70a84262016-11-08 16:51:51 +00001306 }
Andreas Gampeed010d42018-03-02 09:32:03 -08001307
Richard Uhler70a84262016-11-08 16:51:51 +00001308 return std::unique_ptr<OatFile>();
1309}
Calin Juravle5f9a8012018-02-12 20:27:46 -08001310
1311// TODO(calin): we could provide a more refined status here
1312// (e.g. run from uncompressed apk, run with vdex but not oat etc). It will allow us to
1313// track more experiments but adds extra complexity.
1314void OatFileAssistant::GetOptimizationStatus(
1315 const std::string& filename,
1316 InstructionSet isa,
1317 std::string* out_compilation_filter,
1318 std::string* out_compilation_reason) {
Andreas Gampe85615452018-03-15 17:45:03 -07001319 // It may not be possible to load an oat file executable (e.g., selinux restrictions). Load
1320 // non-executable and check the status manually.
1321 OatFileAssistant oat_file_assistant(filename.c_str(), isa, false /* load_executable */);
Calin Juravle5f9a8012018-02-12 20:27:46 -08001322 std::unique_ptr<OatFile> oat_file = oat_file_assistant.GetBestOatFile();
1323
1324 if (oat_file == nullptr) {
1325 *out_compilation_filter = "run-from-apk";
1326 *out_compilation_reason = "unknown";
Andreas Gampe85615452018-03-15 17:45:03 -07001327 return;
Calin Juravle5f9a8012018-02-12 20:27:46 -08001328 }
Andreas Gampe85615452018-03-15 17:45:03 -07001329
1330 OatStatus status = oat_file_assistant.GivenOatFileStatus(*oat_file);
1331 const char* reason = oat_file->GetCompilationReason();
1332 *out_compilation_reason = reason == nullptr ? "unknown" : reason;
1333 switch (status) {
1334 case OatStatus::kOatUpToDate:
1335 *out_compilation_filter = CompilerFilter::NameOfFilter(oat_file->GetCompilerFilter());
1336 return;
1337
1338 case kOatCannotOpen: // This should never happen, but be robust.
1339 *out_compilation_filter = "error";
1340 *out_compilation_reason = "error";
1341 return;
1342
1343 // kOatBootImageOutOfDate - The oat file is up to date with respect to the
1344 // dex file, but is out of date with respect to the boot image.
1345 case kOatBootImageOutOfDate:
1346 FALLTHROUGH_INTENDED;
1347 case kOatDexOutOfDate:
1348 if (oat_file_assistant.HasOriginalDexFiles()) {
1349 *out_compilation_filter = "run-from-apk-fallback";
1350 } else {
1351 *out_compilation_filter = "run-from-vdex-fallback";
1352 }
1353 return;
1354
1355 case kOatRelocationOutOfDate:
1356 // On relocation-out-of-date, we'd run the dex code.
1357 *out_compilation_filter = "run-from-vdex-fallback";
1358 return;
1359 }
1360 LOG(FATAL) << "Unreachable";
1361 UNREACHABLE();
Calin Juravle5f9a8012018-02-12 20:27:46 -08001362}
1363
Richard Uhler66d874d2015-01-15 09:37:19 -08001364} // namespace art