blob: acc06471b560e06a5216787ed1f478784fde1e17 [file] [log] [blame]
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Alan Stokescb27c342018-04-20 17:09:25 +010016#define LOG_TAG "installd"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070017
Alan Stokesa25d90c2017-10-16 10:56:00 +010018#include <array>
Jeff Sharkey90aff262016-12-12 14:28:24 -070019#include <fcntl.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070020#include <stdlib.h>
21#include <string.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070022#include <sys/capability.h>
23#include <sys/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070024#include <sys/stat.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070025#include <sys/time.h>
26#include <sys/types.h>
27#include <sys/resource.h>
28#include <sys/wait.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070029#include <unistd.h>
30
Andreas Gampe023b2242018-02-28 16:03:25 -080031#include <iomanip>
32
Alan Stokesa25d90c2017-10-16 10:56:00 +010033#include <android-base/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070034#include <android-base/logging.h>
Andreas Gampe6a9cf722017-07-24 16:49:10 -070035#include <android-base/properties.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070036#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070037#include <android-base/strings.h>
38#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080039#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070040#include <cutils/properties.h>
41#include <cutils/sched_policy.h>
Andreas Gampefa2dadd2018-02-28 19:52:47 -080042#include <dex2oat_return_codes.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>
Jeff Sharkey90aff262016-12-12 14:28:24 -070048#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070049
50#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080051#include "dexopt_return_codes.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060052#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070053#include "installd_deps.h"
54#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070055#include "utils.h"
56
Jeff Sharkey90aff262016-12-12 14:28:24 -070057using android::base::EndsWith;
Mathieu Chartier9b2da082018-10-26 13:23:11 -070058using android::base::GetBoolProperty;
59using android::base::GetProperty;
Alan Stokesa25d90c2017-10-16 10:56:00 +010060using android::base::ReadFully;
61using android::base::StringPrintf;
62using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080063using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070064
65namespace android {
66namespace installd {
67
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070068// Should minidebug info be included in compiled artifacts? Even if this value is
69// "true," usage might still be conditional to other constraints, e.g., system
70// property overrides.
71static constexpr bool kEnableMinidebugInfo = true;
72
73static constexpr const char* kMinidebugInfoSystemProperty = "dalvik.vm.dex2oat-minidebuginfo";
74static constexpr bool kMinidebugInfoSystemPropertyDefault = false;
75static constexpr const char* kMinidebugDex2oatFlag = "--generate-mini-debug-info";
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -080076static constexpr const char* kDisableCompactDexFlag = "--compact-dex-level=none";
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070077
Andreas Gampefa2dadd2018-02-28 19:52:47 -080078
Calin Juravle114f0812017-03-08 19:05:07 -080079// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
80struct FreeDelete {
81 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
82 void operator()(const void* ptr) const {
83 free(const_cast<void*>(ptr));
84 }
85};
86
87// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
88template <typename T>
89using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
90
Calin Juravle1a0af3b2017-03-09 14:33:33 -080091static unique_fd invalid_unique_fd() {
92 return unique_fd(-1);
93}
94
Andreas Gampe6a9cf722017-07-24 16:49:10 -070095static bool is_debug_runtime() {
96 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
97}
98
David Sehra3b5ab62017-10-25 14:27:29 -070099static bool is_debuggable_build() {
100 return android::base::GetBoolProperty("ro.debuggable", false);
101}
102
Jeff Sharkey90aff262016-12-12 14:28:24 -0700103static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800104 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700105 if (ufd.get() < 0) {
106 if (errno != ENOENT) {
107 PLOG(WARNING) << "Could not open profile " << profile;
108 return false;
109 } else {
110 // Nothing to clear. That's ok.
111 return true;
112 }
113 }
114
115 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
116 if (errno != EWOULDBLOCK) {
117 PLOG(WARNING) << "Error locking profile " << profile;
118 }
119 // This implies that the app owning this profile is running
120 // (and has acquired the lock).
121 //
122 // If we can't acquire the lock bail out since clearing is useless anyway
123 // (the app will write again to the profile).
124 //
125 // Note:
126 // This does not impact the this is not an issue for the profiling correctness.
127 // In case this is needed because of an app upgrade, profiles will still be
128 // eventually cleared by the app itself due to checksum mismatch.
129 // If this is needed because profman advised, then keeping the data around
130 // until the next run is again not an issue.
131 //
132 // If the app attempts to acquire a lock while we've held one here,
133 // it will simply skip the current write cycle.
134 return false;
135 }
136
137 bool truncated = ftruncate(ufd.get(), 0) == 0;
138 if (!truncated) {
139 PLOG(WARNING) << "Could not truncate " << profile;
140 }
141 if (flock(ufd.get(), LOCK_UN) != 0) {
142 PLOG(WARNING) << "Error unlocking profile " << profile;
143 }
144 return truncated;
145}
146
Calin Juravle114f0812017-03-08 19:05:07 -0800147// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800148// The location is the profile name for primary apks or the dex path for secondary dex files.
149static bool clear_reference_profile(const std::string& package_name, const std::string& location,
150 bool is_secondary_dex) {
151 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700152}
153
Calin Juravle114f0812017-03-08 19:05:07 -0800154// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800155// The location is the profile name for primary apks or the dex path for secondary dex files.
156static bool clear_current_profile(const std::string& package_name, const std::string& location,
157 userid_t user, bool is_secondary_dex) {
158 return clear_profile(create_current_profile_path(user, package_name, location,
159 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700160}
161
Calin Juravle114f0812017-03-08 19:05:07 -0800162// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800163// The location is the profile name for primary apks or the dex path for secondary dex files.
164bool clear_primary_reference_profile(const std::string& package_name,
165 const std::string& location) {
166 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800167}
168
169// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800170// The location is the profile name for primary apks or the dex path for secondary dex files.
171bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700172 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800173 // 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 -0700174 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
175 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800176 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700177 }
178 return success;
179}
180
Calin Juravle114f0812017-03-08 19:05:07 -0800181// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800182bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
183 userid_t user) {
184 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800185}
186
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700187static std::vector<std::string> SplitBySpaces(const std::string& str) {
188 if (str.empty()) {
189 return {};
190 }
191 return android::base::Split(str, " ");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700192}
193
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700194static const char* get_location_from_path(const char* path) {
195 static constexpr char kLocationSeparator = '/';
196 const char *location = strrchr(path, kLocationSeparator);
Yi Kong954cf642018-07-17 16:16:24 -0700197 if (location == nullptr) {
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700198 return path;
199 } else {
200 // Skip the separator character.
201 return location + 1;
202 }
203}
204
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800205// ExecVHelper prepares and holds pointers to parsed command line arguments so that no allocations
206// need to be performed between the fork and exec.
207class ExecVHelper {
208 public:
209 // Store a placeholder for the binary name.
210 ExecVHelper() : args_(1u, std::string()) {}
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800211
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800212 void PrepareArgs(const std::string& bin) {
213 CHECK(!args_.empty());
214 CHECK(args_[0].empty());
215 args_[0] = bin;
216 // Write char* into array.
217 for (const std::string& arg : args_) {
218 argv_.push_back(arg.c_str());
219 }
220 argv_.push_back(nullptr); // Add null terminator.
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800221 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800222
223 [[ noreturn ]]
224 void Exec(int exit_code) {
225 execv(argv_[0], (char * const *)&argv_[0]);
226 PLOG(ERROR) << "execv(" << argv_[0] << ") failed";
227 exit(exit_code);
228 }
229
230 // Add an arg if it's not empty.
231 void AddArg(const std::string& arg) {
232 if (!arg.empty()) {
233 args_.push_back(arg);
234 }
235 }
236
237 // Add a runtime arg if it's not empty.
238 void AddRuntimeArg(const std::string& arg) {
239 if (!arg.empty()) {
240 args_.push_back("--runtime-arg");
241 args_.push_back(arg);
242 }
243 }
244
245 protected:
246 // Holder arrays for backing arg storage.
247 std::vector<std::string> args_;
248
249 // Argument poiners.
250 std::vector<const char*> argv_;
251};
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700252
253static std::string MapPropertyToArg(const std::string& property,
254 const std::string& format,
255 const std::string& default_value = "") {
256 std::string prop = GetProperty(property, default_value);
257 if (!prop.empty()) {
258 return StringPrintf(format.c_str(), prop.c_str());
259 }
260 return "";
261}
262
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800263class RunDex2Oat : public ExecVHelper {
264 public:
265 RunDex2Oat(int zip_fd,
266 int oat_fd,
267 int input_vdex_fd,
268 int output_vdex_fd,
269 int image_fd,
270 const char* input_file_name,
271 const char* output_file_name,
272 int swap_fd,
273 const char* instruction_set,
274 const char* compiler_filter,
275 bool debuggable,
276 bool post_bootcomplete,
277 bool background_job_compile,
278 int profile_fd,
279 const char* class_loader_context,
280 int target_sdk_version,
281 bool enable_hidden_api_checks,
282 bool generate_compact_dex,
283 int dex_metadata_fd,
284 const char* compilation_reason) {
285 // Get the relative path to the input file.
286 const char* relative_input_file_name = get_location_from_path(input_file_name);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700287
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800288 std::string dex2oat_Xms_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xms", "-Xms%s");
289 std::string dex2oat_Xmx_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xmx", "-Xmx%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700290
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800291 const char* threads_property = post_bootcomplete
292 ? "dalvik.vm.dex2oat-threads"
293 : "dalvik.vm.boot-dex2oat-threads";
294 std::string dex2oat_threads_arg = MapPropertyToArg(threads_property, "-j%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700295
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800296 const std::string dex2oat_isa_features_key =
297 StringPrintf("dalvik.vm.isa.%s.features", instruction_set);
298 std::string instruction_set_features_arg =
299 MapPropertyToArg(dex2oat_isa_features_key, "--instruction-set-features=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700300
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800301 const std::string dex2oat_isa_variant_key =
302 StringPrintf("dalvik.vm.isa.%s.variant", instruction_set);
303 std::string instruction_set_variant_arg =
304 MapPropertyToArg(dex2oat_isa_variant_key, "--instruction-set-variant=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700305
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800306 const char* dex2oat_norelocation = "-Xnorelocate";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700307
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800308 const std::string dex2oat_flags = GetProperty("dalvik.vm.dex2oat-flags", "");
309 std::vector<std::string> dex2oat_flags_args = SplitBySpaces(dex2oat_flags);
310 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700311
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800312 // If we are booting without the real /data, don't spend time compiling.
313 std::string vold_decrypt = GetProperty("vold.decrypt", "");
314 bool skip_compilation = vold_decrypt == "trigger_restart_min_framework" ||
315 vold_decrypt == "1";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700316
Mathieu Chartierd41622c2019-01-31 12:59:39 -0800317 std::string resolve_startup_string_arg =
318 MapPropertyToArg("persist.device_config.runtime.dex2oat_resolve_startup_strings",
319 "--resolve-startup-const-strings=%s");
320 if (resolve_startup_string_arg.empty()) {
321 // If empty, fall back to system property.
322 resolve_startup_string_arg =
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800323 MapPropertyToArg("dalvik.vm.dex2oat-resolve-startup-strings",
324 "--resolve-startup-const-strings=%s");
Mathieu Chartierd41622c2019-01-31 12:59:39 -0800325 }
Mathieu Chartier5880c032018-11-28 19:15:41 -0800326
327 const std::string image_block_size_arg =
328 MapPropertyToArg("dalvik.vm.dex2oat-max-image-block-size",
329 "--max-image-block-size=%s");
330
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800331 const bool generate_debug_info = GetBoolProperty("debug.generate-debug-info", false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700332
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800333 std::string image_format_arg;
334 if (image_fd >= 0) {
335 image_format_arg = MapPropertyToArg("dalvik.vm.appimageformat", "--image-format=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000336 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000337
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800338 std::string dex2oat_large_app_threshold_arg =
339 MapPropertyToArg("dalvik.vm.dex2oat-very-large", "--very-large-app-threshold=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000340
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800341 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
Roland Levillain67a14f62019-01-23 15:59:50 +0000342 const char* dex2oat_bin = kDex2oatPath;
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800343 // Do not use dex2oatd for release candidates (give dex2oat more soak time).
344 bool is_release = android::base::GetProperty("ro.build.version.codename", "") == "REL";
345 if (is_debug_runtime() ||
346 (background_job_compile && is_debuggable_build() && !is_release)) {
347 if (access(kDex2oatDebugPath, X_OK) == 0) {
348 dex2oat_bin = kDex2oatDebugPath;
349 }
350 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000351
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800352 bool generate_minidebug_info = kEnableMinidebugInfo &&
353 GetBoolProperty(kMinidebugInfoSystemProperty, kMinidebugInfoSystemPropertyDefault);
Mathieu Chartier31636522018-11-09 23:53:07 +0000354
Nicolas Geoffray8b3fa972019-02-14 15:57:47 +0000355 std::string boot_image = MapPropertyToArg("dalvik.vm.boot-image", "-Ximage:%s");
356
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800357 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
358 // use arraysize instead.
359 std::string zip_fd_arg = StringPrintf("--zip-fd=%d", zip_fd);
360 std::string zip_location_arg = StringPrintf("--zip-location=%s", relative_input_file_name);
361 std::string input_vdex_fd_arg = StringPrintf("--input-vdex-fd=%d", input_vdex_fd);
362 std::string output_vdex_fd_arg = StringPrintf("--output-vdex-fd=%d", output_vdex_fd);
363 std::string oat_fd_arg = StringPrintf("--oat-fd=%d", oat_fd);
364 std::string oat_location_arg = StringPrintf("--oat-location=%s", output_file_name);
365 std::string instruction_set_arg = StringPrintf("--instruction-set=%s", instruction_set);
366 std::string dex2oat_compiler_filter_arg;
367 std::string dex2oat_swap_fd;
368 std::string dex2oat_image_fd;
369 std::string target_sdk_version_arg;
370 if (target_sdk_version != 0) {
David Brazdilccfb3cf2019-02-20 10:39:34 +0000371 target_sdk_version_arg = StringPrintf("-Xtarget-sdk-version:%d", target_sdk_version);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800372 }
373 std::string class_loader_context_arg;
374 if (class_loader_context != nullptr) {
375 class_loader_context_arg = StringPrintf("--class-loader-context=%s",
376 class_loader_context);
377 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000378
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800379 if (swap_fd >= 0) {
380 dex2oat_swap_fd = StringPrintf("--swap-fd=%d", swap_fd);
381 }
382 if (image_fd >= 0) {
383 dex2oat_image_fd = StringPrintf("--app-image-fd=%d", image_fd);
384 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000385
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800386 // Compute compiler filter.
387 bool have_dex2oat_relocation_skip_flag = false;
388 if (skip_compilation) {
389 dex2oat_compiler_filter_arg = "--compiler-filter=extract";
390 have_dex2oat_relocation_skip_flag = true;
391 } else if (compiler_filter != nullptr) {
392 dex2oat_compiler_filter_arg = StringPrintf("--compiler-filter=%s", compiler_filter);
393 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000394
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800395 if (dex2oat_compiler_filter_arg.empty()) {
396 dex2oat_compiler_filter_arg = MapPropertyToArg("dalvik.vm.dex2oat-filter",
397 "--compiler-filter=%s");
398 }
399
400 // Check whether all apps should be compiled debuggable.
401 if (!debuggable) {
402 debuggable = GetProperty("dalvik.vm.always_debuggable", "") == "1";
403 }
404 std::string profile_arg;
405 if (profile_fd != -1) {
406 profile_arg = StringPrintf("--profile-file-fd=%d", profile_fd);
407 }
408
409 // Get the directory of the apk to pass as a base classpath directory.
410 std::string base_dir;
411 std::string apk_dir(input_file_name);
412 unsigned long dir_index = apk_dir.rfind('/');
413 bool has_base_dir = dir_index != std::string::npos;
414 if (has_base_dir) {
415 apk_dir = apk_dir.substr(0, dir_index);
416 base_dir = StringPrintf("--classpath-dir=%s", apk_dir.c_str());
417 }
418
419 std::string dex_metadata_fd_arg = "--dm-fd=" + std::to_string(dex_metadata_fd);
420
421 std::string compilation_reason_arg = compilation_reason == nullptr
422 ? ""
423 : std::string("--compilation-reason=") + compilation_reason;
424
425 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
426
427 // Disable cdex if update input vdex is true since this combination of options is not
428 // supported.
429 const bool disable_cdex = !generate_compact_dex || (input_vdex_fd == output_vdex_fd);
430
431 AddArg(zip_fd_arg);
432 AddArg(zip_location_arg);
433 AddArg(input_vdex_fd_arg);
434 AddArg(output_vdex_fd_arg);
435 AddArg(oat_fd_arg);
436 AddArg(oat_location_arg);
437 AddArg(instruction_set_arg);
438
439 AddArg(instruction_set_variant_arg);
440 AddArg(instruction_set_features_arg);
441
Nicolas Geoffray8b3fa972019-02-14 15:57:47 +0000442 AddRuntimeArg(boot_image);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800443 AddRuntimeArg(dex2oat_Xms_arg);
444 AddRuntimeArg(dex2oat_Xmx_arg);
445
446 AddArg(resolve_startup_string_arg);
Mathieu Chartier5880c032018-11-28 19:15:41 -0800447 AddArg(image_block_size_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800448 AddArg(dex2oat_compiler_filter_arg);
449 AddArg(dex2oat_threads_arg);
450 AddArg(dex2oat_swap_fd);
451 AddArg(dex2oat_image_fd);
452
453 if (generate_debug_info) {
454 AddArg("--generate-debug-info");
455 }
456 if (debuggable) {
457 AddArg("--debuggable");
458 }
459 AddArg(image_format_arg);
460 AddArg(dex2oat_large_app_threshold_arg);
461
462 if (have_dex2oat_relocation_skip_flag) {
463 AddRuntimeArg(dex2oat_norelocation);
464 }
465 AddArg(profile_arg);
466 AddArg(base_dir);
467 AddArg(class_loader_context_arg);
468 if (generate_minidebug_info) {
469 AddArg(kMinidebugDex2oatFlag);
470 }
471 if (disable_cdex) {
472 AddArg(kDisableCompactDexFlag);
473 }
David Brazdilccfb3cf2019-02-20 10:39:34 +0000474 AddRuntimeArg(target_sdk_version_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800475 if (enable_hidden_api_checks) {
476 AddRuntimeArg("-Xhidden-api-checks");
477 }
478
479 if (dex_metadata_fd > -1) {
480 AddArg(dex_metadata_fd_arg);
481 }
482
483 AddArg(compilation_reason_arg);
484
485 // Do not add args after dex2oat_flags, they should override others for debugging.
486 args_.insert(args_.end(), dex2oat_flags_args.begin(), dex2oat_flags_args.end());
487
488 PrepareArgs(dex2oat_bin);
Mathieu Chartier31636522018-11-09 23:53:07 +0000489 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800490};
Jeff Sharkey90aff262016-12-12 14:28:24 -0700491
492/*
493 * Whether dexopt should use a swap file when compiling an APK.
494 *
495 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
496 * itself, anyways).
497 *
498 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
499 *
500 * Otherwise, return true if this is a low-mem device.
501 *
502 * Otherwise, return default value.
503 */
504static bool kAlwaysProvideSwapFile = false;
505static bool kDefaultProvideSwapFile = true;
506
507static bool ShouldUseSwapFileForDexopt() {
508 if (kAlwaysProvideSwapFile) {
509 return true;
510 }
511
512 // Check the "override" property. If it exists, return value == "true".
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700513 std::string dex2oat_prop_buf = GetProperty("dalvik.vm.dex2oat-swap", "");
514 if (!dex2oat_prop_buf.empty()) {
515 return dex2oat_prop_buf == "true";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700516 }
517
518 // Shortcut for default value. This is an implementation optimization for the process sketched
519 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
520 // as low-mem is never returning false. The compiler will optimize this away if it can.
521 if (kDefaultProvideSwapFile) {
522 return true;
523 }
524
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700525 if (GetBoolProperty("ro.config.low_ram", false)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700526 return true;
527 }
528
529 // Default value must be false here.
530 return kDefaultProvideSwapFile;
531}
532
Richard Uhler76cc0272016-12-08 10:46:35 +0000533static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700534 if (set_to_bg) {
535 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800536 PLOG(ERROR) << "set_sched_policy failed";
537 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700538 }
539 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800540 PLOG(ERROR) << "setpriority failed";
541 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700542 }
543 }
544}
545
Calin Juravle29591732017-11-20 17:46:19 -0800546static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
547 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800548 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800549 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800550 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800551 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800552 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700553 }
Calin Juravle114f0812017-03-08 19:05:07 -0800554 // Profiles should belong to the app; make sure of that by giving ownership to
555 // the app uid. If we cannot do that, there's no point in returning the fd
556 // since dex2oat/profman will fail with SElinux denials.
557 if (fchown(fd.get(), uid, uid) < 0) {
558 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800559 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800560 }
Calin Juravle29591732017-11-20 17:46:19 -0800561 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800562}
563
Calin Juravle29591732017-11-20 17:46:19 -0800564static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800565 // Do not follow symlinks when opening a profile:
566 // - primary profiles should not contain symlinks in their paths
567 // - secondary dex paths should have been already resolved and validated
568 flags |= O_NOFOLLOW;
569
Calin Juravle29591732017-11-20 17:46:19 -0800570 // Check if we need to create the profile
571 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
572 unique_fd fd;
573 if ((flags & O_CREAT) != 0) {
574 fd = create_profile(uid, profile, flags);
575 } else {
576 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
577 }
578
Calin Juravle114f0812017-03-08 19:05:07 -0800579 if (fd.get() < 0) {
580 if (errno != ENOENT) {
581 // Profiles might be missing for various reasons. For example, in a
582 // multi-user environment, the profile directory for one user can be created
583 // after we start a merge. In this case the current profile for that user
584 // will not be found.
585 // Also, the secondary dex profiles might be deleted by the app at any time,
586 // so we can't we need to prepare if they are missing.
587 PLOG(ERROR) << "Failed to open profile " << profile;
588 }
589 return invalid_unique_fd();
590 }
591
Jeff Sharkey90aff262016-12-12 14:28:24 -0700592 return fd;
593}
594
Calin Juravle824a64d2018-01-18 20:23:17 -0800595static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
596 const std::string& location, bool is_secondary_dex) {
597 std::string profile = create_current_profile_path(user, package_name, location,
598 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800599 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800600}
601
Calin Juravle824a64d2018-01-18 20:23:17 -0800602static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
603 const std::string& location, bool read_write, bool is_secondary_dex) {
604 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800605 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
606}
607
608static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800609 const std::string& location) {
610 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800611 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800612}
613
Calin Juravle824a64d2018-01-18 20:23:17 -0800614static void open_profile_files(uid_t uid, const std::string& package_name,
615 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800616 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700617 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800618 *reference_profile_fd = open_reference_profile(uid, package_name, location,
619 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700620
Calin Juravle114f0812017-03-08 19:05:07 -0800621 // For secondary dex files, we don't really need the user but we use it for sanity checks.
622 // Note: the user owning the dex file should be the current user.
623 std::vector<userid_t> users;
624 if (is_secondary_dex){
625 users.push_back(multiuser_get_user_id(uid));
626 } else {
627 users = get_known_users(/*volume_uuid*/ nullptr);
628 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700629 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800630 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
631 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700632 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800633 if (profile_fd.get() >= 0) {
634 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700635 }
636 }
637}
638
Jeff Sharkey90aff262016-12-12 14:28:24 -0700639static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
640static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
641static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
642static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
643static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
644
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800645class RunProfman : public ExecVHelper {
646 public:
647 void SetupArgs(const std::vector<unique_fd>& profile_fds,
648 const unique_fd& reference_profile_fd,
649 const std::vector<unique_fd>& apk_fds,
650 const std::vector<std::string>& dex_locations,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800651 bool copy_and_update,
652 bool store_aggregation_counters) {
Roland Levillain67a14f62019-01-23 15:59:50 +0000653 const char* profman_bin = is_debug_runtime() ? kProfmanDebugPath: kProfmanPath;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700654
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800655 if (copy_and_update) {
656 CHECK_EQ(1u, profile_fds.size());
657 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000658 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800659 if (reference_profile_fd != -1) {
660 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000661 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800662
663 for (const unique_fd& fd : profile_fds) {
664 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
665 }
666
667 for (const unique_fd& fd : apk_fds) {
668 AddArg("--apk-fd=" + std::to_string(fd.get()));
669 }
670
671 for (const std::string& dex_location : dex_locations) {
672 AddArg("--dex-location=" + dex_location);
673 }
674
675 if (copy_and_update) {
676 AddArg("--copy-and-update-profile-key");
677 }
678
Calin Juravleb3a929d2018-12-11 14:40:00 -0800679 if (store_aggregation_counters) {
680 AddArg("--store-aggregation-counters");
681 }
682
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800683 // Do not add after dex2oat_flags, they should override others for debugging.
684 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800685 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700686
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800687 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
688 const unique_fd& reference_profile_fd,
689 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravleb3a929d2018-12-11 14:40:00 -0800690 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
691 bool store_aggregation_counters = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800692 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800693 reference_profile_fd,
694 apk_fds,
695 dex_locations,
696 /*copy_and_update=*/false,
697 store_aggregation_counters);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800698 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700699
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800700 void SetupCopyAndUpdate(unique_fd&& profile_fd,
701 unique_fd&& reference_profile_fd,
702 unique_fd&& apk_fd,
703 const std::string& dex_location) {
704 // The fds need to stay open longer than the scope of the function, so put them into a local
705 // variable vector.
706 profiles_fd_.push_back(std::move(profile_fd));
707 apk_fds_.push_back(std::move(apk_fd));
708 reference_profile_fd_ = std::move(reference_profile_fd);
709 std::vector<std::string> dex_locations = {dex_location};
Calin Juravleb3a929d2018-12-11 14:40:00 -0800710 SetupArgs(profiles_fd_,
711 reference_profile_fd_,
712 apk_fds_,
713 dex_locations,
714 /*copy_and_update=*/true,
715 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800716 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000717
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800718 void SetupDump(const std::vector<unique_fd>& profiles_fd,
719 const unique_fd& reference_profile_fd,
720 const std::vector<std::string>& dex_locations,
721 const std::vector<unique_fd>& apk_fds,
722 const unique_fd& output_fd) {
723 AddArg("--dump-only");
724 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800725 SetupArgs(profiles_fd,
726 reference_profile_fd,
727 apk_fds,
728 dex_locations,
729 /*copy_and_update=*/false,
730 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800731 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000732
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800733 void Exec() {
734 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
735 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000736
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800737 private:
738 unique_fd reference_profile_fd_;
739 std::vector<unique_fd> profiles_fd_;
740 std::vector<unique_fd> apk_fds_;
741};
Mathieu Chartier31636522018-11-09 23:53:07 +0000742
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800743
Calin Juravlef63d4792018-01-30 17:43:34 +0000744
Jeff Sharkey90aff262016-12-12 14:28:24 -0700745// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800746// The location is the package name for primary apks or the dex path for secondary dex files.
747// Returns true if there is enough information in the current profiles that makes it
748// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700749// If the return value is true all the current profiles would have been merged into
750// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800751static bool analyze_profiles(uid_t uid, const std::string& package_name,
752 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800753 std::vector<unique_fd> profiles_fd;
754 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800755 open_profile_files(uid, package_name, location, is_secondary_dex,
756 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800757 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700758 // Skip profile guided compilation because no profiles were found.
759 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700760 return false;
761 }
762
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800763 RunProfman profman_merge;
764 profman_merge.SetupMerge(profiles_fd, reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700765 pid_t pid = fork();
766 if (pid == 0) {
767 /* child -- drop privileges before continuing */
768 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800769 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700770 }
771 /* parent */
772 int return_code = wait_child(pid);
773 bool need_to_compile = false;
774 bool should_clear_current_profiles = false;
775 bool should_clear_reference_profile = false;
776 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800777 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700778 } else {
779 return_code = WEXITSTATUS(return_code);
780 switch (return_code) {
781 case PROFMAN_BIN_RETURN_CODE_COMPILE:
782 need_to_compile = true;
783 should_clear_current_profiles = true;
784 should_clear_reference_profile = false;
785 break;
786 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
787 need_to_compile = false;
788 should_clear_current_profiles = false;
789 should_clear_reference_profile = false;
790 break;
791 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800792 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700793 need_to_compile = false;
794 should_clear_current_profiles = true;
795 should_clear_reference_profile = true;
796 break;
797 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
798 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
799 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800800 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700801 need_to_compile = false;
802 should_clear_current_profiles = false;
803 should_clear_reference_profile = false;
804 break;
805 default:
806 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800807 LOG(WARNING) << "Unknown error code while processing profiles for location "
808 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700809 need_to_compile = false;
810 should_clear_current_profiles = true;
811 should_clear_reference_profile = true;
812 break;
813 }
814 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800815
Jeff Sharkey90aff262016-12-12 14:28:24 -0700816 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800817 if (is_secondary_dex) {
818 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800819 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
820 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800821 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800822 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800823 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700824 }
825 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800826 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700827 }
828 return need_to_compile;
829}
830
Calin Juravle114f0812017-03-08 19:05:07 -0800831// Decides if profile guided compilation is needed or not based on existing profiles.
832// The analysis is done for the primary apks of the given package.
833// Returns true if there is enough information in the current profiles that makes it
834// worth to recompile the package.
835// If the return value is true all the current profiles would have been merged into
836// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800837bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
838 const std::string& profile_name) {
839 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800840}
841
Calin Juravle408cd4a2018-01-20 23:34:18 -0800842bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
843 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800844 std::vector<unique_fd> profile_fds;
845 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800846 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
847 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700848
Calin Juravle408cd4a2018-01-20 23:34:18 -0800849 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800850 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700851
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800852 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700853 const bool has_profiles = !profile_fds.empty();
854
855 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800856 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700857 return false;
858 }
859
Calin Juravle114f0812017-03-08 19:05:07 -0800860 unique_fd output_fd(open(out_file_name.c_str(),
861 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700862 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800863 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700864 return false;
865 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800866
Jeff Sharkey90aff262016-12-12 14:28:24 -0700867 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800868 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800869 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
870 if (apk_fd == -1) {
871 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
872 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700873 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800874 dex_locations.push_back(get_location_from_path(code_path.c_str()));
875 apk_fds.push_back(std::move(apk_fd));
876
Jeff Sharkey90aff262016-12-12 14:28:24 -0700877
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800878 RunProfman profman_dump;
879 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700880 pid_t pid = fork();
881 if (pid == 0) {
882 /* child -- drop privileges before continuing */
883 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800884 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700885 }
886 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700887 int return_code = wait_child(pid);
888 if (!WIFEXITED(return_code)) {
889 LOG(WARNING) << "profman failed for package " << pkgname << ": "
890 << return_code;
891 return false;
892 }
893 return true;
894}
895
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700896bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800897 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700898 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
899 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800900 package_name,
901 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700902 /*read_write*/ true,
903 /*secondary*/ false));
904 if (in_fd.get() < 0) {
905 PLOG(WARNING) << "Could not open profile " << system_profile;
906 return false;
907 }
908 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800909 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700910 return false;
911 }
912
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700913 // As a security measure we want to write the profile information with the reduced capabilities
914 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700915 pid_t pid = fork();
916 if (pid == 0) {
917 /* child -- drop privileges before continuing */
918 drop_capabilities(packageUid);
919
920 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
921 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800922 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700923 }
924 // This implies that the app owning this profile is running
925 // (and has acquired the lock).
926 //
927 // The app never acquires the lock for the reference profiles of primary apks.
928 // Only dex2oat from installd will do that. Since installd is single threaded
929 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800930 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700931 return false;
932 }
933
934 bool truncated = ftruncate(out_fd.get(), 0) == 0;
935 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800936 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700937 }
938
939 // Copy over data.
940 static constexpr size_t kBufferSize = 4 * 1024;
941 char buffer[kBufferSize];
942 while (true) {
943 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
944 if (bytes == 0) {
945 break;
946 }
947 write(out_fd.get(), buffer, bytes);
948 }
949 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800950 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700951 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700952 // Use _exit since we don't want to run the global destructors in the child.
953 // b/62597429
954 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700955 }
956 /* parent */
957 int return_code = wait_child(pid);
958 return return_code == 0;
959}
960
Jeff Sharkey90aff262016-12-12 14:28:24 -0700961static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
962 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
963 if (EndsWith(oat_path, ".dex")) {
964 std::string new_path = oat_path;
965 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800966 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700967 return new_path;
968 }
969
970 // An odex entry. Not that this may not be an extension, e.g., in the OTA
971 // case (where the base name will have an extension for the B artifact).
972 size_t odex_pos = oat_path.rfind(".odex");
973 if (odex_pos != std::string::npos) {
974 std::string new_path = oat_path;
975 new_path.replace(odex_pos, strlen(".odex"), new_ext);
976 CHECK_NE(new_path.find(new_ext), std::string::npos);
977 return new_path;
978 }
979
980 // Don't know how to handle this.
981 return "";
982}
983
984// Translate the given oat path to an art (app image) path. An empty string
985// denotes an error.
986static std::string create_image_filename(const std::string& oat_path) {
987 return replace_file_extension(oat_path, ".art");
988}
989
990// Translate the given oat path to a vdex path. An empty string denotes an error.
991static std::string create_vdex_filename(const std::string& oat_path) {
992 return replace_file_extension(oat_path, ".vdex");
993}
994
Jeff Sharkey90aff262016-12-12 14:28:24 -0700995static int open_output_file(const char* file_name, bool recreate, int permissions) {
996 int flags = O_RDWR | O_CREAT;
997 if (recreate) {
998 if (unlink(file_name) < 0) {
999 if (errno != ENOENT) {
1000 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1001 }
1002 }
1003 flags |= O_EXCL;
1004 }
1005 return open(file_name, flags, permissions);
1006}
1007
Calin Juravle2289c0a2017-02-15 12:44:14 -08001008static bool set_permissions_and_ownership(
1009 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1010 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1011 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001012 if (fchmod(fd,
1013 S_IRUSR|S_IWUSR|S_IRGRP |
1014 (is_public ? S_IROTH : 0)) < 0) {
1015 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1016 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001017 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001018 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1019 return false;
1020 }
1021 return true;
1022}
1023
1024static bool IsOutputDalvikCache(const char* oat_dir) {
1025 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1026 // into '!'. Play it safe by handling it both.
1027 // TODO: ensure we never get null.
1028 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1029 return oat_dir == nullptr || oat_dir[0] == '!';
1030}
1031
Calin Juravled23dee72017-07-06 16:29:11 -07001032// Best-effort check whether we can fit the the path into our buffers.
1033// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1034// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1035// extension to the cache path (5 bytes).
1036// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1037static bool validate_dex_path_size(const std::string& dex_path) {
1038 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1039 LOG(ERROR) << "dex_path too long: " << dex_path;
1040 return false;
1041 }
1042 return true;
1043}
1044
Jeff Sharkey90aff262016-12-12 14:28:24 -07001045static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001046 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001047 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001048 return false;
1049 }
1050
1051 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001052 // Oat dirs for secondary dex files are already validated.
1053 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001054 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1055 return false;
1056 }
1057 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1058 return false;
1059 }
1060 } else {
1061 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1062 return false;
1063 }
1064 }
1065 return true;
1066}
1067
1068// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1069// on destruction. It will also run the given cleanup (unless told not to) after closing.
1070//
1071// Usage example:
1072//
Calin Juravle7a570e82017-01-14 16:23:30 -08001073// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001074// [name]() {
1075// unlink(name.c_str());
1076// });
1077// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1078// wrapper if captured as a reference.
1079//
1080// if (file.get() == -1) {
1081// // Error opening...
1082// }
1083//
1084// ...
1085// if (error) {
1086// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1087// // and delete the file (after the fd is closed).
1088// return -1;
1089// }
1090//
1091// (Success case)
1092// file.SetCleanup(false);
1093// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1094// // (leaving the file around; after the fd is closed).
1095//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001096class Dex2oatFileWrapper {
1097 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001098 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001099 }
1100
Calin Juravle7a570e82017-01-14 16:23:30 -08001101 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1102 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1103
1104 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1105 value_ = other.value_;
1106 cleanup_ = other.cleanup_;
1107 do_cleanup_ = other.do_cleanup_;
1108 auto_close_ = other.auto_close_;
1109 other.release();
1110 }
1111
1112 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1113 value_ = other.value_;
1114 cleanup_ = other.cleanup_;
1115 do_cleanup_ = other.do_cleanup_;
1116 auto_close_ = other.auto_close_;
1117 other.release();
1118 return *this;
1119 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001120
1121 ~Dex2oatFileWrapper() {
1122 reset(-1);
1123 }
1124
1125 int get() {
1126 return value_;
1127 }
1128
1129 void SetCleanup(bool cleanup) {
1130 do_cleanup_ = cleanup;
1131 }
1132
1133 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001134 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001135 close(value_);
1136 }
1137 if (do_cleanup_ && cleanup_ != nullptr) {
1138 cleanup_();
1139 }
1140
1141 value_ = new_value;
1142 }
1143
Calin Juravle7a570e82017-01-14 16:23:30 -08001144 void reset(int new_value, std::function<void ()> new_cleanup) {
1145 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001146 close(value_);
1147 }
1148 if (do_cleanup_ && cleanup_ != nullptr) {
1149 cleanup_();
1150 }
1151
1152 value_ = new_value;
1153 cleanup_ = new_cleanup;
1154 }
1155
Calin Juravle7a570e82017-01-14 16:23:30 -08001156 void DisableAutoClose() {
1157 auto_close_ = false;
1158 }
1159
Jeff Sharkey90aff262016-12-12 14:28:24 -07001160 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001161 void release() {
1162 value_ = -1;
1163 do_cleanup_ = false;
1164 cleanup_ = nullptr;
1165 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001166 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001167 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001168 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001169 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001170};
1171
Calin Juravle7a570e82017-01-14 16:23:30 -08001172// (re)Creates the app image if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001173Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path,
1174 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001175
1176 // We don't create an image for secondary dex files.
1177 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001178 return Dex2oatFileWrapper();
1179 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001180
Calin Juravle7a570e82017-01-14 16:23:30 -08001181 const std::string image_path = create_image_filename(out_oat_path);
1182 if (image_path.empty()) {
1183 // Happens when the out_oat_path has an unknown extension.
1184 return Dex2oatFileWrapper();
1185 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001186
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001187 // In case there is a stale image, remove it now. Ignore any error.
1188 unlink(image_path.c_str());
1189
1190 // Not enabled, exit.
1191 if (!generate_app_image) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001192 return Dex2oatFileWrapper();
1193 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -07001194 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
1195 if (app_image_format.empty()) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001196 return Dex2oatFileWrapper();
1197 }
1198 // Recreate is true since we do not want to modify a mapped image. If the app is
1199 // already running and we modify the image file, it can cause crashes (b/27493510).
1200 Dex2oatFileWrapper wrapper_fd(
1201 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1202 [image_path]() { unlink(image_path.c_str()); });
1203 if (wrapper_fd.get() < 0) {
1204 // Could not create application image file. Go on since we can compile without it.
1205 LOG(ERROR) << "installd could not create '" << image_path
1206 << "' for image file during dexopt";
1207 // If we have a valid image file path but no image fd, explicitly erase the image file.
1208 if (unlink(image_path.c_str()) < 0) {
1209 if (errno != ENOENT) {
1210 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1211 }
1212 }
1213 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001214 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001215 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1216 wrapper_fd.reset(-1);
1217 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001218
Calin Juravle7a570e82017-01-14 16:23:30 -08001219 return wrapper_fd;
1220}
1221
1222// Creates the dexopt swap file if necessary and return its fd.
1223// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001224unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001225 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001226 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001227 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001228 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001229 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001230 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001231 if (swap_fd.get() < 0) {
1232 // Could not create swap file. Optimistically go on and hope that we can compile
1233 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001234 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001235 } else {
1236 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001237 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001238 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1239 }
1240 }
1241 return swap_fd;
1242}
1243
1244// Opens the reference profiles if needed.
1245// Note that the reference profile might not exist so it's OK if the fd will be -1.
Calin Juravle114f0812017-03-08 19:05:07 -08001246Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001247 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -08001248 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +00001249 // If we are not profile guided compilation, or we are compiling system server
1250 // do not bother to open the profiles; we won't be using them.
1251 if (!profile_guided || (pkgname[0] == '*')) {
1252 return Dex2oatFileWrapper();
1253 }
1254
1255 // If this is a secondary dex path which is public do not open the profile.
1256 // We cannot compile public secondary dex paths with profiles. That's because
1257 // it will expose how the dex files are used by their owner.
1258 //
1259 // Note that the PackageManager is responsible to set the is_public flag for
1260 // primary apks and we do not check it here. In some cases, e.g. when
1261 // compiling with a public profile from the .dm file the PackageManager will
1262 // set is_public toghether with the profile guided compilation.
1263 if (is_secondary_dex && is_public) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001264 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001265 }
Calin Juravle114f0812017-03-08 19:05:07 -08001266
1267 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001268 std::string location;
1269 if (is_secondary_dex) {
1270 location = dex_path;
1271 } else {
1272 if (profile_name == nullptr) {
1273 // This path is taken for system server re-compilation lunched from ZygoteInit.
1274 return Dex2oatFileWrapper();
1275 } else {
1276 location = profile_name;
1277 }
1278 }
Calin Juravle824a64d2018-01-18 20:23:17 -08001279 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1280 is_secondary_dex);
1281 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1282 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001283 };
1284 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001285}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001286
Calin Juravle7a570e82017-01-14 16:23:30 -08001287// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1288// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001289bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001290 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001291 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001292 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1293 CHECK(in_vdex_wrapper_fd != nullptr);
1294 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001295 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1296 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001297 char in_odex_path[PKG_PATH_MAX];
1298 int dexopt_action = abs(dexopt_needed);
1299 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001300 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001301
1302 // Infer the name of the output VDEX.
1303 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1304 if (out_vdex_path_str.empty()) {
1305 return false;
1306 }
1307
1308 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001309 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001310 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1311 const char* path = nullptr;
1312 if (is_odex_location) {
1313 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1314 path = in_odex_path;
1315 } else {
1316 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001317 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001318 }
1319 } else {
1320 path = out_oat_path;
1321 }
1322 in_vdex_path_str = create_vdex_filename(path);
1323 if (in_vdex_path_str.empty()) {
1324 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001325 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001326 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001327 // We can update in place when all these conditions are met:
1328 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1329 // on /system typically cannot be updated in place).
1330 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1331 // cannot be currently used by a running process.
1332 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1333 // different vdex files to operate.
1334 update_vdex_in_place =
1335 (in_vdex_path_str == out_vdex_path_str) &&
1336 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1337 !profile_guided;
1338 if (update_vdex_in_place) {
1339 // Open the file read-write to be able to update it.
1340 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1341 if (in_vdex_wrapper_fd->get() == -1) {
1342 // If we failed to open the file, we cannot update it in place.
1343 update_vdex_in_place = false;
1344 }
1345 } else {
1346 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1347 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001348 }
1349
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001350 // If we are updating the vdex in place, we do not need to recreate a vdex,
1351 // and can use the same existing one.
1352 if (update_vdex_in_place) {
1353 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1354 // have bogus stale vdex files.
1355 out_vdex_wrapper_fd->reset(
1356 in_vdex_wrapper_fd->get(),
1357 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1358 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1359 // wrapper).
1360 in_vdex_wrapper_fd->DisableAutoClose();
1361 } else {
1362 out_vdex_wrapper_fd->reset(
1363 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1364 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1365 if (out_vdex_wrapper_fd->get() < 0) {
1366 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1367 return false;
1368 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001369 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001370 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001371 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001372 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1373 return false;
1374 }
1375
1376 // If we got here we successfully opened the vdex files.
1377 return true;
1378}
1379
1380// Opens the output oat file for the given apk.
1381// If successful it stores the output path into out_oat_path and returns true.
1382Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001383 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1384 char* out_oat_path) {
1385 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001386 return Dex2oatFileWrapper();
1387 }
1388 const std::string out_oat_path_str(out_oat_path);
1389 Dex2oatFileWrapper wrapper_fd(
1390 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1391 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1392 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001393 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001394 } else if (!set_permissions_and_ownership(
1395 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001396 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1397 wrapper_fd.reset(-1);
1398 }
1399 return wrapper_fd;
1400}
1401
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001402// Creates RDONLY fds for oat and vdex files, if exist.
1403// Returns false if it fails to create oat out path for the given apk path.
1404// Note that the method returns true even if the files could not be opened.
1405bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1406 const std::string& oat_dir,
1407 const std::string& instruction_set,
1408 bool is_secondary_dex,
1409 unique_fd* oat_file_fd,
1410 unique_fd* vdex_file_fd) {
1411 char oat_path[PKG_PATH_MAX];
1412 if (!create_oat_out_path(apk_path.c_str(),
1413 instruction_set.c_str(),
1414 oat_dir.c_str(),
1415 is_secondary_dex,
1416 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001417 LOG(ERROR) << "Could not create oat out path for "
1418 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001419 return false;
1420 }
1421 oat_file_fd->reset(open(oat_path, O_RDONLY));
1422 if (oat_file_fd->get() < 0) {
1423 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1424 }
1425
1426 std::string vdex_filename = create_vdex_filename(oat_path);
1427 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1428 if (vdex_file_fd->get() < 0) {
1429 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1430 }
1431
1432 return true;
1433}
1434
Calin Juravle7a570e82017-01-14 16:23:30 -08001435// Updates the access times of out_oat_path based on those from apk_path.
1436void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1437 struct stat input_stat;
1438 memset(&input_stat, 0, sizeof(input_stat));
1439 if (stat(apk_path, &input_stat) != 0) {
1440 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1441 return;
1442 }
1443
1444 struct utimbuf ut;
1445 ut.actime = input_stat.st_atime;
1446 ut.modtime = input_stat.st_mtime;
1447 if (utime(out_oat_path, &ut) != 0) {
1448 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1449 }
1450}
1451
Calin Juravle80a21252017-01-17 14:43:25 -08001452// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001453// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1454// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1455// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001456class RunDexoptAnalyzer : public ExecVHelper {
1457 public:
1458 RunDexoptAnalyzer(const std::string& dex_file,
1459 int vdex_fd,
1460 int oat_fd,
1461 int zip_fd,
1462 const std::string& instruction_set,
1463 const std::string& compiler_filter,
1464 bool profile_was_updated,
1465 bool downgrade,
1466 const char* class_loader_context) {
1467 CHECK_GE(zip_fd, 0);
1468 const char* dexoptanalyzer_bin =
Roland Levillain67a14f62019-01-23 15:59:50 +00001469 is_debug_runtime() ? kDexoptanalyzerDebugPath : kDexoptanalyzerPath;
Calin Juravle80a21252017-01-17 14:43:25 -08001470
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001471 std::string dex_file_arg = "--dex-file=" + dex_file;
1472 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1473 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1474 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1475 std::string isa_arg = "--isa=" + instruction_set;
1476 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1477 const char* assume_profile_changed = "--assume-profile-changed";
1478 const char* downgrade_flag = "--downgrade";
1479 std::string class_loader_context_arg = "--class-loader-context=";
1480 if (class_loader_context != nullptr) {
1481 class_loader_context_arg += class_loader_context;
1482 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001483
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001484 // program name, dex file, isa, filter
1485 AddArg(dex_file_arg);
1486 AddArg(isa_arg);
1487 AddArg(compiler_filter_arg);
1488 if (oat_fd >= 0) {
1489 AddArg(oat_fd_arg);
1490 }
1491 if (vdex_fd >= 0) {
1492 AddArg(vdex_fd_arg);
1493 }
1494 AddArg(zip_fd_arg.c_str());
1495 if (profile_was_updated) {
1496 AddArg(assume_profile_changed);
1497 }
1498 if (downgrade) {
1499 AddArg(downgrade_flag);
1500 }
1501 if (class_loader_context != nullptr) {
1502 AddArg(class_loader_context_arg.c_str());
1503 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001504
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001505 PrepareArgs(dexoptanalyzer_bin);
1506 }
1507};
Calin Juravle80a21252017-01-17 14:43:25 -08001508
1509// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001510static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001511 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001512 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001513 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001514 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001515 return false;
1516 }
Calin Juravle114f0812017-03-08 19:05:07 -08001517 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001518
Calin Juravle80a21252017-01-17 14:43:25 -08001519 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001520 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1521 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001522 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001523 return false;
1524 }
1525
1526 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001527 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001528
Calin Juravle7d765462017-09-04 15:57:10 -07001529 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001530 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001531 return false;
1532 }
1533
1534 return true;
1535}
1536
Calin Juravle7d765462017-09-04 15:57:10 -07001537// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1538// secondary dex files. This return codes are returned by the child process created for
1539// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001540
Andreas Gampe194fe422018-02-28 20:16:19 -08001541enum DexoptAnalyzerSkipCodes {
1542 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001543 // Specific errors are encoded in the name.
1544 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1545 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1546 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1547 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1548 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001549 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001550 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001551};
Calin Juravle7d765462017-09-04 15:57:10 -07001552
1553// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001554// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1555// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001556// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1557// of dexoptanalyzer.
1558static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001559 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001560 // The result values are defined in dexoptanalyzer.
1561 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001562 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001563 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001564 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001565 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001566 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001567 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001568 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001569 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001570 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1571 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001572 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1573 " Expected odex file status for secondary dex %s"
1574 " : dexoptanalyzer result=%d",
1575 dex_path.c_str(),
1576 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001577 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001578 }
1579
1580 // Use a second switch for enum switch-case analysis.
1581 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001582 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001583 // If the file does not exist there's no need for dexopt.
1584 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1585 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001586
1587 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1588 *error_msg = "Dexoptanalyzer path validation failed";
1589 return false;
1590 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1591 *error_msg = "Dexoptanalyzer open zip failed";
1592 return false;
1593 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1594 *error_msg = "Dexoptanalyzer dir preparation failed";
1595 return false;
1596 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1597 *error_msg = "Dexoptanalyzer open output failed";
1598 return false;
1599 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1600 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001601 return false;
1602 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001603
1604 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1605 dex_path.c_str(),
1606 result);
1607 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001608}
1609
Calin Juravle7d765462017-09-04 15:57:10 -07001610enum SecondaryDexAccess {
1611 kSecondaryDexAccessReadOk = 0,
1612 kSecondaryDexAccessDoesNotExist = 1,
1613 kSecondaryDexAccessPermissionError = 2,
1614 kSecondaryDexAccessIOError = 3
1615};
1616
1617static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1618 // Check if the path exists and can be read. If not, there's nothing to do.
1619 if (access(dex_path.c_str(), R_OK) == 0) {
1620 return kSecondaryDexAccessReadOk;
1621 } else {
1622 if (errno == ENOENT) {
1623 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1624 return kSecondaryDexAccessDoesNotExist;
1625 } else {
1626 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1627 return errno == EACCES
1628 ? kSecondaryDexAccessPermissionError
1629 : kSecondaryDexAccessIOError;
1630 }
1631 }
1632}
1633
1634static bool is_file_public(const std::string& filename) {
1635 struct stat file_stat;
1636 if (stat(filename.c_str(), &file_stat) == 0) {
1637 return (file_stat.st_mode & S_IROTH) != 0;
1638 }
1639 return false;
1640}
1641
1642// Create the oat file structure for the secondary dex 'dex_path' and assign
1643// the individual path component to the 'out_' parameters.
1644static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001645 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001646 size_t dirIndex = dex_path.rfind('/');
1647 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001648 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001649 return false;
1650 }
1651 // TODO(calin): we have similar computations in at lest 3 other places
1652 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1653 // using string append.
1654 std::string apk_dir = dex_path.substr(0, dirIndex);
1655 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1656 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1657
1658 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1659 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001660 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001661 return false;
1662 }
1663 return true;
1664}
1665
1666// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1667// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001668static bool validate_dexopt_storage_flags(int dexopt_flags,
1669 int* out_storage_flag,
1670 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001671 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1672 *out_storage_flag = FLAG_STORAGE_CE;
1673 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001674 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001675 return false;
1676 }
1677 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1678 *out_storage_flag = FLAG_STORAGE_DE;
1679 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001680 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001681 return false;
1682 }
1683 return true;
1684}
1685
Calin Juravlec9eab382017-01-25 01:17:17 -08001686// 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 -08001687// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1688// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001689// When returning true, the output parameters will be:
1690// - is_public_out: whether or not the oat file should not be made public
1691// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1692// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001693static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001694 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001695 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001696 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
1697 /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001698 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001699 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001700 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1701 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001702 return false;
1703 }
Calin Juravle7d765462017-09-04 15:57:10 -07001704 // Compute the oat dir as it's not easy to extract it from the child computation.
1705 char oat_path[PKG_PATH_MAX];
1706 char oat_dir[PKG_PATH_MAX];
1707 char oat_isa_dir[PKG_PATH_MAX];
1708 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001709 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1710 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001711 return false;
1712 }
Calin Juravle7d765462017-09-04 15:57:10 -07001713 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001714
Calin Juravle80a21252017-01-17 14:43:25 -08001715 pid_t pid = fork();
1716 if (pid == 0) {
1717 // child -- drop privileges before continuing.
1718 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001719
1720 // Validate the path structure.
1721 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1722 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001723 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001724 }
1725
1726 // Open the dex file.
1727 unique_fd zip_fd;
1728 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1729 if (zip_fd.get() < 0) {
1730 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001731 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001732 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001733 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001734 }
1735 }
1736
1737 // Prepare the oat directories.
1738 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001739 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001740 }
1741
1742 // Open the vdex/oat files if any.
1743 unique_fd oat_file_fd;
1744 unique_fd vdex_file_fd;
1745 if (!maybe_open_oat_and_vdex_file(dex_path,
1746 *oat_dir_out,
1747 instruction_set,
1748 true /* is_secondary_dex */,
1749 &oat_file_fd,
1750 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001751 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001752 }
1753
1754 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001755 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1756 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001757
1758 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001759 // Note that we do not do it before the fork since opening the files is required to happen
1760 // after forking.
1761 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1762 vdex_file_fd.get(),
1763 oat_file_fd.get(),
1764 zip_fd.get(),
1765 instruction_set,
1766 compiler_filter, profile_was_updated,
1767 downgrade,
1768 class_loader_context);
1769 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001770 }
1771
1772 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001773 int result = wait_child(pid);
1774 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001775 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1776 dex_path.c_str(),
1777 result);
1778 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001779 return false;
1780 }
1781 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001782 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001783 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1784 result,
1785 dexopt_needed_out,
1786 error_msg);
1787 if (!success) {
1788 LOG(ERROR) << *error_msg;
1789 }
Calin Juravle7d765462017-09-04 15:57:10 -07001790
1791 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1792
Calin Juravle80a21252017-01-17 14:43:25 -08001793 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001794 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1795 // makes the code simpler; force compilation is only needed during tests).
1796 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001797 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001798 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001799 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1800 }
1801
Calin Juravle7d765462017-09-04 15:57:10 -07001802 // Check if we should make the oat file public.
1803 // Note that if the dex file is not public the compiled code cannot be made public.
1804 // It is ok to check this flag outside in the parent process.
1805 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1806
Calin Juravle80a21252017-01-17 14:43:25 -08001807 return success;
1808}
1809
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001810static std::string format_dexopt_error(int status, const char* dex_path) {
1811 if (WIFEXITED(status)) {
1812 int int_code = WEXITSTATUS(status);
1813 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1814 if (code_name != nullptr) {
1815 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1816 }
1817 }
1818 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001819}
1820
Calin Juravlec9eab382017-01-25 01:17:17 -08001821int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001822 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001823 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001824 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001825 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001826 CHECK(pkgname != nullptr);
1827 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001828 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001829 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1830 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001831
Calin Juravled23dee72017-07-06 16:29:11 -07001832 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001833 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001834 return -1;
1835 }
1836
1837 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001838 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1839 class_loader_context);
1840 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001841 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001842 }
1843
Calin Juravleebc8a792017-04-04 20:21:05 -07001844 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001845 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1846 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1847 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001848 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001849 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001850 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001851 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001852 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001853
1854 // Check if we're dealing with a secondary dex file and if we need to compile it.
1855 std::string oat_dir_str;
1856 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001857 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001858 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Andreas Gampe194fe422018-02-28 20:16:19 -08001859 downgrade, class_loader_context, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001860 oat_dir = oat_dir_str.c_str();
1861 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1862 return 0; // Nothing to do, report success.
1863 }
1864 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001865 if (error_msg->empty()) { // TODO: Make this a CHECK.
1866 *error_msg = "Failed processing secondary.";
1867 }
Calin Juravle80a21252017-01-17 14:43:25 -08001868 return -1; // We had an error, logged in the process method.
1869 }
1870 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001871 // Currently these flags are only use for secondary dex files.
1872 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001873 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1874 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1875 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001876
1877 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001878 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001879 if (input_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001880 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1881 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001882 return -1;
1883 }
1884
1885 // Create the output OAT file.
1886 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001887 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001888 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001889 if (out_oat_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001890 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001891 return -1;
1892 }
1893
1894 // Open vdex files.
1895 Dex2oatFileWrapper in_vdex_fd;
1896 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001897 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1898 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001899 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001900 return -1;
1901 }
1902
Calin Juravlecb556e32017-04-04 20:22:50 -07001903 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1904 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1905 // fully inherit their parent context).
1906 // Note that for primary apk the oat files are created before, in a separate installd
1907 // call which also does the restorecon. TODO(calin): unify the paths.
1908 if (is_secondary_dex) {
1909 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1910 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001911 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1912 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001913 return -1;
1914 }
1915 }
1916
Jeff Sharkey90aff262016-12-12 14:28:24 -07001917 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001918 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001919
Calin Juravle7a570e82017-01-14 16:23:30 -08001920 // Create the app image file if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001921 Dex2oatFileWrapper image_fd = maybe_open_app_image(
1922 out_oat_path, generate_app_image, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001923
Calin Juravle7a570e82017-01-14 16:23:30 -08001924 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001925 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001926 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001927
Calin Juravle62c5a372018-02-01 17:03:23 +00001928 unique_fd dex_metadata_fd;
1929 if (dex_metadata_path != nullptr) {
1930 dex_metadata_fd.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)));
1931 if (dex_metadata_fd.get() < 0) {
1932 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1933 }
1934 }
1935
Andreas Gampe023b2242018-02-28 16:03:25 -08001936 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001937
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001938 RunDex2Oat runner(input_fd.get(),
1939 out_oat_fd.get(),
1940 in_vdex_fd.get(),
1941 out_vdex_fd.get(),
1942 image_fd.get(),
1943 dex_path,
1944 out_oat_path,
1945 swap_fd.get(),
1946 instruction_set,
1947 compiler_filter,
1948 debuggable,
1949 boot_complete,
1950 background_job_compile,
1951 reference_profile_fd.get(),
1952 class_loader_context,
1953 target_sdk_version,
1954 enable_hidden_api_checks,
1955 generate_compact_dex,
1956 dex_metadata_fd.get(),
1957 compilation_reason);
1958
Jeff Sharkey90aff262016-12-12 14:28:24 -07001959 pid_t pid = fork();
1960 if (pid == 0) {
1961 /* child -- drop privileges before continuing */
1962 drop_capabilities(uid);
1963
Vladimir Marko1fea89a2019-02-08 15:11:59 +00001964 // Clear BOOTCLASSPATH.
1965 // Let dex2oat use the BCP from boot image, excluding updatable BCP
1966 // modules for AOT to avoid app recompilation after their upgrades.
1967 unsetenv("BOOTCLASSPATH");
1968
Richard Uhler76cc0272016-12-08 10:46:35 +00001969 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001970 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001971 PLOG(ERROR) << "flock(" << out_oat_path << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001972 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001973 }
1974
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001975 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001976 } else {
1977 int res = wait_child(pid);
1978 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001979 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001980 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001981 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1982 << std::hex << std::setw(4) << res << ", process failed";
1983 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001984 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001985 }
1986 }
1987
Calin Juravlec9eab382017-01-25 01:17:17 -08001988 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001989
1990 // We've been successful, don't delete output.
1991 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001992 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001993 image_fd.SetCleanup(false);
1994 reference_profile_fd.SetCleanup(false);
1995
1996 return 0;
1997}
1998
Calin Juravlec9eab382017-01-25 01:17:17 -08001999// Try to remove the given directory. Log an error if the directory exists
2000// and is empty but could not be removed.
2001static bool rmdir_if_empty(const char* dir) {
2002 if (rmdir(dir) == 0) {
2003 return true;
2004 }
2005 if (errno == ENOENT || errno == ENOTEMPTY) {
2006 return true;
2007 }
2008 PLOG(ERROR) << "Failed to remove dir: " << dir;
2009 return false;
2010}
2011
2012// Try to unlink the given file. Log an error if the file exists and could not
2013// be unlinked.
2014static bool unlink_if_exists(const std::string& file) {
2015 if (unlink(file.c_str()) == 0) {
2016 return true;
2017 }
2018 if (errno == ENOENT) {
2019 return true;
2020
2021 }
2022 PLOG(ERROR) << "Could not unlink: " << file;
2023 return false;
2024}
2025
Calin Juravle7d765462017-09-04 15:57:10 -07002026enum ReconcileSecondaryDexResult {
2027 kReconcileSecondaryDexExists = 0,
2028 kReconcileSecondaryDexCleanedUp = 1,
2029 kReconcileSecondaryDexValidationError = 2,
2030 kReconcileSecondaryDexCleanUpError = 3,
2031 kReconcileSecondaryDexAccessIOError = 4,
2032};
Calin Juravlec9eab382017-01-25 01:17:17 -08002033
2034// Reconcile the secondary dex 'dex_path' and its generated oat files.
2035// Return true if all the parameters are valid and the secondary dex file was
2036// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
2037// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
2038// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
2039// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
2040// Return false if there were errors during processing. In this case
2041// out_secondary_dex_exists will be set to false.
2042bool reconcile_secondary_dex_file(const std::string& dex_path,
2043 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
2044 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2045 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07002046 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08002047 if (isas.size() == 0) {
2048 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
2049 return false;
2050 }
2051
Calin Juravle7d765462017-09-04 15:57:10 -07002052 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2053 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2054 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002055 return false;
2056 }
2057
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002058 // As a security measure we want to unlink art artifacts with the reduced capabilities
2059 // of the package user id. So we fork and drop capabilities in the child.
2060 pid_t pid = fork();
2061 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002062 /* child -- drop privileges before continuing */
2063 drop_capabilities(uid);
2064
2065 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2066 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2067 uid, storage_flag)) {
2068 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2069 _exit(kReconcileSecondaryDexValidationError);
2070 }
2071
2072 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2073 switch (access_check) {
2074 case kSecondaryDexAccessDoesNotExist:
2075 // File does not exist. Proceed with cleaning.
2076 break;
2077 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2078 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2079 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2080 default:
2081 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2082 _exit(kReconcileSecondaryDexValidationError);
2083 }
2084
2085 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002086 char oat_path[PKG_PATH_MAX];
2087 char oat_dir[PKG_PATH_MAX];
2088 char oat_isa_dir[PKG_PATH_MAX];
2089 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002090 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08002091 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002092 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08002093 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
2094 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002095 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002096 }
Calin Juravle51314092017-05-18 15:33:05 -07002097
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002098 // Delete oat/vdex/art files.
2099 result = unlink_if_exists(oat_path) && result;
2100 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2101 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002102
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002103 // Delete profiles.
2104 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002105 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002106 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002107 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002108 result = unlink_if_exists(current_profile) && result;
2109 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002110
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002111 // We upgraded once the location of current profile for secondary dex files.
2112 // Check for any previous left-overs and remove them as well.
2113 std::string old_current_profile = dex_path + ".prof";
2114 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002115
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002116 // Try removing the directories as well, they might be empty.
2117 result = rmdir_if_empty(oat_isa_dir) && result;
2118 result = rmdir_if_empty(oat_dir) && result;
2119 }
Calin Juravle7d765462017-09-04 15:57:10 -07002120 if (!result) {
2121 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2122 }
2123 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002124 }
2125
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002126 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002127 if (!WIFEXITED(return_code)) {
2128 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2129 } else {
2130 return_code = WEXITSTATUS(return_code);
2131 }
2132
2133 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2134
2135 switch (return_code) {
2136 case kReconcileSecondaryDexCleanedUp:
2137 case kReconcileSecondaryDexValidationError:
2138 // If we couldn't validate assume the dex file does not exist.
2139 // This will purge the entry from the PM records.
2140 *out_secondary_dex_exists = false;
2141 return true;
2142 case kReconcileSecondaryDexExists:
2143 *out_secondary_dex_exists = true;
2144 return true;
2145 case kReconcileSecondaryDexAccessIOError:
2146 // We had an access IO error.
2147 // Return false so that we can try again.
2148 // The value of out_secondary_dex_exists does not matter in this case and by convention
2149 // is set to false.
2150 *out_secondary_dex_exists = false;
2151 return false;
2152 default:
2153 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2154 *out_secondary_dex_exists = false;
2155 return false;
2156 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002157}
2158
Alan Stokesa25d90c2017-10-16 10:56:00 +01002159// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2160// Returns true if all parameters are valid and the hash successfully computed and stored in
2161// out_secondary_dex_hash.
2162// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2163// the app.
2164// For any other errors (e.g. if any of the parameters are invalid) returns false.
2165bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2166 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2167 std::vector<uint8_t>* out_secondary_dex_hash) {
2168 out_secondary_dex_hash->clear();
2169
2170 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2171
2172 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2173 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2174 << storage_flag;
2175 return false;
2176 }
2177
2178 // Pipe to get the hash result back from our child process.
2179 unique_fd pipe_read, pipe_write;
2180 if (!Pipe(&pipe_read, &pipe_write)) {
2181 PLOG(ERROR) << "Failed to create pipe";
2182 return false;
2183 }
2184
2185 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2186 // access data the app itself can access.
2187 pid_t pid = fork();
2188 if (pid == 0) {
2189 // child -- drop privileges before continuing
2190 drop_capabilities(uid);
2191 pipe_read.reset();
2192
2193 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2194 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002195 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002196 }
2197
2198 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2199 if (fd == -1) {
2200 if (errno == EACCES || errno == ENOENT) {
2201 // Not treated as an error.
2202 _exit(0);
2203 }
2204 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002205 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002206 }
2207
2208 SHA256_CTX ctx;
2209 SHA256_Init(&ctx);
2210
2211 std::vector<uint8_t> buffer(65536);
2212 while (true) {
2213 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2214 if (bytes_read == 0) {
2215 break;
2216 } else if (bytes_read == -1) {
2217 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002218 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002219 }
2220
2221 SHA256_Update(&ctx, buffer.data(), bytes_read);
2222 }
2223
2224 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2225 SHA256_Final(hash.data(), &ctx);
2226 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002227 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002228 }
2229
2230 _exit(0);
2231 }
2232
2233 // parent
2234 pipe_write.reset();
2235
2236 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2237 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2238 out_secondary_dex_hash->clear();
2239 }
2240 return wait_child(pid) == 0;
2241}
2242
Jeff Sharkey90aff262016-12-12 14:28:24 -07002243// Helper for move_ab, so that we can have common failure-case cleanup.
2244static bool unlink_and_rename(const char* from, const char* to) {
2245 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2246 // return a failure.
2247 struct stat s;
2248 if (stat(to, &s) == 0) {
2249 if (!S_ISREG(s.st_mode)) {
2250 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2251 return false;
2252 }
2253 if (unlink(to) != 0) {
2254 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2255 return false;
2256 }
2257 } else {
2258 // This may be a permission problem. We could investigate the error code, but we'll just
2259 // let the rename failure do the work for us.
2260 }
2261
2262 // Try to rename "to" to "from."
2263 if (rename(from, to) != 0) {
2264 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2265 return false;
2266 }
2267 return true;
2268}
2269
2270// Move/rename a B artifact (from) to an A artifact (to).
2271static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2272 // Check whether B exists.
2273 {
2274 struct stat s;
2275 if (stat(b_path.c_str(), &s) != 0) {
2276 // Silently ignore for now. The service calling this isn't smart enough to understand
2277 // lack of artifacts at the moment.
2278 return false;
2279 }
2280 if (!S_ISREG(s.st_mode)) {
2281 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2282 // Try to unlink, but swallow errors.
2283 unlink(b_path.c_str());
2284 return false;
2285 }
2286 }
2287
2288 // Rename B to A.
2289 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2290 // Delete the b_path so we don't try again (or fail earlier).
2291 if (unlink(b_path.c_str()) != 0) {
2292 PLOG(ERROR) << "Could not unlink " << b_path;
2293 }
2294
2295 return false;
2296 }
2297
2298 return true;
2299}
2300
2301bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2302 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002303 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2304 if (slot_suffix.empty()) {
2305 return false;
2306 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002307
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002308 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2309 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2310 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002311 }
2312
2313 // Validate other inputs.
2314 if (validate_apk_path(apk_path) != 0) {
2315 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2316 return false;
2317 }
2318 if (validate_apk_path(oat_dir) != 0) {
2319 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2320 return false;
2321 }
2322
2323 char a_path[PKG_PATH_MAX];
2324 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2325 return false;
2326 }
2327 const std::string a_vdex_path = create_vdex_filename(a_path);
2328 const std::string a_image_path = create_image_filename(a_path);
2329
2330 // B path = A path + slot suffix.
2331 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2332 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2333 const std::string b_image_path = StringPrintf("%s.%s",
2334 a_image_path.c_str(),
2335 slot_suffix.c_str());
2336
2337 bool success = true;
2338 if (move_ab_path(b_path, a_path)) {
2339 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2340 // Note: we can live without an app image. As such, ignore failure to move the image file.
2341 // If we decide to require the app image, or the app image being moved correctly,
2342 // then change accordingly.
2343 constexpr bool kIgnoreAppImageFailure = true;
2344
2345 if (!a_image_path.empty()) {
2346 if (!move_ab_path(b_image_path, a_image_path)) {
2347 unlink(a_image_path.c_str());
2348 if (!kIgnoreAppImageFailure) {
2349 success = false;
2350 }
2351 }
2352 }
2353 } else {
2354 // Cleanup: delete B image, ignore errors.
2355 unlink(b_image_path.c_str());
2356 success = false;
2357 }
2358 } else {
2359 // Cleanup: delete B image, ignore errors.
2360 unlink(b_vdex_path.c_str());
2361 unlink(b_image_path.c_str());
2362 success = false;
2363 }
2364 return success;
2365}
2366
2367bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2368 // Delete the oat/odex file.
2369 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002370 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002371 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002372 return false;
2373 }
2374
2375 // In case of a permission failure report the issue. Otherwise just print a warning.
2376 auto unlink_and_check = [](const char* path) -> bool {
2377 int result = unlink(path);
2378 if (result != 0) {
2379 if (errno == EACCES || errno == EPERM) {
2380 PLOG(ERROR) << "Could not unlink " << path;
2381 return false;
2382 }
2383 PLOG(WARNING) << "Could not unlink " << path;
2384 }
2385 return true;
2386 };
2387
2388 // Delete the oat/odex file.
2389 bool return_value_oat = unlink_and_check(out_path);
2390
2391 // Derive and delete the app image.
2392 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2393
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002394 // Derive and delete the vdex file.
2395 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2396
Jeff Sharkey90aff262016-12-12 14:28:24 -07002397 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002398 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002399}
2400
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002401static bool is_absolute_path(const std::string& path) {
2402 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2403 LOG(ERROR) << "Invalid absolute path " << path;
2404 return false;
2405 } else {
2406 return true;
2407 }
2408}
2409
2410static bool is_valid_instruction_set(const std::string& instruction_set) {
2411 // TODO: add explicit whitelisting of instruction sets
2412 if (instruction_set.find('/') != std::string::npos) {
2413 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2414 return false;
2415 } else {
2416 return true;
2417 }
2418}
2419
2420bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2421 const char *apk_path, const char *instruction_set) {
2422 std::string oat_dir_ = oat_dir;
2423 std::string apk_path_ = apk_path;
2424 std::string instruction_set_ = instruction_set;
2425
2426 if (!is_absolute_path(oat_dir_)) return false;
2427 if (!is_absolute_path(apk_path_)) return false;
2428 if (!is_valid_instruction_set(instruction_set_)) return false;
2429
2430 std::string::size_type end = apk_path_.rfind('.');
2431 std::string::size_type start = apk_path_.rfind('/', end);
2432 if (end == std::string::npos || start == std::string::npos) {
2433 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2434 return false;
2435 }
2436
2437 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2438 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2439 const char* res = res_.c_str();
2440 if (strlen(res) >= PKG_PATH_MAX) {
2441 LOG(ERROR) << "Result too large";
2442 return false;
2443 } else {
2444 strlcpy(path, res, PKG_PATH_MAX);
2445 return true;
2446 }
2447}
2448
2449bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2450 const char *instruction_set) {
2451 std::string apk_path_ = apk_path;
2452 std::string instruction_set_ = instruction_set;
2453
2454 if (!is_absolute_path(apk_path_)) return false;
2455 if (!is_valid_instruction_set(instruction_set_)) return false;
2456
2457 std::string::size_type end = apk_path_.rfind('.');
2458 std::string::size_type start = apk_path_.rfind('/', end);
2459 if (end == std::string::npos || start == std::string::npos) {
2460 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2461 return false;
2462 }
2463
2464 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2465 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2466}
2467
2468bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2469 const char *instruction_set) {
2470 std::string src_ = src;
2471 std::string instruction_set_ = instruction_set;
2472
2473 if (!is_absolute_path(src_)) return false;
2474 if (!is_valid_instruction_set(instruction_set_)) return false;
2475
2476 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2477 if (*it == '/') {
2478 *it = '@';
2479 }
2480 }
2481
2482 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2483 + DALVIK_CACHE_POSTFIX;
2484 const char* res = res_.c_str();
2485 if (strlen(res) >= PKG_PATH_MAX) {
2486 LOG(ERROR) << "Result too large";
2487 return false;
2488 } else {
2489 strlcpy(path, res, PKG_PATH_MAX);
2490 return true;
2491 }
2492}
2493
Calin Juravle59f7ab82018-04-27 17:50:23 -07002494bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2495 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002496 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2497 for (const std::string& elem : classpaths_elems) {
2498 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2499 if (fd < 0) {
2500 PLOG(ERROR) << "Could not open classpath elem " << elem;
2501 return false;
2502 } else {
2503 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002504 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002505 }
2506 }
2507 return true;
2508}
2509
2510static bool create_app_profile_snapshot(int32_t app_id,
2511 const std::string& package_name,
2512 const std::string& profile_name,
2513 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002514 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2515
Calin Juravle824a64d2018-01-18 20:23:17 -08002516 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002517 if (snapshot_fd < 0) {
2518 return false;
2519 }
2520
2521 std::vector<unique_fd> profiles_fd;
2522 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002523 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2524 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002525 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2526 return false;
2527 }
2528
2529 profiles_fd.push_back(std::move(reference_profile_fd));
2530
Calin Juravle0d0a4922018-01-23 19:54:11 -08002531 // Open the class paths elements. These will be used to filter out profile data that does
2532 // not belong to the classpath during merge.
2533 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002534 std::vector<std::string> dex_locations;
2535 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002536 return false;
2537 }
2538
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002539 RunProfman args;
2540 args.SetupMerge(profiles_fd, snapshot_fd, apk_fds, dex_locations);
Calin Juravle29591732017-11-20 17:46:19 -08002541 pid_t pid = fork();
2542 if (pid == 0) {
2543 /* child -- drop privileges before continuing */
2544 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002545 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002546 }
2547
2548 /* parent */
2549 int return_code = wait_child(pid);
2550 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002551 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002552 return false;
2553 }
2554
2555 return true;
2556}
2557
Calin Juravle0d0a4922018-01-23 19:54:11 -08002558static bool create_boot_image_profile_snapshot(const std::string& package_name,
2559 const std::string& profile_name,
2560 const std::string& classpath) {
2561 // The reference profile directory for the android package might not be prepared. Do it now.
2562 const std::string ref_profile_dir =
2563 create_primary_reference_profile_package_dir_path(package_name);
2564 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2565 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2566 return false;
2567 }
2568
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002569 // Return false for empty class path since it may otherwise return true below if profiles is
2570 // empty.
2571 if (classpath.empty()) {
2572 PLOG(ERROR) << "Class path is empty";
2573 return false;
2574 }
2575
Calin Juravle0d0a4922018-01-23 19:54:11 -08002576 // Open and create the snapshot profile.
2577 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2578
2579 // Collect all non empty profiles.
2580 // The collection will traverse all applications profiles and find the non empty files.
2581 // This has the potential of inspecting a large number of files and directories (depending
2582 // on the number of applications and users). So there is a slight increase in the chance
2583 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2584 // fail the snapshot and aggregate whatever profile we could open.
2585 //
2586 // The profile snapshot is a best effort based on available data it's ok if some data
2587 // from some apps is missing. It will be counter productive for the snapshot to fail
2588 // because we could not open or read some of the files.
2589 std::vector<std::string> profiles;
2590 if (!collect_profiles(&profiles)) {
2591 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2592 }
2593
2594 // If we have no profiles return early.
2595 if (profiles.empty()) {
2596 return true;
2597 }
2598
2599 // Open the classpath elements. These will be used to filter out profile data that does
2600 // not belong to the classpath during merge.
2601 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002602 std::vector<std::string> dex_locations;
2603 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002604 return false;
2605 }
2606
2607 // If we could not open any files from the classpath return an error.
2608 if (apk_fds.empty()) {
2609 LOG(ERROR) << "Could not open any of the classpath elements.";
2610 return false;
2611 }
2612
2613 // Aggregate the profiles in batches of kAggregationBatchSize.
2614 // We do this to avoid opening a huge a amount of files.
2615 static constexpr size_t kAggregationBatchSize = 10;
2616
2617 std::vector<unique_fd> profiles_fd;
2618 for (size_t i = 0; i < profiles.size(); ) {
2619 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2620 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2621 if (fd.get() >= 0) {
2622 profiles_fd.push_back(std::move(fd));
2623 }
2624 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002625 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002626 args.SetupMerge(profiles_fd,
2627 snapshot_fd,
2628 apk_fds,
2629 dex_locations,
2630 /*store_aggregation_counters=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002631 pid_t pid = fork();
2632 if (pid == 0) {
2633 /* child -- drop privileges before continuing */
2634 drop_capabilities(AID_SYSTEM);
2635
Calin Juravle59f7ab82018-04-27 17:50:23 -07002636 // The introduction of new access flags into boot jars causes them to
2637 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002638 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002639 }
2640
2641 /* parent */
2642 int return_code = wait_child(pid);
2643 if (!WIFEXITED(return_code)) {
2644 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2645 return false;
2646 }
2647 return true;
2648 }
2649 return true;
2650}
2651
2652bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2653 const std::string& profile_name, const std::string& classpath) {
2654 if (app_id == -1) {
2655 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2656 } else {
2657 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2658 }
2659}
2660
Calin Juravlec3b049e2018-01-18 22:32:58 -08002661bool prepare_app_profile(const std::string& package_name,
2662 userid_t user_id,
2663 appid_t app_id,
2664 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002665 const std::string& code_path,
Calin Juravlec3b049e2018-01-18 22:32:58 -08002666 const std::unique_ptr<std::string>& dex_metadata) {
2667 // Prepare the current profile.
2668 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2669 /*is_secondary_dex*/ false);
2670 uid_t uid = multiuser_get_uid(user_id, app_id);
2671 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2672 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2673 return false;
2674 }
2675
2676 // Check if we need to install the profile from the dex metadata.
2677 if (dex_metadata == nullptr) {
2678 return true;
2679 }
2680
2681 // We have a dex metdata. Merge the profile into the reference profile.
2682 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2683 /*read_write*/ true, /*is_secondary_dex*/ false);
2684 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2685 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002686 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2687 if (apk_fd < 0) {
2688 PLOG(ERROR) << "Could not open code path " << code_path;
2689 return false;
2690 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002691
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002692 RunProfman args;
2693 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2694 std::move(ref_profile_fd),
2695 std::move(apk_fd),
2696 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002697 pid_t pid = fork();
2698 if (pid == 0) {
2699 /* child -- drop privileges before continuing */
2700 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2701 drop_capabilities(app_shared_gid);
2702
Calin Juravlef63d4792018-01-30 17:43:34 +00002703 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002704 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002705 }
2706
2707 /* parent */
2708 int return_code = wait_child(pid);
2709 if (!WIFEXITED(return_code)) {
2710 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2711 return false;
2712 }
2713 return true;
2714}
2715
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002716} // namespace installd
2717} // namespace android