blob: 65fc46ecafa49a730971a5fbc44131916eb3fb30 [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
yawannga27559e2020-11-13 19:17:44 +0000453 // The percent won't exceed 100, otherwise, don't set it and use the
454 // default one set in profman.
yawanng6fe34a52020-11-06 05:13:53 +0000455 uint32_t min_new_classes_percent_change = ::android::base::GetUintProperty<uint32_t>(
yawannga27559e2020-11-13 19:17:44 +0000456 "dalvik.vm.bgdexopt.new-classes-percent",
457 /*default*/std::numeric_limits<uint32_t>::max());
458 if (min_new_classes_percent_change <= 100) {
yawanng6fe34a52020-11-06 05:13:53 +0000459 AddArg("--min-new-classes-percent-change=" +
460 std::to_string(min_new_classes_percent_change));
461 }
462
yawannga27559e2020-11-13 19:17:44 +0000463 // The percent won't exceed 100, otherwise, don't set it and use the
464 // default one set in profman.
yawanng6fe34a52020-11-06 05:13:53 +0000465 uint32_t min_new_methods_percent_change = ::android::base::GetUintProperty<uint32_t>(
yawannga27559e2020-11-13 19:17:44 +0000466 "dalvik.vm.bgdexopt.new-methods-percent",
467 /*default*/std::numeric_limits<uint32_t>::max());
468 if (min_new_methods_percent_change <= 100) {
yawanng6fe34a52020-11-06 05:13:53 +0000469 AddArg("--min-new-methods-percent-change=" +
470 std::to_string(min_new_methods_percent_change));
471 }
472
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800473 // Do not add after dex2oat_flags, they should override others for debugging.
474 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800475 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700476
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800477 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
478 const unique_fd& reference_profile_fd,
479 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravle78728f32019-11-08 17:55:46 -0800480 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
481 bool for_snapshot = false,
482 bool for_boot_image = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800483 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800484 reference_profile_fd,
485 apk_fds,
486 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800487 /*copy_and_update=*/ false,
488 for_snapshot,
489 for_boot_image);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800490 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700491
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800492 void SetupCopyAndUpdate(unique_fd&& profile_fd,
493 unique_fd&& reference_profile_fd,
494 unique_fd&& apk_fd,
495 const std::string& dex_location) {
496 // The fds need to stay open longer than the scope of the function, so put them into a local
497 // variable vector.
498 profiles_fd_.push_back(std::move(profile_fd));
499 apk_fds_.push_back(std::move(apk_fd));
500 reference_profile_fd_ = std::move(reference_profile_fd);
501 std::vector<std::string> dex_locations = {dex_location};
Calin Juravleb3a929d2018-12-11 14:40:00 -0800502 SetupArgs(profiles_fd_,
503 reference_profile_fd_,
504 apk_fds_,
505 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800506 /*copy_and_update=*/true,
507 /*for_snapshot*/false,
508 /*for_boot_image*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800509 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000510
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800511 void SetupDump(const std::vector<unique_fd>& profiles_fd,
512 const unique_fd& reference_profile_fd,
513 const std::vector<std::string>& dex_locations,
514 const std::vector<unique_fd>& apk_fds,
515 const unique_fd& output_fd) {
516 AddArg("--dump-only");
517 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800518 SetupArgs(profiles_fd,
519 reference_profile_fd,
520 apk_fds,
521 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800522 /*copy_and_update=*/false,
523 /*for_snapshot*/false,
524 /*for_boot_image*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800525 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000526
Victor Hsiehc9821f12020-08-07 11:32:29 -0700527 using ExecVHelper::Exec; // To suppress -Wno-overloaded-virtual
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800528 void Exec() {
529 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
530 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000531
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800532 private:
533 unique_fd reference_profile_fd_;
534 std::vector<unique_fd> profiles_fd_;
535 std::vector<unique_fd> apk_fds_;
536};
Mathieu Chartier31636522018-11-09 23:53:07 +0000537
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800538
Calin Juravlef63d4792018-01-30 17:43:34 +0000539
Jeff Sharkey90aff262016-12-12 14:28:24 -0700540// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800541// The location is the package name for primary apks or the dex path for secondary dex files.
542// Returns true if there is enough information in the current profiles that makes it
543// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700544// If the return value is true all the current profiles would have been merged into
545// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800546static bool analyze_profiles(uid_t uid, const std::string& package_name,
547 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800548 std::vector<unique_fd> profiles_fd;
549 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800550 open_profile_files(uid, package_name, location, is_secondary_dex,
551 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800552 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700553 // Skip profile guided compilation because no profiles were found.
554 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700555 return false;
556 }
557
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800558 RunProfman profman_merge;
Calin Juravlef85ddb92020-05-01 14:05:40 -0700559 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>();
560 const std::vector<std::string>& dex_locations = std::vector<std::string>();
561 profman_merge.SetupMerge(
562 profiles_fd,
563 reference_profile_fd,
564 apk_fds,
565 dex_locations,
566 /* for_snapshot= */ false,
567 IsBootClassPathProfilingEnable());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700568 pid_t pid = fork();
569 if (pid == 0) {
570 /* child -- drop privileges before continuing */
571 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800572 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700573 }
574 /* parent */
575 int return_code = wait_child(pid);
576 bool need_to_compile = false;
577 bool should_clear_current_profiles = false;
578 bool should_clear_reference_profile = false;
579 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800580 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700581 } else {
582 return_code = WEXITSTATUS(return_code);
583 switch (return_code) {
584 case PROFMAN_BIN_RETURN_CODE_COMPILE:
585 need_to_compile = true;
586 should_clear_current_profiles = true;
587 should_clear_reference_profile = false;
588 break;
589 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
590 need_to_compile = false;
591 should_clear_current_profiles = false;
592 should_clear_reference_profile = false;
593 break;
594 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800595 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700596 need_to_compile = false;
597 should_clear_current_profiles = true;
598 should_clear_reference_profile = true;
599 break;
600 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
601 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
602 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800603 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700604 need_to_compile = false;
605 should_clear_current_profiles = false;
606 should_clear_reference_profile = false;
607 break;
Calin Juravle76561322019-11-14 09:08:52 -0800608 case PROFMAN_BIN_RETURN_CODE_ERROR_DIFFERENT_VERSIONS:
609 need_to_compile = false;
610 should_clear_current_profiles = true;
611 should_clear_reference_profile = true;
612 break;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700613 default:
614 // Unknown return code or error. Unlink profiles.
Calin Juravle78728f32019-11-08 17:55:46 -0800615 LOG(WARNING) << "Unexpected error code while processing profiles for location "
Calin Juravle114f0812017-03-08 19:05:07 -0800616 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700617 need_to_compile = false;
618 should_clear_current_profiles = true;
619 should_clear_reference_profile = true;
620 break;
621 }
622 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800623
Jeff Sharkey90aff262016-12-12 14:28:24 -0700624 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800625 if (is_secondary_dex) {
626 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800627 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
628 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800629 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800630 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800631 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700632 }
633 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800634 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700635 }
636 return need_to_compile;
637}
638
Calin Juravle114f0812017-03-08 19:05:07 -0800639// Decides if profile guided compilation is needed or not based on existing profiles.
640// The analysis is done for the primary apks of the given package.
641// Returns true if there is enough information in the current profiles that makes it
642// worth to recompile the package.
643// If the return value is true all the current profiles would have been merged into
644// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800645bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
646 const std::string& profile_name) {
647 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800648}
649
Calin Juravle408cd4a2018-01-20 23:34:18 -0800650bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
651 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800652 std::vector<unique_fd> profile_fds;
653 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800654 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
655 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700656
Calin Juravle408cd4a2018-01-20 23:34:18 -0800657 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800658 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700659
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800660 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700661 const bool has_profiles = !profile_fds.empty();
662
663 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800664 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700665 return false;
666 }
667
Calin Juravle114f0812017-03-08 19:05:07 -0800668 unique_fd output_fd(open(out_file_name.c_str(),
669 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700670 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800671 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700672 return false;
673 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800674
Jeff Sharkey90aff262016-12-12 14:28:24 -0700675 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800676 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800677 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
678 if (apk_fd == -1) {
679 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
680 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700681 }
Victor Hsieh76f19ba2020-08-10 14:37:26 -0700682 dex_locations.push_back(Basename(code_path));
Calin Juravle408cd4a2018-01-20 23:34:18 -0800683 apk_fds.push_back(std::move(apk_fd));
684
Jeff Sharkey90aff262016-12-12 14:28:24 -0700685
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800686 RunProfman profman_dump;
687 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700688 pid_t pid = fork();
689 if (pid == 0) {
690 /* child -- drop privileges before continuing */
691 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800692 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700693 }
694 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700695 int return_code = wait_child(pid);
696 if (!WIFEXITED(return_code)) {
697 LOG(WARNING) << "profman failed for package " << pkgname << ": "
698 << return_code;
699 return false;
700 }
701 return true;
702}
703
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700704bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800705 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700706 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
707 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800708 package_name,
709 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700710 /*read_write*/ true,
711 /*secondary*/ false));
712 if (in_fd.get() < 0) {
713 PLOG(WARNING) << "Could not open profile " << system_profile;
714 return false;
715 }
716 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800717 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700718 return false;
719 }
720
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700721 // As a security measure we want to write the profile information with the reduced capabilities
722 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700723 pid_t pid = fork();
724 if (pid == 0) {
725 /* child -- drop privileges before continuing */
726 drop_capabilities(packageUid);
727
728 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
729 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800730 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700731 }
732 // This implies that the app owning this profile is running
733 // (and has acquired the lock).
734 //
735 // The app never acquires the lock for the reference profiles of primary apks.
736 // Only dex2oat from installd will do that. Since installd is single threaded
737 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800738 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700739 return false;
740 }
741
742 bool truncated = ftruncate(out_fd.get(), 0) == 0;
743 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800744 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700745 }
746
747 // Copy over data.
748 static constexpr size_t kBufferSize = 4 * 1024;
749 char buffer[kBufferSize];
750 while (true) {
751 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
752 if (bytes == 0) {
753 break;
754 }
755 write(out_fd.get(), buffer, bytes);
756 }
757 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800758 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700759 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700760 // Use _exit since we don't want to run the global destructors in the child.
761 // b/62597429
762 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700763 }
764 /* parent */
765 int return_code = wait_child(pid);
766 return return_code == 0;
767}
768
Jeff Sharkey90aff262016-12-12 14:28:24 -0700769static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
770 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
771 if (EndsWith(oat_path, ".dex")) {
772 std::string new_path = oat_path;
773 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800774 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700775 return new_path;
776 }
777
778 // An odex entry. Not that this may not be an extension, e.g., in the OTA
779 // case (where the base name will have an extension for the B artifact).
780 size_t odex_pos = oat_path.rfind(".odex");
781 if (odex_pos != std::string::npos) {
782 std::string new_path = oat_path;
783 new_path.replace(odex_pos, strlen(".odex"), new_ext);
784 CHECK_NE(new_path.find(new_ext), std::string::npos);
785 return new_path;
786 }
787
788 // Don't know how to handle this.
789 return "";
790}
791
792// Translate the given oat path to an art (app image) path. An empty string
793// denotes an error.
794static std::string create_image_filename(const std::string& oat_path) {
795 return replace_file_extension(oat_path, ".art");
796}
797
798// Translate the given oat path to a vdex path. An empty string denotes an error.
799static std::string create_vdex_filename(const std::string& oat_path) {
800 return replace_file_extension(oat_path, ".vdex");
801}
802
Jeff Sharkey90aff262016-12-12 14:28:24 -0700803static int open_output_file(const char* file_name, bool recreate, int permissions) {
804 int flags = O_RDWR | O_CREAT;
805 if (recreate) {
806 if (unlink(file_name) < 0) {
807 if (errno != ENOENT) {
808 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
809 }
810 }
811 flags |= O_EXCL;
812 }
813 return open(file_name, flags, permissions);
814}
815
Calin Juravle2289c0a2017-02-15 12:44:14 -0800816static bool set_permissions_and_ownership(
817 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
818 // Primary apks are owned by the system. Secondary dex files are owned by the app.
819 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700820 if (fchmod(fd,
821 S_IRUSR|S_IWUSR|S_IRGRP |
822 (is_public ? S_IROTH : 0)) < 0) {
823 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
824 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -0800825 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700826 ALOGE("installd cannot chown '%s' during dexopt\n", path);
827 return false;
828 }
829 return true;
830}
831
832static bool IsOutputDalvikCache(const char* oat_dir) {
833 // InstallerConnection.java (which invokes installd) transforms Java null arguments
834 // into '!'. Play it safe by handling it both.
835 // TODO: ensure we never get null.
836 // TODO: pass a flag instead of inferring if the output is dalvik cache.
837 return oat_dir == nullptr || oat_dir[0] == '!';
838}
839
Calin Juravled23dee72017-07-06 16:29:11 -0700840// Best-effort check whether we can fit the the path into our buffers.
841// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
842// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
843// extension to the cache path (5 bytes).
844// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
845static bool validate_dex_path_size(const std::string& dex_path) {
846 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
847 LOG(ERROR) << "dex_path too long: " << dex_path;
848 return false;
849 }
850 return true;
851}
852
Jeff Sharkey90aff262016-12-12 14:28:24 -0700853static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -0800854 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -0700855 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700856 return false;
857 }
858
859 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -0800860 // Oat dirs for secondary dex files are already validated.
861 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700862 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
863 return false;
864 }
865 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
866 return false;
867 }
868 } else {
869 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
870 return false;
871 }
872 }
873 return true;
874}
875
Calin Juravle7a570e82017-01-14 16:23:30 -0800876// (re)Creates the app image if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700877UniqueFile maybe_open_app_image(const std::string& out_oat_path,
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -0700878 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100879
Calin Juravle7a570e82017-01-14 16:23:30 -0800880 const std::string image_path = create_image_filename(out_oat_path);
881 if (image_path.empty()) {
882 // Happens when the out_oat_path has an unknown extension.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700883 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -0800884 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100885
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -0700886 // In case there is a stale image, remove it now. Ignore any error.
887 unlink(image_path.c_str());
888
889 // Not enabled, exit.
890 if (!generate_app_image) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700891 return UniqueFile();
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100892 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700893 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
894 if (app_image_format.empty()) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700895 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -0800896 }
897 // Recreate is true since we do not want to modify a mapped image. If the app is
898 // already running and we modify the image file, it can cause crashes (b/27493510).
Victor Hsiehcb35a062020-08-13 16:11:13 -0700899 UniqueFile image_file(
Calin Juravle7a570e82017-01-14 16:23:30 -0800900 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
Victor Hsiehcb35a062020-08-13 16:11:13 -0700901 image_path,
902 UnlinkIgnoreResult);
903 if (image_file.fd() < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800904 // Could not create application image file. Go on since we can compile without it.
905 LOG(ERROR) << "installd could not create '" << image_path
906 << "' for image file during dexopt";
907 // If we have a valid image file path but no image fd, explicitly erase the image file.
908 if (unlink(image_path.c_str()) < 0) {
909 if (errno != ENOENT) {
910 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
911 }
912 }
913 } else if (!set_permissions_and_ownership(
Victor Hsiehcb35a062020-08-13 16:11:13 -0700914 image_file.fd(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800915 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
Victor Hsiehcb35a062020-08-13 16:11:13 -0700916 image_file.reset();
Calin Juravle7a570e82017-01-14 16:23:30 -0800917 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700918
Victor Hsiehcb35a062020-08-13 16:11:13 -0700919 return image_file;
Calin Juravle7a570e82017-01-14 16:23:30 -0800920}
921
922// Creates the dexopt swap file if necessary and return its fd.
923// Returns -1 if there's no need for a swap or in case of errors.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700924unique_fd maybe_open_dexopt_swap_file(const std::string& out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800925 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800926 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -0800927 }
Victor Hsiehcb35a062020-08-13 16:11:13 -0700928 auto swap_file_name = out_oat_path + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800929 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600930 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -0800931 if (swap_fd.get() < 0) {
932 // Could not create swap file. Optimistically go on and hope that we can compile
933 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600934 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -0800935 } else {
936 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600937 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800938 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
939 }
940 }
941 return swap_fd;
942}
943
944// Opens the reference profiles if needed.
945// 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 -0700946UniqueFile maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000947 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -0800948 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +0000949 // If we are not profile guided compilation, or we are compiling system server
950 // do not bother to open the profiles; we won't be using them.
951 if (!profile_guided || (pkgname[0] == '*')) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700952 return UniqueFile();
Calin Juravle5bd1c722018-02-01 17:23:54 +0000953 }
954
955 // If this is a secondary dex path which is public do not open the profile.
956 // We cannot compile public secondary dex paths with profiles. That's because
957 // it will expose how the dex files are used by their owner.
958 //
959 // Note that the PackageManager is responsible to set the is_public flag for
960 // primary apks and we do not check it here. In some cases, e.g. when
961 // compiling with a public profile from the .dm file the PackageManager will
962 // set is_public toghether with the profile guided compilation.
963 if (is_secondary_dex && is_public) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700964 return UniqueFile();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700965 }
Calin Juravle114f0812017-03-08 19:05:07 -0800966
967 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000968 std::string location;
969 if (is_secondary_dex) {
970 location = dex_path;
971 } else {
972 if (profile_name == nullptr) {
973 // This path is taken for system server re-compilation lunched from ZygoteInit.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700974 return UniqueFile();
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000975 } else {
976 location = profile_name;
977 }
978 }
Victor Hsiehcb35a062020-08-13 16:11:13 -0700979 return open_reference_profile_as_unique_file(uid, pkgname, location, /*read_write*/false,
980 is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -0800981}
Jeff Sharkey90aff262016-12-12 14:28:24 -0700982
Victor Hsiehcb35a062020-08-13 16:11:13 -0700983// Opens the vdex files and assigns the input fd to in_vdex_wrapper and the output fd to
984// out_vdex_wrapper. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -0700985bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +0000986 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Victor Hsiehcb35a062020-08-13 16:11:13 -0700987 bool profile_guided, UniqueFile* in_vdex_wrapper,
988 UniqueFile* out_vdex_wrapper) {
989 CHECK(in_vdex_wrapper != nullptr);
990 CHECK(out_vdex_wrapper != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700991 // Open the existing VDEX. We do this before creating the new output VDEX, which will
992 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +0000993 char in_odex_path[PKG_PATH_MAX];
994 int dexopt_action = abs(dexopt_needed);
995 bool is_odex_location = dexopt_needed < 0;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +0000996
997 // Infer the name of the output VDEX.
998 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
999 if (out_vdex_path_str.empty()) {
1000 return false;
1001 }
1002
1003 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001004 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001005 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1006 const char* path = nullptr;
1007 if (is_odex_location) {
1008 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1009 path = in_odex_path;
1010 } else {
1011 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001012 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001013 }
1014 } else {
1015 path = out_oat_path;
1016 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001017 std::string in_vdex_path_str = create_vdex_filename(path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001018 if (in_vdex_path_str.empty()) {
1019 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001020 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001021 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001022 // We can update in place when all these conditions are met:
1023 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1024 // on /system typically cannot be updated in place).
1025 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1026 // cannot be currently used by a running process.
1027 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1028 // different vdex files to operate.
1029 update_vdex_in_place =
1030 (in_vdex_path_str == out_vdex_path_str) &&
1031 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1032 !profile_guided;
1033 if (update_vdex_in_place) {
1034 // Open the file read-write to be able to update it.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001035 in_vdex_wrapper->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0),
1036 in_vdex_path_str);
1037 if (in_vdex_wrapper->fd() == -1) {
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001038 // If we failed to open the file, we cannot update it in place.
1039 update_vdex_in_place = false;
1040 }
1041 } else {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001042 in_vdex_wrapper->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0),
1043 in_vdex_path_str);
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001044 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001045 }
1046
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001047 // If we are updating the vdex in place, we do not need to recreate a vdex,
1048 // and can use the same existing one.
1049 if (update_vdex_in_place) {
1050 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1051 // have bogus stale vdex files.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001052 out_vdex_wrapper->reset(
1053 in_vdex_wrapper->fd(),
1054 out_vdex_path_str,
1055 UnlinkIgnoreResult);
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001056 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1057 // wrapper).
Victor Hsiehcb35a062020-08-13 16:11:13 -07001058 in_vdex_wrapper->DisableAutoClose();
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001059 } else {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001060 out_vdex_wrapper->reset(
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001061 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
Victor Hsiehcb35a062020-08-13 16:11:13 -07001062 out_vdex_path_str,
1063 UnlinkIgnoreResult);
1064 if (out_vdex_wrapper->fd() < 0) {
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001065 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1066 return false;
1067 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001068 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001069 if (!set_permissions_and_ownership(out_vdex_wrapper->fd(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001070 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001071 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1072 return false;
1073 }
1074
1075 // If we got here we successfully opened the vdex files.
1076 return true;
1077}
1078
1079// Opens the output oat file for the given apk.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001080UniqueFile open_oat_out_file(const char* apk_path, const char* oat_dir,
1081 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex) {
1082 char out_oat_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08001083 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001084 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -08001085 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001086 UniqueFile oat(
Calin Juravle7a570e82017-01-14 16:23:30 -08001087 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
Victor Hsiehcb35a062020-08-13 16:11:13 -07001088 out_oat_path,
1089 UnlinkIgnoreResult);
1090 if (oat.fd() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001091 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001092 } else if (!set_permissions_and_ownership(
Victor Hsiehcb35a062020-08-13 16:11:13 -07001093 oat.fd(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001094 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
Victor Hsiehcb35a062020-08-13 16:11:13 -07001095 oat.reset();
Calin Juravle7a570e82017-01-14 16:23:30 -08001096 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001097 return oat;
Calin Juravle7a570e82017-01-14 16:23:30 -08001098}
1099
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001100// Creates RDONLY fds for oat and vdex files, if exist.
1101// Returns false if it fails to create oat out path for the given apk path.
1102// Note that the method returns true even if the files could not be opened.
1103bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1104 const std::string& oat_dir,
1105 const std::string& instruction_set,
1106 bool is_secondary_dex,
1107 unique_fd* oat_file_fd,
1108 unique_fd* vdex_file_fd) {
1109 char oat_path[PKG_PATH_MAX];
1110 if (!create_oat_out_path(apk_path.c_str(),
1111 instruction_set.c_str(),
1112 oat_dir.c_str(),
1113 is_secondary_dex,
1114 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001115 LOG(ERROR) << "Could not create oat out path for "
1116 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001117 return false;
1118 }
1119 oat_file_fd->reset(open(oat_path, O_RDONLY));
1120 if (oat_file_fd->get() < 0) {
1121 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1122 }
1123
1124 std::string vdex_filename = create_vdex_filename(oat_path);
1125 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1126 if (vdex_file_fd->get() < 0) {
1127 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1128 }
1129
1130 return true;
1131}
1132
Calin Juravle7a570e82017-01-14 16:23:30 -08001133// Updates the access times of out_oat_path based on those from apk_path.
1134void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1135 struct stat input_stat;
1136 memset(&input_stat, 0, sizeof(input_stat));
1137 if (stat(apk_path, &input_stat) != 0) {
1138 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1139 return;
1140 }
1141
1142 struct utimbuf ut;
1143 ut.actime = input_stat.st_atime;
1144 ut.modtime = input_stat.st_mtime;
1145 if (utime(out_oat_path, &ut) != 0) {
1146 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1147 }
1148}
1149
Calin Juravle80a21252017-01-17 14:43:25 -08001150// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001151// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1152// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1153// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001154class RunDexoptAnalyzer : public ExecVHelper {
1155 public:
1156 RunDexoptAnalyzer(const std::string& dex_file,
David Brazdil4f6027a2019-03-19 11:44:21 +00001157 int vdex_fd,
1158 int oat_fd,
1159 int zip_fd,
1160 const std::string& instruction_set,
1161 const std::string& compiler_filter,
1162 bool profile_was_updated,
1163 bool downgrade,
1164 const char* class_loader_context,
1165 const std::string& class_loader_context_fds) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001166 CHECK_GE(zip_fd, 0);
Calin Juravlef74a7372019-02-28 20:29:41 -08001167
1168 // We always run the analyzer in the background job.
1169 const char* dexoptanalyzer_bin = select_execution_binary(
1170 kDexoptanalyzerPath, kDexoptanalyzerDebugPath, /*background_job_compile=*/ true);
Calin Juravle80a21252017-01-17 14:43:25 -08001171
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001172 std::string dex_file_arg = "--dex-file=" + dex_file;
1173 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1174 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1175 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1176 std::string isa_arg = "--isa=" + instruction_set;
1177 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1178 const char* assume_profile_changed = "--assume-profile-changed";
1179 const char* downgrade_flag = "--downgrade";
1180 std::string class_loader_context_arg = "--class-loader-context=";
1181 if (class_loader_context != nullptr) {
1182 class_loader_context_arg += class_loader_context;
1183 }
David Brazdil4f6027a2019-03-19 11:44:21 +00001184 std::string class_loader_context_fds_arg = "--class-loader-context-fds=";
1185 if (!class_loader_context_fds.empty()) {
1186 class_loader_context_fds_arg += class_loader_context_fds;
1187 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001188
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001189 // program name, dex file, isa, filter
1190 AddArg(dex_file_arg);
1191 AddArg(isa_arg);
1192 AddArg(compiler_filter_arg);
1193 if (oat_fd >= 0) {
1194 AddArg(oat_fd_arg);
1195 }
1196 if (vdex_fd >= 0) {
1197 AddArg(vdex_fd_arg);
1198 }
Greg Kaiser8042c372019-03-26 06:23:19 -07001199 AddArg(zip_fd_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001200 if (profile_was_updated) {
1201 AddArg(assume_profile_changed);
1202 }
1203 if (downgrade) {
1204 AddArg(downgrade_flag);
1205 }
1206 if (class_loader_context != nullptr) {
Greg Kaiser8042c372019-03-26 06:23:19 -07001207 AddArg(class_loader_context_arg);
David Brazdil4f6027a2019-03-19 11:44:21 +00001208 if (!class_loader_context_fds.empty()) {
Greg Kaiser8042c372019-03-26 06:23:19 -07001209 AddArg(class_loader_context_fds_arg);
David Brazdil4f6027a2019-03-19 11:44:21 +00001210 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001211 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001212
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001213 PrepareArgs(dexoptanalyzer_bin);
1214 }
David Brazdil4f6027a2019-03-19 11:44:21 +00001215
1216 // Dexoptanalyzer mode which flattens the given class loader context and
1217 // prints a list of its dex files in that flattened order.
1218 RunDexoptAnalyzer(const char* class_loader_context) {
1219 CHECK(class_loader_context != nullptr);
1220
1221 // We always run the analyzer in the background job.
1222 const char* dexoptanalyzer_bin = select_execution_binary(
1223 kDexoptanalyzerPath, kDexoptanalyzerDebugPath, /*background_job_compile=*/ true);
1224
1225 AddArg("--flatten-class-loader-context");
1226 AddArg(std::string("--class-loader-context=") + class_loader_context);
1227 PrepareArgs(dexoptanalyzer_bin);
1228 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001229};
Calin Juravle80a21252017-01-17 14:43:25 -08001230
1231// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001232static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001233 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001234 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001235 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001236 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001237 return false;
1238 }
Calin Juravle114f0812017-03-08 19:05:07 -08001239 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001240
Calin Juravle80a21252017-01-17 14:43:25 -08001241 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001242 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1243 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001244 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001245 return false;
1246 }
1247
1248 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001249 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001250
Calin Juravle7d765462017-09-04 15:57:10 -07001251 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001252 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001253 return false;
1254 }
1255
1256 return true;
1257}
1258
Calin Juravle7d765462017-09-04 15:57:10 -07001259// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1260// secondary dex files. This return codes are returned by the child process created for
1261// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001262
Andreas Gampe194fe422018-02-28 20:16:19 -08001263enum DexoptAnalyzerSkipCodes {
1264 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001265 // Specific errors are encoded in the name.
1266 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1267 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1268 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1269 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1270 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001271 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001272 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001273};
Calin Juravle7d765462017-09-04 15:57:10 -07001274
1275// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001276// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1277// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001278// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1279// of dexoptanalyzer.
1280static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001281 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001282 // The result values are defined in dexoptanalyzer.
1283 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001284 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001285 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001286 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001287 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001288 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001289 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001290 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001291 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001292 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1293 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001294 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1295 " Expected odex file status for secondary dex %s"
1296 " : dexoptanalyzer result=%d",
1297 dex_path.c_str(),
1298 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001299 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001300 }
1301
1302 // Use a second switch for enum switch-case analysis.
1303 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001304 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001305 // If the file does not exist there's no need for dexopt.
1306 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1307 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001308
1309 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1310 *error_msg = "Dexoptanalyzer path validation failed";
1311 return false;
1312 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1313 *error_msg = "Dexoptanalyzer open zip failed";
1314 return false;
1315 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1316 *error_msg = "Dexoptanalyzer dir preparation failed";
1317 return false;
1318 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1319 *error_msg = "Dexoptanalyzer open output failed";
1320 return false;
1321 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1322 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001323 return false;
1324 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001325
1326 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1327 dex_path.c_str(),
1328 result);
1329 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001330}
1331
Calin Juravle7d765462017-09-04 15:57:10 -07001332enum SecondaryDexAccess {
1333 kSecondaryDexAccessReadOk = 0,
1334 kSecondaryDexAccessDoesNotExist = 1,
1335 kSecondaryDexAccessPermissionError = 2,
1336 kSecondaryDexAccessIOError = 3
1337};
1338
1339static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1340 // Check if the path exists and can be read. If not, there's nothing to do.
1341 if (access(dex_path.c_str(), R_OK) == 0) {
1342 return kSecondaryDexAccessReadOk;
1343 } else {
1344 if (errno == ENOENT) {
1345 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1346 return kSecondaryDexAccessDoesNotExist;
1347 } else {
1348 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1349 return errno == EACCES
1350 ? kSecondaryDexAccessPermissionError
1351 : kSecondaryDexAccessIOError;
1352 }
1353 }
1354}
1355
1356static bool is_file_public(const std::string& filename) {
1357 struct stat file_stat;
1358 if (stat(filename.c_str(), &file_stat) == 0) {
1359 return (file_stat.st_mode & S_IROTH) != 0;
1360 }
1361 return false;
1362}
1363
1364// Create the oat file structure for the secondary dex 'dex_path' and assign
1365// the individual path component to the 'out_' parameters.
1366static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001367 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001368 size_t dirIndex = dex_path.rfind('/');
1369 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001370 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001371 return false;
1372 }
1373 // TODO(calin): we have similar computations in at lest 3 other places
1374 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1375 // using string append.
1376 std::string apk_dir = dex_path.substr(0, dirIndex);
1377 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1378 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1379
1380 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1381 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001382 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001383 return false;
1384 }
1385 return true;
1386}
1387
1388// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1389// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001390static bool validate_dexopt_storage_flags(int dexopt_flags,
1391 int* out_storage_flag,
1392 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001393 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1394 *out_storage_flag = FLAG_STORAGE_CE;
1395 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001396 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001397 return false;
1398 }
1399 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1400 *out_storage_flag = FLAG_STORAGE_DE;
1401 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001402 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001403 return false;
1404 }
1405 return true;
1406}
1407
David Brazdil4f6027a2019-03-19 11:44:21 +00001408static bool get_class_loader_context_dex_paths(const char* class_loader_context, int uid,
1409 /* out */ std::vector<std::string>* context_dex_paths) {
1410 if (class_loader_context == nullptr) {
1411 return true;
1412 }
1413
1414 LOG(DEBUG) << "Getting dex paths for context " << class_loader_context;
1415
1416 // Pipe to get the hash result back from our child process.
1417 unique_fd pipe_read, pipe_write;
1418 if (!Pipe(&pipe_read, &pipe_write)) {
1419 PLOG(ERROR) << "Failed to create pipe";
1420 return false;
1421 }
1422
1423 pid_t pid = fork();
1424 if (pid == 0) {
1425 // child -- drop privileges before continuing.
1426 drop_capabilities(uid);
1427
1428 // Route stdout to `pipe_write`
1429 while ((dup2(pipe_write, STDOUT_FILENO) == -1) && (errno == EINTR)) {}
1430 pipe_write.reset();
1431 pipe_read.reset();
1432
1433 RunDexoptAnalyzer run_dexopt_analyzer(class_loader_context);
1434 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
1435 }
1436
1437 /* parent */
1438 pipe_write.reset();
1439
1440 std::string str_dex_paths;
1441 if (!ReadFdToString(pipe_read, &str_dex_paths)) {
1442 PLOG(ERROR) << "Failed to read from pipe";
1443 return false;
1444 }
1445 pipe_read.reset();
1446
1447 int return_code = wait_child(pid);
1448 if (!WIFEXITED(return_code)) {
1449 PLOG(ERROR) << "Error waiting for child dexoptanalyzer process";
1450 return false;
1451 }
1452
1453 constexpr int kFlattenClassLoaderContextSuccess = 50;
1454 return_code = WEXITSTATUS(return_code);
1455 if (return_code != kFlattenClassLoaderContextSuccess) {
1456 LOG(ERROR) << "Dexoptanalyzer could not flatten class loader context, code=" << return_code;
1457 return false;
1458 }
1459
1460 if (!str_dex_paths.empty()) {
1461 *context_dex_paths = android::base::Split(str_dex_paths, ":");
1462 }
1463 return true;
1464}
1465
1466static int open_dex_paths(const std::vector<std::string>& dex_paths,
1467 /* out */ std::vector<unique_fd>* zip_fds, /* out */ std::string* error_msg) {
1468 for (const std::string& dex_path : dex_paths) {
1469 zip_fds->emplace_back(open(dex_path.c_str(), O_RDONLY));
1470 if (zip_fds->back().get() < 0) {
1471 *error_msg = StringPrintf(
1472 "installd cannot open '%s' for input during dexopt", dex_path.c_str());
1473 if (errno == ENOENT) {
1474 return kSecondaryDexDexoptAnalyzerSkippedNoFile;
1475 } else {
1476 return kSecondaryDexDexoptAnalyzerSkippedOpenZip;
1477 }
1478 }
1479 }
1480 return 0;
1481}
1482
1483static std::string join_fds(const std::vector<unique_fd>& fds) {
1484 std::stringstream ss;
1485 bool is_first = true;
1486 for (const unique_fd& fd : fds) {
1487 if (is_first) {
1488 is_first = false;
1489 } else {
1490 ss << ":";
1491 }
1492 ss << fd.get();
1493 }
1494 return ss.str();
1495}
1496
Calin Juravlec9eab382017-01-25 01:17:17 -08001497// 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 -08001498// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1499// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001500// When returning true, the output parameters will be:
1501// - is_public_out: whether or not the oat file should not be made public
1502// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1503// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001504static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001505 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001506 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001507 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
David Brazdil4f6027a2019-03-19 11:44:21 +00001508 const std::vector<std::string>& context_dex_paths, /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001509 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001510 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001511 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1512 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001513 return false;
1514 }
Calin Juravle7d765462017-09-04 15:57:10 -07001515 // Compute the oat dir as it's not easy to extract it from the child computation.
1516 char oat_path[PKG_PATH_MAX];
1517 char oat_dir[PKG_PATH_MAX];
1518 char oat_isa_dir[PKG_PATH_MAX];
1519 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001520 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1521 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001522 return false;
1523 }
Calin Juravle7d765462017-09-04 15:57:10 -07001524 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001525
Calin Juravle80a21252017-01-17 14:43:25 -08001526 pid_t pid = fork();
1527 if (pid == 0) {
1528 // child -- drop privileges before continuing.
1529 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001530
1531 // Validate the path structure.
1532 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1533 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001534 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001535 }
1536
1537 // Open the dex file.
1538 unique_fd zip_fd;
1539 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1540 if (zip_fd.get() < 0) {
1541 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001542 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001543 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001544 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001545 }
1546 }
1547
David Brazdil4f6027a2019-03-19 11:44:21 +00001548 // Open class loader context dex files.
1549 std::vector<unique_fd> context_zip_fds;
1550 int open_dex_paths_rc = open_dex_paths(context_dex_paths, &context_zip_fds, error_msg);
1551 if (open_dex_paths_rc != 0) {
1552 _exit(open_dex_paths_rc);
1553 }
1554
Calin Juravle7d765462017-09-04 15:57:10 -07001555 // Prepare the oat directories.
1556 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001557 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001558 }
1559
1560 // Open the vdex/oat files if any.
1561 unique_fd oat_file_fd;
1562 unique_fd vdex_file_fd;
1563 if (!maybe_open_oat_and_vdex_file(dex_path,
1564 *oat_dir_out,
1565 instruction_set,
1566 true /* is_secondary_dex */,
1567 &oat_file_fd,
1568 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001569 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001570 }
1571
1572 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001573 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1574 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001575
1576 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001577 // Note that we do not do it before the fork since opening the files is required to happen
1578 // after forking.
1579 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1580 vdex_file_fd.get(),
1581 oat_file_fd.get(),
1582 zip_fd.get(),
1583 instruction_set,
1584 compiler_filter, profile_was_updated,
1585 downgrade,
David Brazdil4f6027a2019-03-19 11:44:21 +00001586 class_loader_context,
1587 join_fds(context_zip_fds));
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001588 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001589 }
1590
1591 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001592 int result = wait_child(pid);
1593 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001594 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1595 dex_path.c_str(),
1596 result);
1597 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001598 return false;
1599 }
1600 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001601 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001602 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1603 result,
1604 dexopt_needed_out,
1605 error_msg);
1606 if (!success) {
1607 LOG(ERROR) << *error_msg;
1608 }
Calin Juravle7d765462017-09-04 15:57:10 -07001609
1610 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1611
Calin Juravle80a21252017-01-17 14:43:25 -08001612 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001613 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1614 // makes the code simpler; force compilation is only needed during tests).
1615 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001616 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001617 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001618 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1619 }
1620
Calin Juravle7d765462017-09-04 15:57:10 -07001621 // Check if we should make the oat file public.
1622 // Note that if the dex file is not public the compiled code cannot be made public.
1623 // It is ok to check this flag outside in the parent process.
1624 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1625
Calin Juravle80a21252017-01-17 14:43:25 -08001626 return success;
1627}
1628
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001629static std::string format_dexopt_error(int status, const char* dex_path) {
1630 if (WIFEXITED(status)) {
1631 int int_code = WEXITSTATUS(status);
1632 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1633 if (code_name != nullptr) {
1634 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1635 }
1636 }
1637 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001638}
1639
Calin Juravlec9eab382017-01-25 01:17:17 -08001640int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001641 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001642 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001643 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001644 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001645 CHECK(pkgname != nullptr);
1646 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001647 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001648 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1649 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001650
Calin Juravled23dee72017-07-06 16:29:11 -07001651 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001652 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001653 return -1;
1654 }
1655
1656 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001657 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1658 class_loader_context);
1659 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001660 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001661 }
1662
Calin Juravleebc8a792017-04-04 20:21:05 -07001663 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001664 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1665 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1666 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001667 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001668 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001669 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001670 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001671 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Patrick Baumann2271b3e2020-04-14 17:03:00 -07001672 bool for_restore = (dexopt_flags & DEXOPT_FOR_RESTORE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001673
1674 // Check if we're dealing with a secondary dex file and if we need to compile it.
1675 std::string oat_dir_str;
David Brazdil4f6027a2019-03-19 11:44:21 +00001676 std::vector<std::string> context_dex_paths;
Calin Juravle80a21252017-01-17 14:43:25 -08001677 if (is_secondary_dex) {
David Brazdil4f6027a2019-03-19 11:44:21 +00001678 if (!get_class_loader_context_dex_paths(class_loader_context, uid, &context_dex_paths)) {
1679 *error_msg = "Failed acquiring context dex paths";
1680 return -1; // We had an error, logged in the process method.
1681 }
1682
Calin Juravlec9eab382017-01-25 01:17:17 -08001683 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001684 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
David Brazdil4f6027a2019-03-19 11:44:21 +00001685 downgrade, class_loader_context, context_dex_paths, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001686 oat_dir = oat_dir_str.c_str();
1687 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1688 return 0; // Nothing to do, report success.
1689 }
1690 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001691 if (error_msg->empty()) { // TODO: Make this a CHECK.
1692 *error_msg = "Failed processing secondary.";
1693 }
Calin Juravle80a21252017-01-17 14:43:25 -08001694 return -1; // We had an error, logged in the process method.
1695 }
1696 } else {
David Brazdil4f6027a2019-03-19 11:44:21 +00001697 // Currently these flags are only used for secondary dex files.
Calin Juravlec9eab382017-01-25 01:17:17 -08001698 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001699 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1700 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1701 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001702
1703 // Open the input file.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001704 UniqueFile in_dex(open(dex_path, O_RDONLY, 0), dex_path);
1705 if (in_dex.fd() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001706 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1707 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001708 return -1;
1709 }
1710
David Brazdil4f6027a2019-03-19 11:44:21 +00001711 // Open class loader context dex files.
1712 std::vector<unique_fd> context_input_fds;
1713 if (open_dex_paths(context_dex_paths, &context_input_fds, error_msg) != 0) {
1714 LOG(ERROR) << *error_msg;
1715 return -1;
1716 }
1717
Calin Juravle7a570e82017-01-14 16:23:30 -08001718 // Create the output OAT file.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001719 UniqueFile out_oat = open_oat_out_file(dex_path, oat_dir, is_public, uid,
1720 instruction_set, is_secondary_dex);
1721 if (out_oat.fd() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001722 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001723 return -1;
1724 }
1725
1726 // Open vdex files.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001727 UniqueFile in_vdex;
1728 UniqueFile out_vdex;
1729 if (!open_vdex_files_for_dex2oat(dex_path, out_oat.path().c_str(), dexopt_needed,
1730 instruction_set, is_public, uid, is_secondary_dex, profile_guided, &in_vdex,
1731 &out_vdex)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001732 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001733 return -1;
1734 }
1735
Calin Juravlecb556e32017-04-04 20:22:50 -07001736 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1737 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1738 // fully inherit their parent context).
1739 // Note that for primary apk the oat files are created before, in a separate installd
1740 // call which also does the restorecon. TODO(calin): unify the paths.
1741 if (is_secondary_dex) {
1742 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1743 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001744 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1745 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001746 return -1;
1747 }
1748 }
1749
Jeff Sharkey90aff262016-12-12 14:28:24 -07001750 // Create a swap file if necessary.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001751 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat.path());
Jeff Sharkey90aff262016-12-12 14:28:24 -07001752
Calin Juravle7a570e82017-01-14 16:23:30 -08001753 // Open the reference profile if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001754 UniqueFile reference_profile = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001755 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001756
Victor Hsiehcb35a062020-08-13 16:11:13 -07001757 if (reference_profile.fd() == -1) {
liulvping61907742018-08-21 09:36:52 +08001758 // We don't create an app image without reference profile since there is no speedup from
1759 // loading it in that case and instead will be a small overhead.
1760 generate_app_image = false;
1761 }
1762
1763 // Create the app image file if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001764 UniqueFile out_image = maybe_open_app_image(
1765 out_oat.path(), generate_app_image, is_public, uid, is_secondary_dex);
liulvping61907742018-08-21 09:36:52 +08001766
Victor Hsiehcb35a062020-08-13 16:11:13 -07001767 UniqueFile dex_metadata;
Calin Juravle62c5a372018-02-01 17:03:23 +00001768 if (dex_metadata_path != nullptr) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001769 dex_metadata.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)),
1770 dex_metadata_path);
1771 if (dex_metadata.fd() < 0) {
Calin Juravle62c5a372018-02-01 17:03:23 +00001772 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1773 }
1774 }
1775
Victor Hsieh8948a862020-08-07 11:30:55 -07001776 std::string jitzygote_flag = server_configurable_flags::GetServerConfigurableFlag(
1777 RUNTIME_NATIVE_BOOT_NAMESPACE,
1778 ENABLE_JITZYGOTE_IMAGE,
1779 /*default_value=*/ "");
1780 bool use_jitzygote_image = jitzygote_flag == "true" || IsBootClassPathProfilingEnable();
1781
Victor Hsiehe98e6512020-08-10 15:39:22 -07001782 // Decide whether to use dex2oat64.
1783 bool use_dex2oat64 = false;
1784 // Check whether the device even supports 64-bit ABIs.
1785 if (!GetProperty("ro.product.cpu.abilist64", "").empty()) {
1786 use_dex2oat64 = GetBoolProperty("dalvik.vm.dex2oat64.enabled", false);
1787 }
1788 const char* dex2oat_bin = select_execution_binary(
1789 (use_dex2oat64 ? kDex2oat64Path : kDex2oat32Path),
1790 (use_dex2oat64 ? kDex2oatDebug64Path : kDex2oatDebug32Path),
1791 background_job_compile);
1792
Victor Hsiehc9821f12020-08-07 11:32:29 -07001793 auto execv_helper = std::make_unique<ExecVHelper>();
1794
Andreas Gampe023b2242018-02-28 16:03:25 -08001795 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001796
Victor Hsiehc9821f12020-08-07 11:32:29 -07001797 RunDex2Oat runner(dex2oat_bin, execv_helper.get());
Victor Hsiehcb35a062020-08-13 16:11:13 -07001798 runner.Initialize(out_oat,
1799 out_vdex,
1800 out_image,
1801 in_dex,
1802 in_vdex,
1803 dex_metadata,
1804 reference_profile,
1805 class_loader_context,
1806 join_fds(context_input_fds),
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001807 swap_fd.get(),
1808 instruction_set,
1809 compiler_filter,
1810 debuggable,
1811 boot_complete,
Patrick Baumann2271b3e2020-04-14 17:03:00 -07001812 for_restore,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001813 target_sdk_version,
1814 enable_hidden_api_checks,
1815 generate_compact_dex,
Victor Hsieh8948a862020-08-07 11:30:55 -07001816 use_jitzygote_image,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001817 compilation_reason);
1818
Jeff Sharkey90aff262016-12-12 14:28:24 -07001819 pid_t pid = fork();
1820 if (pid == 0) {
Wei Wange0dbd9b2020-12-11 17:24:19 +00001821 // Need to set schedpolicy before dropping privileges
1822 // for cgroup migration. See details at b/175178520.
1823 SetDex2OatScheduling(boot_complete);
1824
Jeff Sharkey90aff262016-12-12 14:28:24 -07001825 /* child -- drop privileges before continuing */
1826 drop_capabilities(uid);
1827
Victor Hsiehcb35a062020-08-13 16:11:13 -07001828 if (flock(out_oat.fd(), LOCK_EX | LOCK_NB) != 0) {
1829 PLOG(ERROR) << "flock(" << out_oat.path() << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001830 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001831 }
1832
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001833 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001834 } else {
1835 int res = wait_child(pid);
1836 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001837 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001838 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001839 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1840 << std::hex << std::setw(4) << res << ", process failed";
1841 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001842 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001843 }
1844 }
1845
Victor Hsiehcb35a062020-08-13 16:11:13 -07001846 update_out_oat_access_times(dex_path, out_oat.path().c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -07001847
1848 // We've been successful, don't delete output.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001849 out_oat.DisableCleanup();
1850 out_vdex.DisableCleanup();
1851 out_image.DisableCleanup();
1852 reference_profile.DisableCleanup();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001853
1854 return 0;
1855}
1856
Calin Juravlec9eab382017-01-25 01:17:17 -08001857// Try to remove the given directory. Log an error if the directory exists
1858// and is empty but could not be removed.
1859static bool rmdir_if_empty(const char* dir) {
1860 if (rmdir(dir) == 0) {
1861 return true;
1862 }
1863 if (errno == ENOENT || errno == ENOTEMPTY) {
1864 return true;
1865 }
1866 PLOG(ERROR) << "Failed to remove dir: " << dir;
1867 return false;
1868}
1869
1870// Try to unlink the given file. Log an error if the file exists and could not
1871// be unlinked.
1872static bool unlink_if_exists(const std::string& file) {
1873 if (unlink(file.c_str()) == 0) {
1874 return true;
1875 }
1876 if (errno == ENOENT) {
1877 return true;
1878
1879 }
1880 PLOG(ERROR) << "Could not unlink: " << file;
1881 return false;
1882}
1883
Calin Juravle7d765462017-09-04 15:57:10 -07001884enum ReconcileSecondaryDexResult {
1885 kReconcileSecondaryDexExists = 0,
1886 kReconcileSecondaryDexCleanedUp = 1,
1887 kReconcileSecondaryDexValidationError = 2,
1888 kReconcileSecondaryDexCleanUpError = 3,
1889 kReconcileSecondaryDexAccessIOError = 4,
1890};
Calin Juravlec9eab382017-01-25 01:17:17 -08001891
1892// Reconcile the secondary dex 'dex_path' and its generated oat files.
1893// Return true if all the parameters are valid and the secondary dex file was
1894// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1895// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1896// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1897// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1898// Return false if there were errors during processing. In this case
1899// out_secondary_dex_exists will be set to false.
1900bool reconcile_secondary_dex_file(const std::string& dex_path,
1901 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09001902 const std::optional<std::string>& volume_uuid, int storage_flag,
Calin Juravlec9eab382017-01-25 01:17:17 -08001903 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07001904 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08001905 if (isas.size() == 0) {
1906 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1907 return false;
1908 }
1909
Calin Juravle7d765462017-09-04 15:57:10 -07001910 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
1911 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
1912 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08001913 return false;
1914 }
1915
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001916 // As a security measure we want to unlink art artifacts with the reduced capabilities
1917 // of the package user id. So we fork and drop capabilities in the child.
1918 pid_t pid = fork();
1919 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07001920 /* child -- drop privileges before continuing */
1921 drop_capabilities(uid);
1922
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09001923 const char* volume_uuid_cstr = volume_uuid ? volume_uuid->c_str() : nullptr;
Greg Kaiser8042c372019-03-26 06:23:19 -07001924 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr,
Calin Juravle7d765462017-09-04 15:57:10 -07001925 uid, storage_flag)) {
1926 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
1927 _exit(kReconcileSecondaryDexValidationError);
1928 }
1929
1930 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
1931 switch (access_check) {
1932 case kSecondaryDexAccessDoesNotExist:
1933 // File does not exist. Proceed with cleaning.
1934 break;
1935 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
1936 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
1937 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
1938 default:
1939 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
1940 _exit(kReconcileSecondaryDexValidationError);
1941 }
1942
1943 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001944 char oat_path[PKG_PATH_MAX];
1945 char oat_dir[PKG_PATH_MAX];
1946 char oat_isa_dir[PKG_PATH_MAX];
1947 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001948 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001949 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07001950 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001951 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
1952 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07001953 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001954 }
Calin Juravle51314092017-05-18 15:33:05 -07001955
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001956 // Delete oat/vdex/art files.
1957 result = unlink_if_exists(oat_path) && result;
1958 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
1959 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08001960
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001961 // Delete profiles.
1962 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08001963 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001964 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08001965 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001966 result = unlink_if_exists(current_profile) && result;
1967 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07001968
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001969 // We upgraded once the location of current profile for secondary dex files.
1970 // Check for any previous left-overs and remove them as well.
1971 std::string old_current_profile = dex_path + ".prof";
1972 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07001973
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001974 // Try removing the directories as well, they might be empty.
1975 result = rmdir_if_empty(oat_isa_dir) && result;
1976 result = rmdir_if_empty(oat_dir) && result;
1977 }
Calin Juravle7d765462017-09-04 15:57:10 -07001978 if (!result) {
1979 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
1980 }
1981 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08001982 }
1983
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001984 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07001985 if (!WIFEXITED(return_code)) {
1986 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
1987 } else {
1988 return_code = WEXITSTATUS(return_code);
1989 }
1990
1991 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
1992
1993 switch (return_code) {
1994 case kReconcileSecondaryDexCleanedUp:
1995 case kReconcileSecondaryDexValidationError:
1996 // If we couldn't validate assume the dex file does not exist.
1997 // This will purge the entry from the PM records.
1998 *out_secondary_dex_exists = false;
1999 return true;
2000 case kReconcileSecondaryDexExists:
2001 *out_secondary_dex_exists = true;
2002 return true;
2003 case kReconcileSecondaryDexAccessIOError:
2004 // We had an access IO error.
2005 // Return false so that we can try again.
2006 // The value of out_secondary_dex_exists does not matter in this case and by convention
2007 // is set to false.
2008 *out_secondary_dex_exists = false;
2009 return false;
2010 default:
2011 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2012 *out_secondary_dex_exists = false;
2013 return false;
2014 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002015}
2016
Alan Stokesa25d90c2017-10-16 10:56:00 +01002017// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2018// Returns true if all parameters are valid and the hash successfully computed and stored in
2019// out_secondary_dex_hash.
2020// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2021// the app.
2022// For any other errors (e.g. if any of the parameters are invalid) returns false.
2023bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002024 const std::optional<std::string>& volume_uuid, int storage_flag,
Alan Stokesa25d90c2017-10-16 10:56:00 +01002025 std::vector<uint8_t>* out_secondary_dex_hash) {
2026 out_secondary_dex_hash->clear();
2027
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002028 const char* volume_uuid_cstr = volume_uuid ? volume_uuid->c_str() : nullptr;
Alan Stokesa25d90c2017-10-16 10:56:00 +01002029
2030 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2031 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2032 << storage_flag;
2033 return false;
2034 }
2035
2036 // Pipe to get the hash result back from our child process.
2037 unique_fd pipe_read, pipe_write;
2038 if (!Pipe(&pipe_read, &pipe_write)) {
2039 PLOG(ERROR) << "Failed to create pipe";
2040 return false;
2041 }
2042
2043 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2044 // access data the app itself can access.
2045 pid_t pid = fork();
2046 if (pid == 0) {
2047 // child -- drop privileges before continuing
2048 drop_capabilities(uid);
2049 pipe_read.reset();
2050
2051 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2052 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002053 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002054 }
2055
2056 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2057 if (fd == -1) {
2058 if (errno == EACCES || errno == ENOENT) {
2059 // Not treated as an error.
2060 _exit(0);
2061 }
2062 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002063 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002064 }
2065
2066 SHA256_CTX ctx;
2067 SHA256_Init(&ctx);
2068
2069 std::vector<uint8_t> buffer(65536);
2070 while (true) {
2071 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2072 if (bytes_read == 0) {
2073 break;
2074 } else if (bytes_read == -1) {
2075 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002076 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002077 }
2078
2079 SHA256_Update(&ctx, buffer.data(), bytes_read);
2080 }
2081
2082 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2083 SHA256_Final(hash.data(), &ctx);
2084 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002085 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002086 }
2087
2088 _exit(0);
2089 }
2090
2091 // parent
2092 pipe_write.reset();
2093
2094 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2095 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2096 out_secondary_dex_hash->clear();
2097 }
2098 return wait_child(pid) == 0;
2099}
2100
Jeff Sharkey90aff262016-12-12 14:28:24 -07002101// Helper for move_ab, so that we can have common failure-case cleanup.
2102static bool unlink_and_rename(const char* from, const char* to) {
2103 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2104 // return a failure.
2105 struct stat s;
2106 if (stat(to, &s) == 0) {
2107 if (!S_ISREG(s.st_mode)) {
2108 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2109 return false;
2110 }
2111 if (unlink(to) != 0) {
2112 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2113 return false;
2114 }
2115 } else {
2116 // This may be a permission problem. We could investigate the error code, but we'll just
2117 // let the rename failure do the work for us.
2118 }
2119
2120 // Try to rename "to" to "from."
2121 if (rename(from, to) != 0) {
2122 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2123 return false;
2124 }
2125 return true;
2126}
2127
2128// Move/rename a B artifact (from) to an A artifact (to).
2129static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2130 // Check whether B exists.
2131 {
2132 struct stat s;
2133 if (stat(b_path.c_str(), &s) != 0) {
2134 // Silently ignore for now. The service calling this isn't smart enough to understand
2135 // lack of artifacts at the moment.
2136 return false;
2137 }
2138 if (!S_ISREG(s.st_mode)) {
2139 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2140 // Try to unlink, but swallow errors.
2141 unlink(b_path.c_str());
2142 return false;
2143 }
2144 }
2145
2146 // Rename B to A.
2147 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2148 // Delete the b_path so we don't try again (or fail earlier).
2149 if (unlink(b_path.c_str()) != 0) {
2150 PLOG(ERROR) << "Could not unlink " << b_path;
2151 }
2152
2153 return false;
2154 }
2155
2156 return true;
2157}
2158
2159bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2160 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002161 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2162 if (slot_suffix.empty()) {
2163 return false;
2164 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002165
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002166 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2167 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2168 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002169 }
2170
2171 // Validate other inputs.
2172 if (validate_apk_path(apk_path) != 0) {
2173 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2174 return false;
2175 }
2176 if (validate_apk_path(oat_dir) != 0) {
2177 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2178 return false;
2179 }
2180
2181 char a_path[PKG_PATH_MAX];
2182 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2183 return false;
2184 }
2185 const std::string a_vdex_path = create_vdex_filename(a_path);
2186 const std::string a_image_path = create_image_filename(a_path);
2187
2188 // B path = A path + slot suffix.
2189 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2190 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2191 const std::string b_image_path = StringPrintf("%s.%s",
2192 a_image_path.c_str(),
2193 slot_suffix.c_str());
2194
2195 bool success = true;
2196 if (move_ab_path(b_path, a_path)) {
2197 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2198 // Note: we can live without an app image. As such, ignore failure to move the image file.
2199 // If we decide to require the app image, or the app image being moved correctly,
2200 // then change accordingly.
2201 constexpr bool kIgnoreAppImageFailure = true;
2202
2203 if (!a_image_path.empty()) {
2204 if (!move_ab_path(b_image_path, a_image_path)) {
2205 unlink(a_image_path.c_str());
2206 if (!kIgnoreAppImageFailure) {
2207 success = false;
2208 }
2209 }
2210 }
2211 } else {
2212 // Cleanup: delete B image, ignore errors.
2213 unlink(b_image_path.c_str());
2214 success = false;
2215 }
2216 } else {
2217 // Cleanup: delete B image, ignore errors.
2218 unlink(b_vdex_path.c_str());
2219 unlink(b_image_path.c_str());
2220 success = false;
2221 }
2222 return success;
2223}
2224
2225bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2226 // Delete the oat/odex file.
2227 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002228 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002229 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002230 return false;
2231 }
2232
2233 // In case of a permission failure report the issue. Otherwise just print a warning.
2234 auto unlink_and_check = [](const char* path) -> bool {
2235 int result = unlink(path);
2236 if (result != 0) {
2237 if (errno == EACCES || errno == EPERM) {
2238 PLOG(ERROR) << "Could not unlink " << path;
2239 return false;
2240 }
2241 PLOG(WARNING) << "Could not unlink " << path;
2242 }
2243 return true;
2244 };
2245
2246 // Delete the oat/odex file.
2247 bool return_value_oat = unlink_and_check(out_path);
2248
2249 // Derive and delete the app image.
2250 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2251
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002252 // Derive and delete the vdex file.
2253 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2254
Jeff Sharkey90aff262016-12-12 14:28:24 -07002255 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002256 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002257}
2258
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002259static bool is_absolute_path(const std::string& path) {
2260 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2261 LOG(ERROR) << "Invalid absolute path " << path;
2262 return false;
2263 } else {
2264 return true;
2265 }
2266}
2267
2268static bool is_valid_instruction_set(const std::string& instruction_set) {
2269 // TODO: add explicit whitelisting of instruction sets
2270 if (instruction_set.find('/') != std::string::npos) {
2271 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2272 return false;
2273 } else {
2274 return true;
2275 }
2276}
2277
2278bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2279 const char *apk_path, const char *instruction_set) {
2280 std::string oat_dir_ = oat_dir;
2281 std::string apk_path_ = apk_path;
2282 std::string instruction_set_ = instruction_set;
2283
2284 if (!is_absolute_path(oat_dir_)) return false;
2285 if (!is_absolute_path(apk_path_)) return false;
2286 if (!is_valid_instruction_set(instruction_set_)) return false;
2287
2288 std::string::size_type end = apk_path_.rfind('.');
2289 std::string::size_type start = apk_path_.rfind('/', end);
2290 if (end == std::string::npos || start == std::string::npos) {
2291 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2292 return false;
2293 }
2294
2295 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2296 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2297 const char* res = res_.c_str();
2298 if (strlen(res) >= PKG_PATH_MAX) {
2299 LOG(ERROR) << "Result too large";
2300 return false;
2301 } else {
2302 strlcpy(path, res, PKG_PATH_MAX);
2303 return true;
2304 }
2305}
2306
2307bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2308 const char *instruction_set) {
2309 std::string apk_path_ = apk_path;
2310 std::string instruction_set_ = instruction_set;
2311
2312 if (!is_absolute_path(apk_path_)) return false;
2313 if (!is_valid_instruction_set(instruction_set_)) return false;
2314
2315 std::string::size_type end = apk_path_.rfind('.');
2316 std::string::size_type start = apk_path_.rfind('/', end);
2317 if (end == std::string::npos || start == std::string::npos) {
2318 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2319 return false;
2320 }
2321
2322 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2323 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2324}
2325
2326bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2327 const char *instruction_set) {
2328 std::string src_ = src;
2329 std::string instruction_set_ = instruction_set;
2330
2331 if (!is_absolute_path(src_)) return false;
2332 if (!is_valid_instruction_set(instruction_set_)) return false;
2333
2334 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2335 if (*it == '/') {
2336 *it = '@';
2337 }
2338 }
2339
2340 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2341 + DALVIK_CACHE_POSTFIX;
2342 const char* res = res_.c_str();
2343 if (strlen(res) >= PKG_PATH_MAX) {
2344 LOG(ERROR) << "Result too large";
2345 return false;
2346 } else {
2347 strlcpy(path, res, PKG_PATH_MAX);
2348 return true;
2349 }
2350}
2351
Calin Juravle59f7ab82018-04-27 17:50:23 -07002352bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2353 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002354 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2355 for (const std::string& elem : classpaths_elems) {
2356 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2357 if (fd < 0) {
2358 PLOG(ERROR) << "Could not open classpath elem " << elem;
2359 return false;
2360 } else {
2361 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002362 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002363 }
2364 }
2365 return true;
2366}
2367
2368static bool create_app_profile_snapshot(int32_t app_id,
2369 const std::string& package_name,
2370 const std::string& profile_name,
2371 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002372 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2373
Calin Juravle824a64d2018-01-18 20:23:17 -08002374 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002375 if (snapshot_fd < 0) {
2376 return false;
2377 }
2378
2379 std::vector<unique_fd> profiles_fd;
2380 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002381 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2382 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002383 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2384 return false;
2385 }
2386
2387 profiles_fd.push_back(std::move(reference_profile_fd));
2388
Calin Juravle0d0a4922018-01-23 19:54:11 -08002389 // Open the class paths elements. These will be used to filter out profile data that does
2390 // not belong to the classpath during merge.
2391 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002392 std::vector<std::string> dex_locations;
2393 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002394 return false;
2395 }
2396
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002397 RunProfman args;
Calin Juravlef85ddb92020-05-01 14:05:40 -07002398 // This is specifically a snapshot for an app, so don't use boot image profiles.
2399 args.SetupMerge(profiles_fd,
2400 snapshot_fd,
2401 apk_fds,
2402 dex_locations,
2403 /* for_snapshot= */ true,
2404 /* for_boot_image= */ false);
Calin Juravle29591732017-11-20 17:46:19 -08002405 pid_t pid = fork();
2406 if (pid == 0) {
2407 /* child -- drop privileges before continuing */
2408 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002409 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002410 }
2411
2412 /* parent */
2413 int return_code = wait_child(pid);
2414 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002415 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002416 return false;
2417 }
2418
Calin Juravle78728f32019-11-08 17:55:46 -08002419 // Verify that profman finished successfully.
2420 int profman_code = WEXITSTATUS(return_code);
2421 if (profman_code != PROFMAN_BIN_RETURN_CODE_SUCCESS) {
2422 LOG(WARNING) << "profman error for " << package_name << ":" << profile_name
2423 << ":" << profman_code;
2424 return false;
2425 }
Calin Juravle29591732017-11-20 17:46:19 -08002426 return true;
2427}
2428
Calin Juravle0d0a4922018-01-23 19:54:11 -08002429static bool create_boot_image_profile_snapshot(const std::string& package_name,
2430 const std::string& profile_name,
2431 const std::string& classpath) {
2432 // The reference profile directory for the android package might not be prepared. Do it now.
2433 const std::string ref_profile_dir =
2434 create_primary_reference_profile_package_dir_path(package_name);
2435 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2436 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2437 return false;
2438 }
2439
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002440 // Return false for empty class path since it may otherwise return true below if profiles is
2441 // empty.
2442 if (classpath.empty()) {
2443 PLOG(ERROR) << "Class path is empty";
2444 return false;
2445 }
2446
Calin Juravle0d0a4922018-01-23 19:54:11 -08002447 // Open and create the snapshot profile.
2448 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2449
2450 // Collect all non empty profiles.
2451 // The collection will traverse all applications profiles and find the non empty files.
2452 // This has the potential of inspecting a large number of files and directories (depending
2453 // on the number of applications and users). So there is a slight increase in the chance
2454 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2455 // fail the snapshot and aggregate whatever profile we could open.
2456 //
2457 // The profile snapshot is a best effort based on available data it's ok if some data
2458 // from some apps is missing. It will be counter productive for the snapshot to fail
2459 // because we could not open or read some of the files.
2460 std::vector<std::string> profiles;
2461 if (!collect_profiles(&profiles)) {
2462 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2463 }
2464
2465 // If we have no profiles return early.
2466 if (profiles.empty()) {
2467 return true;
2468 }
2469
2470 // Open the classpath elements. These will be used to filter out profile data that does
2471 // not belong to the classpath during merge.
2472 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002473 std::vector<std::string> dex_locations;
2474 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002475 return false;
2476 }
2477
2478 // If we could not open any files from the classpath return an error.
2479 if (apk_fds.empty()) {
2480 LOG(ERROR) << "Could not open any of the classpath elements.";
2481 return false;
2482 }
2483
2484 // Aggregate the profiles in batches of kAggregationBatchSize.
2485 // We do this to avoid opening a huge a amount of files.
2486 static constexpr size_t kAggregationBatchSize = 10;
2487
Calin Juravle0d0a4922018-01-23 19:54:11 -08002488 for (size_t i = 0; i < profiles.size(); ) {
Calin Juravlea64fb512019-11-06 16:11:14 -08002489 std::vector<unique_fd> profiles_fd;
Calin Juravle0d0a4922018-01-23 19:54:11 -08002490 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2491 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2492 if (fd.get() >= 0) {
2493 profiles_fd.push_back(std::move(fd));
2494 }
2495 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002496
2497 // We aggregate (read & write) into the same fd multiple times in a row.
2498 // We need to reset the cursor every time to ensure we read the whole file every time.
2499 if (TEMP_FAILURE_RETRY(lseek(snapshot_fd, 0, SEEK_SET)) == static_cast<off_t>(-1)) {
2500 PLOG(ERROR) << "Cannot reset position for snapshot profile";
2501 return false;
2502 }
2503
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002504 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002505 args.SetupMerge(profiles_fd,
2506 snapshot_fd,
2507 apk_fds,
Calin Juravle78728f32019-11-08 17:55:46 -08002508 dex_locations,
2509 /*for_snapshot=*/true,
2510 /*for_boot_image=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002511 pid_t pid = fork();
2512 if (pid == 0) {
2513 /* child -- drop privileges before continuing */
2514 drop_capabilities(AID_SYSTEM);
2515
Calin Juravle59f7ab82018-04-27 17:50:23 -07002516 // The introduction of new access flags into boot jars causes them to
2517 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002518 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002519 }
2520
2521 /* parent */
2522 int return_code = wait_child(pid);
Calin Juravlea64fb512019-11-06 16:11:14 -08002523
Calin Juravle0d0a4922018-01-23 19:54:11 -08002524 if (!WIFEXITED(return_code)) {
2525 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2526 return false;
2527 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002528
2529 // Verify that profman finished successfully.
2530 int profman_code = WEXITSTATUS(return_code);
Calin Juravle78728f32019-11-08 17:55:46 -08002531 if (profman_code != PROFMAN_BIN_RETURN_CODE_SUCCESS) {
2532 LOG(WARNING) << "profman error for " << package_name << ":" << profile_name
2533 << ":" << profman_code;
2534 return false;
Calin Juravlea64fb512019-11-06 16:11:14 -08002535 }
Calin Juravle0d0a4922018-01-23 19:54:11 -08002536 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002537
Calin Juravle0d0a4922018-01-23 19:54:11 -08002538 return true;
2539}
2540
2541bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2542 const std::string& profile_name, const std::string& classpath) {
2543 if (app_id == -1) {
2544 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2545 } else {
2546 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2547 }
2548}
2549
Calin Juravlec3b049e2018-01-18 22:32:58 -08002550bool prepare_app_profile(const std::string& package_name,
2551 userid_t user_id,
2552 appid_t app_id,
2553 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002554 const std::string& code_path,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002555 const std::optional<std::string>& dex_metadata) {
Calin Juravlec3b049e2018-01-18 22:32:58 -08002556 // Prepare the current profile.
2557 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2558 /*is_secondary_dex*/ false);
2559 uid_t uid = multiuser_get_uid(user_id, app_id);
2560 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2561 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2562 return false;
2563 }
2564
2565 // Check if we need to install the profile from the dex metadata.
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002566 if (!dex_metadata) {
Calin Juravlec3b049e2018-01-18 22:32:58 -08002567 return true;
2568 }
2569
2570 // We have a dex metdata. Merge the profile into the reference profile.
2571 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2572 /*read_write*/ true, /*is_secondary_dex*/ false);
2573 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2574 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002575 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2576 if (apk_fd < 0) {
2577 PLOG(ERROR) << "Could not open code path " << code_path;
2578 return false;
2579 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002580
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002581 RunProfman args;
2582 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2583 std::move(ref_profile_fd),
2584 std::move(apk_fd),
2585 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002586 pid_t pid = fork();
2587 if (pid == 0) {
2588 /* child -- drop privileges before continuing */
2589 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2590 drop_capabilities(app_shared_gid);
2591
Calin Juravlef63d4792018-01-30 17:43:34 +00002592 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002593 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002594 }
2595
2596 /* parent */
2597 int return_code = wait_child(pid);
2598 if (!WIFEXITED(return_code)) {
2599 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2600 return false;
2601 }
2602 return true;
2603}
2604
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002605} // namespace installd
2606} // namespace android