blob: 5076ae6e56ece3f87db16c185aa250b70e6dafc0 [file] [log] [blame]
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07001/*
2 * Copyright (C) 2016 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 */
Alan Stokescb27c342018-04-20 17:09:25 +010016#define LOG_TAG "installd"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070017
Alan Stokesa25d90c2017-10-16 10:56:00 +010018#include <array>
Jeff Sharkey90aff262016-12-12 14:28:24 -070019#include <fcntl.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070020#include <stdlib.h>
21#include <string.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070022#include <sys/capability.h>
23#include <sys/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070024#include <sys/stat.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070025#include <sys/time.h>
26#include <sys/types.h>
27#include <sys/resource.h>
28#include <sys/wait.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070029#include <unistd.h>
30
Andreas Gampe023b2242018-02-28 16:03:25 -080031#include <iomanip>
32
Alan Stokesa25d90c2017-10-16 10:56:00 +010033#include <android-base/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070034#include <android-base/logging.h>
Andreas Gampe6a9cf722017-07-24 16:49:10 -070035#include <android-base/properties.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070036#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070037#include <android-base/strings.h>
38#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080039#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070040#include <cutils/properties.h>
41#include <cutils/sched_policy.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070042#include <log/log.h> // TODO: Move everything to base/logging.
Alan Stokesa25d90c2017-10-16 10:56:00 +010043#include <openssl/sha.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070044#include <private/android_filesystem_config.h>
Suren Baghdasaryan1cc5de62019-01-25 05:29:23 +000045#include <processgroup/sched_policy.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070046#include <selinux/android.h>
Nicolas Geoffrayaaad21e2019-02-25 13:31:10 +000047#include <server_configurable_flags/get_flags.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070048#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070049
50#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080051#include "dexopt_return_codes.h"
Victor Hsiehc9821f12020-08-07 11:32:29 -070052#include "execv_helper.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060053#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070054#include "installd_deps.h"
55#include "otapreopt_utils.h"
Victor Hsiehc9821f12020-08-07 11:32:29 -070056#include "run_dex2oat.h"
Victor Hsiehcb35a062020-08-13 16:11:13 -070057#include "unique_file.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070058#include "utils.h"
59
Victor Hsieh76f19ba2020-08-10 14:37:26 -070060using android::base::Basename;
Jeff Sharkey90aff262016-12-12 14:28:24 -070061using android::base::EndsWith;
Mathieu Chartier9b2da082018-10-26 13:23:11 -070062using android::base::GetBoolProperty;
63using android::base::GetProperty;
David Brazdil4f6027a2019-03-19 11:44:21 +000064using android::base::ReadFdToString;
Alan Stokesa25d90c2017-10-16 10:56:00 +010065using android::base::ReadFully;
66using android::base::StringPrintf;
67using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080068using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070069
70namespace android {
71namespace installd {
72
Andreas Gampefa2dadd2018-02-28 19:52:47 -080073
Calin Juravle114f0812017-03-08 19:05:07 -080074// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
75struct FreeDelete {
76 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
77 void operator()(const void* ptr) const {
78 free(const_cast<void*>(ptr));
79 }
80};
81
82// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
83template <typename T>
84using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
85
Calin Juravle1a0af3b2017-03-09 14:33:33 -080086static unique_fd invalid_unique_fd() {
87 return unique_fd(-1);
88}
89
Andreas Gampe6a9cf722017-07-24 16:49:10 -070090static bool is_debug_runtime() {
91 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
92}
93
David Sehra3b5ab62017-10-25 14:27:29 -070094static bool is_debuggable_build() {
95 return android::base::GetBoolProperty("ro.debuggable", false);
96}
97
Jeff Sharkey90aff262016-12-12 14:28:24 -070098static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -080099 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700100 if (ufd.get() < 0) {
101 if (errno != ENOENT) {
102 PLOG(WARNING) << "Could not open profile " << profile;
103 return false;
104 } else {
105 // Nothing to clear. That's ok.
106 return true;
107 }
108 }
109
110 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
111 if (errno != EWOULDBLOCK) {
112 PLOG(WARNING) << "Error locking profile " << profile;
113 }
114 // This implies that the app owning this profile is running
115 // (and has acquired the lock).
116 //
117 // If we can't acquire the lock bail out since clearing is useless anyway
118 // (the app will write again to the profile).
119 //
120 // Note:
121 // This does not impact the this is not an issue for the profiling correctness.
122 // In case this is needed because of an app upgrade, profiles will still be
123 // eventually cleared by the app itself due to checksum mismatch.
124 // If this is needed because profman advised, then keeping the data around
125 // until the next run is again not an issue.
126 //
127 // If the app attempts to acquire a lock while we've held one here,
128 // it will simply skip the current write cycle.
129 return false;
130 }
131
132 bool truncated = ftruncate(ufd.get(), 0) == 0;
133 if (!truncated) {
134 PLOG(WARNING) << "Could not truncate " << profile;
135 }
136 if (flock(ufd.get(), LOCK_UN) != 0) {
137 PLOG(WARNING) << "Error unlocking profile " << profile;
138 }
139 return truncated;
140}
141
Calin Juravle114f0812017-03-08 19:05:07 -0800142// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800143// The location is the profile name for primary apks or the dex path for secondary dex files.
144static bool clear_reference_profile(const std::string& package_name, const std::string& location,
145 bool is_secondary_dex) {
146 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700147}
148
Calin Juravle114f0812017-03-08 19:05:07 -0800149// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800150// The location is the profile name for primary apks or the dex path for secondary dex files.
151static bool clear_current_profile(const std::string& package_name, const std::string& location,
152 userid_t user, bool is_secondary_dex) {
153 return clear_profile(create_current_profile_path(user, package_name, location,
154 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700155}
156
Calin Juravle114f0812017-03-08 19:05:07 -0800157// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800158// The location is the profile name for primary apks or the dex path for secondary dex files.
159bool clear_primary_reference_profile(const std::string& package_name,
160 const std::string& location) {
161 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800162}
163
164// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800165// The location is the profile name for primary apks or the dex path for secondary dex files.
166bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700167 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800168 // For secondary dex files, we don't really need the user but we use it for sanity checks.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700169 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
170 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800171 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700172 }
173 return success;
174}
175
Calin Juravle114f0812017-03-08 19:05:07 -0800176// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800177bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
178 userid_t user) {
179 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800180}
181
Calin Juravlef74a7372019-02-28 20:29:41 -0800182// Determines which binary we should use for execution (the debug or non-debug version).
183// e.g. dex2oatd vs dex2oat
184static const char* select_execution_binary(const char* binary, const char* debug_binary,
185 bool background_job_compile) {
186 return select_execution_binary(
187 binary,
188 debug_binary,
189 background_job_compile,
190 is_debug_runtime(),
191 (android::base::GetProperty("ro.build.version.codename", "") == "REL"),
192 is_debuggable_build());
193}
194
195// Determines which binary we should use for execution (the debug or non-debug version).
196// e.g. dex2oatd vs dex2oat
197// This is convenient method which is much easier to test because it doesn't read
198// system properties.
199const char* select_execution_binary(
200 const char* binary,
201 const char* debug_binary,
202 bool background_job_compile,
203 bool is_debug_runtime,
204 bool is_release,
205 bool is_debuggable_build) {
206 // Do not use debug binaries for release candidates (to give more soak time).
207 bool is_debug_bg_job = background_job_compile && is_debuggable_build && !is_release;
208
209 // If the runtime was requested to use libartd.so, we'll run the debug version - assuming
210 // the file is present (it may not be on images with very little space available).
211 bool useDebug = (is_debug_runtime || is_debug_bg_job) && (access(debug_binary, X_OK) == 0);
212
213 return useDebug ? debug_binary : binary;
214}
215
Nicolas Geoffrayaaad21e2019-02-25 13:31:10 +0000216// Namespace for Android Runtime flags applied during boot time.
217static const char* RUNTIME_NATIVE_BOOT_NAMESPACE = "runtime_native_boot";
218// Feature flag name for running the JIT in Zygote experiment, b/119800099.
Nicolas Geoffray5a4c4e92020-02-07 11:37:34 +0000219static const char* ENABLE_JITZYGOTE_IMAGE = "enable_apex_image";
Nicolas Geoffrayaaad21e2019-02-25 13:31:10 +0000220
Mathieu Chartiere97261e2019-10-01 15:36:01 -0700221// Phenotype property name for enabling profiling the boot class path.
222static const char* PROFILE_BOOT_CLASS_PATH = "profilebootclasspath";
223
Calin Juravlef85ddb92020-05-01 14:05:40 -0700224static bool IsBootClassPathProfilingEnable() {
225 std::string profile_boot_class_path = GetProperty("dalvik.vm.profilebootclasspath", "");
226 profile_boot_class_path =
227 server_configurable_flags::GetServerConfigurableFlag(
228 RUNTIME_NATIVE_BOOT_NAMESPACE,
229 PROFILE_BOOT_CLASS_PATH,
230 /*default_value=*/ profile_boot_class_path);
231 return profile_boot_class_path == "true";
232}
233
Victor Hsiehcb35a062020-08-13 16:11:13 -0700234static void UnlinkIgnoreResult(const std::string& path) {
235 if (unlink(path.c_str()) < 0) {
236 PLOG(ERROR) << "Failed to unlink " << path;
237 }
238}
239
Jeff Sharkey90aff262016-12-12 14:28:24 -0700240/*
241 * Whether dexopt should use a swap file when compiling an APK.
242 *
243 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
244 * itself, anyways).
245 *
246 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
247 *
248 * Otherwise, return true if this is a low-mem device.
249 *
250 * Otherwise, return default value.
251 */
252static bool kAlwaysProvideSwapFile = false;
253static bool kDefaultProvideSwapFile = true;
254
255static bool ShouldUseSwapFileForDexopt() {
256 if (kAlwaysProvideSwapFile) {
257 return true;
258 }
259
260 // Check the "override" property. If it exists, return value == "true".
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700261 std::string dex2oat_prop_buf = GetProperty("dalvik.vm.dex2oat-swap", "");
262 if (!dex2oat_prop_buf.empty()) {
263 return dex2oat_prop_buf == "true";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700264 }
265
266 // Shortcut for default value. This is an implementation optimization for the process sketched
267 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
268 // as low-mem is never returning false. The compiler will optimize this away if it can.
269 if (kDefaultProvideSwapFile) {
270 return true;
271 }
272
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700273 if (GetBoolProperty("ro.config.low_ram", false)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700274 return true;
275 }
276
277 // Default value must be false here.
278 return kDefaultProvideSwapFile;
279}
280
Richard Uhler76cc0272016-12-08 10:46:35 +0000281static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700282 if (set_to_bg) {
283 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800284 PLOG(ERROR) << "set_sched_policy failed";
285 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700286 }
287 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800288 PLOG(ERROR) << "setpriority failed";
289 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700290 }
291 }
292}
293
Calin Juravle29591732017-11-20 17:46:19 -0800294static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
295 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800296 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800297 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800298 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800299 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800300 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700301 }
Calin Juravle114f0812017-03-08 19:05:07 -0800302 // Profiles should belong to the app; make sure of that by giving ownership to
303 // the app uid. If we cannot do that, there's no point in returning the fd
304 // since dex2oat/profman will fail with SElinux denials.
305 if (fchown(fd.get(), uid, uid) < 0) {
Roland Levillain019db5b2019-03-14 14:31:59 +0000306 PLOG(ERROR) << "Could not chown profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800307 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800308 }
Calin Juravle29591732017-11-20 17:46:19 -0800309 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800310}
311
Calin Juravle29591732017-11-20 17:46:19 -0800312static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800313 // Do not follow symlinks when opening a profile:
314 // - primary profiles should not contain symlinks in their paths
315 // - secondary dex paths should have been already resolved and validated
316 flags |= O_NOFOLLOW;
317
Calin Juravle29591732017-11-20 17:46:19 -0800318 // Check if we need to create the profile
319 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
320 unique_fd fd;
321 if ((flags & O_CREAT) != 0) {
322 fd = create_profile(uid, profile, flags);
323 } else {
324 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
325 }
326
Calin Juravle114f0812017-03-08 19:05:07 -0800327 if (fd.get() < 0) {
328 if (errno != ENOENT) {
329 // Profiles might be missing for various reasons. For example, in a
330 // multi-user environment, the profile directory for one user can be created
331 // after we start a merge. In this case the current profile for that user
332 // will not be found.
333 // Also, the secondary dex profiles might be deleted by the app at any time,
334 // so we can't we need to prepare if they are missing.
335 PLOG(ERROR) << "Failed to open profile " << profile;
336 }
337 return invalid_unique_fd();
338 }
339
Jeff Sharkey90aff262016-12-12 14:28:24 -0700340 return fd;
341}
342
Calin Juravle824a64d2018-01-18 20:23:17 -0800343static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
344 const std::string& location, bool is_secondary_dex) {
345 std::string profile = create_current_profile_path(user, package_name, location,
346 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800347 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800348}
349
Calin Juravle824a64d2018-01-18 20:23:17 -0800350static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
351 const std::string& location, bool read_write, bool is_secondary_dex) {
352 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800353 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
354}
355
Victor Hsiehcb35a062020-08-13 16:11:13 -0700356static UniqueFile open_reference_profile_as_unique_file(uid_t uid, const std::string& package_name,
357 const std::string& location, bool read_write, bool is_secondary_dex) {
358 std::string profile_path = create_reference_profile_path(package_name, location,
359 is_secondary_dex);
360 unique_fd ufd = open_profile(uid, profile_path, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
361 return UniqueFile(ufd.release(), profile_path, [](const std::string& path) {
362 clear_profile(path);
363 });
364}
365
Calin Juravle29591732017-11-20 17:46:19 -0800366static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800367 const std::string& location) {
368 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800369 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800370}
371
Calin Juravle824a64d2018-01-18 20:23:17 -0800372static void open_profile_files(uid_t uid, const std::string& package_name,
373 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800374 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700375 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800376 *reference_profile_fd = open_reference_profile(uid, package_name, location,
377 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700378
Calin Juravle114f0812017-03-08 19:05:07 -0800379 // For secondary dex files, we don't really need the user but we use it for sanity checks.
380 // Note: the user owning the dex file should be the current user.
381 std::vector<userid_t> users;
382 if (is_secondary_dex){
383 users.push_back(multiuser_get_user_id(uid));
384 } else {
385 users = get_known_users(/*volume_uuid*/ nullptr);
386 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700387 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800388 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
389 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700390 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800391 if (profile_fd.get() >= 0) {
392 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700393 }
394 }
395}
396
Calin Juravle76561322019-11-14 09:08:52 -0800397static constexpr int PROFMAN_BIN_RETURN_CODE_SUCCESS = 0;
398static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 1;
399static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 2;
400static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 3;
401static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 4;
402static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 5;
403static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_DIFFERENT_VERSIONS = 6;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700404
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800405class RunProfman : public ExecVHelper {
406 public:
407 void SetupArgs(const std::vector<unique_fd>& profile_fds,
408 const unique_fd& reference_profile_fd,
409 const std::vector<unique_fd>& apk_fds,
410 const std::vector<std::string>& dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800411 bool copy_and_update,
412 bool for_snapshot,
413 bool for_boot_image) {
Calin Juravlef74a7372019-02-28 20:29:41 -0800414
415 // TODO(calin): Assume for now we run in the bg compile job (which is in
416 // most of the invocation). With the current data flow, is not very easy or
417 // clean to discover this in RunProfman (it will require quite a messy refactoring).
418 const char* profman_bin = select_execution_binary(
419 kProfmanPath, kProfmanDebugPath, /*background_job_compile=*/ true);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700420
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800421 if (copy_and_update) {
422 CHECK_EQ(1u, profile_fds.size());
423 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000424 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800425 if (reference_profile_fd != -1) {
426 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000427 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800428
429 for (const unique_fd& fd : profile_fds) {
430 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
431 }
432
433 for (const unique_fd& fd : apk_fds) {
434 AddArg("--apk-fd=" + std::to_string(fd.get()));
435 }
436
437 for (const std::string& dex_location : dex_locations) {
438 AddArg("--dex-location=" + dex_location);
439 }
440
441 if (copy_and_update) {
442 AddArg("--copy-and-update-profile-key");
443 }
444
Calin Juravle78728f32019-11-08 17:55:46 -0800445 if (for_snapshot) {
446 AddArg("--force-merge");
447 }
448
449 if (for_boot_image) {
450 AddArg("--boot-image-merge");
451 }
452
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800453 // Do not add after dex2oat_flags, they should override others for debugging.
454 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800455 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700456
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800457 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
458 const unique_fd& reference_profile_fd,
459 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravle78728f32019-11-08 17:55:46 -0800460 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
461 bool for_snapshot = false,
462 bool for_boot_image = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800463 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800464 reference_profile_fd,
465 apk_fds,
466 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800467 /*copy_and_update=*/ false,
468 for_snapshot,
469 for_boot_image);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800470 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700471
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800472 void SetupCopyAndUpdate(unique_fd&& profile_fd,
473 unique_fd&& reference_profile_fd,
474 unique_fd&& apk_fd,
475 const std::string& dex_location) {
476 // The fds need to stay open longer than the scope of the function, so put them into a local
477 // variable vector.
478 profiles_fd_.push_back(std::move(profile_fd));
479 apk_fds_.push_back(std::move(apk_fd));
480 reference_profile_fd_ = std::move(reference_profile_fd);
481 std::vector<std::string> dex_locations = {dex_location};
Calin Juravleb3a929d2018-12-11 14:40:00 -0800482 SetupArgs(profiles_fd_,
483 reference_profile_fd_,
484 apk_fds_,
485 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800486 /*copy_and_update=*/true,
487 /*for_snapshot*/false,
488 /*for_boot_image*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800489 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000490
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800491 void SetupDump(const std::vector<unique_fd>& profiles_fd,
492 const unique_fd& reference_profile_fd,
493 const std::vector<std::string>& dex_locations,
494 const std::vector<unique_fd>& apk_fds,
495 const unique_fd& output_fd) {
496 AddArg("--dump-only");
497 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800498 SetupArgs(profiles_fd,
499 reference_profile_fd,
500 apk_fds,
501 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800502 /*copy_and_update=*/false,
503 /*for_snapshot*/false,
504 /*for_boot_image*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800505 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000506
Victor Hsiehc9821f12020-08-07 11:32:29 -0700507 using ExecVHelper::Exec; // To suppress -Wno-overloaded-virtual
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800508 void Exec() {
509 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
510 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000511
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800512 private:
513 unique_fd reference_profile_fd_;
514 std::vector<unique_fd> profiles_fd_;
515 std::vector<unique_fd> apk_fds_;
516};
Mathieu Chartier31636522018-11-09 23:53:07 +0000517
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800518
Calin Juravlef63d4792018-01-30 17:43:34 +0000519
Jeff Sharkey90aff262016-12-12 14:28:24 -0700520// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800521// The location is the package name for primary apks or the dex path for secondary dex files.
522// Returns true if there is enough information in the current profiles that makes it
523// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700524// If the return value is true all the current profiles would have been merged into
525// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800526static bool analyze_profiles(uid_t uid, const std::string& package_name,
527 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800528 std::vector<unique_fd> profiles_fd;
529 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800530 open_profile_files(uid, package_name, location, is_secondary_dex,
531 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800532 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700533 // Skip profile guided compilation because no profiles were found.
534 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700535 return false;
536 }
537
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800538 RunProfman profman_merge;
Calin Juravlef85ddb92020-05-01 14:05:40 -0700539 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>();
540 const std::vector<std::string>& dex_locations = std::vector<std::string>();
541 profman_merge.SetupMerge(
542 profiles_fd,
543 reference_profile_fd,
544 apk_fds,
545 dex_locations,
546 /* for_snapshot= */ false,
547 IsBootClassPathProfilingEnable());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700548 pid_t pid = fork();
549 if (pid == 0) {
550 /* child -- drop privileges before continuing */
551 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800552 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700553 }
554 /* parent */
555 int return_code = wait_child(pid);
556 bool need_to_compile = false;
557 bool should_clear_current_profiles = false;
558 bool should_clear_reference_profile = false;
559 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800560 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700561 } else {
562 return_code = WEXITSTATUS(return_code);
563 switch (return_code) {
564 case PROFMAN_BIN_RETURN_CODE_COMPILE:
565 need_to_compile = true;
566 should_clear_current_profiles = true;
567 should_clear_reference_profile = false;
568 break;
569 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
570 need_to_compile = false;
571 should_clear_current_profiles = false;
572 should_clear_reference_profile = false;
573 break;
574 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800575 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700576 need_to_compile = false;
577 should_clear_current_profiles = true;
578 should_clear_reference_profile = true;
579 break;
580 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
581 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
582 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800583 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700584 need_to_compile = false;
585 should_clear_current_profiles = false;
586 should_clear_reference_profile = false;
587 break;
Calin Juravle76561322019-11-14 09:08:52 -0800588 case PROFMAN_BIN_RETURN_CODE_ERROR_DIFFERENT_VERSIONS:
589 need_to_compile = false;
590 should_clear_current_profiles = true;
591 should_clear_reference_profile = true;
592 break;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700593 default:
594 // Unknown return code or error. Unlink profiles.
Calin Juravle78728f32019-11-08 17:55:46 -0800595 LOG(WARNING) << "Unexpected error code while processing profiles for location "
Calin Juravle114f0812017-03-08 19:05:07 -0800596 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700597 need_to_compile = false;
598 should_clear_current_profiles = true;
599 should_clear_reference_profile = true;
600 break;
601 }
602 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800603
Jeff Sharkey90aff262016-12-12 14:28:24 -0700604 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800605 if (is_secondary_dex) {
606 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800607 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
608 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800609 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800610 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800611 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700612 }
613 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800614 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700615 }
616 return need_to_compile;
617}
618
Calin Juravle114f0812017-03-08 19:05:07 -0800619// Decides if profile guided compilation is needed or not based on existing profiles.
620// The analysis is done for the primary apks of the given package.
621// Returns true if there is enough information in the current profiles that makes it
622// worth to recompile the package.
623// If the return value is true all the current profiles would have been merged into
624// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800625bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
626 const std::string& profile_name) {
627 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800628}
629
Calin Juravle408cd4a2018-01-20 23:34:18 -0800630bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
631 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800632 std::vector<unique_fd> profile_fds;
633 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800634 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
635 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700636
Calin Juravle408cd4a2018-01-20 23:34:18 -0800637 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800638 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700639
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800640 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700641 const bool has_profiles = !profile_fds.empty();
642
643 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800644 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700645 return false;
646 }
647
Calin Juravle114f0812017-03-08 19:05:07 -0800648 unique_fd output_fd(open(out_file_name.c_str(),
649 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700650 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800651 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700652 return false;
653 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800654
Jeff Sharkey90aff262016-12-12 14:28:24 -0700655 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800656 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800657 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
658 if (apk_fd == -1) {
659 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
660 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700661 }
Victor Hsieh76f19ba2020-08-10 14:37:26 -0700662 dex_locations.push_back(Basename(code_path));
Calin Juravle408cd4a2018-01-20 23:34:18 -0800663 apk_fds.push_back(std::move(apk_fd));
664
Jeff Sharkey90aff262016-12-12 14:28:24 -0700665
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800666 RunProfman profman_dump;
667 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700668 pid_t pid = fork();
669 if (pid == 0) {
670 /* child -- drop privileges before continuing */
671 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800672 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700673 }
674 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700675 int return_code = wait_child(pid);
676 if (!WIFEXITED(return_code)) {
677 LOG(WARNING) << "profman failed for package " << pkgname << ": "
678 << return_code;
679 return false;
680 }
681 return true;
682}
683
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700684bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800685 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700686 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
687 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800688 package_name,
689 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700690 /*read_write*/ true,
691 /*secondary*/ false));
692 if (in_fd.get() < 0) {
693 PLOG(WARNING) << "Could not open profile " << system_profile;
694 return false;
695 }
696 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800697 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700698 return false;
699 }
700
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700701 // As a security measure we want to write the profile information with the reduced capabilities
702 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700703 pid_t pid = fork();
704 if (pid == 0) {
705 /* child -- drop privileges before continuing */
706 drop_capabilities(packageUid);
707
708 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
709 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800710 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700711 }
712 // This implies that the app owning this profile is running
713 // (and has acquired the lock).
714 //
715 // The app never acquires the lock for the reference profiles of primary apks.
716 // Only dex2oat from installd will do that. Since installd is single threaded
717 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800718 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700719 return false;
720 }
721
722 bool truncated = ftruncate(out_fd.get(), 0) == 0;
723 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800724 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700725 }
726
727 // Copy over data.
728 static constexpr size_t kBufferSize = 4 * 1024;
729 char buffer[kBufferSize];
730 while (true) {
731 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
732 if (bytes == 0) {
733 break;
734 }
735 write(out_fd.get(), buffer, bytes);
736 }
737 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800738 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700739 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700740 // Use _exit since we don't want to run the global destructors in the child.
741 // b/62597429
742 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700743 }
744 /* parent */
745 int return_code = wait_child(pid);
746 return return_code == 0;
747}
748
Jeff Sharkey90aff262016-12-12 14:28:24 -0700749static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
750 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
751 if (EndsWith(oat_path, ".dex")) {
752 std::string new_path = oat_path;
753 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800754 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700755 return new_path;
756 }
757
758 // An odex entry. Not that this may not be an extension, e.g., in the OTA
759 // case (where the base name will have an extension for the B artifact).
760 size_t odex_pos = oat_path.rfind(".odex");
761 if (odex_pos != std::string::npos) {
762 std::string new_path = oat_path;
763 new_path.replace(odex_pos, strlen(".odex"), new_ext);
764 CHECK_NE(new_path.find(new_ext), std::string::npos);
765 return new_path;
766 }
767
768 // Don't know how to handle this.
769 return "";
770}
771
772// Translate the given oat path to an art (app image) path. An empty string
773// denotes an error.
774static std::string create_image_filename(const std::string& oat_path) {
775 return replace_file_extension(oat_path, ".art");
776}
777
778// Translate the given oat path to a vdex path. An empty string denotes an error.
779static std::string create_vdex_filename(const std::string& oat_path) {
780 return replace_file_extension(oat_path, ".vdex");
781}
782
Jeff Sharkey90aff262016-12-12 14:28:24 -0700783static int open_output_file(const char* file_name, bool recreate, int permissions) {
784 int flags = O_RDWR | O_CREAT;
785 if (recreate) {
786 if (unlink(file_name) < 0) {
787 if (errno != ENOENT) {
788 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
789 }
790 }
791 flags |= O_EXCL;
792 }
793 return open(file_name, flags, permissions);
794}
795
Calin Juravle2289c0a2017-02-15 12:44:14 -0800796static bool set_permissions_and_ownership(
797 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
798 // Primary apks are owned by the system. Secondary dex files are owned by the app.
799 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700800 if (fchmod(fd,
801 S_IRUSR|S_IWUSR|S_IRGRP |
802 (is_public ? S_IROTH : 0)) < 0) {
803 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
804 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -0800805 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700806 ALOGE("installd cannot chown '%s' during dexopt\n", path);
807 return false;
808 }
809 return true;
810}
811
812static bool IsOutputDalvikCache(const char* oat_dir) {
813 // InstallerConnection.java (which invokes installd) transforms Java null arguments
814 // into '!'. Play it safe by handling it both.
815 // TODO: ensure we never get null.
816 // TODO: pass a flag instead of inferring if the output is dalvik cache.
817 return oat_dir == nullptr || oat_dir[0] == '!';
818}
819
Calin Juravled23dee72017-07-06 16:29:11 -0700820// Best-effort check whether we can fit the the path into our buffers.
821// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
822// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
823// extension to the cache path (5 bytes).
824// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
825static bool validate_dex_path_size(const std::string& dex_path) {
826 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
827 LOG(ERROR) << "dex_path too long: " << dex_path;
828 return false;
829 }
830 return true;
831}
832
Jeff Sharkey90aff262016-12-12 14:28:24 -0700833static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -0800834 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -0700835 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700836 return false;
837 }
838
839 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -0800840 // Oat dirs for secondary dex files are already validated.
841 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700842 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
843 return false;
844 }
845 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
846 return false;
847 }
848 } else {
849 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
850 return false;
851 }
852 }
853 return true;
854}
855
Calin Juravle7a570e82017-01-14 16:23:30 -0800856// (re)Creates the app image if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700857UniqueFile maybe_open_app_image(const std::string& out_oat_path,
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -0700858 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100859
Calin Juravle7a570e82017-01-14 16:23:30 -0800860 const std::string image_path = create_image_filename(out_oat_path);
861 if (image_path.empty()) {
862 // Happens when the out_oat_path has an unknown extension.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700863 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -0800864 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100865
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -0700866 // In case there is a stale image, remove it now. Ignore any error.
867 unlink(image_path.c_str());
868
869 // Not enabled, exit.
870 if (!generate_app_image) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700871 return UniqueFile();
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100872 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700873 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
874 if (app_image_format.empty()) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700875 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -0800876 }
877 // Recreate is true since we do not want to modify a mapped image. If the app is
878 // already running and we modify the image file, it can cause crashes (b/27493510).
Victor Hsiehcb35a062020-08-13 16:11:13 -0700879 UniqueFile image_file(
Calin Juravle7a570e82017-01-14 16:23:30 -0800880 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
Victor Hsiehcb35a062020-08-13 16:11:13 -0700881 image_path,
882 UnlinkIgnoreResult);
883 if (image_file.fd() < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800884 // Could not create application image file. Go on since we can compile without it.
885 LOG(ERROR) << "installd could not create '" << image_path
886 << "' for image file during dexopt";
887 // If we have a valid image file path but no image fd, explicitly erase the image file.
888 if (unlink(image_path.c_str()) < 0) {
889 if (errno != ENOENT) {
890 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
891 }
892 }
893 } else if (!set_permissions_and_ownership(
Victor Hsiehcb35a062020-08-13 16:11:13 -0700894 image_file.fd(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800895 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
Victor Hsiehcb35a062020-08-13 16:11:13 -0700896 image_file.reset();
Calin Juravle7a570e82017-01-14 16:23:30 -0800897 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700898
Victor Hsiehcb35a062020-08-13 16:11:13 -0700899 return image_file;
Calin Juravle7a570e82017-01-14 16:23:30 -0800900}
901
902// Creates the dexopt swap file if necessary and return its fd.
903// Returns -1 if there's no need for a swap or in case of errors.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700904unique_fd maybe_open_dexopt_swap_file(const std::string& out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800905 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800906 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -0800907 }
Victor Hsiehcb35a062020-08-13 16:11:13 -0700908 auto swap_file_name = out_oat_path + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800909 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600910 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -0800911 if (swap_fd.get() < 0) {
912 // Could not create swap file. Optimistically go on and hope that we can compile
913 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600914 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -0800915 } else {
916 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600917 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800918 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
919 }
920 }
921 return swap_fd;
922}
923
924// Opens the reference profiles if needed.
925// Note that the reference profile might not exist so it's OK if the fd will be -1.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700926UniqueFile maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000927 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -0800928 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +0000929 // If we are not profile guided compilation, or we are compiling system server
930 // do not bother to open the profiles; we won't be using them.
931 if (!profile_guided || (pkgname[0] == '*')) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700932 return UniqueFile();
Calin Juravle5bd1c722018-02-01 17:23:54 +0000933 }
934
935 // If this is a secondary dex path which is public do not open the profile.
936 // We cannot compile public secondary dex paths with profiles. That's because
937 // it will expose how the dex files are used by their owner.
938 //
939 // Note that the PackageManager is responsible to set the is_public flag for
940 // primary apks and we do not check it here. In some cases, e.g. when
941 // compiling with a public profile from the .dm file the PackageManager will
942 // set is_public toghether with the profile guided compilation.
943 if (is_secondary_dex && is_public) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700944 return UniqueFile();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700945 }
Calin Juravle114f0812017-03-08 19:05:07 -0800946
947 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000948 std::string location;
949 if (is_secondary_dex) {
950 location = dex_path;
951 } else {
952 if (profile_name == nullptr) {
953 // This path is taken for system server re-compilation lunched from ZygoteInit.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700954 return UniqueFile();
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000955 } else {
956 location = profile_name;
957 }
958 }
Victor Hsiehcb35a062020-08-13 16:11:13 -0700959 return open_reference_profile_as_unique_file(uid, pkgname, location, /*read_write*/false,
960 is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -0800961}
Jeff Sharkey90aff262016-12-12 14:28:24 -0700962
Victor Hsiehcb35a062020-08-13 16:11:13 -0700963// Opens the vdex files and assigns the input fd to in_vdex_wrapper and the output fd to
964// out_vdex_wrapper. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -0700965bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +0000966 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Victor Hsiehcb35a062020-08-13 16:11:13 -0700967 bool profile_guided, UniqueFile* in_vdex_wrapper,
968 UniqueFile* out_vdex_wrapper) {
969 CHECK(in_vdex_wrapper != nullptr);
970 CHECK(out_vdex_wrapper != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700971 // Open the existing VDEX. We do this before creating the new output VDEX, which will
972 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +0000973 char in_odex_path[PKG_PATH_MAX];
974 int dexopt_action = abs(dexopt_needed);
975 bool is_odex_location = dexopt_needed < 0;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +0000976
977 // Infer the name of the output VDEX.
978 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
979 if (out_vdex_path_str.empty()) {
980 return false;
981 }
982
983 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +0000984 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700985 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
986 const char* path = nullptr;
987 if (is_odex_location) {
988 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
989 path = in_odex_path;
990 } else {
991 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -0800992 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700993 }
994 } else {
995 path = out_oat_path;
996 }
Victor Hsiehcb35a062020-08-13 16:11:13 -0700997 std::string in_vdex_path_str = create_vdex_filename(path);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700998 if (in_vdex_path_str.empty()) {
999 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001000 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001001 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001002 // We can update in place when all these conditions are met:
1003 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1004 // on /system typically cannot be updated in place).
1005 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1006 // cannot be currently used by a running process.
1007 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1008 // different vdex files to operate.
1009 update_vdex_in_place =
1010 (in_vdex_path_str == out_vdex_path_str) &&
1011 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1012 !profile_guided;
1013 if (update_vdex_in_place) {
1014 // Open the file read-write to be able to update it.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001015 in_vdex_wrapper->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0),
1016 in_vdex_path_str);
1017 if (in_vdex_wrapper->fd() == -1) {
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001018 // If we failed to open the file, we cannot update it in place.
1019 update_vdex_in_place = false;
1020 }
1021 } else {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001022 in_vdex_wrapper->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0),
1023 in_vdex_path_str);
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001024 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001025 }
1026
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001027 // If we are updating the vdex in place, we do not need to recreate a vdex,
1028 // and can use the same existing one.
1029 if (update_vdex_in_place) {
1030 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1031 // have bogus stale vdex files.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001032 out_vdex_wrapper->reset(
1033 in_vdex_wrapper->fd(),
1034 out_vdex_path_str,
1035 UnlinkIgnoreResult);
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001036 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1037 // wrapper).
Victor Hsiehcb35a062020-08-13 16:11:13 -07001038 in_vdex_wrapper->DisableAutoClose();
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001039 } else {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001040 out_vdex_wrapper->reset(
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001041 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
Victor Hsiehcb35a062020-08-13 16:11:13 -07001042 out_vdex_path_str,
1043 UnlinkIgnoreResult);
1044 if (out_vdex_wrapper->fd() < 0) {
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001045 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1046 return false;
1047 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001048 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001049 if (!set_permissions_and_ownership(out_vdex_wrapper->fd(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001050 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001051 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1052 return false;
1053 }
1054
1055 // If we got here we successfully opened the vdex files.
1056 return true;
1057}
1058
1059// Opens the output oat file for the given apk.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001060UniqueFile open_oat_out_file(const char* apk_path, const char* oat_dir,
1061 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex) {
1062 char out_oat_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08001063 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001064 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -08001065 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001066 UniqueFile oat(
Calin Juravle7a570e82017-01-14 16:23:30 -08001067 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
Victor Hsiehcb35a062020-08-13 16:11:13 -07001068 out_oat_path,
1069 UnlinkIgnoreResult);
1070 if (oat.fd() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001071 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001072 } else if (!set_permissions_and_ownership(
Victor Hsiehcb35a062020-08-13 16:11:13 -07001073 oat.fd(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001074 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
Victor Hsiehcb35a062020-08-13 16:11:13 -07001075 oat.reset();
Calin Juravle7a570e82017-01-14 16:23:30 -08001076 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001077 return oat;
Calin Juravle7a570e82017-01-14 16:23:30 -08001078}
1079
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001080// Creates RDONLY fds for oat and vdex files, if exist.
1081// Returns false if it fails to create oat out path for the given apk path.
1082// Note that the method returns true even if the files could not be opened.
1083bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1084 const std::string& oat_dir,
1085 const std::string& instruction_set,
1086 bool is_secondary_dex,
1087 unique_fd* oat_file_fd,
1088 unique_fd* vdex_file_fd) {
1089 char oat_path[PKG_PATH_MAX];
1090 if (!create_oat_out_path(apk_path.c_str(),
1091 instruction_set.c_str(),
1092 oat_dir.c_str(),
1093 is_secondary_dex,
1094 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001095 LOG(ERROR) << "Could not create oat out path for "
1096 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001097 return false;
1098 }
1099 oat_file_fd->reset(open(oat_path, O_RDONLY));
1100 if (oat_file_fd->get() < 0) {
1101 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1102 }
1103
1104 std::string vdex_filename = create_vdex_filename(oat_path);
1105 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1106 if (vdex_file_fd->get() < 0) {
1107 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1108 }
1109
1110 return true;
1111}
1112
Calin Juravle7a570e82017-01-14 16:23:30 -08001113// Updates the access times of out_oat_path based on those from apk_path.
1114void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1115 struct stat input_stat;
1116 memset(&input_stat, 0, sizeof(input_stat));
1117 if (stat(apk_path, &input_stat) != 0) {
1118 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1119 return;
1120 }
1121
1122 struct utimbuf ut;
1123 ut.actime = input_stat.st_atime;
1124 ut.modtime = input_stat.st_mtime;
1125 if (utime(out_oat_path, &ut) != 0) {
1126 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1127 }
1128}
1129
Calin Juravle80a21252017-01-17 14:43:25 -08001130// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001131// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1132// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1133// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001134class RunDexoptAnalyzer : public ExecVHelper {
1135 public:
1136 RunDexoptAnalyzer(const std::string& dex_file,
David Brazdil4f6027a2019-03-19 11:44:21 +00001137 int vdex_fd,
1138 int oat_fd,
1139 int zip_fd,
1140 const std::string& instruction_set,
1141 const std::string& compiler_filter,
1142 bool profile_was_updated,
1143 bool downgrade,
1144 const char* class_loader_context,
1145 const std::string& class_loader_context_fds) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001146 CHECK_GE(zip_fd, 0);
Calin Juravlef74a7372019-02-28 20:29:41 -08001147
1148 // We always run the analyzer in the background job.
1149 const char* dexoptanalyzer_bin = select_execution_binary(
1150 kDexoptanalyzerPath, kDexoptanalyzerDebugPath, /*background_job_compile=*/ true);
Calin Juravle80a21252017-01-17 14:43:25 -08001151
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001152 std::string dex_file_arg = "--dex-file=" + dex_file;
1153 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1154 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1155 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1156 std::string isa_arg = "--isa=" + instruction_set;
1157 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1158 const char* assume_profile_changed = "--assume-profile-changed";
1159 const char* downgrade_flag = "--downgrade";
1160 std::string class_loader_context_arg = "--class-loader-context=";
1161 if (class_loader_context != nullptr) {
1162 class_loader_context_arg += class_loader_context;
1163 }
David Brazdil4f6027a2019-03-19 11:44:21 +00001164 std::string class_loader_context_fds_arg = "--class-loader-context-fds=";
1165 if (!class_loader_context_fds.empty()) {
1166 class_loader_context_fds_arg += class_loader_context_fds;
1167 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001168
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001169 // program name, dex file, isa, filter
1170 AddArg(dex_file_arg);
1171 AddArg(isa_arg);
1172 AddArg(compiler_filter_arg);
1173 if (oat_fd >= 0) {
1174 AddArg(oat_fd_arg);
1175 }
1176 if (vdex_fd >= 0) {
1177 AddArg(vdex_fd_arg);
1178 }
Greg Kaiser8042c372019-03-26 06:23:19 -07001179 AddArg(zip_fd_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001180 if (profile_was_updated) {
1181 AddArg(assume_profile_changed);
1182 }
1183 if (downgrade) {
1184 AddArg(downgrade_flag);
1185 }
1186 if (class_loader_context != nullptr) {
Greg Kaiser8042c372019-03-26 06:23:19 -07001187 AddArg(class_loader_context_arg);
David Brazdil4f6027a2019-03-19 11:44:21 +00001188 if (!class_loader_context_fds.empty()) {
Greg Kaiser8042c372019-03-26 06:23:19 -07001189 AddArg(class_loader_context_fds_arg);
David Brazdil4f6027a2019-03-19 11:44:21 +00001190 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001191 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001192
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001193 PrepareArgs(dexoptanalyzer_bin);
1194 }
David Brazdil4f6027a2019-03-19 11:44:21 +00001195
1196 // Dexoptanalyzer mode which flattens the given class loader context and
1197 // prints a list of its dex files in that flattened order.
1198 RunDexoptAnalyzer(const char* class_loader_context) {
1199 CHECK(class_loader_context != nullptr);
1200
1201 // We always run the analyzer in the background job.
1202 const char* dexoptanalyzer_bin = select_execution_binary(
1203 kDexoptanalyzerPath, kDexoptanalyzerDebugPath, /*background_job_compile=*/ true);
1204
1205 AddArg("--flatten-class-loader-context");
1206 AddArg(std::string("--class-loader-context=") + class_loader_context);
1207 PrepareArgs(dexoptanalyzer_bin);
1208 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001209};
Calin Juravle80a21252017-01-17 14:43:25 -08001210
1211// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001212static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001213 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001214 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001215 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001216 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001217 return false;
1218 }
Calin Juravle114f0812017-03-08 19:05:07 -08001219 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001220
Calin Juravle80a21252017-01-17 14:43:25 -08001221 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001222 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1223 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001224 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001225 return false;
1226 }
1227
1228 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001229 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001230
Calin Juravle7d765462017-09-04 15:57:10 -07001231 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001232 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001233 return false;
1234 }
1235
1236 return true;
1237}
1238
Calin Juravle7d765462017-09-04 15:57:10 -07001239// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1240// secondary dex files. This return codes are returned by the child process created for
1241// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001242
Andreas Gampe194fe422018-02-28 20:16:19 -08001243enum DexoptAnalyzerSkipCodes {
1244 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001245 // Specific errors are encoded in the name.
1246 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1247 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1248 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1249 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1250 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001251 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001252 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001253};
Calin Juravle7d765462017-09-04 15:57:10 -07001254
1255// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001256// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1257// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001258// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1259// of dexoptanalyzer.
1260static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001261 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001262 // The result values are defined in dexoptanalyzer.
1263 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001264 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001265 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001266 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001267 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001268 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001269 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001270 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001271 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001272 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1273 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001274 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1275 " Expected odex file status for secondary dex %s"
1276 " : dexoptanalyzer result=%d",
1277 dex_path.c_str(),
1278 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001279 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001280 }
1281
1282 // Use a second switch for enum switch-case analysis.
1283 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001284 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001285 // If the file does not exist there's no need for dexopt.
1286 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1287 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001288
1289 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1290 *error_msg = "Dexoptanalyzer path validation failed";
1291 return false;
1292 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1293 *error_msg = "Dexoptanalyzer open zip failed";
1294 return false;
1295 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1296 *error_msg = "Dexoptanalyzer dir preparation failed";
1297 return false;
1298 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1299 *error_msg = "Dexoptanalyzer open output failed";
1300 return false;
1301 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1302 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001303 return false;
1304 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001305
1306 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1307 dex_path.c_str(),
1308 result);
1309 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001310}
1311
Calin Juravle7d765462017-09-04 15:57:10 -07001312enum SecondaryDexAccess {
1313 kSecondaryDexAccessReadOk = 0,
1314 kSecondaryDexAccessDoesNotExist = 1,
1315 kSecondaryDexAccessPermissionError = 2,
1316 kSecondaryDexAccessIOError = 3
1317};
1318
1319static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1320 // Check if the path exists and can be read. If not, there's nothing to do.
1321 if (access(dex_path.c_str(), R_OK) == 0) {
1322 return kSecondaryDexAccessReadOk;
1323 } else {
1324 if (errno == ENOENT) {
1325 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1326 return kSecondaryDexAccessDoesNotExist;
1327 } else {
1328 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1329 return errno == EACCES
1330 ? kSecondaryDexAccessPermissionError
1331 : kSecondaryDexAccessIOError;
1332 }
1333 }
1334}
1335
1336static bool is_file_public(const std::string& filename) {
1337 struct stat file_stat;
1338 if (stat(filename.c_str(), &file_stat) == 0) {
1339 return (file_stat.st_mode & S_IROTH) != 0;
1340 }
1341 return false;
1342}
1343
1344// Create the oat file structure for the secondary dex 'dex_path' and assign
1345// the individual path component to the 'out_' parameters.
1346static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001347 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001348 size_t dirIndex = dex_path.rfind('/');
1349 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001350 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001351 return false;
1352 }
1353 // TODO(calin): we have similar computations in at lest 3 other places
1354 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1355 // using string append.
1356 std::string apk_dir = dex_path.substr(0, dirIndex);
1357 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1358 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1359
1360 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1361 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001362 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001363 return false;
1364 }
1365 return true;
1366}
1367
1368// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1369// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001370static bool validate_dexopt_storage_flags(int dexopt_flags,
1371 int* out_storage_flag,
1372 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001373 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1374 *out_storage_flag = FLAG_STORAGE_CE;
1375 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001376 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001377 return false;
1378 }
1379 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1380 *out_storage_flag = FLAG_STORAGE_DE;
1381 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001382 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001383 return false;
1384 }
1385 return true;
1386}
1387
David Brazdil4f6027a2019-03-19 11:44:21 +00001388static bool get_class_loader_context_dex_paths(const char* class_loader_context, int uid,
1389 /* out */ std::vector<std::string>* context_dex_paths) {
1390 if (class_loader_context == nullptr) {
1391 return true;
1392 }
1393
1394 LOG(DEBUG) << "Getting dex paths for context " << class_loader_context;
1395
1396 // Pipe to get the hash result back from our child process.
1397 unique_fd pipe_read, pipe_write;
1398 if (!Pipe(&pipe_read, &pipe_write)) {
1399 PLOG(ERROR) << "Failed to create pipe";
1400 return false;
1401 }
1402
1403 pid_t pid = fork();
1404 if (pid == 0) {
1405 // child -- drop privileges before continuing.
1406 drop_capabilities(uid);
1407
1408 // Route stdout to `pipe_write`
1409 while ((dup2(pipe_write, STDOUT_FILENO) == -1) && (errno == EINTR)) {}
1410 pipe_write.reset();
1411 pipe_read.reset();
1412
1413 RunDexoptAnalyzer run_dexopt_analyzer(class_loader_context);
1414 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
1415 }
1416
1417 /* parent */
1418 pipe_write.reset();
1419
1420 std::string str_dex_paths;
1421 if (!ReadFdToString(pipe_read, &str_dex_paths)) {
1422 PLOG(ERROR) << "Failed to read from pipe";
1423 return false;
1424 }
1425 pipe_read.reset();
1426
1427 int return_code = wait_child(pid);
1428 if (!WIFEXITED(return_code)) {
1429 PLOG(ERROR) << "Error waiting for child dexoptanalyzer process";
1430 return false;
1431 }
1432
1433 constexpr int kFlattenClassLoaderContextSuccess = 50;
1434 return_code = WEXITSTATUS(return_code);
1435 if (return_code != kFlattenClassLoaderContextSuccess) {
1436 LOG(ERROR) << "Dexoptanalyzer could not flatten class loader context, code=" << return_code;
1437 return false;
1438 }
1439
1440 if (!str_dex_paths.empty()) {
1441 *context_dex_paths = android::base::Split(str_dex_paths, ":");
1442 }
1443 return true;
1444}
1445
1446static int open_dex_paths(const std::vector<std::string>& dex_paths,
1447 /* out */ std::vector<unique_fd>* zip_fds, /* out */ std::string* error_msg) {
1448 for (const std::string& dex_path : dex_paths) {
1449 zip_fds->emplace_back(open(dex_path.c_str(), O_RDONLY));
1450 if (zip_fds->back().get() < 0) {
1451 *error_msg = StringPrintf(
1452 "installd cannot open '%s' for input during dexopt", dex_path.c_str());
1453 if (errno == ENOENT) {
1454 return kSecondaryDexDexoptAnalyzerSkippedNoFile;
1455 } else {
1456 return kSecondaryDexDexoptAnalyzerSkippedOpenZip;
1457 }
1458 }
1459 }
1460 return 0;
1461}
1462
1463static std::string join_fds(const std::vector<unique_fd>& fds) {
1464 std::stringstream ss;
1465 bool is_first = true;
1466 for (const unique_fd& fd : fds) {
1467 if (is_first) {
1468 is_first = false;
1469 } else {
1470 ss << ":";
1471 }
1472 ss << fd.get();
1473 }
1474 return ss.str();
1475}
1476
Calin Juravlec9eab382017-01-25 01:17:17 -08001477// Processes the dex_path as a secondary dex files and return true if the path dex file should
Calin Juravle80a21252017-01-17 14:43:25 -08001478// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1479// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001480// When returning true, the output parameters will be:
1481// - is_public_out: whether or not the oat file should not be made public
1482// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1483// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001484static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001485 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001486 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001487 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
David Brazdil4f6027a2019-03-19 11:44:21 +00001488 const std::vector<std::string>& context_dex_paths, /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001489 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001490 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001491 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1492 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001493 return false;
1494 }
Calin Juravle7d765462017-09-04 15:57:10 -07001495 // Compute the oat dir as it's not easy to extract it from the child computation.
1496 char oat_path[PKG_PATH_MAX];
1497 char oat_dir[PKG_PATH_MAX];
1498 char oat_isa_dir[PKG_PATH_MAX];
1499 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001500 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1501 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001502 return false;
1503 }
Calin Juravle7d765462017-09-04 15:57:10 -07001504 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001505
Calin Juravle80a21252017-01-17 14:43:25 -08001506 pid_t pid = fork();
1507 if (pid == 0) {
1508 // child -- drop privileges before continuing.
1509 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001510
1511 // Validate the path structure.
1512 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1513 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001514 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001515 }
1516
1517 // Open the dex file.
1518 unique_fd zip_fd;
1519 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1520 if (zip_fd.get() < 0) {
1521 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001522 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001523 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001524 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001525 }
1526 }
1527
David Brazdil4f6027a2019-03-19 11:44:21 +00001528 // Open class loader context dex files.
1529 std::vector<unique_fd> context_zip_fds;
1530 int open_dex_paths_rc = open_dex_paths(context_dex_paths, &context_zip_fds, error_msg);
1531 if (open_dex_paths_rc != 0) {
1532 _exit(open_dex_paths_rc);
1533 }
1534
Calin Juravle7d765462017-09-04 15:57:10 -07001535 // Prepare the oat directories.
1536 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001537 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001538 }
1539
1540 // Open the vdex/oat files if any.
1541 unique_fd oat_file_fd;
1542 unique_fd vdex_file_fd;
1543 if (!maybe_open_oat_and_vdex_file(dex_path,
1544 *oat_dir_out,
1545 instruction_set,
1546 true /* is_secondary_dex */,
1547 &oat_file_fd,
1548 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001549 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001550 }
1551
1552 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001553 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1554 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001555
1556 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001557 // Note that we do not do it before the fork since opening the files is required to happen
1558 // after forking.
1559 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1560 vdex_file_fd.get(),
1561 oat_file_fd.get(),
1562 zip_fd.get(),
1563 instruction_set,
1564 compiler_filter, profile_was_updated,
1565 downgrade,
David Brazdil4f6027a2019-03-19 11:44:21 +00001566 class_loader_context,
1567 join_fds(context_zip_fds));
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001568 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001569 }
1570
1571 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001572 int result = wait_child(pid);
1573 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001574 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1575 dex_path.c_str(),
1576 result);
1577 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001578 return false;
1579 }
1580 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001581 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001582 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1583 result,
1584 dexopt_needed_out,
1585 error_msg);
1586 if (!success) {
1587 LOG(ERROR) << *error_msg;
1588 }
Calin Juravle7d765462017-09-04 15:57:10 -07001589
1590 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1591
Calin Juravle80a21252017-01-17 14:43:25 -08001592 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001593 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1594 // makes the code simpler; force compilation is only needed during tests).
1595 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001596 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001597 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001598 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1599 }
1600
Calin Juravle7d765462017-09-04 15:57:10 -07001601 // Check if we should make the oat file public.
1602 // Note that if the dex file is not public the compiled code cannot be made public.
1603 // It is ok to check this flag outside in the parent process.
1604 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1605
Calin Juravle80a21252017-01-17 14:43:25 -08001606 return success;
1607}
1608
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001609static std::string format_dexopt_error(int status, const char* dex_path) {
1610 if (WIFEXITED(status)) {
1611 int int_code = WEXITSTATUS(status);
1612 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1613 if (code_name != nullptr) {
1614 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1615 }
1616 }
1617 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001618}
1619
Calin Juravlec9eab382017-01-25 01:17:17 -08001620int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001621 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001622 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001623 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001624 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001625 CHECK(pkgname != nullptr);
1626 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001627 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001628 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1629 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001630
Calin Juravled23dee72017-07-06 16:29:11 -07001631 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001632 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001633 return -1;
1634 }
1635
1636 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001637 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1638 class_loader_context);
1639 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001640 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001641 }
1642
Calin Juravleebc8a792017-04-04 20:21:05 -07001643 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001644 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1645 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1646 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001647 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001648 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001649 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001650 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001651 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Patrick Baumann2271b3e2020-04-14 17:03:00 -07001652 bool for_restore = (dexopt_flags & DEXOPT_FOR_RESTORE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001653
1654 // Check if we're dealing with a secondary dex file and if we need to compile it.
1655 std::string oat_dir_str;
David Brazdil4f6027a2019-03-19 11:44:21 +00001656 std::vector<std::string> context_dex_paths;
Calin Juravle80a21252017-01-17 14:43:25 -08001657 if (is_secondary_dex) {
David Brazdil4f6027a2019-03-19 11:44:21 +00001658 if (!get_class_loader_context_dex_paths(class_loader_context, uid, &context_dex_paths)) {
1659 *error_msg = "Failed acquiring context dex paths";
1660 return -1; // We had an error, logged in the process method.
1661 }
1662
Calin Juravlec9eab382017-01-25 01:17:17 -08001663 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001664 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
David Brazdil4f6027a2019-03-19 11:44:21 +00001665 downgrade, class_loader_context, context_dex_paths, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001666 oat_dir = oat_dir_str.c_str();
1667 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1668 return 0; // Nothing to do, report success.
1669 }
1670 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001671 if (error_msg->empty()) { // TODO: Make this a CHECK.
1672 *error_msg = "Failed processing secondary.";
1673 }
Calin Juravle80a21252017-01-17 14:43:25 -08001674 return -1; // We had an error, logged in the process method.
1675 }
1676 } else {
David Brazdil4f6027a2019-03-19 11:44:21 +00001677 // Currently these flags are only used for secondary dex files.
Calin Juravlec9eab382017-01-25 01:17:17 -08001678 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001679 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1680 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1681 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001682
1683 // Open the input file.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001684 UniqueFile in_dex(open(dex_path, O_RDONLY, 0), dex_path);
1685 if (in_dex.fd() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001686 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1687 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001688 return -1;
1689 }
1690
David Brazdil4f6027a2019-03-19 11:44:21 +00001691 // Open class loader context dex files.
1692 std::vector<unique_fd> context_input_fds;
1693 if (open_dex_paths(context_dex_paths, &context_input_fds, error_msg) != 0) {
1694 LOG(ERROR) << *error_msg;
1695 return -1;
1696 }
1697
Calin Juravle7a570e82017-01-14 16:23:30 -08001698 // Create the output OAT file.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001699 UniqueFile out_oat = open_oat_out_file(dex_path, oat_dir, is_public, uid,
1700 instruction_set, is_secondary_dex);
1701 if (out_oat.fd() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001702 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001703 return -1;
1704 }
1705
1706 // Open vdex files.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001707 UniqueFile in_vdex;
1708 UniqueFile out_vdex;
1709 if (!open_vdex_files_for_dex2oat(dex_path, out_oat.path().c_str(), dexopt_needed,
1710 instruction_set, is_public, uid, is_secondary_dex, profile_guided, &in_vdex,
1711 &out_vdex)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001712 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001713 return -1;
1714 }
1715
Calin Juravlecb556e32017-04-04 20:22:50 -07001716 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1717 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1718 // fully inherit their parent context).
1719 // Note that for primary apk the oat files are created before, in a separate installd
1720 // call which also does the restorecon. TODO(calin): unify the paths.
1721 if (is_secondary_dex) {
1722 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1723 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001724 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1725 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001726 return -1;
1727 }
1728 }
1729
Jeff Sharkey90aff262016-12-12 14:28:24 -07001730 // Create a swap file if necessary.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001731 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat.path());
Jeff Sharkey90aff262016-12-12 14:28:24 -07001732
Calin Juravle7a570e82017-01-14 16:23:30 -08001733 // Open the reference profile if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001734 UniqueFile reference_profile = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001735 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001736
Victor Hsiehcb35a062020-08-13 16:11:13 -07001737 if (reference_profile.fd() == -1) {
liulvping61907742018-08-21 09:36:52 +08001738 // We don't create an app image without reference profile since there is no speedup from
1739 // loading it in that case and instead will be a small overhead.
1740 generate_app_image = false;
1741 }
1742
1743 // Create the app image file if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001744 UniqueFile out_image = maybe_open_app_image(
1745 out_oat.path(), generate_app_image, is_public, uid, is_secondary_dex);
liulvping61907742018-08-21 09:36:52 +08001746
Victor Hsiehcb35a062020-08-13 16:11:13 -07001747 UniqueFile dex_metadata;
Calin Juravle62c5a372018-02-01 17:03:23 +00001748 if (dex_metadata_path != nullptr) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001749 dex_metadata.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)),
1750 dex_metadata_path);
1751 if (dex_metadata.fd() < 0) {
Calin Juravle62c5a372018-02-01 17:03:23 +00001752 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1753 }
1754 }
1755
Victor Hsieh8948a862020-08-07 11:30:55 -07001756 std::string jitzygote_flag = server_configurable_flags::GetServerConfigurableFlag(
1757 RUNTIME_NATIVE_BOOT_NAMESPACE,
1758 ENABLE_JITZYGOTE_IMAGE,
1759 /*default_value=*/ "");
1760 bool use_jitzygote_image = jitzygote_flag == "true" || IsBootClassPathProfilingEnable();
1761
Victor Hsiehe98e6512020-08-10 15:39:22 -07001762 // Decide whether to use dex2oat64.
1763 bool use_dex2oat64 = false;
1764 // Check whether the device even supports 64-bit ABIs.
1765 if (!GetProperty("ro.product.cpu.abilist64", "").empty()) {
1766 use_dex2oat64 = GetBoolProperty("dalvik.vm.dex2oat64.enabled", false);
1767 }
1768 const char* dex2oat_bin = select_execution_binary(
1769 (use_dex2oat64 ? kDex2oat64Path : kDex2oat32Path),
1770 (use_dex2oat64 ? kDex2oatDebug64Path : kDex2oatDebug32Path),
1771 background_job_compile);
1772
Victor Hsiehc9821f12020-08-07 11:32:29 -07001773 auto execv_helper = std::make_unique<ExecVHelper>();
1774
Andreas Gampe023b2242018-02-28 16:03:25 -08001775 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001776
Victor Hsiehc9821f12020-08-07 11:32:29 -07001777 RunDex2Oat runner(dex2oat_bin, execv_helper.get());
Victor Hsiehcb35a062020-08-13 16:11:13 -07001778 runner.Initialize(out_oat,
1779 out_vdex,
1780 out_image,
1781 in_dex,
1782 in_vdex,
1783 dex_metadata,
1784 reference_profile,
1785 class_loader_context,
1786 join_fds(context_input_fds),
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001787 swap_fd.get(),
1788 instruction_set,
1789 compiler_filter,
1790 debuggable,
1791 boot_complete,
Patrick Baumann2271b3e2020-04-14 17:03:00 -07001792 for_restore,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001793 target_sdk_version,
1794 enable_hidden_api_checks,
1795 generate_compact_dex,
Victor Hsieh8948a862020-08-07 11:30:55 -07001796 use_jitzygote_image,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001797 compilation_reason);
1798
Jeff Sharkey90aff262016-12-12 14:28:24 -07001799 pid_t pid = fork();
1800 if (pid == 0) {
1801 /* child -- drop privileges before continuing */
1802 drop_capabilities(uid);
1803
Richard Uhler76cc0272016-12-08 10:46:35 +00001804 SetDex2OatScheduling(boot_complete);
Victor Hsiehcb35a062020-08-13 16:11:13 -07001805 if (flock(out_oat.fd(), LOCK_EX | LOCK_NB) != 0) {
1806 PLOG(ERROR) << "flock(" << out_oat.path() << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001807 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001808 }
1809
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001810 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001811 } else {
1812 int res = wait_child(pid);
1813 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001814 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001815 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001816 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1817 << std::hex << std::setw(4) << res << ", process failed";
1818 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001819 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001820 }
1821 }
1822
Victor Hsiehcb35a062020-08-13 16:11:13 -07001823 update_out_oat_access_times(dex_path, out_oat.path().c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -07001824
1825 // We've been successful, don't delete output.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001826 out_oat.DisableCleanup();
1827 out_vdex.DisableCleanup();
1828 out_image.DisableCleanup();
1829 reference_profile.DisableCleanup();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001830
1831 return 0;
1832}
1833
Calin Juravlec9eab382017-01-25 01:17:17 -08001834// Try to remove the given directory. Log an error if the directory exists
1835// and is empty but could not be removed.
1836static bool rmdir_if_empty(const char* dir) {
1837 if (rmdir(dir) == 0) {
1838 return true;
1839 }
1840 if (errno == ENOENT || errno == ENOTEMPTY) {
1841 return true;
1842 }
1843 PLOG(ERROR) << "Failed to remove dir: " << dir;
1844 return false;
1845}
1846
1847// Try to unlink the given file. Log an error if the file exists and could not
1848// be unlinked.
1849static bool unlink_if_exists(const std::string& file) {
1850 if (unlink(file.c_str()) == 0) {
1851 return true;
1852 }
1853 if (errno == ENOENT) {
1854 return true;
1855
1856 }
1857 PLOG(ERROR) << "Could not unlink: " << file;
1858 return false;
1859}
1860
Calin Juravle7d765462017-09-04 15:57:10 -07001861enum ReconcileSecondaryDexResult {
1862 kReconcileSecondaryDexExists = 0,
1863 kReconcileSecondaryDexCleanedUp = 1,
1864 kReconcileSecondaryDexValidationError = 2,
1865 kReconcileSecondaryDexCleanUpError = 3,
1866 kReconcileSecondaryDexAccessIOError = 4,
1867};
Calin Juravlec9eab382017-01-25 01:17:17 -08001868
1869// Reconcile the secondary dex 'dex_path' and its generated oat files.
1870// Return true if all the parameters are valid and the secondary dex file was
1871// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1872// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1873// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1874// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1875// Return false if there were errors during processing. In this case
1876// out_secondary_dex_exists will be set to false.
1877bool reconcile_secondary_dex_file(const std::string& dex_path,
1878 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09001879 const std::optional<std::string>& volume_uuid, int storage_flag,
Calin Juravlec9eab382017-01-25 01:17:17 -08001880 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07001881 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08001882 if (isas.size() == 0) {
1883 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1884 return false;
1885 }
1886
Calin Juravle7d765462017-09-04 15:57:10 -07001887 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
1888 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
1889 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08001890 return false;
1891 }
1892
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001893 // As a security measure we want to unlink art artifacts with the reduced capabilities
1894 // of the package user id. So we fork and drop capabilities in the child.
1895 pid_t pid = fork();
1896 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07001897 /* child -- drop privileges before continuing */
1898 drop_capabilities(uid);
1899
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09001900 const char* volume_uuid_cstr = volume_uuid ? volume_uuid->c_str() : nullptr;
Greg Kaiser8042c372019-03-26 06:23:19 -07001901 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr,
Calin Juravle7d765462017-09-04 15:57:10 -07001902 uid, storage_flag)) {
1903 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
1904 _exit(kReconcileSecondaryDexValidationError);
1905 }
1906
1907 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
1908 switch (access_check) {
1909 case kSecondaryDexAccessDoesNotExist:
1910 // File does not exist. Proceed with cleaning.
1911 break;
1912 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
1913 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
1914 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
1915 default:
1916 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
1917 _exit(kReconcileSecondaryDexValidationError);
1918 }
1919
1920 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001921 char oat_path[PKG_PATH_MAX];
1922 char oat_dir[PKG_PATH_MAX];
1923 char oat_isa_dir[PKG_PATH_MAX];
1924 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001925 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001926 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07001927 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001928 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
1929 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07001930 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001931 }
Calin Juravle51314092017-05-18 15:33:05 -07001932
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001933 // Delete oat/vdex/art files.
1934 result = unlink_if_exists(oat_path) && result;
1935 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
1936 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08001937
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001938 // Delete profiles.
1939 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08001940 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001941 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08001942 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001943 result = unlink_if_exists(current_profile) && result;
1944 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07001945
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001946 // We upgraded once the location of current profile for secondary dex files.
1947 // Check for any previous left-overs and remove them as well.
1948 std::string old_current_profile = dex_path + ".prof";
1949 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07001950
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001951 // Try removing the directories as well, they might be empty.
1952 result = rmdir_if_empty(oat_isa_dir) && result;
1953 result = rmdir_if_empty(oat_dir) && result;
1954 }
Calin Juravle7d765462017-09-04 15:57:10 -07001955 if (!result) {
1956 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
1957 }
1958 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08001959 }
1960
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001961 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07001962 if (!WIFEXITED(return_code)) {
1963 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
1964 } else {
1965 return_code = WEXITSTATUS(return_code);
1966 }
1967
1968 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
1969
1970 switch (return_code) {
1971 case kReconcileSecondaryDexCleanedUp:
1972 case kReconcileSecondaryDexValidationError:
1973 // If we couldn't validate assume the dex file does not exist.
1974 // This will purge the entry from the PM records.
1975 *out_secondary_dex_exists = false;
1976 return true;
1977 case kReconcileSecondaryDexExists:
1978 *out_secondary_dex_exists = true;
1979 return true;
1980 case kReconcileSecondaryDexAccessIOError:
1981 // We had an access IO error.
1982 // Return false so that we can try again.
1983 // The value of out_secondary_dex_exists does not matter in this case and by convention
1984 // is set to false.
1985 *out_secondary_dex_exists = false;
1986 return false;
1987 default:
1988 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
1989 *out_secondary_dex_exists = false;
1990 return false;
1991 }
Calin Juravlec9eab382017-01-25 01:17:17 -08001992}
1993
Alan Stokesa25d90c2017-10-16 10:56:00 +01001994// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
1995// Returns true if all parameters are valid and the hash successfully computed and stored in
1996// out_secondary_dex_hash.
1997// Also returns true with an empty hash if the file does not currently exist or is not accessible to
1998// the app.
1999// For any other errors (e.g. if any of the parameters are invalid) returns false.
2000bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002001 const std::optional<std::string>& volume_uuid, int storage_flag,
Alan Stokesa25d90c2017-10-16 10:56:00 +01002002 std::vector<uint8_t>* out_secondary_dex_hash) {
2003 out_secondary_dex_hash->clear();
2004
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002005 const char* volume_uuid_cstr = volume_uuid ? volume_uuid->c_str() : nullptr;
Alan Stokesa25d90c2017-10-16 10:56:00 +01002006
2007 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2008 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2009 << storage_flag;
2010 return false;
2011 }
2012
2013 // Pipe to get the hash result back from our child process.
2014 unique_fd pipe_read, pipe_write;
2015 if (!Pipe(&pipe_read, &pipe_write)) {
2016 PLOG(ERROR) << "Failed to create pipe";
2017 return false;
2018 }
2019
2020 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2021 // access data the app itself can access.
2022 pid_t pid = fork();
2023 if (pid == 0) {
2024 // child -- drop privileges before continuing
2025 drop_capabilities(uid);
2026 pipe_read.reset();
2027
2028 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2029 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002030 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002031 }
2032
2033 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2034 if (fd == -1) {
2035 if (errno == EACCES || errno == ENOENT) {
2036 // Not treated as an error.
2037 _exit(0);
2038 }
2039 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002040 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002041 }
2042
2043 SHA256_CTX ctx;
2044 SHA256_Init(&ctx);
2045
2046 std::vector<uint8_t> buffer(65536);
2047 while (true) {
2048 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2049 if (bytes_read == 0) {
2050 break;
2051 } else if (bytes_read == -1) {
2052 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002053 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002054 }
2055
2056 SHA256_Update(&ctx, buffer.data(), bytes_read);
2057 }
2058
2059 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2060 SHA256_Final(hash.data(), &ctx);
2061 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002062 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002063 }
2064
2065 _exit(0);
2066 }
2067
2068 // parent
2069 pipe_write.reset();
2070
2071 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2072 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2073 out_secondary_dex_hash->clear();
2074 }
2075 return wait_child(pid) == 0;
2076}
2077
Jeff Sharkey90aff262016-12-12 14:28:24 -07002078// Helper for move_ab, so that we can have common failure-case cleanup.
2079static bool unlink_and_rename(const char* from, const char* to) {
2080 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2081 // return a failure.
2082 struct stat s;
2083 if (stat(to, &s) == 0) {
2084 if (!S_ISREG(s.st_mode)) {
2085 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2086 return false;
2087 }
2088 if (unlink(to) != 0) {
2089 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2090 return false;
2091 }
2092 } else {
2093 // This may be a permission problem. We could investigate the error code, but we'll just
2094 // let the rename failure do the work for us.
2095 }
2096
2097 // Try to rename "to" to "from."
2098 if (rename(from, to) != 0) {
2099 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2100 return false;
2101 }
2102 return true;
2103}
2104
2105// Move/rename a B artifact (from) to an A artifact (to).
2106static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2107 // Check whether B exists.
2108 {
2109 struct stat s;
2110 if (stat(b_path.c_str(), &s) != 0) {
2111 // Silently ignore for now. The service calling this isn't smart enough to understand
2112 // lack of artifacts at the moment.
2113 return false;
2114 }
2115 if (!S_ISREG(s.st_mode)) {
2116 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2117 // Try to unlink, but swallow errors.
2118 unlink(b_path.c_str());
2119 return false;
2120 }
2121 }
2122
2123 // Rename B to A.
2124 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2125 // Delete the b_path so we don't try again (or fail earlier).
2126 if (unlink(b_path.c_str()) != 0) {
2127 PLOG(ERROR) << "Could not unlink " << b_path;
2128 }
2129
2130 return false;
2131 }
2132
2133 return true;
2134}
2135
2136bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2137 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002138 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2139 if (slot_suffix.empty()) {
2140 return false;
2141 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002142
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002143 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2144 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2145 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002146 }
2147
2148 // Validate other inputs.
2149 if (validate_apk_path(apk_path) != 0) {
2150 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2151 return false;
2152 }
2153 if (validate_apk_path(oat_dir) != 0) {
2154 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2155 return false;
2156 }
2157
2158 char a_path[PKG_PATH_MAX];
2159 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2160 return false;
2161 }
2162 const std::string a_vdex_path = create_vdex_filename(a_path);
2163 const std::string a_image_path = create_image_filename(a_path);
2164
2165 // B path = A path + slot suffix.
2166 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2167 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2168 const std::string b_image_path = StringPrintf("%s.%s",
2169 a_image_path.c_str(),
2170 slot_suffix.c_str());
2171
2172 bool success = true;
2173 if (move_ab_path(b_path, a_path)) {
2174 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2175 // Note: we can live without an app image. As such, ignore failure to move the image file.
2176 // If we decide to require the app image, or the app image being moved correctly,
2177 // then change accordingly.
2178 constexpr bool kIgnoreAppImageFailure = true;
2179
2180 if (!a_image_path.empty()) {
2181 if (!move_ab_path(b_image_path, a_image_path)) {
2182 unlink(a_image_path.c_str());
2183 if (!kIgnoreAppImageFailure) {
2184 success = false;
2185 }
2186 }
2187 }
2188 } else {
2189 // Cleanup: delete B image, ignore errors.
2190 unlink(b_image_path.c_str());
2191 success = false;
2192 }
2193 } else {
2194 // Cleanup: delete B image, ignore errors.
2195 unlink(b_vdex_path.c_str());
2196 unlink(b_image_path.c_str());
2197 success = false;
2198 }
2199 return success;
2200}
2201
2202bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2203 // Delete the oat/odex file.
2204 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002205 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002206 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002207 return false;
2208 }
2209
2210 // In case of a permission failure report the issue. Otherwise just print a warning.
2211 auto unlink_and_check = [](const char* path) -> bool {
2212 int result = unlink(path);
2213 if (result != 0) {
2214 if (errno == EACCES || errno == EPERM) {
2215 PLOG(ERROR) << "Could not unlink " << path;
2216 return false;
2217 }
2218 PLOG(WARNING) << "Could not unlink " << path;
2219 }
2220 return true;
2221 };
2222
2223 // Delete the oat/odex file.
2224 bool return_value_oat = unlink_and_check(out_path);
2225
2226 // Derive and delete the app image.
2227 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2228
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002229 // Derive and delete the vdex file.
2230 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2231
Jeff Sharkey90aff262016-12-12 14:28:24 -07002232 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002233 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002234}
2235
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002236static bool is_absolute_path(const std::string& path) {
2237 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2238 LOG(ERROR) << "Invalid absolute path " << path;
2239 return false;
2240 } else {
2241 return true;
2242 }
2243}
2244
2245static bool is_valid_instruction_set(const std::string& instruction_set) {
2246 // TODO: add explicit whitelisting of instruction sets
2247 if (instruction_set.find('/') != std::string::npos) {
2248 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2249 return false;
2250 } else {
2251 return true;
2252 }
2253}
2254
2255bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2256 const char *apk_path, const char *instruction_set) {
2257 std::string oat_dir_ = oat_dir;
2258 std::string apk_path_ = apk_path;
2259 std::string instruction_set_ = instruction_set;
2260
2261 if (!is_absolute_path(oat_dir_)) return false;
2262 if (!is_absolute_path(apk_path_)) return false;
2263 if (!is_valid_instruction_set(instruction_set_)) return false;
2264
2265 std::string::size_type end = apk_path_.rfind('.');
2266 std::string::size_type start = apk_path_.rfind('/', end);
2267 if (end == std::string::npos || start == std::string::npos) {
2268 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2269 return false;
2270 }
2271
2272 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2273 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2274 const char* res = res_.c_str();
2275 if (strlen(res) >= PKG_PATH_MAX) {
2276 LOG(ERROR) << "Result too large";
2277 return false;
2278 } else {
2279 strlcpy(path, res, PKG_PATH_MAX);
2280 return true;
2281 }
2282}
2283
2284bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2285 const char *instruction_set) {
2286 std::string apk_path_ = apk_path;
2287 std::string instruction_set_ = instruction_set;
2288
2289 if (!is_absolute_path(apk_path_)) return false;
2290 if (!is_valid_instruction_set(instruction_set_)) return false;
2291
2292 std::string::size_type end = apk_path_.rfind('.');
2293 std::string::size_type start = apk_path_.rfind('/', end);
2294 if (end == std::string::npos || start == std::string::npos) {
2295 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2296 return false;
2297 }
2298
2299 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2300 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2301}
2302
2303bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2304 const char *instruction_set) {
2305 std::string src_ = src;
2306 std::string instruction_set_ = instruction_set;
2307
2308 if (!is_absolute_path(src_)) return false;
2309 if (!is_valid_instruction_set(instruction_set_)) return false;
2310
2311 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2312 if (*it == '/') {
2313 *it = '@';
2314 }
2315 }
2316
2317 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2318 + DALVIK_CACHE_POSTFIX;
2319 const char* res = res_.c_str();
2320 if (strlen(res) >= PKG_PATH_MAX) {
2321 LOG(ERROR) << "Result too large";
2322 return false;
2323 } else {
2324 strlcpy(path, res, PKG_PATH_MAX);
2325 return true;
2326 }
2327}
2328
Calin Juravle59f7ab82018-04-27 17:50:23 -07002329bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2330 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002331 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2332 for (const std::string& elem : classpaths_elems) {
2333 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2334 if (fd < 0) {
2335 PLOG(ERROR) << "Could not open classpath elem " << elem;
2336 return false;
2337 } else {
2338 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002339 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002340 }
2341 }
2342 return true;
2343}
2344
2345static bool create_app_profile_snapshot(int32_t app_id,
2346 const std::string& package_name,
2347 const std::string& profile_name,
2348 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002349 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2350
Calin Juravle824a64d2018-01-18 20:23:17 -08002351 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002352 if (snapshot_fd < 0) {
2353 return false;
2354 }
2355
2356 std::vector<unique_fd> profiles_fd;
2357 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002358 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2359 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002360 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2361 return false;
2362 }
2363
2364 profiles_fd.push_back(std::move(reference_profile_fd));
2365
Calin Juravle0d0a4922018-01-23 19:54:11 -08002366 // Open the class paths elements. These will be used to filter out profile data that does
2367 // not belong to the classpath during merge.
2368 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002369 std::vector<std::string> dex_locations;
2370 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002371 return false;
2372 }
2373
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002374 RunProfman args;
Calin Juravlef85ddb92020-05-01 14:05:40 -07002375 // This is specifically a snapshot for an app, so don't use boot image profiles.
2376 args.SetupMerge(profiles_fd,
2377 snapshot_fd,
2378 apk_fds,
2379 dex_locations,
2380 /* for_snapshot= */ true,
2381 /* for_boot_image= */ false);
Calin Juravle29591732017-11-20 17:46:19 -08002382 pid_t pid = fork();
2383 if (pid == 0) {
2384 /* child -- drop privileges before continuing */
2385 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002386 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002387 }
2388
2389 /* parent */
2390 int return_code = wait_child(pid);
2391 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002392 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002393 return false;
2394 }
2395
Calin Juravle78728f32019-11-08 17:55:46 -08002396 // Verify that profman finished successfully.
2397 int profman_code = WEXITSTATUS(return_code);
2398 if (profman_code != PROFMAN_BIN_RETURN_CODE_SUCCESS) {
2399 LOG(WARNING) << "profman error for " << package_name << ":" << profile_name
2400 << ":" << profman_code;
2401 return false;
2402 }
Calin Juravle29591732017-11-20 17:46:19 -08002403 return true;
2404}
2405
Calin Juravle0d0a4922018-01-23 19:54:11 -08002406static bool create_boot_image_profile_snapshot(const std::string& package_name,
2407 const std::string& profile_name,
2408 const std::string& classpath) {
2409 // The reference profile directory for the android package might not be prepared. Do it now.
2410 const std::string ref_profile_dir =
2411 create_primary_reference_profile_package_dir_path(package_name);
2412 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2413 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2414 return false;
2415 }
2416
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002417 // Return false for empty class path since it may otherwise return true below if profiles is
2418 // empty.
2419 if (classpath.empty()) {
2420 PLOG(ERROR) << "Class path is empty";
2421 return false;
2422 }
2423
Calin Juravle0d0a4922018-01-23 19:54:11 -08002424 // Open and create the snapshot profile.
2425 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2426
2427 // Collect all non empty profiles.
2428 // The collection will traverse all applications profiles and find the non empty files.
2429 // This has the potential of inspecting a large number of files and directories (depending
2430 // on the number of applications and users). So there is a slight increase in the chance
2431 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2432 // fail the snapshot and aggregate whatever profile we could open.
2433 //
2434 // The profile snapshot is a best effort based on available data it's ok if some data
2435 // from some apps is missing. It will be counter productive for the snapshot to fail
2436 // because we could not open or read some of the files.
2437 std::vector<std::string> profiles;
2438 if (!collect_profiles(&profiles)) {
2439 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2440 }
2441
2442 // If we have no profiles return early.
2443 if (profiles.empty()) {
2444 return true;
2445 }
2446
2447 // Open the classpath elements. These will be used to filter out profile data that does
2448 // not belong to the classpath during merge.
2449 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002450 std::vector<std::string> dex_locations;
2451 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002452 return false;
2453 }
2454
2455 // If we could not open any files from the classpath return an error.
2456 if (apk_fds.empty()) {
2457 LOG(ERROR) << "Could not open any of the classpath elements.";
2458 return false;
2459 }
2460
2461 // Aggregate the profiles in batches of kAggregationBatchSize.
2462 // We do this to avoid opening a huge a amount of files.
2463 static constexpr size_t kAggregationBatchSize = 10;
2464
Calin Juravle0d0a4922018-01-23 19:54:11 -08002465 for (size_t i = 0; i < profiles.size(); ) {
Calin Juravlea64fb512019-11-06 16:11:14 -08002466 std::vector<unique_fd> profiles_fd;
Calin Juravle0d0a4922018-01-23 19:54:11 -08002467 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2468 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2469 if (fd.get() >= 0) {
2470 profiles_fd.push_back(std::move(fd));
2471 }
2472 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002473
2474 // We aggregate (read & write) into the same fd multiple times in a row.
2475 // We need to reset the cursor every time to ensure we read the whole file every time.
2476 if (TEMP_FAILURE_RETRY(lseek(snapshot_fd, 0, SEEK_SET)) == static_cast<off_t>(-1)) {
2477 PLOG(ERROR) << "Cannot reset position for snapshot profile";
2478 return false;
2479 }
2480
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002481 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002482 args.SetupMerge(profiles_fd,
2483 snapshot_fd,
2484 apk_fds,
Calin Juravle78728f32019-11-08 17:55:46 -08002485 dex_locations,
2486 /*for_snapshot=*/true,
2487 /*for_boot_image=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002488 pid_t pid = fork();
2489 if (pid == 0) {
2490 /* child -- drop privileges before continuing */
2491 drop_capabilities(AID_SYSTEM);
2492
Calin Juravle59f7ab82018-04-27 17:50:23 -07002493 // The introduction of new access flags into boot jars causes them to
2494 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002495 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002496 }
2497
2498 /* parent */
2499 int return_code = wait_child(pid);
Calin Juravlea64fb512019-11-06 16:11:14 -08002500
Calin Juravle0d0a4922018-01-23 19:54:11 -08002501 if (!WIFEXITED(return_code)) {
2502 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2503 return false;
2504 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002505
2506 // Verify that profman finished successfully.
2507 int profman_code = WEXITSTATUS(return_code);
Calin Juravle78728f32019-11-08 17:55:46 -08002508 if (profman_code != PROFMAN_BIN_RETURN_CODE_SUCCESS) {
2509 LOG(WARNING) << "profman error for " << package_name << ":" << profile_name
2510 << ":" << profman_code;
2511 return false;
Calin Juravlea64fb512019-11-06 16:11:14 -08002512 }
Calin Juravle0d0a4922018-01-23 19:54:11 -08002513 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002514
Calin Juravle0d0a4922018-01-23 19:54:11 -08002515 return true;
2516}
2517
2518bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2519 const std::string& profile_name, const std::string& classpath) {
2520 if (app_id == -1) {
2521 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2522 } else {
2523 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2524 }
2525}
2526
Calin Juravlec3b049e2018-01-18 22:32:58 -08002527bool prepare_app_profile(const std::string& package_name,
2528 userid_t user_id,
2529 appid_t app_id,
2530 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002531 const std::string& code_path,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002532 const std::optional<std::string>& dex_metadata) {
Calin Juravlec3b049e2018-01-18 22:32:58 -08002533 // Prepare the current profile.
2534 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2535 /*is_secondary_dex*/ false);
2536 uid_t uid = multiuser_get_uid(user_id, app_id);
2537 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2538 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2539 return false;
2540 }
2541
2542 // Check if we need to install the profile from the dex metadata.
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002543 if (!dex_metadata) {
Calin Juravlec3b049e2018-01-18 22:32:58 -08002544 return true;
2545 }
2546
2547 // We have a dex metdata. Merge the profile into the reference profile.
2548 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2549 /*read_write*/ true, /*is_secondary_dex*/ false);
2550 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2551 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002552 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2553 if (apk_fd < 0) {
2554 PLOG(ERROR) << "Could not open code path " << code_path;
2555 return false;
2556 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002557
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002558 RunProfman args;
2559 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2560 std::move(ref_profile_fd),
2561 std::move(apk_fd),
2562 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002563 pid_t pid = fork();
2564 if (pid == 0) {
2565 /* child -- drop privileges before continuing */
2566 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2567 drop_capabilities(app_shared_gid);
2568
Calin Juravlef63d4792018-01-30 17:43:34 +00002569 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002570 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002571 }
2572
2573 /* parent */
2574 int return_code = wait_child(pid);
2575 if (!WIFEXITED(return_code)) {
2576 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2577 return false;
2578 }
2579 return true;
2580}
2581
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002582} // namespace installd
2583} // namespace android