blob: 210f9775850334dd35a0fb1f82f5315ec1e135a3 [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>
Martijn Coenen6de402a2021-04-26 16:23:40 +020039#include <async_safe/log.h>
Calin Juravle80a21252017-01-17 14:43:25 -080040#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070041#include <cutils/properties.h>
42#include <cutils/sched_policy.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070043#include <log/log.h> // TODO: Move everything to base/logging.
Alan Stokesa25d90c2017-10-16 10:56:00 +010044#include <openssl/sha.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070045#include <private/android_filesystem_config.h>
Suren Baghdasaryan1cc5de62019-01-25 05:29:23 +000046#include <processgroup/sched_policy.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070047#include <selinux/android.h>
Nicolas Geoffrayaaad21e2019-02-25 13:31:10 +000048#include <server_configurable_flags/get_flags.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070049#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070050
51#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080052#include "dexopt_return_codes.h"
Victor Hsiehc9821f12020-08-07 11:32:29 -070053#include "execv_helper.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060054#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070055#include "installd_deps.h"
Calin Juravlee90de862021-06-08 08:04:52 -070056#include "installd_constants.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070057#include "otapreopt_utils.h"
Victor Hsiehc9821f12020-08-07 11:32:29 -070058#include "run_dex2oat.h"
Victor Hsiehcb35a062020-08-13 16:11:13 -070059#include "unique_file.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070060#include "utils.h"
61
Victor Hsieh76f19ba2020-08-10 14:37:26 -070062using android::base::Basename;
Jeff Sharkey90aff262016-12-12 14:28:24 -070063using android::base::EndsWith;
Mathieu Chartier9b2da082018-10-26 13:23:11 -070064using android::base::GetBoolProperty;
65using android::base::GetProperty;
David Brazdil4f6027a2019-03-19 11:44:21 +000066using android::base::ReadFdToString;
Alan Stokesa25d90c2017-10-16 10:56:00 +010067using android::base::ReadFully;
68using android::base::StringPrintf;
69using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080070using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070071
72namespace android {
73namespace installd {
74
Andreas Gampefa2dadd2018-02-28 19:52:47 -080075
Calin Juravle114f0812017-03-08 19:05:07 -080076// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
77struct FreeDelete {
78 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
79 void operator()(const void* ptr) const {
80 free(const_cast<void*>(ptr));
81 }
82};
83
84// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
85template <typename T>
86using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
87
Calin Juravle1a0af3b2017-03-09 14:33:33 -080088static unique_fd invalid_unique_fd() {
89 return unique_fd(-1);
90}
91
Andreas Gampe6a9cf722017-07-24 16:49:10 -070092static bool is_debug_runtime() {
93 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
94}
95
David Sehra3b5ab62017-10-25 14:27:29 -070096static bool is_debuggable_build() {
97 return android::base::GetBoolProperty("ro.debuggable", false);
98}
99
Jeff Sharkey90aff262016-12-12 14:28:24 -0700100static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800101 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700102 if (ufd.get() < 0) {
103 if (errno != ENOENT) {
104 PLOG(WARNING) << "Could not open profile " << profile;
105 return false;
106 } else {
107 // Nothing to clear. That's ok.
108 return true;
109 }
110 }
111
112 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
113 if (errno != EWOULDBLOCK) {
114 PLOG(WARNING) << "Error locking profile " << profile;
115 }
116 // This implies that the app owning this profile is running
117 // (and has acquired the lock).
118 //
119 // If we can't acquire the lock bail out since clearing is useless anyway
120 // (the app will write again to the profile).
121 //
122 // Note:
123 // This does not impact the this is not an issue for the profiling correctness.
124 // In case this is needed because of an app upgrade, profiles will still be
125 // eventually cleared by the app itself due to checksum mismatch.
126 // If this is needed because profman advised, then keeping the data around
127 // until the next run is again not an issue.
128 //
129 // If the app attempts to acquire a lock while we've held one here,
130 // it will simply skip the current write cycle.
131 return false;
132 }
133
134 bool truncated = ftruncate(ufd.get(), 0) == 0;
135 if (!truncated) {
136 PLOG(WARNING) << "Could not truncate " << profile;
137 }
138 if (flock(ufd.get(), LOCK_UN) != 0) {
139 PLOG(WARNING) << "Error unlocking profile " << profile;
140 }
141 return truncated;
142}
143
Calin Juravle114f0812017-03-08 19:05:07 -0800144// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800145// The location is the profile name for primary apks or the dex path for secondary dex files.
146static bool clear_reference_profile(const std::string& package_name, const std::string& location,
147 bool is_secondary_dex) {
148 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700149}
150
Calin Juravle114f0812017-03-08 19:05:07 -0800151// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800152// The location is the profile name for primary apks or the dex path for secondary dex files.
153static bool clear_current_profile(const std::string& package_name, const std::string& location,
154 userid_t user, bool is_secondary_dex) {
155 return clear_profile(create_current_profile_path(user, package_name, location,
156 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700157}
158
Calin Juravle114f0812017-03-08 19:05:07 -0800159// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800160// The location is the profile name for primary apks or the dex path for secondary dex files.
161bool clear_primary_reference_profile(const std::string& package_name,
162 const std::string& location) {
163 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800164}
165
166// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800167// The location is the profile name for primary apks or the dex path for secondary dex files.
168bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700169 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800170 // 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 -0700171 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
172 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800173 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700174 }
175 return success;
176}
177
Calin Juravle114f0812017-03-08 19:05:07 -0800178// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800179bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
180 userid_t user) {
181 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800182}
183
Calin Juravlef74a7372019-02-28 20:29:41 -0800184// Determines which binary we should use for execution (the debug or non-debug version).
185// e.g. dex2oatd vs dex2oat
186static const char* select_execution_binary(const char* binary, const char* debug_binary,
187 bool background_job_compile) {
188 return select_execution_binary(
189 binary,
190 debug_binary,
191 background_job_compile,
192 is_debug_runtime(),
193 (android::base::GetProperty("ro.build.version.codename", "") == "REL"),
194 is_debuggable_build());
195}
196
197// Determines which binary we should use for execution (the debug or non-debug version).
198// e.g. dex2oatd vs dex2oat
199// This is convenient method which is much easier to test because it doesn't read
200// system properties.
201const char* select_execution_binary(
202 const char* binary,
203 const char* debug_binary,
204 bool background_job_compile,
205 bool is_debug_runtime,
206 bool is_release,
207 bool is_debuggable_build) {
208 // Do not use debug binaries for release candidates (to give more soak time).
209 bool is_debug_bg_job = background_job_compile && is_debuggable_build && !is_release;
210
211 // If the runtime was requested to use libartd.so, we'll run the debug version - assuming
212 // the file is present (it may not be on images with very little space available).
213 bool useDebug = (is_debug_runtime || is_debug_bg_job) && (access(debug_binary, X_OK) == 0);
214
215 return useDebug ? debug_binary : binary;
216}
217
Nicolas Geoffrayaaad21e2019-02-25 13:31:10 +0000218// Namespace for Android Runtime flags applied during boot time.
219static const char* RUNTIME_NATIVE_BOOT_NAMESPACE = "runtime_native_boot";
220// Feature flag name for running the JIT in Zygote experiment, b/119800099.
Nicolas Geoffray5a4c4e92020-02-07 11:37:34 +0000221static const char* ENABLE_JITZYGOTE_IMAGE = "enable_apex_image";
Nicolas Geoffrayaaad21e2019-02-25 13:31:10 +0000222
Mathieu Chartiere97261e2019-10-01 15:36:01 -0700223// Phenotype property name for enabling profiling the boot class path.
224static const char* PROFILE_BOOT_CLASS_PATH = "profilebootclasspath";
225
Calin Juravlef85ddb92020-05-01 14:05:40 -0700226static bool IsBootClassPathProfilingEnable() {
227 std::string profile_boot_class_path = GetProperty("dalvik.vm.profilebootclasspath", "");
228 profile_boot_class_path =
229 server_configurable_flags::GetServerConfigurableFlag(
230 RUNTIME_NATIVE_BOOT_NAMESPACE,
231 PROFILE_BOOT_CLASS_PATH,
232 /*default_value=*/ profile_boot_class_path);
233 return profile_boot_class_path == "true";
234}
235
Victor Hsiehcb35a062020-08-13 16:11:13 -0700236static void UnlinkIgnoreResult(const std::string& path) {
237 if (unlink(path.c_str()) < 0) {
238 PLOG(ERROR) << "Failed to unlink " << path;
239 }
240}
241
Jeff Sharkey90aff262016-12-12 14:28:24 -0700242/*
243 * Whether dexopt should use a swap file when compiling an APK.
244 *
245 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
246 * itself, anyways).
247 *
248 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
249 *
250 * Otherwise, return true if this is a low-mem device.
251 *
252 * Otherwise, return default value.
253 */
254static bool kAlwaysProvideSwapFile = false;
255static bool kDefaultProvideSwapFile = true;
256
257static bool ShouldUseSwapFileForDexopt() {
258 if (kAlwaysProvideSwapFile) {
259 return true;
260 }
261
262 // Check the "override" property. If it exists, return value == "true".
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700263 std::string dex2oat_prop_buf = GetProperty("dalvik.vm.dex2oat-swap", "");
264 if (!dex2oat_prop_buf.empty()) {
265 return dex2oat_prop_buf == "true";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700266 }
267
268 // Shortcut for default value. This is an implementation optimization for the process sketched
269 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
270 // as low-mem is never returning false. The compiler will optimize this away if it can.
271 if (kDefaultProvideSwapFile) {
272 return true;
273 }
274
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700275 if (GetBoolProperty("ro.config.low_ram", false)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700276 return true;
277 }
278
279 // Default value must be false here.
280 return kDefaultProvideSwapFile;
281}
282
Richard Uhler76cc0272016-12-08 10:46:35 +0000283static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700284 if (set_to_bg) {
285 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800286 PLOG(ERROR) << "set_sched_policy failed";
287 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700288 }
289 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800290 PLOG(ERROR) << "setpriority failed";
291 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700292 }
293 }
294}
295
Calin Juravle31c68e72021-06-03 18:16:54 -0700296static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags, mode_t mode) {
297 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, mode)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800298 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800299 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800300 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800301 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800302 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700303 }
Calin Juravle114f0812017-03-08 19:05:07 -0800304 // Profiles should belong to the app; make sure of that by giving ownership to
305 // the app uid. If we cannot do that, there's no point in returning the fd
306 // since dex2oat/profman will fail with SElinux denials.
307 if (fchown(fd.get(), uid, uid) < 0) {
Roland Levillain019db5b2019-03-14 14:31:59 +0000308 PLOG(ERROR) << "Could not chown profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800309 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800310 }
Calin Juravle29591732017-11-20 17:46:19 -0800311 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800312}
313
Calin Juravle31c68e72021-06-03 18:16:54 -0700314static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags, mode_t mode) {
Calin Juravle114f0812017-03-08 19:05:07 -0800315 // Do not follow symlinks when opening a profile:
316 // - primary profiles should not contain symlinks in their paths
317 // - secondary dex paths should have been already resolved and validated
318 flags |= O_NOFOLLOW;
319
Calin Juravle29591732017-11-20 17:46:19 -0800320 // Check if we need to create the profile
321 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
322 unique_fd fd;
323 if ((flags & O_CREAT) != 0) {
Calin Juravle31c68e72021-06-03 18:16:54 -0700324 fd = create_profile(uid, profile, flags, mode);
Calin Juravle29591732017-11-20 17:46:19 -0800325 } else {
326 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
327 }
328
Calin Juravle114f0812017-03-08 19:05:07 -0800329 if (fd.get() < 0) {
330 if (errno != ENOENT) {
331 // Profiles might be missing for various reasons. For example, in a
332 // multi-user environment, the profile directory for one user can be created
333 // after we start a merge. In this case the current profile for that user
334 // will not be found.
335 // Also, the secondary dex profiles might be deleted by the app at any time,
336 // so we can't we need to prepare if they are missing.
337 PLOG(ERROR) << "Failed to open profile " << profile;
338 }
339 return invalid_unique_fd();
Calin Juravle31c68e72021-06-03 18:16:54 -0700340 } else {
341 // If we just create the file we need to set its mode because on Android
342 // open has a mask that only allows owner access.
343 if ((flags & O_CREAT) != 0) {
344 if (fchmod(fd.get(), mode) != 0) {
345 PLOG(ERROR) << "Could not set mode " << std::hex << mode << std::dec
346 << " on profile" << profile;
347 // Not a terminal failure.
348 }
349 }
Calin Juravle114f0812017-03-08 19:05:07 -0800350 }
351
Jeff Sharkey90aff262016-12-12 14:28:24 -0700352 return fd;
353}
354
Calin Juravle824a64d2018-01-18 20:23:17 -0800355static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
356 const std::string& location, bool is_secondary_dex) {
357 std::string profile = create_current_profile_path(user, package_name, location,
358 is_secondary_dex);
Calin Juravle31c68e72021-06-03 18:16:54 -0700359 return open_profile(uid, profile, O_RDONLY, /*mode=*/ 0);
Calin Juravle114f0812017-03-08 19:05:07 -0800360}
361
Calin Juravle824a64d2018-01-18 20:23:17 -0800362static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
363 const std::string& location, bool read_write, bool is_secondary_dex) {
364 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle31c68e72021-06-03 18:16:54 -0700365 return open_profile(
366 uid,
367 profile,
368 read_write ? (O_CREAT | O_RDWR) : O_RDONLY,
369 S_IRUSR | S_IWUSR | S_IRGRP); // so that ART can also read it when apps run.
Calin Juravle29591732017-11-20 17:46:19 -0800370}
371
Victor Hsiehcb35a062020-08-13 16:11:13 -0700372static UniqueFile open_reference_profile_as_unique_file(uid_t uid, const std::string& package_name,
373 const std::string& location, bool read_write, bool is_secondary_dex) {
374 std::string profile_path = create_reference_profile_path(package_name, location,
375 is_secondary_dex);
Calin Juravle31c68e72021-06-03 18:16:54 -0700376 unique_fd ufd = open_profile(
377 uid,
378 profile_path,
379 read_write ? (O_CREAT | O_RDWR) : O_RDONLY,
380 S_IRUSR | S_IWUSR | S_IRGRP); // so that ART can also read it when apps run.
381
Victor Hsiehcb35a062020-08-13 16:11:13 -0700382 return UniqueFile(ufd.release(), profile_path, [](const std::string& path) {
383 clear_profile(path);
384 });
385}
386
Calin Juravle29591732017-11-20 17:46:19 -0800387static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800388 const std::string& location) {
389 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle31c68e72021-06-03 18:16:54 -0700390 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR);
Calin Juravle114f0812017-03-08 19:05:07 -0800391}
392
Calin Juravle824a64d2018-01-18 20:23:17 -0800393static void open_profile_files(uid_t uid, const std::string& package_name,
394 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800395 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700396 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800397 *reference_profile_fd = open_reference_profile(uid, package_name, location,
398 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700399
Calin Juravle114f0812017-03-08 19:05:07 -0800400 // For secondary dex files, we don't really need the user but we use it for sanity checks.
401 // Note: the user owning the dex file should be the current user.
402 std::vector<userid_t> users;
403 if (is_secondary_dex){
404 users.push_back(multiuser_get_user_id(uid));
405 } else {
406 users = get_known_users(/*volume_uuid*/ nullptr);
407 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700408 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800409 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
410 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700411 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800412 if (profile_fd.get() >= 0) {
413 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700414 }
415 }
416}
417
Calin Juravle76561322019-11-14 09:08:52 -0800418static constexpr int PROFMAN_BIN_RETURN_CODE_SUCCESS = 0;
419static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 1;
Calin Juravlee90de862021-06-08 08:04:52 -0700420static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION_NOT_ENOUGH_DELTA = 2;
Calin Juravle76561322019-11-14 09:08:52 -0800421static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 3;
422static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 4;
423static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 5;
424static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_DIFFERENT_VERSIONS = 6;
Calin Juravlee90de862021-06-08 08:04:52 -0700425static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION_EMPTY_PROFILES = 7;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700426
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800427class RunProfman : public ExecVHelper {
428 public:
429 void SetupArgs(const std::vector<unique_fd>& profile_fds,
430 const unique_fd& reference_profile_fd,
431 const std::vector<unique_fd>& apk_fds,
432 const std::vector<std::string>& dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800433 bool copy_and_update,
434 bool for_snapshot,
435 bool for_boot_image) {
Calin Juravlef74a7372019-02-28 20:29:41 -0800436
437 // TODO(calin): Assume for now we run in the bg compile job (which is in
438 // most of the invocation). With the current data flow, is not very easy or
439 // clean to discover this in RunProfman (it will require quite a messy refactoring).
440 const char* profman_bin = select_execution_binary(
441 kProfmanPath, kProfmanDebugPath, /*background_job_compile=*/ true);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700442
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800443 if (copy_and_update) {
444 CHECK_EQ(1u, profile_fds.size());
445 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000446 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800447 if (reference_profile_fd != -1) {
448 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000449 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800450
451 for (const unique_fd& fd : profile_fds) {
452 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
453 }
454
455 for (const unique_fd& fd : apk_fds) {
456 AddArg("--apk-fd=" + std::to_string(fd.get()));
457 }
458
459 for (const std::string& dex_location : dex_locations) {
460 AddArg("--dex-location=" + dex_location);
461 }
462
463 if (copy_and_update) {
464 AddArg("--copy-and-update-profile-key");
465 }
466
Calin Juravle78728f32019-11-08 17:55:46 -0800467 if (for_snapshot) {
468 AddArg("--force-merge");
469 }
470
471 if (for_boot_image) {
472 AddArg("--boot-image-merge");
473 }
474
yawannga27559e2020-11-13 19:17:44 +0000475 // The percent won't exceed 100, otherwise, don't set it and use the
476 // default one set in profman.
yawanng6fe34a52020-11-06 05:13:53 +0000477 uint32_t min_new_classes_percent_change = ::android::base::GetUintProperty<uint32_t>(
yawannga27559e2020-11-13 19:17:44 +0000478 "dalvik.vm.bgdexopt.new-classes-percent",
479 /*default*/std::numeric_limits<uint32_t>::max());
480 if (min_new_classes_percent_change <= 100) {
yawanng6fe34a52020-11-06 05:13:53 +0000481 AddArg("--min-new-classes-percent-change=" +
482 std::to_string(min_new_classes_percent_change));
483 }
484
yawannga27559e2020-11-13 19:17:44 +0000485 // The percent won't exceed 100, otherwise, don't set it and use the
486 // default one set in profman.
yawanng6fe34a52020-11-06 05:13:53 +0000487 uint32_t min_new_methods_percent_change = ::android::base::GetUintProperty<uint32_t>(
yawannga27559e2020-11-13 19:17:44 +0000488 "dalvik.vm.bgdexopt.new-methods-percent",
489 /*default*/std::numeric_limits<uint32_t>::max());
490 if (min_new_methods_percent_change <= 100) {
yawanng6fe34a52020-11-06 05:13:53 +0000491 AddArg("--min-new-methods-percent-change=" +
492 std::to_string(min_new_methods_percent_change));
493 }
494
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800495 // Do not add after dex2oat_flags, they should override others for debugging.
496 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800497 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700498
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800499 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
500 const unique_fd& reference_profile_fd,
501 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravle78728f32019-11-08 17:55:46 -0800502 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
503 bool for_snapshot = false,
504 bool for_boot_image = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800505 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800506 reference_profile_fd,
507 apk_fds,
508 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800509 /*copy_and_update=*/ false,
510 for_snapshot,
511 for_boot_image);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800512 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700513
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800514 void SetupCopyAndUpdate(unique_fd&& profile_fd,
515 unique_fd&& reference_profile_fd,
516 unique_fd&& apk_fd,
517 const std::string& dex_location) {
518 // The fds need to stay open longer than the scope of the function, so put them into a local
519 // variable vector.
520 profiles_fd_.push_back(std::move(profile_fd));
521 apk_fds_.push_back(std::move(apk_fd));
522 reference_profile_fd_ = std::move(reference_profile_fd);
523 std::vector<std::string> dex_locations = {dex_location};
Calin Juravleb3a929d2018-12-11 14:40:00 -0800524 SetupArgs(profiles_fd_,
525 reference_profile_fd_,
526 apk_fds_,
527 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800528 /*copy_and_update=*/true,
529 /*for_snapshot*/false,
530 /*for_boot_image*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800531 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000532
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800533 void SetupDump(const std::vector<unique_fd>& profiles_fd,
534 const unique_fd& reference_profile_fd,
535 const std::vector<std::string>& dex_locations,
536 const std::vector<unique_fd>& apk_fds,
537 const unique_fd& output_fd) {
538 AddArg("--dump-only");
539 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800540 SetupArgs(profiles_fd,
541 reference_profile_fd,
542 apk_fds,
543 dex_locations,
Calin Juravle78728f32019-11-08 17:55:46 -0800544 /*copy_and_update=*/false,
545 /*for_snapshot*/false,
546 /*for_boot_image*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800547 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000548
Victor Hsiehc9821f12020-08-07 11:32:29 -0700549 using ExecVHelper::Exec; // To suppress -Wno-overloaded-virtual
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800550 void Exec() {
551 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
552 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000553
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800554 private:
555 unique_fd reference_profile_fd_;
556 std::vector<unique_fd> profiles_fd_;
557 std::vector<unique_fd> apk_fds_;
558};
Mathieu Chartier31636522018-11-09 23:53:07 +0000559
Calin Juravlee90de862021-06-08 08:04:52 -0700560static int analyze_profiles(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800561 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800562 std::vector<unique_fd> profiles_fd;
563 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800564 open_profile_files(uid, package_name, location, is_secondary_dex,
565 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800566 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700567 // Skip profile guided compilation because no profiles were found.
568 // Or if the reference profile info couldn't be opened.
Calin Juravlee90de862021-06-08 08:04:52 -0700569 return PROFILES_ANALYSIS_DONT_OPTIMIZE_EMPTY_PROFILES;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700570 }
571
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800572 RunProfman profman_merge;
Calin Juravlef85ddb92020-05-01 14:05:40 -0700573 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>();
574 const std::vector<std::string>& dex_locations = std::vector<std::string>();
575 profman_merge.SetupMerge(
576 profiles_fd,
577 reference_profile_fd,
578 apk_fds,
579 dex_locations,
580 /* for_snapshot= */ false,
581 IsBootClassPathProfilingEnable());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700582 pid_t pid = fork();
583 if (pid == 0) {
584 /* child -- drop privileges before continuing */
585 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800586 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700587 }
588 /* parent */
589 int return_code = wait_child(pid);
590 bool need_to_compile = false;
Calin Juravlee90de862021-06-08 08:04:52 -0700591 bool empty_profiles = false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700592 bool should_clear_current_profiles = false;
593 bool should_clear_reference_profile = false;
594 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800595 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700596 } else {
597 return_code = WEXITSTATUS(return_code);
598 switch (return_code) {
599 case PROFMAN_BIN_RETURN_CODE_COMPILE:
600 need_to_compile = true;
601 should_clear_current_profiles = true;
602 should_clear_reference_profile = false;
603 break;
Calin Juravlee90de862021-06-08 08:04:52 -0700604 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION_NOT_ENOUGH_DELTA:
Jeff Sharkey90aff262016-12-12 14:28:24 -0700605 need_to_compile = false;
606 should_clear_current_profiles = false;
607 should_clear_reference_profile = false;
608 break;
Calin Juravlee90de862021-06-08 08:04:52 -0700609 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION_EMPTY_PROFILES:
610 need_to_compile = false;
611 empty_profiles = true;
612 should_clear_current_profiles = false;
613 should_clear_reference_profile = false;
614 break;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700615 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800616 LOG(WARNING) << "Bad profiles for location " << location;
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 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
622 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
623 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800624 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700625 need_to_compile = false;
626 should_clear_current_profiles = false;
627 should_clear_reference_profile = false;
628 break;
Calin Juravle76561322019-11-14 09:08:52 -0800629 case PROFMAN_BIN_RETURN_CODE_ERROR_DIFFERENT_VERSIONS:
630 need_to_compile = false;
631 should_clear_current_profiles = true;
632 should_clear_reference_profile = true;
633 break;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700634 default:
635 // Unknown return code or error. Unlink profiles.
Calin Juravle78728f32019-11-08 17:55:46 -0800636 LOG(WARNING) << "Unexpected error code while processing profiles for location "
Calin Juravle114f0812017-03-08 19:05:07 -0800637 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700638 need_to_compile = false;
639 should_clear_current_profiles = true;
640 should_clear_reference_profile = true;
641 break;
642 }
643 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800644
Jeff Sharkey90aff262016-12-12 14:28:24 -0700645 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800646 if (is_secondary_dex) {
647 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800648 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
649 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800650 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800651 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800652 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700653 }
654 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800655 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700656 }
Calin Juravlee90de862021-06-08 08:04:52 -0700657 int result = 0;
658 if (need_to_compile) {
659 result = PROFILES_ANALYSIS_OPTIMIZE;
660 } else if (empty_profiles) {
661 result = PROFILES_ANALYSIS_DONT_OPTIMIZE_EMPTY_PROFILES;
662 } else {
663 result = PROFILES_ANALYSIS_DONT_OPTIMIZE_SMALL_DELTA;
664 }
665 return result;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700666}
667
Calin Juravle114f0812017-03-08 19:05:07 -0800668// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravlee90de862021-06-08 08:04:52 -0700669// The analysis is done for a single profile name (which corresponds to a single code path).
670//
671// Returns PROFILES_ANALYSIS_OPTIMIZE if there is enough information in the current profiles
672// that makes it worth to recompile the package.
673// If the return value is PROFILES_ANALYSIS_OPTIMIZE all the current profiles would have been
674// merged into the reference profiles accessible with open_reference_profile().
675//
676// Return PROFILES_ANALYSIS_DONT_OPTIMIZE_SMALL_DELTA if the package should not optimize.
677// As a special case returns PROFILES_ANALYSIS_DONT_OPTIMIZE_EMPTY_PROFILES if all profiles are
678// empty.
679int analyze_primary_profiles(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800680 const std::string& profile_name) {
681 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800682}
683
Calin Juravle408cd4a2018-01-20 23:34:18 -0800684bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
685 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800686 std::vector<unique_fd> profile_fds;
687 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800688 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
689 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700690
Calin Juravle408cd4a2018-01-20 23:34:18 -0800691 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800692 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700693
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800694 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700695 const bool has_profiles = !profile_fds.empty();
696
697 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800698 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700699 return false;
700 }
701
Calin Juravle114f0812017-03-08 19:05:07 -0800702 unique_fd output_fd(open(out_file_name.c_str(),
703 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700704 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800705 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700706 return false;
707 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800708
Jeff Sharkey90aff262016-12-12 14:28:24 -0700709 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800710 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800711 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
712 if (apk_fd == -1) {
713 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
714 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700715 }
Victor Hsieh76f19ba2020-08-10 14:37:26 -0700716 dex_locations.push_back(Basename(code_path));
Calin Juravle408cd4a2018-01-20 23:34:18 -0800717 apk_fds.push_back(std::move(apk_fd));
718
Jeff Sharkey90aff262016-12-12 14:28:24 -0700719
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800720 RunProfman profman_dump;
721 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700722 pid_t pid = fork();
723 if (pid == 0) {
724 /* child -- drop privileges before continuing */
725 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800726 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700727 }
728 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700729 int return_code = wait_child(pid);
730 if (!WIFEXITED(return_code)) {
731 LOG(WARNING) << "profman failed for package " << pkgname << ": "
732 << return_code;
733 return false;
734 }
735 return true;
736}
737
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700738bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800739 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700740 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
741 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800742 package_name,
743 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700744 /*read_write*/ true,
745 /*secondary*/ false));
746 if (in_fd.get() < 0) {
747 PLOG(WARNING) << "Could not open profile " << system_profile;
748 return false;
749 }
750 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800751 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700752 return false;
753 }
754
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700755 // As a security measure we want to write the profile information with the reduced capabilities
756 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700757 pid_t pid = fork();
758 if (pid == 0) {
759 /* child -- drop privileges before continuing */
760 drop_capabilities(packageUid);
761
762 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
763 if (errno != EWOULDBLOCK) {
Martijn Coenen6de402a2021-04-26 16:23:40 +0200764 async_safe_format_log(ANDROID_LOG_WARN, LOG_TAG, "Error locking profile %s: %d",
765 package_name.c_str(), errno);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700766 }
767 // This implies that the app owning this profile is running
768 // (and has acquired the lock).
769 //
770 // The app never acquires the lock for the reference profiles of primary apks.
771 // Only dex2oat from installd will do that. Since installd is single threaded
772 // we should not see this case. Nevertheless be prepared for it.
Martijn Coenen6de402a2021-04-26 16:23:40 +0200773 async_safe_format_log(ANDROID_LOG_WARN, LOG_TAG, "Failed to flock %s: %d",
774 package_name.c_str(), errno);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700775 return false;
776 }
777
778 bool truncated = ftruncate(out_fd.get(), 0) == 0;
779 if (!truncated) {
Martijn Coenen6de402a2021-04-26 16:23:40 +0200780 async_safe_format_log(ANDROID_LOG_WARN, LOG_TAG, "Could not truncate %s: %d",
781 package_name.c_str(), errno);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700782 }
783
784 // Copy over data.
785 static constexpr size_t kBufferSize = 4 * 1024;
786 char buffer[kBufferSize];
787 while (true) {
788 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
789 if (bytes == 0) {
790 break;
791 }
792 write(out_fd.get(), buffer, bytes);
793 }
794 if (flock(out_fd.get(), LOCK_UN) != 0) {
Martijn Coenen6de402a2021-04-26 16:23:40 +0200795 async_safe_format_log(ANDROID_LOG_WARN, LOG_TAG, "Error unlocking profile %s: %d",
796 package_name.c_str(), errno);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700797 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700798 // Use _exit since we don't want to run the global destructors in the child.
799 // b/62597429
800 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700801 }
802 /* parent */
803 int return_code = wait_child(pid);
804 return return_code == 0;
805}
806
Jeff Sharkey90aff262016-12-12 14:28:24 -0700807static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
808 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
809 if (EndsWith(oat_path, ".dex")) {
810 std::string new_path = oat_path;
811 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800812 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700813 return new_path;
814 }
815
816 // An odex entry. Not that this may not be an extension, e.g., in the OTA
817 // case (where the base name will have an extension for the B artifact).
818 size_t odex_pos = oat_path.rfind(".odex");
819 if (odex_pos != std::string::npos) {
820 std::string new_path = oat_path;
821 new_path.replace(odex_pos, strlen(".odex"), new_ext);
822 CHECK_NE(new_path.find(new_ext), std::string::npos);
823 return new_path;
824 }
825
826 // Don't know how to handle this.
827 return "";
828}
829
830// Translate the given oat path to an art (app image) path. An empty string
831// denotes an error.
832static std::string create_image_filename(const std::string& oat_path) {
833 return replace_file_extension(oat_path, ".art");
834}
835
836// Translate the given oat path to a vdex path. An empty string denotes an error.
837static std::string create_vdex_filename(const std::string& oat_path) {
838 return replace_file_extension(oat_path, ".vdex");
839}
840
Jeff Sharkey90aff262016-12-12 14:28:24 -0700841static int open_output_file(const char* file_name, bool recreate, int permissions) {
842 int flags = O_RDWR | O_CREAT;
843 if (recreate) {
844 if (unlink(file_name) < 0) {
845 if (errno != ENOENT) {
846 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
847 }
848 }
849 flags |= O_EXCL;
850 }
851 return open(file_name, flags, permissions);
852}
853
Calin Juravle2289c0a2017-02-15 12:44:14 -0800854static bool set_permissions_and_ownership(
855 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
856 // Primary apks are owned by the system. Secondary dex files are owned by the app.
857 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700858 if (fchmod(fd,
859 S_IRUSR|S_IWUSR|S_IRGRP |
860 (is_public ? S_IROTH : 0)) < 0) {
861 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
862 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -0800863 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700864 ALOGE("installd cannot chown '%s' during dexopt\n", path);
865 return false;
866 }
867 return true;
868}
869
870static bool IsOutputDalvikCache(const char* oat_dir) {
871 // InstallerConnection.java (which invokes installd) transforms Java null arguments
872 // into '!'. Play it safe by handling it both.
873 // TODO: ensure we never get null.
874 // TODO: pass a flag instead of inferring if the output is dalvik cache.
875 return oat_dir == nullptr || oat_dir[0] == '!';
876}
877
Calin Juravled23dee72017-07-06 16:29:11 -0700878// Best-effort check whether we can fit the the path into our buffers.
879// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
880// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
881// extension to the cache path (5 bytes).
882// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
883static bool validate_dex_path_size(const std::string& dex_path) {
884 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
885 LOG(ERROR) << "dex_path too long: " << dex_path;
886 return false;
887 }
888 return true;
889}
890
Jeff Sharkey90aff262016-12-12 14:28:24 -0700891static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -0800892 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -0700893 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700894 return false;
895 }
896
897 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -0800898 // Oat dirs for secondary dex files are already validated.
899 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700900 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
901 return false;
902 }
903 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
904 return false;
905 }
906 } else {
907 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
908 return false;
909 }
910 }
911 return true;
912}
913
Calin Juravle7a570e82017-01-14 16:23:30 -0800914// (re)Creates the app image if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700915UniqueFile maybe_open_app_image(const std::string& out_oat_path,
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -0700916 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100917
Calin Juravle7a570e82017-01-14 16:23:30 -0800918 const std::string image_path = create_image_filename(out_oat_path);
919 if (image_path.empty()) {
920 // Happens when the out_oat_path has an unknown extension.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700921 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -0800922 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100923
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -0700924 // In case there is a stale image, remove it now. Ignore any error.
925 unlink(image_path.c_str());
926
927 // Not enabled, exit.
928 if (!generate_app_image) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700929 return UniqueFile();
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +0100930 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700931 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
932 if (app_image_format.empty()) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700933 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -0800934 }
935 // Recreate is true since we do not want to modify a mapped image. If the app is
936 // already running and we modify the image file, it can cause crashes (b/27493510).
Victor Hsiehcb35a062020-08-13 16:11:13 -0700937 UniqueFile image_file(
Calin Juravle7a570e82017-01-14 16:23:30 -0800938 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
Victor Hsiehcb35a062020-08-13 16:11:13 -0700939 image_path,
940 UnlinkIgnoreResult);
941 if (image_file.fd() < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800942 // Could not create application image file. Go on since we can compile without it.
943 LOG(ERROR) << "installd could not create '" << image_path
944 << "' for image file during dexopt";
945 // If we have a valid image file path but no image fd, explicitly erase the image file.
946 if (unlink(image_path.c_str()) < 0) {
947 if (errno != ENOENT) {
948 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
949 }
950 }
951 } else if (!set_permissions_and_ownership(
Victor Hsiehcb35a062020-08-13 16:11:13 -0700952 image_file.fd(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800953 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
Victor Hsiehcb35a062020-08-13 16:11:13 -0700954 image_file.reset();
Calin Juravle7a570e82017-01-14 16:23:30 -0800955 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700956
Victor Hsiehcb35a062020-08-13 16:11:13 -0700957 return image_file;
Calin Juravle7a570e82017-01-14 16:23:30 -0800958}
959
960// Creates the dexopt swap file if necessary and return its fd.
961// Returns -1 if there's no need for a swap or in case of errors.
Victor Hsiehcb35a062020-08-13 16:11:13 -0700962unique_fd maybe_open_dexopt_swap_file(const std::string& out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800963 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800964 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -0800965 }
Victor Hsiehcb35a062020-08-13 16:11:13 -0700966 auto swap_file_name = out_oat_path + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800967 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600968 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -0800969 if (swap_fd.get() < 0) {
970 // Could not create swap file. Optimistically go on and hope that we can compile
971 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600972 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -0800973 } else {
974 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600975 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -0800976 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
977 }
978 }
979 return swap_fd;
980}
981
982// Opens the reference profiles if needed.
983// 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 -0700984UniqueFile maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +0000985 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -0800986 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +0000987 // If we are not profile guided compilation, or we are compiling system server
988 // do not bother to open the profiles; we won't be using them.
989 if (!profile_guided || (pkgname[0] == '*')) {
Victor Hsiehcb35a062020-08-13 16:11:13 -0700990 return UniqueFile();
Calin Juravle5bd1c722018-02-01 17:23:54 +0000991 }
992
993 // If this is a secondary dex path which is public do not open the profile.
994 // We cannot compile public secondary dex paths with profiles. That's because
995 // it will expose how the dex files are used by their owner.
996 //
997 // Note that the PackageManager is responsible to set the is_public flag for
998 // primary apks and we do not check it here. In some cases, e.g. when
999 // compiling with a public profile from the .dm file the PackageManager will
1000 // set is_public toghether with the profile guided compilation.
1001 if (is_secondary_dex && is_public) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001002 return UniqueFile();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001003 }
Calin Juravle114f0812017-03-08 19:05:07 -08001004
1005 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001006 std::string location;
1007 if (is_secondary_dex) {
1008 location = dex_path;
1009 } else {
1010 if (profile_name == nullptr) {
1011 // This path is taken for system server re-compilation lunched from ZygoteInit.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001012 return UniqueFile();
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001013 } else {
1014 location = profile_name;
1015 }
1016 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001017 return open_reference_profile_as_unique_file(uid, pkgname, location, /*read_write*/false,
1018 is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001019}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001020
Victor Hsiehcb35a062020-08-13 16:11:13 -07001021// Opens the vdex files and assigns the input fd to in_vdex_wrapper and the output fd to
1022// out_vdex_wrapper. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001023bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001024 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Victor Hsiehcb35a062020-08-13 16:11:13 -07001025 bool profile_guided, UniqueFile* in_vdex_wrapper,
1026 UniqueFile* out_vdex_wrapper) {
1027 CHECK(in_vdex_wrapper != nullptr);
1028 CHECK(out_vdex_wrapper != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001029 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1030 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001031 char in_odex_path[PKG_PATH_MAX];
1032 int dexopt_action = abs(dexopt_needed);
1033 bool is_odex_location = dexopt_needed < 0;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001034
1035 // Infer the name of the output VDEX.
1036 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1037 if (out_vdex_path_str.empty()) {
1038 return false;
1039 }
1040
1041 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001042 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001043 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1044 const char* path = nullptr;
1045 if (is_odex_location) {
1046 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1047 path = in_odex_path;
1048 } else {
1049 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001050 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001051 }
1052 } else {
1053 path = out_oat_path;
1054 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001055 std::string in_vdex_path_str = create_vdex_filename(path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001056 if (in_vdex_path_str.empty()) {
1057 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001058 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001059 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001060 // We can update in place when all these conditions are met:
1061 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1062 // on /system typically cannot be updated in place).
1063 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1064 // cannot be currently used by a running process.
1065 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1066 // different vdex files to operate.
1067 update_vdex_in_place =
1068 (in_vdex_path_str == out_vdex_path_str) &&
1069 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1070 !profile_guided;
1071 if (update_vdex_in_place) {
1072 // Open the file read-write to be able to update it.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001073 in_vdex_wrapper->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0),
1074 in_vdex_path_str);
1075 if (in_vdex_wrapper->fd() == -1) {
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001076 // If we failed to open the file, we cannot update it in place.
1077 update_vdex_in_place = false;
1078 }
1079 } else {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001080 in_vdex_wrapper->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0),
1081 in_vdex_path_str);
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001082 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001083 }
1084
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001085 // If we are updating the vdex in place, we do not need to recreate a vdex,
1086 // and can use the same existing one.
1087 if (update_vdex_in_place) {
1088 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1089 // have bogus stale vdex files.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001090 out_vdex_wrapper->reset(
1091 in_vdex_wrapper->fd(),
1092 out_vdex_path_str,
1093 UnlinkIgnoreResult);
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001094 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1095 // wrapper).
Victor Hsiehcb35a062020-08-13 16:11:13 -07001096 in_vdex_wrapper->DisableAutoClose();
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001097 } else {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001098 out_vdex_wrapper->reset(
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001099 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
Victor Hsiehcb35a062020-08-13 16:11:13 -07001100 out_vdex_path_str,
1101 UnlinkIgnoreResult);
1102 if (out_vdex_wrapper->fd() < 0) {
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001103 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1104 return false;
1105 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001106 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001107 if (!set_permissions_and_ownership(out_vdex_wrapper->fd(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001108 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001109 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1110 return false;
1111 }
1112
1113 // If we got here we successfully opened the vdex files.
1114 return true;
1115}
1116
1117// Opens the output oat file for the given apk.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001118UniqueFile open_oat_out_file(const char* apk_path, const char* oat_dir,
1119 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex) {
1120 char out_oat_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08001121 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001122 return UniqueFile();
Calin Juravle7a570e82017-01-14 16:23:30 -08001123 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001124 UniqueFile oat(
Calin Juravle7a570e82017-01-14 16:23:30 -08001125 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
Victor Hsiehcb35a062020-08-13 16:11:13 -07001126 out_oat_path,
1127 UnlinkIgnoreResult);
1128 if (oat.fd() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001129 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001130 } else if (!set_permissions_and_ownership(
Victor Hsiehcb35a062020-08-13 16:11:13 -07001131 oat.fd(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001132 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
Victor Hsiehcb35a062020-08-13 16:11:13 -07001133 oat.reset();
Calin Juravle7a570e82017-01-14 16:23:30 -08001134 }
Victor Hsiehcb35a062020-08-13 16:11:13 -07001135 return oat;
Calin Juravle7a570e82017-01-14 16:23:30 -08001136}
1137
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001138// Creates RDONLY fds for oat and vdex files, if exist.
1139// Returns false if it fails to create oat out path for the given apk path.
1140// Note that the method returns true even if the files could not be opened.
1141bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1142 const std::string& oat_dir,
1143 const std::string& instruction_set,
1144 bool is_secondary_dex,
1145 unique_fd* oat_file_fd,
1146 unique_fd* vdex_file_fd) {
1147 char oat_path[PKG_PATH_MAX];
1148 if (!create_oat_out_path(apk_path.c_str(),
1149 instruction_set.c_str(),
1150 oat_dir.c_str(),
1151 is_secondary_dex,
1152 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001153 LOG(ERROR) << "Could not create oat out path for "
1154 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001155 return false;
1156 }
1157 oat_file_fd->reset(open(oat_path, O_RDONLY));
1158 if (oat_file_fd->get() < 0) {
1159 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1160 }
1161
1162 std::string vdex_filename = create_vdex_filename(oat_path);
1163 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1164 if (vdex_file_fd->get() < 0) {
1165 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1166 }
1167
1168 return true;
1169}
1170
Calin Juravle80a21252017-01-17 14:43:25 -08001171// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001172// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1173// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1174// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001175class RunDexoptAnalyzer : public ExecVHelper {
1176 public:
1177 RunDexoptAnalyzer(const std::string& dex_file,
David Brazdil4f6027a2019-03-19 11:44:21 +00001178 int vdex_fd,
1179 int oat_fd,
1180 int zip_fd,
1181 const std::string& instruction_set,
1182 const std::string& compiler_filter,
Calin Juravlee90de862021-06-08 08:04:52 -07001183 int profile_analysis_result,
David Brazdil4f6027a2019-03-19 11:44:21 +00001184 bool downgrade,
1185 const char* class_loader_context,
1186 const std::string& class_loader_context_fds) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001187 CHECK_GE(zip_fd, 0);
Calin Juravlef74a7372019-02-28 20:29:41 -08001188
1189 // We always run the analyzer in the background job.
1190 const char* dexoptanalyzer_bin = select_execution_binary(
1191 kDexoptanalyzerPath, kDexoptanalyzerDebugPath, /*background_job_compile=*/ true);
Calin Juravle80a21252017-01-17 14:43:25 -08001192
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001193 std::string dex_file_arg = "--dex-file=" + dex_file;
1194 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1195 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1196 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1197 std::string isa_arg = "--isa=" + instruction_set;
1198 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
Calin Juravlee90de862021-06-08 08:04:52 -07001199 std::string profile_analysis_arg = "--profile-analysis-result="
1200 + std::to_string(profile_analysis_result);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001201 const char* downgrade_flag = "--downgrade";
1202 std::string class_loader_context_arg = "--class-loader-context=";
1203 if (class_loader_context != nullptr) {
1204 class_loader_context_arg += class_loader_context;
1205 }
David Brazdil4f6027a2019-03-19 11:44:21 +00001206 std::string class_loader_context_fds_arg = "--class-loader-context-fds=";
1207 if (!class_loader_context_fds.empty()) {
1208 class_loader_context_fds_arg += class_loader_context_fds;
1209 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001210
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001211 // program name, dex file, isa, filter
1212 AddArg(dex_file_arg);
1213 AddArg(isa_arg);
1214 AddArg(compiler_filter_arg);
1215 if (oat_fd >= 0) {
1216 AddArg(oat_fd_arg);
1217 }
1218 if (vdex_fd >= 0) {
1219 AddArg(vdex_fd_arg);
1220 }
Greg Kaiser8042c372019-03-26 06:23:19 -07001221 AddArg(zip_fd_arg);
Calin Juravlee90de862021-06-08 08:04:52 -07001222 AddArg(profile_analysis_arg);
1223
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001224 if (downgrade) {
1225 AddArg(downgrade_flag);
1226 }
1227 if (class_loader_context != nullptr) {
Greg Kaiser8042c372019-03-26 06:23:19 -07001228 AddArg(class_loader_context_arg);
David Brazdil4f6027a2019-03-19 11:44:21 +00001229 if (!class_loader_context_fds.empty()) {
Greg Kaiser8042c372019-03-26 06:23:19 -07001230 AddArg(class_loader_context_fds_arg);
David Brazdil4f6027a2019-03-19 11:44:21 +00001231 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001232 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001233
Orion Hodson2b12e7c2021-07-01 12:12:40 +01001234 // On-device signing related. odsign sets the system property odsign.verification.success if
1235 // AOT artifacts have the expected signatures.
1236 const bool trust_art_apex_data_files =
1237 ::android::base::GetBoolProperty("odsign.verification.success", false);
1238 if (!trust_art_apex_data_files) {
1239 AddRuntimeArg("-Xdeny-art-apex-data-files");
1240 }
1241
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001242 PrepareArgs(dexoptanalyzer_bin);
1243 }
David Brazdil4f6027a2019-03-19 11:44:21 +00001244
1245 // Dexoptanalyzer mode which flattens the given class loader context and
1246 // prints a list of its dex files in that flattened order.
1247 RunDexoptAnalyzer(const char* class_loader_context) {
1248 CHECK(class_loader_context != nullptr);
1249
1250 // We always run the analyzer in the background job.
1251 const char* dexoptanalyzer_bin = select_execution_binary(
1252 kDexoptanalyzerPath, kDexoptanalyzerDebugPath, /*background_job_compile=*/ true);
1253
1254 AddArg("--flatten-class-loader-context");
1255 AddArg(std::string("--class-loader-context=") + class_loader_context);
1256 PrepareArgs(dexoptanalyzer_bin);
1257 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001258};
Calin Juravle80a21252017-01-17 14:43:25 -08001259
1260// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001261static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001262 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001263 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001264 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001265 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001266 return false;
1267 }
Calin Juravle114f0812017-03-08 19:05:07 -08001268 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001269
Calin Juravle80a21252017-01-17 14:43:25 -08001270 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001271 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1272 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001273 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001274 return false;
1275 }
1276
1277 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001278 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001279
Calin Juravle7d765462017-09-04 15:57:10 -07001280 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001281 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001282 return false;
1283 }
1284
1285 return true;
1286}
1287
Calin Juravle7d765462017-09-04 15:57:10 -07001288// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1289// secondary dex files. This return codes are returned by the child process created for
1290// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001291
Andreas Gampe194fe422018-02-28 20:16:19 -08001292enum DexoptAnalyzerSkipCodes {
1293 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001294 // Specific errors are encoded in the name.
1295 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1296 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1297 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1298 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1299 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001300 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001301 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001302};
Calin Juravle7d765462017-09-04 15:57:10 -07001303
1304// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001305// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1306// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001307// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1308// of dexoptanalyzer.
1309static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001310 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001311 // The result values are defined in dexoptanalyzer.
1312 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001313 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001314 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001315 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001316 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001317 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001318 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001319 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001320 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001321 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1322 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001323 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1324 " Expected odex file status for secondary dex %s"
1325 " : dexoptanalyzer result=%d",
1326 dex_path.c_str(),
1327 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001328 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001329 }
1330
1331 // Use a second switch for enum switch-case analysis.
1332 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001333 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001334 // If the file does not exist there's no need for dexopt.
1335 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1336 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001337
1338 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1339 *error_msg = "Dexoptanalyzer path validation failed";
1340 return false;
1341 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1342 *error_msg = "Dexoptanalyzer open zip failed";
1343 return false;
1344 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1345 *error_msg = "Dexoptanalyzer dir preparation failed";
1346 return false;
1347 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1348 *error_msg = "Dexoptanalyzer open output failed";
1349 return false;
1350 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1351 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001352 return false;
1353 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001354
1355 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1356 dex_path.c_str(),
1357 result);
1358 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001359}
1360
Calin Juravle7d765462017-09-04 15:57:10 -07001361enum SecondaryDexAccess {
1362 kSecondaryDexAccessReadOk = 0,
1363 kSecondaryDexAccessDoesNotExist = 1,
1364 kSecondaryDexAccessPermissionError = 2,
1365 kSecondaryDexAccessIOError = 3
1366};
1367
1368static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1369 // Check if the path exists and can be read. If not, there's nothing to do.
1370 if (access(dex_path.c_str(), R_OK) == 0) {
1371 return kSecondaryDexAccessReadOk;
1372 } else {
1373 if (errno == ENOENT) {
Martijn Coenenc417edf2021-07-12 11:47:39 +02001374 async_safe_format_log(ANDROID_LOG_INFO, LOG_TAG,
1375 "Secondary dex does not exist: %s", dex_path.c_str());
Calin Juravle7d765462017-09-04 15:57:10 -07001376 return kSecondaryDexAccessDoesNotExist;
1377 } else {
Martijn Coenenc417edf2021-07-12 11:47:39 +02001378 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
1379 "Could not access secondary dex: %s (%d)", dex_path.c_str(), errno);
Calin Juravle7d765462017-09-04 15:57:10 -07001380 return errno == EACCES
1381 ? kSecondaryDexAccessPermissionError
1382 : kSecondaryDexAccessIOError;
1383 }
1384 }
1385}
1386
1387static bool is_file_public(const std::string& filename) {
1388 struct stat file_stat;
1389 if (stat(filename.c_str(), &file_stat) == 0) {
1390 return (file_stat.st_mode & S_IROTH) != 0;
1391 }
1392 return false;
1393}
1394
1395// Create the oat file structure for the secondary dex 'dex_path' and assign
1396// the individual path component to the 'out_' parameters.
1397static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001398 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001399 size_t dirIndex = dex_path.rfind('/');
1400 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001401 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001402 return false;
1403 }
1404 // TODO(calin): we have similar computations in at lest 3 other places
1405 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1406 // using string append.
1407 std::string apk_dir = dex_path.substr(0, dirIndex);
1408 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1409 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1410
1411 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1412 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001413 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001414 return false;
1415 }
1416 return true;
1417}
1418
1419// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1420// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001421static bool validate_dexopt_storage_flags(int dexopt_flags,
1422 int* out_storage_flag,
1423 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001424 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1425 *out_storage_flag = FLAG_STORAGE_CE;
1426 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001427 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001428 return false;
1429 }
1430 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1431 *out_storage_flag = FLAG_STORAGE_DE;
1432 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001433 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001434 return false;
1435 }
1436 return true;
1437}
1438
David Brazdil4f6027a2019-03-19 11:44:21 +00001439static bool get_class_loader_context_dex_paths(const char* class_loader_context, int uid,
1440 /* out */ std::vector<std::string>* context_dex_paths) {
1441 if (class_loader_context == nullptr) {
1442 return true;
1443 }
1444
1445 LOG(DEBUG) << "Getting dex paths for context " << class_loader_context;
1446
1447 // Pipe to get the hash result back from our child process.
1448 unique_fd pipe_read, pipe_write;
1449 if (!Pipe(&pipe_read, &pipe_write)) {
1450 PLOG(ERROR) << "Failed to create pipe";
1451 return false;
1452 }
1453
1454 pid_t pid = fork();
1455 if (pid == 0) {
1456 // child -- drop privileges before continuing.
1457 drop_capabilities(uid);
1458
1459 // Route stdout to `pipe_write`
1460 while ((dup2(pipe_write, STDOUT_FILENO) == -1) && (errno == EINTR)) {}
1461 pipe_write.reset();
1462 pipe_read.reset();
1463
1464 RunDexoptAnalyzer run_dexopt_analyzer(class_loader_context);
1465 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
1466 }
1467
1468 /* parent */
1469 pipe_write.reset();
1470
1471 std::string str_dex_paths;
1472 if (!ReadFdToString(pipe_read, &str_dex_paths)) {
1473 PLOG(ERROR) << "Failed to read from pipe";
1474 return false;
1475 }
1476 pipe_read.reset();
1477
1478 int return_code = wait_child(pid);
1479 if (!WIFEXITED(return_code)) {
1480 PLOG(ERROR) << "Error waiting for child dexoptanalyzer process";
1481 return false;
1482 }
1483
1484 constexpr int kFlattenClassLoaderContextSuccess = 50;
1485 return_code = WEXITSTATUS(return_code);
1486 if (return_code != kFlattenClassLoaderContextSuccess) {
1487 LOG(ERROR) << "Dexoptanalyzer could not flatten class loader context, code=" << return_code;
1488 return false;
1489 }
1490
1491 if (!str_dex_paths.empty()) {
1492 *context_dex_paths = android::base::Split(str_dex_paths, ":");
1493 }
1494 return true;
1495}
1496
1497static int open_dex_paths(const std::vector<std::string>& dex_paths,
1498 /* out */ std::vector<unique_fd>* zip_fds, /* out */ std::string* error_msg) {
1499 for (const std::string& dex_path : dex_paths) {
1500 zip_fds->emplace_back(open(dex_path.c_str(), O_RDONLY));
1501 if (zip_fds->back().get() < 0) {
1502 *error_msg = StringPrintf(
1503 "installd cannot open '%s' for input during dexopt", dex_path.c_str());
1504 if (errno == ENOENT) {
1505 return kSecondaryDexDexoptAnalyzerSkippedNoFile;
1506 } else {
1507 return kSecondaryDexDexoptAnalyzerSkippedOpenZip;
1508 }
1509 }
1510 }
1511 return 0;
1512}
1513
1514static std::string join_fds(const std::vector<unique_fd>& fds) {
1515 std::stringstream ss;
1516 bool is_first = true;
1517 for (const unique_fd& fd : fds) {
1518 if (is_first) {
1519 is_first = false;
1520 } else {
1521 ss << ":";
1522 }
1523 ss << fd.get();
1524 }
1525 return ss.str();
1526}
1527
Calin Juravlec9eab382017-01-25 01:17:17 -08001528// 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 -08001529// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1530// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001531// When returning true, the output parameters will be:
1532// - is_public_out: whether or not the oat file should not be made public
1533// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1534// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001535static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001536 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001537 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001538 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
David Brazdil4f6027a2019-03-19 11:44:21 +00001539 const std::vector<std::string>& context_dex_paths, /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001540 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001541 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001542 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1543 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001544 return false;
1545 }
Calin Juravle7d765462017-09-04 15:57:10 -07001546 // Compute the oat dir as it's not easy to extract it from the child computation.
1547 char oat_path[PKG_PATH_MAX];
1548 char oat_dir[PKG_PATH_MAX];
1549 char oat_isa_dir[PKG_PATH_MAX];
1550 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001551 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1552 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001553 return false;
1554 }
Calin Juravle7d765462017-09-04 15:57:10 -07001555 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001556
Calin Juravle80a21252017-01-17 14:43:25 -08001557 pid_t pid = fork();
1558 if (pid == 0) {
1559 // child -- drop privileges before continuing.
1560 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001561
1562 // Validate the path structure.
1563 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02001564 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
1565 "Could not validate secondary dex path %s", dex_path.c_str());
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001566 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001567 }
1568
1569 // Open the dex file.
1570 unique_fd zip_fd;
1571 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1572 if (zip_fd.get() < 0) {
1573 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001574 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001575 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001576 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001577 }
1578 }
1579
David Brazdil4f6027a2019-03-19 11:44:21 +00001580 // Open class loader context dex files.
1581 std::vector<unique_fd> context_zip_fds;
1582 int open_dex_paths_rc = open_dex_paths(context_dex_paths, &context_zip_fds, error_msg);
1583 if (open_dex_paths_rc != 0) {
1584 _exit(open_dex_paths_rc);
1585 }
1586
Calin Juravle7d765462017-09-04 15:57:10 -07001587 // Prepare the oat directories.
1588 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001589 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001590 }
1591
1592 // Open the vdex/oat files if any.
1593 unique_fd oat_file_fd;
1594 unique_fd vdex_file_fd;
1595 if (!maybe_open_oat_and_vdex_file(dex_path,
1596 *oat_dir_out,
1597 instruction_set,
1598 true /* is_secondary_dex */,
1599 &oat_file_fd,
1600 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001601 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001602 }
1603
1604 // Analyze profiles.
Calin Juravlee90de862021-06-08 08:04:52 -07001605 int profile_analysis_result = analyze_profiles(uid, pkgname, dex_path,
Calin Juravle824a64d2018-01-18 20:23:17 -08001606 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001607
1608 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001609 // Note that we do not do it before the fork since opening the files is required to happen
1610 // after forking.
1611 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1612 vdex_file_fd.get(),
1613 oat_file_fd.get(),
1614 zip_fd.get(),
1615 instruction_set,
Calin Juravlee90de862021-06-08 08:04:52 -07001616 compiler_filter,
1617 profile_analysis_result,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001618 downgrade,
David Brazdil4f6027a2019-03-19 11:44:21 +00001619 class_loader_context,
1620 join_fds(context_zip_fds));
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001621 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001622 }
1623
1624 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001625 int result = wait_child(pid);
1626 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001627 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1628 dex_path.c_str(),
1629 result);
1630 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001631 return false;
1632 }
1633 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001634 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001635 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1636 result,
1637 dexopt_needed_out,
1638 error_msg);
1639 if (!success) {
1640 LOG(ERROR) << *error_msg;
1641 }
Calin Juravle7d765462017-09-04 15:57:10 -07001642
1643 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1644
Calin Juravle80a21252017-01-17 14:43:25 -08001645 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001646 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1647 // makes the code simpler; force compilation is only needed during tests).
1648 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001649 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001650 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001651 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1652 }
1653
Calin Juravle7d765462017-09-04 15:57:10 -07001654 // Check if we should make the oat file public.
1655 // Note that if the dex file is not public the compiled code cannot be made public.
1656 // It is ok to check this flag outside in the parent process.
1657 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1658
Calin Juravle80a21252017-01-17 14:43:25 -08001659 return success;
1660}
1661
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001662static std::string format_dexopt_error(int status, const char* dex_path) {
1663 if (WIFEXITED(status)) {
1664 int int_code = WEXITSTATUS(status);
1665 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1666 if (code_name != nullptr) {
1667 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1668 }
1669 }
1670 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001671}
1672
Calin Juravlec9eab382017-01-25 01:17:17 -08001673int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001674 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001675 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001676 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001677 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001678 CHECK(pkgname != nullptr);
1679 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001680 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001681 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1682 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001683
Calin Juravled23dee72017-07-06 16:29:11 -07001684 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001685 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001686 return -1;
1687 }
1688
1689 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001690 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1691 class_loader_context);
1692 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001693 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001694 }
1695
Calin Juravleebc8a792017-04-04 20:21:05 -07001696 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001697 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1698 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1699 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001700 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001701 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001702 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001703 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001704 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Patrick Baumann2271b3e2020-04-14 17:03:00 -07001705 bool for_restore = (dexopt_flags & DEXOPT_FOR_RESTORE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001706
1707 // Check if we're dealing with a secondary dex file and if we need to compile it.
1708 std::string oat_dir_str;
David Brazdil4f6027a2019-03-19 11:44:21 +00001709 std::vector<std::string> context_dex_paths;
Calin Juravle80a21252017-01-17 14:43:25 -08001710 if (is_secondary_dex) {
David Brazdil4f6027a2019-03-19 11:44:21 +00001711 if (!get_class_loader_context_dex_paths(class_loader_context, uid, &context_dex_paths)) {
1712 *error_msg = "Failed acquiring context dex paths";
1713 return -1; // We had an error, logged in the process method.
1714 }
1715
Calin Juravlec9eab382017-01-25 01:17:17 -08001716 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001717 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
David Brazdil4f6027a2019-03-19 11:44:21 +00001718 downgrade, class_loader_context, context_dex_paths, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001719 oat_dir = oat_dir_str.c_str();
1720 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1721 return 0; // Nothing to do, report success.
1722 }
1723 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001724 if (error_msg->empty()) { // TODO: Make this a CHECK.
1725 *error_msg = "Failed processing secondary.";
1726 }
Calin Juravle80a21252017-01-17 14:43:25 -08001727 return -1; // We had an error, logged in the process method.
1728 }
1729 } else {
David Brazdil4f6027a2019-03-19 11:44:21 +00001730 // Currently these flags are only used for secondary dex files.
Calin Juravlec9eab382017-01-25 01:17:17 -08001731 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001732 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1733 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1734 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001735
1736 // Open the input file.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001737 UniqueFile in_dex(open(dex_path, O_RDONLY, 0), dex_path);
1738 if (in_dex.fd() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001739 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1740 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001741 return -1;
1742 }
1743
David Brazdil4f6027a2019-03-19 11:44:21 +00001744 // Open class loader context dex files.
1745 std::vector<unique_fd> context_input_fds;
1746 if (open_dex_paths(context_dex_paths, &context_input_fds, error_msg) != 0) {
1747 LOG(ERROR) << *error_msg;
1748 return -1;
1749 }
1750
Calin Juravle7a570e82017-01-14 16:23:30 -08001751 // Create the output OAT file.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001752 UniqueFile out_oat = open_oat_out_file(dex_path, oat_dir, is_public, uid,
1753 instruction_set, is_secondary_dex);
1754 if (out_oat.fd() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001755 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001756 return -1;
1757 }
1758
1759 // Open vdex files.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001760 UniqueFile in_vdex;
1761 UniqueFile out_vdex;
1762 if (!open_vdex_files_for_dex2oat(dex_path, out_oat.path().c_str(), dexopt_needed,
1763 instruction_set, is_public, uid, is_secondary_dex, profile_guided, &in_vdex,
1764 &out_vdex)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001765 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001766 return -1;
1767 }
1768
Calin Juravlecb556e32017-04-04 20:22:50 -07001769 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1770 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1771 // fully inherit their parent context).
1772 // Note that for primary apk the oat files are created before, in a separate installd
1773 // call which also does the restorecon. TODO(calin): unify the paths.
1774 if (is_secondary_dex) {
1775 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1776 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001777 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1778 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001779 return -1;
1780 }
1781 }
1782
Jeff Sharkey90aff262016-12-12 14:28:24 -07001783 // Create a swap file if necessary.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001784 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat.path());
Jeff Sharkey90aff262016-12-12 14:28:24 -07001785
Calin Juravle7a570e82017-01-14 16:23:30 -08001786 // Open the reference profile if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001787 UniqueFile reference_profile = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001788 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001789
Victor Hsiehcb35a062020-08-13 16:11:13 -07001790 if (reference_profile.fd() == -1) {
liulvping61907742018-08-21 09:36:52 +08001791 // We don't create an app image without reference profile since there is no speedup from
1792 // loading it in that case and instead will be a small overhead.
1793 generate_app_image = false;
1794 }
1795
1796 // Create the app image file if needed.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001797 UniqueFile out_image = maybe_open_app_image(
1798 out_oat.path(), generate_app_image, is_public, uid, is_secondary_dex);
liulvping61907742018-08-21 09:36:52 +08001799
Victor Hsiehcb35a062020-08-13 16:11:13 -07001800 UniqueFile dex_metadata;
Calin Juravle62c5a372018-02-01 17:03:23 +00001801 if (dex_metadata_path != nullptr) {
Victor Hsiehcb35a062020-08-13 16:11:13 -07001802 dex_metadata.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)),
1803 dex_metadata_path);
1804 if (dex_metadata.fd() < 0) {
Calin Juravle62c5a372018-02-01 17:03:23 +00001805 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1806 }
1807 }
1808
Victor Hsieh8948a862020-08-07 11:30:55 -07001809 std::string jitzygote_flag = server_configurable_flags::GetServerConfigurableFlag(
1810 RUNTIME_NATIVE_BOOT_NAMESPACE,
1811 ENABLE_JITZYGOTE_IMAGE,
1812 /*default_value=*/ "");
1813 bool use_jitzygote_image = jitzygote_flag == "true" || IsBootClassPathProfilingEnable();
1814
Victor Hsiehe98e6512020-08-10 15:39:22 -07001815 // Decide whether to use dex2oat64.
1816 bool use_dex2oat64 = false;
1817 // Check whether the device even supports 64-bit ABIs.
1818 if (!GetProperty("ro.product.cpu.abilist64", "").empty()) {
1819 use_dex2oat64 = GetBoolProperty("dalvik.vm.dex2oat64.enabled", false);
1820 }
1821 const char* dex2oat_bin = select_execution_binary(
1822 (use_dex2oat64 ? kDex2oat64Path : kDex2oat32Path),
1823 (use_dex2oat64 ? kDex2oatDebug64Path : kDex2oatDebug32Path),
1824 background_job_compile);
1825
Victor Hsiehc9821f12020-08-07 11:32:29 -07001826 auto execv_helper = std::make_unique<ExecVHelper>();
1827
Andreas Gampe023b2242018-02-28 16:03:25 -08001828 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001829
Victor Hsiehc9821f12020-08-07 11:32:29 -07001830 RunDex2Oat runner(dex2oat_bin, execv_helper.get());
Victor Hsiehcb35a062020-08-13 16:11:13 -07001831 runner.Initialize(out_oat,
1832 out_vdex,
1833 out_image,
1834 in_dex,
1835 in_vdex,
1836 dex_metadata,
1837 reference_profile,
1838 class_loader_context,
1839 join_fds(context_input_fds),
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001840 swap_fd.get(),
1841 instruction_set,
1842 compiler_filter,
1843 debuggable,
1844 boot_complete,
Patrick Baumann2271b3e2020-04-14 17:03:00 -07001845 for_restore,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001846 target_sdk_version,
1847 enable_hidden_api_checks,
1848 generate_compact_dex,
Victor Hsieh8948a862020-08-07 11:30:55 -07001849 use_jitzygote_image,
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001850 compilation_reason);
1851
Jeff Sharkey90aff262016-12-12 14:28:24 -07001852 pid_t pid = fork();
1853 if (pid == 0) {
Wei Wange0dbd9b2020-12-11 17:24:19 +00001854 // Need to set schedpolicy before dropping privileges
1855 // for cgroup migration. See details at b/175178520.
1856 SetDex2OatScheduling(boot_complete);
1857
Jeff Sharkey90aff262016-12-12 14:28:24 -07001858 /* child -- drop privileges before continuing */
1859 drop_capabilities(uid);
1860
Victor Hsiehcb35a062020-08-13 16:11:13 -07001861 if (flock(out_oat.fd(), LOCK_EX | LOCK_NB) != 0) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02001862 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG, "flock(%s) failed",
1863 out_oat.path().c_str());
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001864 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001865 }
1866
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001867 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001868 } else {
1869 int res = wait_child(pid);
1870 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001871 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001872 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001873 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1874 << std::hex << std::setw(4) << res << ", process failed";
1875 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001876 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001877 }
1878 }
1879
Jeff Sharkey90aff262016-12-12 14:28:24 -07001880 // We've been successful, don't delete output.
Victor Hsiehcb35a062020-08-13 16:11:13 -07001881 out_oat.DisableCleanup();
1882 out_vdex.DisableCleanup();
1883 out_image.DisableCleanup();
1884 reference_profile.DisableCleanup();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001885
1886 return 0;
1887}
1888
Calin Juravlec9eab382017-01-25 01:17:17 -08001889// Try to remove the given directory. Log an error if the directory exists
1890// and is empty but could not be removed.
1891static bool rmdir_if_empty(const char* dir) {
1892 if (rmdir(dir) == 0) {
1893 return true;
1894 }
1895 if (errno == ENOENT || errno == ENOTEMPTY) {
1896 return true;
1897 }
1898 PLOG(ERROR) << "Failed to remove dir: " << dir;
1899 return false;
1900}
1901
1902// Try to unlink the given file. Log an error if the file exists and could not
1903// be unlinked.
1904static bool unlink_if_exists(const std::string& file) {
1905 if (unlink(file.c_str()) == 0) {
1906 return true;
1907 }
1908 if (errno == ENOENT) {
1909 return true;
1910
1911 }
1912 PLOG(ERROR) << "Could not unlink: " << file;
1913 return false;
1914}
1915
Calin Juravle7d765462017-09-04 15:57:10 -07001916enum ReconcileSecondaryDexResult {
1917 kReconcileSecondaryDexExists = 0,
1918 kReconcileSecondaryDexCleanedUp = 1,
1919 kReconcileSecondaryDexValidationError = 2,
1920 kReconcileSecondaryDexCleanUpError = 3,
1921 kReconcileSecondaryDexAccessIOError = 4,
1922};
Calin Juravlec9eab382017-01-25 01:17:17 -08001923
1924// Reconcile the secondary dex 'dex_path' and its generated oat files.
1925// Return true if all the parameters are valid and the secondary dex file was
1926// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1927// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1928// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1929// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1930// Return false if there were errors during processing. In this case
1931// out_secondary_dex_exists will be set to false.
1932bool reconcile_secondary_dex_file(const std::string& dex_path,
1933 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09001934 const std::optional<std::string>& volume_uuid, int storage_flag,
Calin Juravlec9eab382017-01-25 01:17:17 -08001935 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07001936 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08001937 if (isas.size() == 0) {
1938 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1939 return false;
1940 }
1941
Calin Juravle7d765462017-09-04 15:57:10 -07001942 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
1943 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
1944 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08001945 return false;
1946 }
1947
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001948 // As a security measure we want to unlink art artifacts with the reduced capabilities
1949 // of the package user id. So we fork and drop capabilities in the child.
1950 pid_t pid = fork();
1951 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07001952 /* child -- drop privileges before continuing */
1953 drop_capabilities(uid);
1954
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09001955 const char* volume_uuid_cstr = volume_uuid ? volume_uuid->c_str() : nullptr;
Greg Kaiser8042c372019-03-26 06:23:19 -07001956 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr,
Calin Juravle7d765462017-09-04 15:57:10 -07001957 uid, storage_flag)) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02001958 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
1959 "Could not validate secondary dex path %s", dex_path.c_str());
Calin Juravle7d765462017-09-04 15:57:10 -07001960 _exit(kReconcileSecondaryDexValidationError);
1961 }
1962
1963 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
1964 switch (access_check) {
1965 case kSecondaryDexAccessDoesNotExist:
1966 // File does not exist. Proceed with cleaning.
1967 break;
1968 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
1969 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
1970 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
1971 default:
Martijn Coenen6de402a2021-04-26 16:23:40 +02001972 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
1973 "Unexpected result from check_secondary_dex_access: %d", access_check);
Calin Juravle7d765462017-09-04 15:57:10 -07001974 _exit(kReconcileSecondaryDexValidationError);
1975 }
1976
1977 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001978 char oat_path[PKG_PATH_MAX];
1979 char oat_dir[PKG_PATH_MAX];
1980 char oat_isa_dir[PKG_PATH_MAX];
1981 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001982 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001983 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07001984 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001985 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02001986 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG, "%s", error_msg.c_str());
Calin Juravle7d765462017-09-04 15:57:10 -07001987 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001988 }
Calin Juravle51314092017-05-18 15:33:05 -07001989
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001990 // Delete oat/vdex/art files.
1991 result = unlink_if_exists(oat_path) && result;
1992 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
1993 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08001994
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001995 // Delete profiles.
1996 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08001997 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001998 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08001999 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002000 result = unlink_if_exists(current_profile) && result;
2001 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002002
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002003 // We upgraded once the location of current profile for secondary dex files.
2004 // Check for any previous left-overs and remove them as well.
2005 std::string old_current_profile = dex_path + ".prof";
2006 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002007
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002008 // Try removing the directories as well, they might be empty.
2009 result = rmdir_if_empty(oat_isa_dir) && result;
2010 result = rmdir_if_empty(oat_dir) && result;
2011 }
Calin Juravle7d765462017-09-04 15:57:10 -07002012 if (!result) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02002013 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
2014 "Could not validate secondary dex path %s", dex_path.c_str());
Calin Juravle7d765462017-09-04 15:57:10 -07002015 }
2016 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002017 }
2018
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002019 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002020 if (!WIFEXITED(return_code)) {
2021 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2022 } else {
2023 return_code = WEXITSTATUS(return_code);
2024 }
2025
2026 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2027
2028 switch (return_code) {
2029 case kReconcileSecondaryDexCleanedUp:
2030 case kReconcileSecondaryDexValidationError:
2031 // If we couldn't validate assume the dex file does not exist.
2032 // This will purge the entry from the PM records.
2033 *out_secondary_dex_exists = false;
2034 return true;
2035 case kReconcileSecondaryDexExists:
2036 *out_secondary_dex_exists = true;
2037 return true;
2038 case kReconcileSecondaryDexAccessIOError:
2039 // We had an access IO error.
2040 // Return false so that we can try again.
2041 // The value of out_secondary_dex_exists does not matter in this case and by convention
2042 // is set to false.
2043 *out_secondary_dex_exists = false;
2044 return false;
2045 default:
2046 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2047 *out_secondary_dex_exists = false;
2048 return false;
2049 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002050}
2051
Alan Stokesa25d90c2017-10-16 10:56:00 +01002052// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2053// Returns true if all parameters are valid and the hash successfully computed and stored in
2054// out_secondary_dex_hash.
2055// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2056// the app.
2057// For any other errors (e.g. if any of the parameters are invalid) returns false.
2058bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002059 const std::optional<std::string>& volume_uuid, int storage_flag,
Alan Stokesa25d90c2017-10-16 10:56:00 +01002060 std::vector<uint8_t>* out_secondary_dex_hash) {
2061 out_secondary_dex_hash->clear();
2062
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002063 const char* volume_uuid_cstr = volume_uuid ? volume_uuid->c_str() : nullptr;
Alan Stokesa25d90c2017-10-16 10:56:00 +01002064
2065 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2066 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2067 << storage_flag;
2068 return false;
2069 }
2070
2071 // Pipe to get the hash result back from our child process.
2072 unique_fd pipe_read, pipe_write;
2073 if (!Pipe(&pipe_read, &pipe_write)) {
2074 PLOG(ERROR) << "Failed to create pipe";
2075 return false;
2076 }
2077
2078 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2079 // access data the app itself can access.
2080 pid_t pid = fork();
2081 if (pid == 0) {
2082 // child -- drop privileges before continuing
2083 drop_capabilities(uid);
2084 pipe_read.reset();
2085
2086 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02002087 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
2088 "Could not validate secondary dex path %s", dex_path.c_str());
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002089 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002090 }
2091
2092 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2093 if (fd == -1) {
2094 if (errno == EACCES || errno == ENOENT) {
2095 // Not treated as an error.
2096 _exit(0);
2097 }
2098 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Martijn Coenen6de402a2021-04-26 16:23:40 +02002099 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
2100 "Failed to open secondary dex %s: %d", dex_path.c_str(), errno);
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002101 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002102 }
2103
2104 SHA256_CTX ctx;
2105 SHA256_Init(&ctx);
2106
2107 std::vector<uint8_t> buffer(65536);
2108 while (true) {
2109 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2110 if (bytes_read == 0) {
2111 break;
2112 } else if (bytes_read == -1) {
Martijn Coenen6de402a2021-04-26 16:23:40 +02002113 async_safe_format_log(ANDROID_LOG_ERROR, LOG_TAG,
2114 "Failed to read secondary dex %s: %d", dex_path.c_str(), errno);
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002115 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002116 }
2117
2118 SHA256_Update(&ctx, buffer.data(), bytes_read);
2119 }
2120
2121 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2122 SHA256_Final(hash.data(), &ctx);
2123 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002124 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002125 }
2126
2127 _exit(0);
2128 }
2129
2130 // parent
2131 pipe_write.reset();
2132
2133 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2134 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2135 out_secondary_dex_hash->clear();
2136 }
2137 return wait_child(pid) == 0;
2138}
2139
Jeff Sharkey90aff262016-12-12 14:28:24 -07002140// Helper for move_ab, so that we can have common failure-case cleanup.
2141static bool unlink_and_rename(const char* from, const char* to) {
2142 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2143 // return a failure.
2144 struct stat s;
2145 if (stat(to, &s) == 0) {
2146 if (!S_ISREG(s.st_mode)) {
2147 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2148 return false;
2149 }
2150 if (unlink(to) != 0) {
2151 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2152 return false;
2153 }
2154 } else {
2155 // This may be a permission problem. We could investigate the error code, but we'll just
2156 // let the rename failure do the work for us.
2157 }
2158
2159 // Try to rename "to" to "from."
2160 if (rename(from, to) != 0) {
2161 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2162 return false;
2163 }
2164 return true;
2165}
2166
2167// Move/rename a B artifact (from) to an A artifact (to).
2168static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2169 // Check whether B exists.
2170 {
2171 struct stat s;
2172 if (stat(b_path.c_str(), &s) != 0) {
Alex Light9f295662021-02-25 11:50:33 -08002173 // Ignore for now. The service calling this isn't smart enough to
2174 // understand lack of artifacts at the moment.
2175 LOG(VERBOSE) << "A/B artifact " << b_path << " does not exist!";
Jeff Sharkey90aff262016-12-12 14:28:24 -07002176 return false;
2177 }
2178 if (!S_ISREG(s.st_mode)) {
2179 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2180 // Try to unlink, but swallow errors.
2181 unlink(b_path.c_str());
2182 return false;
2183 }
2184 }
2185
2186 // Rename B to A.
2187 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2188 // Delete the b_path so we don't try again (or fail earlier).
2189 if (unlink(b_path.c_str()) != 0) {
2190 PLOG(ERROR) << "Could not unlink " << b_path;
2191 }
2192
2193 return false;
2194 }
2195
2196 return true;
2197}
2198
2199bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2200 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002201 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2202 if (slot_suffix.empty()) {
2203 return false;
2204 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002205
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002206 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2207 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2208 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002209 }
2210
2211 // Validate other inputs.
2212 if (validate_apk_path(apk_path) != 0) {
2213 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2214 return false;
2215 }
2216 if (validate_apk_path(oat_dir) != 0) {
2217 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2218 return false;
2219 }
2220
2221 char a_path[PKG_PATH_MAX];
2222 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2223 return false;
2224 }
2225 const std::string a_vdex_path = create_vdex_filename(a_path);
2226 const std::string a_image_path = create_image_filename(a_path);
2227
2228 // B path = A path + slot suffix.
2229 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2230 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2231 const std::string b_image_path = StringPrintf("%s.%s",
2232 a_image_path.c_str(),
2233 slot_suffix.c_str());
2234
2235 bool success = true;
2236 if (move_ab_path(b_path, a_path)) {
2237 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2238 // Note: we can live without an app image. As such, ignore failure to move the image file.
2239 // If we decide to require the app image, or the app image being moved correctly,
2240 // then change accordingly.
2241 constexpr bool kIgnoreAppImageFailure = true;
2242
2243 if (!a_image_path.empty()) {
2244 if (!move_ab_path(b_image_path, a_image_path)) {
2245 unlink(a_image_path.c_str());
2246 if (!kIgnoreAppImageFailure) {
2247 success = false;
2248 }
2249 }
2250 }
2251 } else {
2252 // Cleanup: delete B image, ignore errors.
2253 unlink(b_image_path.c_str());
2254 success = false;
2255 }
2256 } else {
2257 // Cleanup: delete B image, ignore errors.
2258 unlink(b_vdex_path.c_str());
2259 unlink(b_image_path.c_str());
2260 success = false;
2261 }
2262 return success;
2263}
2264
Calin Juravle0f3beba2021-06-11 09:17:20 -07002265int64_t delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002266 // Delete the oat/odex file.
2267 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002268 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002269 /*is_secondary_dex*/false, out_path)) {
Calin Juravle0f3beba2021-06-11 09:17:20 -07002270 LOG(ERROR) << "Cannot create apk path for " << apk_path;
2271 return -1;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002272 }
2273
2274 // In case of a permission failure report the issue. Otherwise just print a warning.
Calin Juravle0f3beba2021-06-11 09:17:20 -07002275 auto unlink_and_check = [](const char* path) -> int64_t {
2276 struct stat file_stat;
2277 if (stat(path, &file_stat) != 0) {
2278 if (errno != ENOENT) {
2279 PLOG(ERROR) << "Could not stat " << path;
2280 return -1;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002281 }
Calin Juravle0f3beba2021-06-11 09:17:20 -07002282 return 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002283 }
Calin Juravle0f3beba2021-06-11 09:17:20 -07002284
2285 if (unlink(path) != 0) {
2286 if (errno != ENOENT) {
2287 PLOG(ERROR) << "Could not unlink " << path;
2288 return -1;
2289 }
2290 }
2291 return static_cast<int64_t>(file_stat.st_size);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002292 };
2293
2294 // Delete the oat/odex file.
Calin Juravle0f3beba2021-06-11 09:17:20 -07002295 int64_t return_value_oat = unlink_and_check(out_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002296
2297 // Derive and delete the app image.
Calin Juravle0f3beba2021-06-11 09:17:20 -07002298 int64_t return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -07002299
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002300 // Derive and delete the vdex file.
Calin Juravle0f3beba2021-06-11 09:17:20 -07002301 int64_t return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002302
Calin Juravle0f3beba2021-06-11 09:17:20 -07002303 // Report result
2304 if (return_value_oat == -1
2305 || return_value_art == -1
2306 || return_value_vdex == -1) {
2307 return -1;
2308 }
2309
2310 return return_value_oat + return_value_art + return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002311}
2312
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002313static bool is_absolute_path(const std::string& path) {
2314 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2315 LOG(ERROR) << "Invalid absolute path " << path;
2316 return false;
2317 } else {
2318 return true;
2319 }
2320}
2321
2322static bool is_valid_instruction_set(const std::string& instruction_set) {
2323 // TODO: add explicit whitelisting of instruction sets
2324 if (instruction_set.find('/') != std::string::npos) {
2325 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2326 return false;
2327 } else {
2328 return true;
2329 }
2330}
2331
2332bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2333 const char *apk_path, const char *instruction_set) {
2334 std::string oat_dir_ = oat_dir;
2335 std::string apk_path_ = apk_path;
2336 std::string instruction_set_ = instruction_set;
2337
2338 if (!is_absolute_path(oat_dir_)) return false;
2339 if (!is_absolute_path(apk_path_)) return false;
2340 if (!is_valid_instruction_set(instruction_set_)) return false;
2341
2342 std::string::size_type end = apk_path_.rfind('.');
2343 std::string::size_type start = apk_path_.rfind('/', end);
2344 if (end == std::string::npos || start == std::string::npos) {
2345 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2346 return false;
2347 }
2348
2349 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2350 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2351 const char* res = res_.c_str();
2352 if (strlen(res) >= PKG_PATH_MAX) {
2353 LOG(ERROR) << "Result too large";
2354 return false;
2355 } else {
2356 strlcpy(path, res, PKG_PATH_MAX);
2357 return true;
2358 }
2359}
2360
2361bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2362 const char *instruction_set) {
2363 std::string apk_path_ = apk_path;
2364 std::string instruction_set_ = instruction_set;
2365
2366 if (!is_absolute_path(apk_path_)) return false;
2367 if (!is_valid_instruction_set(instruction_set_)) return false;
2368
2369 std::string::size_type end = apk_path_.rfind('.');
2370 std::string::size_type start = apk_path_.rfind('/', end);
2371 if (end == std::string::npos || start == std::string::npos) {
2372 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2373 return false;
2374 }
2375
2376 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2377 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2378}
2379
2380bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2381 const char *instruction_set) {
2382 std::string src_ = src;
2383 std::string instruction_set_ = instruction_set;
2384
2385 if (!is_absolute_path(src_)) return false;
2386 if (!is_valid_instruction_set(instruction_set_)) return false;
2387
2388 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2389 if (*it == '/') {
2390 *it = '@';
2391 }
2392 }
2393
2394 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2395 + DALVIK_CACHE_POSTFIX;
2396 const char* res = res_.c_str();
2397 if (strlen(res) >= PKG_PATH_MAX) {
2398 LOG(ERROR) << "Result too large";
2399 return false;
2400 } else {
2401 strlcpy(path, res, PKG_PATH_MAX);
2402 return true;
2403 }
2404}
2405
Calin Juravle59f7ab82018-04-27 17:50:23 -07002406bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2407 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002408 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2409 for (const std::string& elem : classpaths_elems) {
2410 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2411 if (fd < 0) {
2412 PLOG(ERROR) << "Could not open classpath elem " << elem;
2413 return false;
2414 } else {
2415 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002416 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002417 }
2418 }
2419 return true;
2420}
2421
2422static bool create_app_profile_snapshot(int32_t app_id,
2423 const std::string& package_name,
2424 const std::string& profile_name,
2425 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002426 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2427
Calin Juravle824a64d2018-01-18 20:23:17 -08002428 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002429 if (snapshot_fd < 0) {
2430 return false;
2431 }
2432
2433 std::vector<unique_fd> profiles_fd;
2434 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002435 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2436 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002437 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2438 return false;
2439 }
2440
2441 profiles_fd.push_back(std::move(reference_profile_fd));
2442
Calin Juravle0d0a4922018-01-23 19:54:11 -08002443 // Open the class paths elements. These will be used to filter out profile data that does
2444 // not belong to the classpath during merge.
2445 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002446 std::vector<std::string> dex_locations;
2447 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002448 return false;
2449 }
2450
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002451 RunProfman args;
Calin Juravlef85ddb92020-05-01 14:05:40 -07002452 // This is specifically a snapshot for an app, so don't use boot image profiles.
2453 args.SetupMerge(profiles_fd,
2454 snapshot_fd,
2455 apk_fds,
2456 dex_locations,
2457 /* for_snapshot= */ true,
2458 /* for_boot_image= */ false);
Calin Juravle29591732017-11-20 17:46:19 -08002459 pid_t pid = fork();
2460 if (pid == 0) {
2461 /* child -- drop privileges before continuing */
2462 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002463 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002464 }
2465
2466 /* parent */
2467 int return_code = wait_child(pid);
2468 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002469 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002470 return false;
2471 }
2472
Calin Juravle78728f32019-11-08 17:55:46 -08002473 // Verify that profman finished successfully.
2474 int profman_code = WEXITSTATUS(return_code);
2475 if (profman_code != PROFMAN_BIN_RETURN_CODE_SUCCESS) {
2476 LOG(WARNING) << "profman error for " << package_name << ":" << profile_name
2477 << ":" << profman_code;
2478 return false;
2479 }
Calin Juravle29591732017-11-20 17:46:19 -08002480 return true;
2481}
2482
Calin Juravle0d0a4922018-01-23 19:54:11 -08002483static bool create_boot_image_profile_snapshot(const std::string& package_name,
2484 const std::string& profile_name,
2485 const std::string& classpath) {
2486 // The reference profile directory for the android package might not be prepared. Do it now.
2487 const std::string ref_profile_dir =
2488 create_primary_reference_profile_package_dir_path(package_name);
2489 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2490 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2491 return false;
2492 }
2493
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002494 // Return false for empty class path since it may otherwise return true below if profiles is
2495 // empty.
2496 if (classpath.empty()) {
2497 PLOG(ERROR) << "Class path is empty";
2498 return false;
2499 }
2500
Calin Juravle0d0a4922018-01-23 19:54:11 -08002501 // Open and create the snapshot profile.
2502 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2503
2504 // Collect all non empty profiles.
2505 // The collection will traverse all applications profiles and find the non empty files.
2506 // This has the potential of inspecting a large number of files and directories (depending
2507 // on the number of applications and users). So there is a slight increase in the chance
2508 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2509 // fail the snapshot and aggregate whatever profile we could open.
2510 //
2511 // The profile snapshot is a best effort based on available data it's ok if some data
2512 // from some apps is missing. It will be counter productive for the snapshot to fail
2513 // because we could not open or read some of the files.
2514 std::vector<std::string> profiles;
2515 if (!collect_profiles(&profiles)) {
2516 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2517 }
2518
2519 // If we have no profiles return early.
2520 if (profiles.empty()) {
2521 return true;
2522 }
2523
2524 // Open the classpath elements. These will be used to filter out profile data that does
2525 // not belong to the classpath during merge.
2526 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002527 std::vector<std::string> dex_locations;
2528 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002529 return false;
2530 }
2531
2532 // If we could not open any files from the classpath return an error.
2533 if (apk_fds.empty()) {
2534 LOG(ERROR) << "Could not open any of the classpath elements.";
2535 return false;
2536 }
2537
2538 // Aggregate the profiles in batches of kAggregationBatchSize.
2539 // We do this to avoid opening a huge a amount of files.
2540 static constexpr size_t kAggregationBatchSize = 10;
2541
Calin Juravle0d0a4922018-01-23 19:54:11 -08002542 for (size_t i = 0; i < profiles.size(); ) {
Calin Juravlea64fb512019-11-06 16:11:14 -08002543 std::vector<unique_fd> profiles_fd;
Calin Juravle0d0a4922018-01-23 19:54:11 -08002544 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
Calin Juravle31c68e72021-06-03 18:16:54 -07002545 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY, /*mode=*/ 0);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002546 if (fd.get() >= 0) {
2547 profiles_fd.push_back(std::move(fd));
2548 }
2549 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002550
2551 // We aggregate (read & write) into the same fd multiple times in a row.
2552 // We need to reset the cursor every time to ensure we read the whole file every time.
2553 if (TEMP_FAILURE_RETRY(lseek(snapshot_fd, 0, SEEK_SET)) == static_cast<off_t>(-1)) {
2554 PLOG(ERROR) << "Cannot reset position for snapshot profile";
2555 return false;
2556 }
2557
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002558 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002559 args.SetupMerge(profiles_fd,
2560 snapshot_fd,
2561 apk_fds,
Calin Juravle78728f32019-11-08 17:55:46 -08002562 dex_locations,
2563 /*for_snapshot=*/true,
2564 /*for_boot_image=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002565 pid_t pid = fork();
2566 if (pid == 0) {
2567 /* child -- drop privileges before continuing */
2568 drop_capabilities(AID_SYSTEM);
2569
Calin Juravle59f7ab82018-04-27 17:50:23 -07002570 // The introduction of new access flags into boot jars causes them to
2571 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002572 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002573 }
2574
2575 /* parent */
2576 int return_code = wait_child(pid);
Calin Juravlea64fb512019-11-06 16:11:14 -08002577
Calin Juravle0d0a4922018-01-23 19:54:11 -08002578 if (!WIFEXITED(return_code)) {
2579 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2580 return false;
2581 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002582
2583 // Verify that profman finished successfully.
2584 int profman_code = WEXITSTATUS(return_code);
Calin Juravle78728f32019-11-08 17:55:46 -08002585 if (profman_code != PROFMAN_BIN_RETURN_CODE_SUCCESS) {
2586 LOG(WARNING) << "profman error for " << package_name << ":" << profile_name
2587 << ":" << profman_code;
2588 return false;
Calin Juravlea64fb512019-11-06 16:11:14 -08002589 }
Calin Juravle0d0a4922018-01-23 19:54:11 -08002590 }
Calin Juravlea64fb512019-11-06 16:11:14 -08002591
Calin Juravle0d0a4922018-01-23 19:54:11 -08002592 return true;
2593}
2594
2595bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2596 const std::string& profile_name, const std::string& classpath) {
2597 if (app_id == -1) {
2598 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2599 } else {
2600 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2601 }
2602}
2603
Calin Juravlec3b049e2018-01-18 22:32:58 -08002604bool prepare_app_profile(const std::string& package_name,
2605 userid_t user_id,
2606 appid_t app_id,
2607 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002608 const std::string& code_path,
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002609 const std::optional<std::string>& dex_metadata) {
Calin Juravlec3b049e2018-01-18 22:32:58 -08002610 // Prepare the current profile.
2611 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2612 /*is_secondary_dex*/ false);
2613 uid_t uid = multiuser_get_uid(user_id, app_id);
2614 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2615 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2616 return false;
2617 }
2618
2619 // Check if we need to install the profile from the dex metadata.
Jooyung Han9fcc4ef2020-01-23 12:45:10 +09002620 if (!dex_metadata) {
Calin Juravlec3b049e2018-01-18 22:32:58 -08002621 return true;
2622 }
2623
2624 // We have a dex metdata. Merge the profile into the reference profile.
2625 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2626 /*read_write*/ true, /*is_secondary_dex*/ false);
2627 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2628 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002629 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2630 if (apk_fd < 0) {
2631 PLOG(ERROR) << "Could not open code path " << code_path;
2632 return false;
2633 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002634
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002635 RunProfman args;
2636 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2637 std::move(ref_profile_fd),
2638 std::move(apk_fd),
2639 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002640 pid_t pid = fork();
2641 if (pid == 0) {
2642 /* child -- drop privileges before continuing */
2643 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2644 drop_capabilities(app_shared_gid);
2645
Calin Juravlef63d4792018-01-30 17:43:34 +00002646 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002647 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002648 }
2649
2650 /* parent */
2651 int return_code = wait_child(pid);
2652 if (!WIFEXITED(return_code)) {
2653 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2654 return false;
2655 }
2656 return true;
2657}
2658
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002659} // namespace installd
2660} // namespace android