blob: 2112fda3627d689e00dff249599516c0a39be8c4 [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>
Calin Juravlecb556e32017-04-04 20:22:50 -070046#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070047#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070048
49#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080050#include "dexopt_return_codes.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060051#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070052#include "installd_deps.h"
53#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070054#include "utils.h"
55
Jeff Sharkey90aff262016-12-12 14:28:24 -070056using android::base::EndsWith;
Mathieu Chartier9b2da082018-10-26 13:23:11 -070057using android::base::GetBoolProperty;
58using android::base::GetProperty;
Alan Stokesa25d90c2017-10-16 10:56:00 +010059using android::base::ReadFully;
60using android::base::StringPrintf;
61using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080062using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070063
64namespace android {
65namespace installd {
66
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070067// Should minidebug info be included in compiled artifacts? Even if this value is
68// "true," usage might still be conditional to other constraints, e.g., system
69// property overrides.
70static constexpr bool kEnableMinidebugInfo = true;
71
72static constexpr const char* kMinidebugInfoSystemProperty = "dalvik.vm.dex2oat-minidebuginfo";
73static constexpr bool kMinidebugInfoSystemPropertyDefault = false;
74static constexpr const char* kMinidebugDex2oatFlag = "--generate-mini-debug-info";
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -080075static constexpr const char* kDisableCompactDexFlag = "--compact-dex-level=none";
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070076
Andreas Gampefa2dadd2018-02-28 19:52:47 -080077
Calin Juravle114f0812017-03-08 19:05:07 -080078// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
79struct FreeDelete {
80 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
81 void operator()(const void* ptr) const {
82 free(const_cast<void*>(ptr));
83 }
84};
85
86// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
87template <typename T>
88using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
89
Calin Juravle1a0af3b2017-03-09 14:33:33 -080090static unique_fd invalid_unique_fd() {
91 return unique_fd(-1);
92}
93
Andreas Gampe6a9cf722017-07-24 16:49:10 -070094static bool is_debug_runtime() {
95 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
96}
97
David Sehra3b5ab62017-10-25 14:27:29 -070098static bool is_debuggable_build() {
99 return android::base::GetBoolProperty("ro.debuggable", false);
100}
101
Jeff Sharkey90aff262016-12-12 14:28:24 -0700102static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800103 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700104 if (ufd.get() < 0) {
105 if (errno != ENOENT) {
106 PLOG(WARNING) << "Could not open profile " << profile;
107 return false;
108 } else {
109 // Nothing to clear. That's ok.
110 return true;
111 }
112 }
113
114 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
115 if (errno != EWOULDBLOCK) {
116 PLOG(WARNING) << "Error locking profile " << profile;
117 }
118 // This implies that the app owning this profile is running
119 // (and has acquired the lock).
120 //
121 // If we can't acquire the lock bail out since clearing is useless anyway
122 // (the app will write again to the profile).
123 //
124 // Note:
125 // This does not impact the this is not an issue for the profiling correctness.
126 // In case this is needed because of an app upgrade, profiles will still be
127 // eventually cleared by the app itself due to checksum mismatch.
128 // If this is needed because profman advised, then keeping the data around
129 // until the next run is again not an issue.
130 //
131 // If the app attempts to acquire a lock while we've held one here,
132 // it will simply skip the current write cycle.
133 return false;
134 }
135
136 bool truncated = ftruncate(ufd.get(), 0) == 0;
137 if (!truncated) {
138 PLOG(WARNING) << "Could not truncate " << profile;
139 }
140 if (flock(ufd.get(), LOCK_UN) != 0) {
141 PLOG(WARNING) << "Error unlocking profile " << profile;
142 }
143 return truncated;
144}
145
Calin Juravle114f0812017-03-08 19:05:07 -0800146// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800147// The location is the profile name for primary apks or the dex path for secondary dex files.
148static bool clear_reference_profile(const std::string& package_name, const std::string& location,
149 bool is_secondary_dex) {
150 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700151}
152
Calin Juravle114f0812017-03-08 19:05:07 -0800153// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800154// The location is the profile name for primary apks or the dex path for secondary dex files.
155static bool clear_current_profile(const std::string& package_name, const std::string& location,
156 userid_t user, bool is_secondary_dex) {
157 return clear_profile(create_current_profile_path(user, package_name, location,
158 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700159}
160
Calin Juravle114f0812017-03-08 19:05:07 -0800161// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800162// The location is the profile name for primary apks or the dex path for secondary dex files.
163bool clear_primary_reference_profile(const std::string& package_name,
164 const std::string& location) {
165 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800166}
167
168// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800169// The location is the profile name for primary apks or the dex path for secondary dex files.
170bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700171 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800172 // 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 -0700173 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
174 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800175 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700176 }
177 return success;
178}
179
Calin Juravle114f0812017-03-08 19:05:07 -0800180// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800181bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
182 userid_t user) {
183 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800184}
185
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700186static std::vector<std::string> SplitBySpaces(const std::string& str) {
187 if (str.empty()) {
188 return {};
189 }
190 return android::base::Split(str, " ");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700191}
192
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700193static const char* get_location_from_path(const char* path) {
194 static constexpr char kLocationSeparator = '/';
195 const char *location = strrchr(path, kLocationSeparator);
Yi Kong954cf642018-07-17 16:16:24 -0700196 if (location == nullptr) {
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700197 return path;
198 } else {
199 // Skip the separator character.
200 return location + 1;
201 }
202}
203
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800204// ExecVHelper prepares and holds pointers to parsed command line arguments so that no allocations
205// need to be performed between the fork and exec.
206class ExecVHelper {
207 public:
208 // Store a placeholder for the binary name.
209 ExecVHelper() : args_(1u, std::string()) {}
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800210
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800211 void PrepareArgs(const std::string& bin) {
212 CHECK(!args_.empty());
213 CHECK(args_[0].empty());
214 args_[0] = bin;
215 // Write char* into array.
216 for (const std::string& arg : args_) {
217 argv_.push_back(arg.c_str());
218 }
219 argv_.push_back(nullptr); // Add null terminator.
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800220 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800221
222 [[ noreturn ]]
223 void Exec(int exit_code) {
224 execv(argv_[0], (char * const *)&argv_[0]);
225 PLOG(ERROR) << "execv(" << argv_[0] << ") failed";
226 exit(exit_code);
227 }
228
229 // Add an arg if it's not empty.
230 void AddArg(const std::string& arg) {
231 if (!arg.empty()) {
232 args_.push_back(arg);
233 }
234 }
235
236 // Add a runtime arg if it's not empty.
237 void AddRuntimeArg(const std::string& arg) {
238 if (!arg.empty()) {
239 args_.push_back("--runtime-arg");
240 args_.push_back(arg);
241 }
242 }
243
244 protected:
245 // Holder arrays for backing arg storage.
246 std::vector<std::string> args_;
247
248 // Argument poiners.
249 std::vector<const char*> argv_;
250};
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700251
252static std::string MapPropertyToArg(const std::string& property,
253 const std::string& format,
254 const std::string& default_value = "") {
255 std::string prop = GetProperty(property, default_value);
256 if (!prop.empty()) {
257 return StringPrintf(format.c_str(), prop.c_str());
258 }
259 return "";
260}
261
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800262class RunDex2Oat : public ExecVHelper {
263 public:
264 RunDex2Oat(int zip_fd,
265 int oat_fd,
266 int input_vdex_fd,
267 int output_vdex_fd,
268 int image_fd,
269 const char* input_file_name,
270 const char* output_file_name,
271 int swap_fd,
272 const char* instruction_set,
273 const char* compiler_filter,
274 bool debuggable,
275 bool post_bootcomplete,
276 bool background_job_compile,
277 int profile_fd,
278 const char* class_loader_context,
279 int target_sdk_version,
280 bool enable_hidden_api_checks,
281 bool generate_compact_dex,
282 int dex_metadata_fd,
283 const char* compilation_reason) {
284 // Get the relative path to the input file.
285 const char* relative_input_file_name = get_location_from_path(input_file_name);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700286
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800287 std::string dex2oat_Xms_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xms", "-Xms%s");
288 std::string dex2oat_Xmx_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xmx", "-Xmx%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700289
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800290 const char* threads_property = post_bootcomplete
291 ? "dalvik.vm.dex2oat-threads"
292 : "dalvik.vm.boot-dex2oat-threads";
293 std::string dex2oat_threads_arg = MapPropertyToArg(threads_property, "-j%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700294
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800295 const std::string dex2oat_isa_features_key =
296 StringPrintf("dalvik.vm.isa.%s.features", instruction_set);
297 std::string instruction_set_features_arg =
298 MapPropertyToArg(dex2oat_isa_features_key, "--instruction-set-features=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700299
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800300 const std::string dex2oat_isa_variant_key =
301 StringPrintf("dalvik.vm.isa.%s.variant", instruction_set);
302 std::string instruction_set_variant_arg =
303 MapPropertyToArg(dex2oat_isa_variant_key, "--instruction-set-variant=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700304
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800305 const char* dex2oat_norelocation = "-Xnorelocate";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700306
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800307 const std::string dex2oat_flags = GetProperty("dalvik.vm.dex2oat-flags", "");
308 std::vector<std::string> dex2oat_flags_args = SplitBySpaces(dex2oat_flags);
309 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700310
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800311 // If we are booting without the real /data, don't spend time compiling.
312 std::string vold_decrypt = GetProperty("vold.decrypt", "");
313 bool skip_compilation = vold_decrypt == "trigger_restart_min_framework" ||
314 vold_decrypt == "1";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700315
Mathieu Chartier5880c032018-11-28 19:15:41 -0800316 const std::string resolve_startup_string_arg =
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800317 MapPropertyToArg("dalvik.vm.dex2oat-resolve-startup-strings",
318 "--resolve-startup-const-strings=%s");
Mathieu Chartier5880c032018-11-28 19:15:41 -0800319
320 const std::string image_block_size_arg =
321 MapPropertyToArg("dalvik.vm.dex2oat-max-image-block-size",
322 "--max-image-block-size=%s");
323
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800324 const bool generate_debug_info = GetBoolProperty("debug.generate-debug-info", false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700325
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800326 std::string image_format_arg;
327 if (image_fd >= 0) {
328 image_format_arg = MapPropertyToArg("dalvik.vm.appimageformat", "--image-format=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000329 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000330
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800331 std::string dex2oat_large_app_threshold_arg =
332 MapPropertyToArg("dalvik.vm.dex2oat-very-large", "--very-large-app-threshold=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000333
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800334 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
Roland Levillain370222c2018-12-12 15:06:16 +0000335 const char* dex2oat_bin = "/apex/com.android.runtime/bin/dex2oat";
336 constexpr const char* kDex2oatDebugPath = "/apex/com.android.runtime/bin/dex2oatd";
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800337 // Do not use dex2oatd for release candidates (give dex2oat more soak time).
338 bool is_release = android::base::GetProperty("ro.build.version.codename", "") == "REL";
339 if (is_debug_runtime() ||
340 (background_job_compile && is_debuggable_build() && !is_release)) {
341 if (access(kDex2oatDebugPath, X_OK) == 0) {
342 dex2oat_bin = kDex2oatDebugPath;
343 }
344 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000345
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800346 bool generate_minidebug_info = kEnableMinidebugInfo &&
347 GetBoolProperty(kMinidebugInfoSystemProperty, kMinidebugInfoSystemPropertyDefault);
Mathieu Chartier31636522018-11-09 23:53:07 +0000348
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800349 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
350 // use arraysize instead.
351 std::string zip_fd_arg = StringPrintf("--zip-fd=%d", zip_fd);
352 std::string zip_location_arg = StringPrintf("--zip-location=%s", relative_input_file_name);
353 std::string input_vdex_fd_arg = StringPrintf("--input-vdex-fd=%d", input_vdex_fd);
354 std::string output_vdex_fd_arg = StringPrintf("--output-vdex-fd=%d", output_vdex_fd);
355 std::string oat_fd_arg = StringPrintf("--oat-fd=%d", oat_fd);
356 std::string oat_location_arg = StringPrintf("--oat-location=%s", output_file_name);
357 std::string instruction_set_arg = StringPrintf("--instruction-set=%s", instruction_set);
358 std::string dex2oat_compiler_filter_arg;
359 std::string dex2oat_swap_fd;
360 std::string dex2oat_image_fd;
361 std::string target_sdk_version_arg;
362 if (target_sdk_version != 0) {
363 StringPrintf("-Xtarget-sdk-version:%d", target_sdk_version);
364 }
365 std::string class_loader_context_arg;
366 if (class_loader_context != nullptr) {
367 class_loader_context_arg = StringPrintf("--class-loader-context=%s",
368 class_loader_context);
369 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000370
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800371 if (swap_fd >= 0) {
372 dex2oat_swap_fd = StringPrintf("--swap-fd=%d", swap_fd);
373 }
374 if (image_fd >= 0) {
375 dex2oat_image_fd = StringPrintf("--app-image-fd=%d", image_fd);
376 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000377
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800378 // Compute compiler filter.
379 bool have_dex2oat_relocation_skip_flag = false;
380 if (skip_compilation) {
381 dex2oat_compiler_filter_arg = "--compiler-filter=extract";
382 have_dex2oat_relocation_skip_flag = true;
383 } else if (compiler_filter != nullptr) {
384 dex2oat_compiler_filter_arg = StringPrintf("--compiler-filter=%s", compiler_filter);
385 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000386
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800387 if (dex2oat_compiler_filter_arg.empty()) {
388 dex2oat_compiler_filter_arg = MapPropertyToArg("dalvik.vm.dex2oat-filter",
389 "--compiler-filter=%s");
390 }
391
392 // Check whether all apps should be compiled debuggable.
393 if (!debuggable) {
394 debuggable = GetProperty("dalvik.vm.always_debuggable", "") == "1";
395 }
396 std::string profile_arg;
397 if (profile_fd != -1) {
398 profile_arg = StringPrintf("--profile-file-fd=%d", profile_fd);
399 }
400
401 // Get the directory of the apk to pass as a base classpath directory.
402 std::string base_dir;
403 std::string apk_dir(input_file_name);
404 unsigned long dir_index = apk_dir.rfind('/');
405 bool has_base_dir = dir_index != std::string::npos;
406 if (has_base_dir) {
407 apk_dir = apk_dir.substr(0, dir_index);
408 base_dir = StringPrintf("--classpath-dir=%s", apk_dir.c_str());
409 }
410
411 std::string dex_metadata_fd_arg = "--dm-fd=" + std::to_string(dex_metadata_fd);
412
413 std::string compilation_reason_arg = compilation_reason == nullptr
414 ? ""
415 : std::string("--compilation-reason=") + compilation_reason;
416
417 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
418
419 // Disable cdex if update input vdex is true since this combination of options is not
420 // supported.
421 const bool disable_cdex = !generate_compact_dex || (input_vdex_fd == output_vdex_fd);
422
423 AddArg(zip_fd_arg);
424 AddArg(zip_location_arg);
425 AddArg(input_vdex_fd_arg);
426 AddArg(output_vdex_fd_arg);
427 AddArg(oat_fd_arg);
428 AddArg(oat_location_arg);
429 AddArg(instruction_set_arg);
430
431 AddArg(instruction_set_variant_arg);
432 AddArg(instruction_set_features_arg);
433
434 AddRuntimeArg(dex2oat_Xms_arg);
435 AddRuntimeArg(dex2oat_Xmx_arg);
436
437 AddArg(resolve_startup_string_arg);
Mathieu Chartier5880c032018-11-28 19:15:41 -0800438 AddArg(image_block_size_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800439 AddArg(dex2oat_compiler_filter_arg);
440 AddArg(dex2oat_threads_arg);
441 AddArg(dex2oat_swap_fd);
442 AddArg(dex2oat_image_fd);
443
444 if (generate_debug_info) {
445 AddArg("--generate-debug-info");
446 }
447 if (debuggable) {
448 AddArg("--debuggable");
449 }
450 AddArg(image_format_arg);
451 AddArg(dex2oat_large_app_threshold_arg);
452
453 if (have_dex2oat_relocation_skip_flag) {
454 AddRuntimeArg(dex2oat_norelocation);
455 }
456 AddArg(profile_arg);
457 AddArg(base_dir);
458 AddArg(class_loader_context_arg);
459 if (generate_minidebug_info) {
460 AddArg(kMinidebugDex2oatFlag);
461 }
462 if (disable_cdex) {
463 AddArg(kDisableCompactDexFlag);
464 }
465 AddArg(target_sdk_version_arg);
466 if (enable_hidden_api_checks) {
467 AddRuntimeArg("-Xhidden-api-checks");
468 }
469
470 if (dex_metadata_fd > -1) {
471 AddArg(dex_metadata_fd_arg);
472 }
473
474 AddArg(compilation_reason_arg);
475
476 // Do not add args after dex2oat_flags, they should override others for debugging.
477 args_.insert(args_.end(), dex2oat_flags_args.begin(), dex2oat_flags_args.end());
478
479 PrepareArgs(dex2oat_bin);
Mathieu Chartier31636522018-11-09 23:53:07 +0000480 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800481};
Jeff Sharkey90aff262016-12-12 14:28:24 -0700482
483/*
484 * Whether dexopt should use a swap file when compiling an APK.
485 *
486 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
487 * itself, anyways).
488 *
489 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
490 *
491 * Otherwise, return true if this is a low-mem device.
492 *
493 * Otherwise, return default value.
494 */
495static bool kAlwaysProvideSwapFile = false;
496static bool kDefaultProvideSwapFile = true;
497
498static bool ShouldUseSwapFileForDexopt() {
499 if (kAlwaysProvideSwapFile) {
500 return true;
501 }
502
503 // Check the "override" property. If it exists, return value == "true".
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700504 std::string dex2oat_prop_buf = GetProperty("dalvik.vm.dex2oat-swap", "");
505 if (!dex2oat_prop_buf.empty()) {
506 return dex2oat_prop_buf == "true";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700507 }
508
509 // Shortcut for default value. This is an implementation optimization for the process sketched
510 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
511 // as low-mem is never returning false. The compiler will optimize this away if it can.
512 if (kDefaultProvideSwapFile) {
513 return true;
514 }
515
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700516 if (GetBoolProperty("ro.config.low_ram", false)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700517 return true;
518 }
519
520 // Default value must be false here.
521 return kDefaultProvideSwapFile;
522}
523
Richard Uhler76cc0272016-12-08 10:46:35 +0000524static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700525 if (set_to_bg) {
526 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800527 PLOG(ERROR) << "set_sched_policy failed";
528 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700529 }
530 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800531 PLOG(ERROR) << "setpriority failed";
532 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700533 }
534 }
535}
536
Calin Juravle29591732017-11-20 17:46:19 -0800537static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
538 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800539 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800540 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800541 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800542 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800543 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700544 }
Calin Juravle114f0812017-03-08 19:05:07 -0800545 // Profiles should belong to the app; make sure of that by giving ownership to
546 // the app uid. If we cannot do that, there's no point in returning the fd
547 // since dex2oat/profman will fail with SElinux denials.
548 if (fchown(fd.get(), uid, uid) < 0) {
549 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800550 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800551 }
Calin Juravle29591732017-11-20 17:46:19 -0800552 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800553}
554
Calin Juravle29591732017-11-20 17:46:19 -0800555static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800556 // Do not follow symlinks when opening a profile:
557 // - primary profiles should not contain symlinks in their paths
558 // - secondary dex paths should have been already resolved and validated
559 flags |= O_NOFOLLOW;
560
Calin Juravle29591732017-11-20 17:46:19 -0800561 // Check if we need to create the profile
562 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
563 unique_fd fd;
564 if ((flags & O_CREAT) != 0) {
565 fd = create_profile(uid, profile, flags);
566 } else {
567 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
568 }
569
Calin Juravle114f0812017-03-08 19:05:07 -0800570 if (fd.get() < 0) {
571 if (errno != ENOENT) {
572 // Profiles might be missing for various reasons. For example, in a
573 // multi-user environment, the profile directory for one user can be created
574 // after we start a merge. In this case the current profile for that user
575 // will not be found.
576 // Also, the secondary dex profiles might be deleted by the app at any time,
577 // so we can't we need to prepare if they are missing.
578 PLOG(ERROR) << "Failed to open profile " << profile;
579 }
580 return invalid_unique_fd();
581 }
582
Jeff Sharkey90aff262016-12-12 14:28:24 -0700583 return fd;
584}
585
Calin Juravle824a64d2018-01-18 20:23:17 -0800586static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
587 const std::string& location, bool is_secondary_dex) {
588 std::string profile = create_current_profile_path(user, package_name, location,
589 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800590 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800591}
592
Calin Juravle824a64d2018-01-18 20:23:17 -0800593static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
594 const std::string& location, bool read_write, bool is_secondary_dex) {
595 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800596 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
597}
598
599static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800600 const std::string& location) {
601 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800602 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800603}
604
Calin Juravle824a64d2018-01-18 20:23:17 -0800605static void open_profile_files(uid_t uid, const std::string& package_name,
606 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800607 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700608 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800609 *reference_profile_fd = open_reference_profile(uid, package_name, location,
610 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700611
Calin Juravle114f0812017-03-08 19:05:07 -0800612 // For secondary dex files, we don't really need the user but we use it for sanity checks.
613 // Note: the user owning the dex file should be the current user.
614 std::vector<userid_t> users;
615 if (is_secondary_dex){
616 users.push_back(multiuser_get_user_id(uid));
617 } else {
618 users = get_known_users(/*volume_uuid*/ nullptr);
619 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700620 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800621 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
622 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700623 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800624 if (profile_fd.get() >= 0) {
625 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700626 }
627 }
628}
629
630static void drop_capabilities(uid_t uid) {
631 if (setgid(uid) != 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800632 PLOG(ERROR) << "setgid(" << uid << ") failed in installd during dexopt";
633 exit(DexoptReturnCodes::kSetGid);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700634 }
635 if (setuid(uid) != 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800636 PLOG(ERROR) << "setuid(" << uid << ") failed in installd during dexopt";
637 exit(DexoptReturnCodes::kSetUid);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700638 }
639 // drop capabilities
640 struct __user_cap_header_struct capheader;
641 struct __user_cap_data_struct capdata[2];
642 memset(&capheader, 0, sizeof(capheader));
643 memset(&capdata, 0, sizeof(capdata));
644 capheader.version = _LINUX_CAPABILITY_VERSION_3;
645 if (capset(&capheader, &capdata[0]) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800646 PLOG(ERROR) << "capset failed";
647 exit(DexoptReturnCodes::kCapSet);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700648 }
649}
650
651static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
652static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
653static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
654static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
655static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
656
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800657class RunProfman : public ExecVHelper {
658 public:
659 void SetupArgs(const std::vector<unique_fd>& profile_fds,
660 const unique_fd& reference_profile_fd,
661 const std::vector<unique_fd>& apk_fds,
662 const std::vector<std::string>& dex_locations,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800663 bool copy_and_update,
664 bool store_aggregation_counters) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800665 const char* profman_bin =
Roland Levillain370222c2018-12-12 15:06:16 +0000666 is_debug_runtime()
667 ? "/apex/com.android.runtime/bin/profmand"
668 : "/apex/com.android.runtime/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700669
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800670 if (copy_and_update) {
671 CHECK_EQ(1u, profile_fds.size());
672 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000673 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800674 if (reference_profile_fd != -1) {
675 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000676 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800677
678 for (const unique_fd& fd : profile_fds) {
679 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
680 }
681
682 for (const unique_fd& fd : apk_fds) {
683 AddArg("--apk-fd=" + std::to_string(fd.get()));
684 }
685
686 for (const std::string& dex_location : dex_locations) {
687 AddArg("--dex-location=" + dex_location);
688 }
689
690 if (copy_and_update) {
691 AddArg("--copy-and-update-profile-key");
692 }
693
Calin Juravleb3a929d2018-12-11 14:40:00 -0800694 if (store_aggregation_counters) {
695 AddArg("--store-aggregation-counters");
696 }
697
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800698 // Do not add after dex2oat_flags, they should override others for debugging.
699 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800700 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700701
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800702 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
703 const unique_fd& reference_profile_fd,
704 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravleb3a929d2018-12-11 14:40:00 -0800705 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
706 bool store_aggregation_counters = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800707 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800708 reference_profile_fd,
709 apk_fds,
710 dex_locations,
711 /*copy_and_update=*/false,
712 store_aggregation_counters);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800713 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700714
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800715 void SetupCopyAndUpdate(unique_fd&& profile_fd,
716 unique_fd&& reference_profile_fd,
717 unique_fd&& apk_fd,
718 const std::string& dex_location) {
719 // The fds need to stay open longer than the scope of the function, so put them into a local
720 // variable vector.
721 profiles_fd_.push_back(std::move(profile_fd));
722 apk_fds_.push_back(std::move(apk_fd));
723 reference_profile_fd_ = std::move(reference_profile_fd);
724 std::vector<std::string> dex_locations = {dex_location};
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=*/true,
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 SetupDump(const std::vector<unique_fd>& profiles_fd,
734 const unique_fd& reference_profile_fd,
735 const std::vector<std::string>& dex_locations,
736 const std::vector<unique_fd>& apk_fds,
737 const unique_fd& output_fd) {
738 AddArg("--dump-only");
739 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800740 SetupArgs(profiles_fd,
741 reference_profile_fd,
742 apk_fds,
743 dex_locations,
744 /*copy_and_update=*/false,
745 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800746 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000747
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800748 void Exec() {
749 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
750 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000751
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800752 private:
753 unique_fd reference_profile_fd_;
754 std::vector<unique_fd> profiles_fd_;
755 std::vector<unique_fd> apk_fds_;
756};
Mathieu Chartier31636522018-11-09 23:53:07 +0000757
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800758
Calin Juravlef63d4792018-01-30 17:43:34 +0000759
Jeff Sharkey90aff262016-12-12 14:28:24 -0700760// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800761// The location is the package name for primary apks or the dex path for secondary dex files.
762// Returns true if there is enough information in the current profiles that makes it
763// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700764// If the return value is true all the current profiles would have been merged into
765// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800766static bool analyze_profiles(uid_t uid, const std::string& package_name,
767 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800768 std::vector<unique_fd> profiles_fd;
769 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800770 open_profile_files(uid, package_name, location, is_secondary_dex,
771 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800772 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700773 // Skip profile guided compilation because no profiles were found.
774 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700775 return false;
776 }
777
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800778 RunProfman profman_merge;
779 profman_merge.SetupMerge(profiles_fd, reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700780 pid_t pid = fork();
781 if (pid == 0) {
782 /* child -- drop privileges before continuing */
783 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800784 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700785 }
786 /* parent */
787 int return_code = wait_child(pid);
788 bool need_to_compile = false;
789 bool should_clear_current_profiles = false;
790 bool should_clear_reference_profile = false;
791 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800792 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700793 } else {
794 return_code = WEXITSTATUS(return_code);
795 switch (return_code) {
796 case PROFMAN_BIN_RETURN_CODE_COMPILE:
797 need_to_compile = true;
798 should_clear_current_profiles = true;
799 should_clear_reference_profile = false;
800 break;
801 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
802 need_to_compile = false;
803 should_clear_current_profiles = false;
804 should_clear_reference_profile = false;
805 break;
806 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800807 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700808 need_to_compile = false;
809 should_clear_current_profiles = true;
810 should_clear_reference_profile = true;
811 break;
812 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
813 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
814 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800815 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700816 need_to_compile = false;
817 should_clear_current_profiles = false;
818 should_clear_reference_profile = false;
819 break;
820 default:
821 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800822 LOG(WARNING) << "Unknown error code while processing profiles for location "
823 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700824 need_to_compile = false;
825 should_clear_current_profiles = true;
826 should_clear_reference_profile = true;
827 break;
828 }
829 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800830
Jeff Sharkey90aff262016-12-12 14:28:24 -0700831 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800832 if (is_secondary_dex) {
833 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800834 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
835 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800836 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800837 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800838 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700839 }
840 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800841 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700842 }
843 return need_to_compile;
844}
845
Calin Juravle114f0812017-03-08 19:05:07 -0800846// Decides if profile guided compilation is needed or not based on existing profiles.
847// The analysis is done for the primary apks of the given package.
848// Returns true if there is enough information in the current profiles that makes it
849// worth to recompile the package.
850// If the return value is true all the current profiles would have been merged into
851// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800852bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
853 const std::string& profile_name) {
854 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800855}
856
Calin Juravle408cd4a2018-01-20 23:34:18 -0800857bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
858 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800859 std::vector<unique_fd> profile_fds;
860 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800861 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
862 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700863
Calin Juravle408cd4a2018-01-20 23:34:18 -0800864 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800865 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700866
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800867 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700868 const bool has_profiles = !profile_fds.empty();
869
870 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800871 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700872 return false;
873 }
874
Calin Juravle114f0812017-03-08 19:05:07 -0800875 unique_fd output_fd(open(out_file_name.c_str(),
876 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700877 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800878 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700879 return false;
880 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800881
Jeff Sharkey90aff262016-12-12 14:28:24 -0700882 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800883 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800884 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
885 if (apk_fd == -1) {
886 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
887 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700888 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800889 dex_locations.push_back(get_location_from_path(code_path.c_str()));
890 apk_fds.push_back(std::move(apk_fd));
891
Jeff Sharkey90aff262016-12-12 14:28:24 -0700892
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800893 RunProfman profman_dump;
894 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700895 pid_t pid = fork();
896 if (pid == 0) {
897 /* child -- drop privileges before continuing */
898 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800899 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700900 }
901 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700902 int return_code = wait_child(pid);
903 if (!WIFEXITED(return_code)) {
904 LOG(WARNING) << "profman failed for package " << pkgname << ": "
905 << return_code;
906 return false;
907 }
908 return true;
909}
910
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700911bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800912 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700913 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
914 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800915 package_name,
916 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700917 /*read_write*/ true,
918 /*secondary*/ false));
919 if (in_fd.get() < 0) {
920 PLOG(WARNING) << "Could not open profile " << system_profile;
921 return false;
922 }
923 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800924 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700925 return false;
926 }
927
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700928 // As a security measure we want to write the profile information with the reduced capabilities
929 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700930 pid_t pid = fork();
931 if (pid == 0) {
932 /* child -- drop privileges before continuing */
933 drop_capabilities(packageUid);
934
935 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
936 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800937 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700938 }
939 // This implies that the app owning this profile is running
940 // (and has acquired the lock).
941 //
942 // The app never acquires the lock for the reference profiles of primary apks.
943 // Only dex2oat from installd will do that. Since installd is single threaded
944 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800945 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700946 return false;
947 }
948
949 bool truncated = ftruncate(out_fd.get(), 0) == 0;
950 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800951 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700952 }
953
954 // Copy over data.
955 static constexpr size_t kBufferSize = 4 * 1024;
956 char buffer[kBufferSize];
957 while (true) {
958 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
959 if (bytes == 0) {
960 break;
961 }
962 write(out_fd.get(), buffer, bytes);
963 }
964 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800965 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700966 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700967 // Use _exit since we don't want to run the global destructors in the child.
968 // b/62597429
969 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700970 }
971 /* parent */
972 int return_code = wait_child(pid);
973 return return_code == 0;
974}
975
Jeff Sharkey90aff262016-12-12 14:28:24 -0700976static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
977 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
978 if (EndsWith(oat_path, ".dex")) {
979 std::string new_path = oat_path;
980 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800981 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700982 return new_path;
983 }
984
985 // An odex entry. Not that this may not be an extension, e.g., in the OTA
986 // case (where the base name will have an extension for the B artifact).
987 size_t odex_pos = oat_path.rfind(".odex");
988 if (odex_pos != std::string::npos) {
989 std::string new_path = oat_path;
990 new_path.replace(odex_pos, strlen(".odex"), new_ext);
991 CHECK_NE(new_path.find(new_ext), std::string::npos);
992 return new_path;
993 }
994
995 // Don't know how to handle this.
996 return "";
997}
998
999// Translate the given oat path to an art (app image) path. An empty string
1000// denotes an error.
1001static std::string create_image_filename(const std::string& oat_path) {
1002 return replace_file_extension(oat_path, ".art");
1003}
1004
1005// Translate the given oat path to a vdex path. An empty string denotes an error.
1006static std::string create_vdex_filename(const std::string& oat_path) {
1007 return replace_file_extension(oat_path, ".vdex");
1008}
1009
Jeff Sharkey90aff262016-12-12 14:28:24 -07001010static int open_output_file(const char* file_name, bool recreate, int permissions) {
1011 int flags = O_RDWR | O_CREAT;
1012 if (recreate) {
1013 if (unlink(file_name) < 0) {
1014 if (errno != ENOENT) {
1015 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1016 }
1017 }
1018 flags |= O_EXCL;
1019 }
1020 return open(file_name, flags, permissions);
1021}
1022
Calin Juravle2289c0a2017-02-15 12:44:14 -08001023static bool set_permissions_and_ownership(
1024 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1025 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1026 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001027 if (fchmod(fd,
1028 S_IRUSR|S_IWUSR|S_IRGRP |
1029 (is_public ? S_IROTH : 0)) < 0) {
1030 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1031 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001032 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001033 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1034 return false;
1035 }
1036 return true;
1037}
1038
1039static bool IsOutputDalvikCache(const char* oat_dir) {
1040 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1041 // into '!'. Play it safe by handling it both.
1042 // TODO: ensure we never get null.
1043 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1044 return oat_dir == nullptr || oat_dir[0] == '!';
1045}
1046
Calin Juravled23dee72017-07-06 16:29:11 -07001047// Best-effort check whether we can fit the the path into our buffers.
1048// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1049// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1050// extension to the cache path (5 bytes).
1051// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1052static bool validate_dex_path_size(const std::string& dex_path) {
1053 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1054 LOG(ERROR) << "dex_path too long: " << dex_path;
1055 return false;
1056 }
1057 return true;
1058}
1059
Jeff Sharkey90aff262016-12-12 14:28:24 -07001060static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001061 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001062 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001063 return false;
1064 }
1065
1066 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001067 // Oat dirs for secondary dex files are already validated.
1068 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001069 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1070 return false;
1071 }
1072 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1073 return false;
1074 }
1075 } else {
1076 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1077 return false;
1078 }
1079 }
1080 return true;
1081}
1082
1083// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1084// on destruction. It will also run the given cleanup (unless told not to) after closing.
1085//
1086// Usage example:
1087//
Calin Juravle7a570e82017-01-14 16:23:30 -08001088// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001089// [name]() {
1090// unlink(name.c_str());
1091// });
1092// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1093// wrapper if captured as a reference.
1094//
1095// if (file.get() == -1) {
1096// // Error opening...
1097// }
1098//
1099// ...
1100// if (error) {
1101// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1102// // and delete the file (after the fd is closed).
1103// return -1;
1104// }
1105//
1106// (Success case)
1107// file.SetCleanup(false);
1108// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1109// // (leaving the file around; after the fd is closed).
1110//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001111class Dex2oatFileWrapper {
1112 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001113 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001114 }
1115
Calin Juravle7a570e82017-01-14 16:23:30 -08001116 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1117 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1118
1119 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1120 value_ = other.value_;
1121 cleanup_ = other.cleanup_;
1122 do_cleanup_ = other.do_cleanup_;
1123 auto_close_ = other.auto_close_;
1124 other.release();
1125 }
1126
1127 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1128 value_ = other.value_;
1129 cleanup_ = other.cleanup_;
1130 do_cleanup_ = other.do_cleanup_;
1131 auto_close_ = other.auto_close_;
1132 other.release();
1133 return *this;
1134 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001135
1136 ~Dex2oatFileWrapper() {
1137 reset(-1);
1138 }
1139
1140 int get() {
1141 return value_;
1142 }
1143
1144 void SetCleanup(bool cleanup) {
1145 do_cleanup_ = cleanup;
1146 }
1147
1148 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001149 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001150 close(value_);
1151 }
1152 if (do_cleanup_ && cleanup_ != nullptr) {
1153 cleanup_();
1154 }
1155
1156 value_ = new_value;
1157 }
1158
Calin Juravle7a570e82017-01-14 16:23:30 -08001159 void reset(int new_value, std::function<void ()> new_cleanup) {
1160 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001161 close(value_);
1162 }
1163 if (do_cleanup_ && cleanup_ != nullptr) {
1164 cleanup_();
1165 }
1166
1167 value_ = new_value;
1168 cleanup_ = new_cleanup;
1169 }
1170
Calin Juravle7a570e82017-01-14 16:23:30 -08001171 void DisableAutoClose() {
1172 auto_close_ = false;
1173 }
1174
Jeff Sharkey90aff262016-12-12 14:28:24 -07001175 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001176 void release() {
1177 value_ = -1;
1178 do_cleanup_ = false;
1179 cleanup_ = nullptr;
1180 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001181 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001182 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001183 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001184 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001185};
1186
Calin Juravle7a570e82017-01-14 16:23:30 -08001187// (re)Creates the app image if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001188Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path,
1189 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001190
1191 // We don't create an image for secondary dex files.
1192 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001193 return Dex2oatFileWrapper();
1194 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001195
Calin Juravle7a570e82017-01-14 16:23:30 -08001196 const std::string image_path = create_image_filename(out_oat_path);
1197 if (image_path.empty()) {
1198 // Happens when the out_oat_path has an unknown extension.
1199 return Dex2oatFileWrapper();
1200 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001201
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001202 // In case there is a stale image, remove it now. Ignore any error.
1203 unlink(image_path.c_str());
1204
1205 // Not enabled, exit.
1206 if (!generate_app_image) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001207 return Dex2oatFileWrapper();
1208 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -07001209 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
1210 if (app_image_format.empty()) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001211 return Dex2oatFileWrapper();
1212 }
1213 // Recreate is true since we do not want to modify a mapped image. If the app is
1214 // already running and we modify the image file, it can cause crashes (b/27493510).
1215 Dex2oatFileWrapper wrapper_fd(
1216 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1217 [image_path]() { unlink(image_path.c_str()); });
1218 if (wrapper_fd.get() < 0) {
1219 // Could not create application image file. Go on since we can compile without it.
1220 LOG(ERROR) << "installd could not create '" << image_path
1221 << "' for image file during dexopt";
1222 // If we have a valid image file path but no image fd, explicitly erase the image file.
1223 if (unlink(image_path.c_str()) < 0) {
1224 if (errno != ENOENT) {
1225 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1226 }
1227 }
1228 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001229 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001230 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1231 wrapper_fd.reset(-1);
1232 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001233
Calin Juravle7a570e82017-01-14 16:23:30 -08001234 return wrapper_fd;
1235}
1236
1237// Creates the dexopt swap file if necessary and return its fd.
1238// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001239unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001240 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001241 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001242 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001243 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001244 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001245 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001246 if (swap_fd.get() < 0) {
1247 // Could not create swap file. Optimistically go on and hope that we can compile
1248 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001249 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001250 } else {
1251 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001252 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001253 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1254 }
1255 }
1256 return swap_fd;
1257}
1258
1259// Opens the reference profiles if needed.
1260// 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 -08001261Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001262 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -08001263 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +00001264 // If we are not profile guided compilation, or we are compiling system server
1265 // do not bother to open the profiles; we won't be using them.
1266 if (!profile_guided || (pkgname[0] == '*')) {
1267 return Dex2oatFileWrapper();
1268 }
1269
1270 // If this is a secondary dex path which is public do not open the profile.
1271 // We cannot compile public secondary dex paths with profiles. That's because
1272 // it will expose how the dex files are used by their owner.
1273 //
1274 // Note that the PackageManager is responsible to set the is_public flag for
1275 // primary apks and we do not check it here. In some cases, e.g. when
1276 // compiling with a public profile from the .dm file the PackageManager will
1277 // set is_public toghether with the profile guided compilation.
1278 if (is_secondary_dex && is_public) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001279 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001280 }
Calin Juravle114f0812017-03-08 19:05:07 -08001281
1282 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001283 std::string location;
1284 if (is_secondary_dex) {
1285 location = dex_path;
1286 } else {
1287 if (profile_name == nullptr) {
1288 // This path is taken for system server re-compilation lunched from ZygoteInit.
1289 return Dex2oatFileWrapper();
1290 } else {
1291 location = profile_name;
1292 }
1293 }
Calin Juravle824a64d2018-01-18 20:23:17 -08001294 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1295 is_secondary_dex);
1296 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1297 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001298 };
1299 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001300}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001301
Calin Juravle7a570e82017-01-14 16:23:30 -08001302// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1303// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001304bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001305 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001306 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001307 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1308 CHECK(in_vdex_wrapper_fd != nullptr);
1309 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001310 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1311 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001312 char in_odex_path[PKG_PATH_MAX];
1313 int dexopt_action = abs(dexopt_needed);
1314 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001315 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001316
1317 // Infer the name of the output VDEX.
1318 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1319 if (out_vdex_path_str.empty()) {
1320 return false;
1321 }
1322
1323 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001324 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001325 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1326 const char* path = nullptr;
1327 if (is_odex_location) {
1328 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1329 path = in_odex_path;
1330 } else {
1331 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001332 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001333 }
1334 } else {
1335 path = out_oat_path;
1336 }
1337 in_vdex_path_str = create_vdex_filename(path);
1338 if (in_vdex_path_str.empty()) {
1339 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001340 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001341 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001342 // We can update in place when all these conditions are met:
1343 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1344 // on /system typically cannot be updated in place).
1345 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1346 // cannot be currently used by a running process.
1347 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1348 // different vdex files to operate.
1349 update_vdex_in_place =
1350 (in_vdex_path_str == out_vdex_path_str) &&
1351 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1352 !profile_guided;
1353 if (update_vdex_in_place) {
1354 // Open the file read-write to be able to update it.
1355 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1356 if (in_vdex_wrapper_fd->get() == -1) {
1357 // If we failed to open the file, we cannot update it in place.
1358 update_vdex_in_place = false;
1359 }
1360 } else {
1361 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1362 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001363 }
1364
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001365 // If we are updating the vdex in place, we do not need to recreate a vdex,
1366 // and can use the same existing one.
1367 if (update_vdex_in_place) {
1368 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1369 // have bogus stale vdex files.
1370 out_vdex_wrapper_fd->reset(
1371 in_vdex_wrapper_fd->get(),
1372 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1373 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1374 // wrapper).
1375 in_vdex_wrapper_fd->DisableAutoClose();
1376 } else {
1377 out_vdex_wrapper_fd->reset(
1378 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1379 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1380 if (out_vdex_wrapper_fd->get() < 0) {
1381 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1382 return false;
1383 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001384 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001385 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001386 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001387 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1388 return false;
1389 }
1390
1391 // If we got here we successfully opened the vdex files.
1392 return true;
1393}
1394
1395// Opens the output oat file for the given apk.
1396// If successful it stores the output path into out_oat_path and returns true.
1397Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001398 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1399 char* out_oat_path) {
1400 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001401 return Dex2oatFileWrapper();
1402 }
1403 const std::string out_oat_path_str(out_oat_path);
1404 Dex2oatFileWrapper wrapper_fd(
1405 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1406 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1407 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001408 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001409 } else if (!set_permissions_and_ownership(
1410 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001411 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1412 wrapper_fd.reset(-1);
1413 }
1414 return wrapper_fd;
1415}
1416
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001417// Creates RDONLY fds for oat and vdex files, if exist.
1418// Returns false if it fails to create oat out path for the given apk path.
1419// Note that the method returns true even if the files could not be opened.
1420bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1421 const std::string& oat_dir,
1422 const std::string& instruction_set,
1423 bool is_secondary_dex,
1424 unique_fd* oat_file_fd,
1425 unique_fd* vdex_file_fd) {
1426 char oat_path[PKG_PATH_MAX];
1427 if (!create_oat_out_path(apk_path.c_str(),
1428 instruction_set.c_str(),
1429 oat_dir.c_str(),
1430 is_secondary_dex,
1431 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001432 LOG(ERROR) << "Could not create oat out path for "
1433 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001434 return false;
1435 }
1436 oat_file_fd->reset(open(oat_path, O_RDONLY));
1437 if (oat_file_fd->get() < 0) {
1438 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1439 }
1440
1441 std::string vdex_filename = create_vdex_filename(oat_path);
1442 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1443 if (vdex_file_fd->get() < 0) {
1444 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1445 }
1446
1447 return true;
1448}
1449
Calin Juravle7a570e82017-01-14 16:23:30 -08001450// Updates the access times of out_oat_path based on those from apk_path.
1451void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1452 struct stat input_stat;
1453 memset(&input_stat, 0, sizeof(input_stat));
1454 if (stat(apk_path, &input_stat) != 0) {
1455 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1456 return;
1457 }
1458
1459 struct utimbuf ut;
1460 ut.actime = input_stat.st_atime;
1461 ut.modtime = input_stat.st_mtime;
1462 if (utime(out_oat_path, &ut) != 0) {
1463 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1464 }
1465}
1466
Calin Juravle80a21252017-01-17 14:43:25 -08001467// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001468// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1469// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1470// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001471class RunDexoptAnalyzer : public ExecVHelper {
1472 public:
1473 RunDexoptAnalyzer(const std::string& dex_file,
1474 int vdex_fd,
1475 int oat_fd,
1476 int zip_fd,
1477 const std::string& instruction_set,
1478 const std::string& compiler_filter,
1479 bool profile_was_updated,
1480 bool downgrade,
1481 const char* class_loader_context) {
1482 CHECK_GE(zip_fd, 0);
1483 const char* dexoptanalyzer_bin =
Roland Levillain370222c2018-12-12 15:06:16 +00001484 is_debug_runtime()
1485 ? "/apex/com.android.runtime/bin/dexoptanalyzerd"
1486 : "/apex/com.android.runtime/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001487
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001488 std::string dex_file_arg = "--dex-file=" + dex_file;
1489 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1490 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1491 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1492 std::string isa_arg = "--isa=" + instruction_set;
1493 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1494 const char* assume_profile_changed = "--assume-profile-changed";
1495 const char* downgrade_flag = "--downgrade";
1496 std::string class_loader_context_arg = "--class-loader-context=";
1497 if (class_loader_context != nullptr) {
1498 class_loader_context_arg += class_loader_context;
1499 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001500
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001501 // program name, dex file, isa, filter
1502 AddArg(dex_file_arg);
1503 AddArg(isa_arg);
1504 AddArg(compiler_filter_arg);
1505 if (oat_fd >= 0) {
1506 AddArg(oat_fd_arg);
1507 }
1508 if (vdex_fd >= 0) {
1509 AddArg(vdex_fd_arg);
1510 }
1511 AddArg(zip_fd_arg.c_str());
1512 if (profile_was_updated) {
1513 AddArg(assume_profile_changed);
1514 }
1515 if (downgrade) {
1516 AddArg(downgrade_flag);
1517 }
1518 if (class_loader_context != nullptr) {
1519 AddArg(class_loader_context_arg.c_str());
1520 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001521
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001522 PrepareArgs(dexoptanalyzer_bin);
1523 }
1524};
Calin Juravle80a21252017-01-17 14:43:25 -08001525
1526// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001527static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001528 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001529 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001530 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001531 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001532 return false;
1533 }
Calin Juravle114f0812017-03-08 19:05:07 -08001534 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001535
Calin Juravle80a21252017-01-17 14:43:25 -08001536 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001537 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1538 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001539 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001540 return false;
1541 }
1542
1543 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001544 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001545
Calin Juravle7d765462017-09-04 15:57:10 -07001546 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001547 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001548 return false;
1549 }
1550
1551 return true;
1552}
1553
Calin Juravle7d765462017-09-04 15:57:10 -07001554// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1555// secondary dex files. This return codes are returned by the child process created for
1556// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001557
Andreas Gampe194fe422018-02-28 20:16:19 -08001558enum DexoptAnalyzerSkipCodes {
1559 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001560 // Specific errors are encoded in the name.
1561 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1562 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1563 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1564 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1565 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001566 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001567 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001568};
Calin Juravle7d765462017-09-04 15:57:10 -07001569
1570// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001571// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1572// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001573// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1574// of dexoptanalyzer.
1575static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001576 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001577 // The result values are defined in dexoptanalyzer.
1578 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001579 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001580 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001581 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001582 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001583 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001584 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001585 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001586 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001587 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1588 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001589 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1590 " Expected odex file status for secondary dex %s"
1591 " : dexoptanalyzer result=%d",
1592 dex_path.c_str(),
1593 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001594 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001595 }
1596
1597 // Use a second switch for enum switch-case analysis.
1598 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001599 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001600 // If the file does not exist there's no need for dexopt.
1601 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1602 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001603
1604 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1605 *error_msg = "Dexoptanalyzer path validation failed";
1606 return false;
1607 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1608 *error_msg = "Dexoptanalyzer open zip failed";
1609 return false;
1610 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1611 *error_msg = "Dexoptanalyzer dir preparation failed";
1612 return false;
1613 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1614 *error_msg = "Dexoptanalyzer open output failed";
1615 return false;
1616 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1617 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001618 return false;
1619 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001620
1621 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1622 dex_path.c_str(),
1623 result);
1624 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001625}
1626
Calin Juravle7d765462017-09-04 15:57:10 -07001627enum SecondaryDexAccess {
1628 kSecondaryDexAccessReadOk = 0,
1629 kSecondaryDexAccessDoesNotExist = 1,
1630 kSecondaryDexAccessPermissionError = 2,
1631 kSecondaryDexAccessIOError = 3
1632};
1633
1634static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1635 // Check if the path exists and can be read. If not, there's nothing to do.
1636 if (access(dex_path.c_str(), R_OK) == 0) {
1637 return kSecondaryDexAccessReadOk;
1638 } else {
1639 if (errno == ENOENT) {
1640 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1641 return kSecondaryDexAccessDoesNotExist;
1642 } else {
1643 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1644 return errno == EACCES
1645 ? kSecondaryDexAccessPermissionError
1646 : kSecondaryDexAccessIOError;
1647 }
1648 }
1649}
1650
1651static bool is_file_public(const std::string& filename) {
1652 struct stat file_stat;
1653 if (stat(filename.c_str(), &file_stat) == 0) {
1654 return (file_stat.st_mode & S_IROTH) != 0;
1655 }
1656 return false;
1657}
1658
1659// Create the oat file structure for the secondary dex 'dex_path' and assign
1660// the individual path component to the 'out_' parameters.
1661static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001662 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001663 size_t dirIndex = dex_path.rfind('/');
1664 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001665 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001666 return false;
1667 }
1668 // TODO(calin): we have similar computations in at lest 3 other places
1669 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1670 // using string append.
1671 std::string apk_dir = dex_path.substr(0, dirIndex);
1672 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1673 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1674
1675 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1676 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001677 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001678 return false;
1679 }
1680 return true;
1681}
1682
1683// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1684// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001685static bool validate_dexopt_storage_flags(int dexopt_flags,
1686 int* out_storage_flag,
1687 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001688 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1689 *out_storage_flag = FLAG_STORAGE_CE;
1690 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001691 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001692 return false;
1693 }
1694 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1695 *out_storage_flag = FLAG_STORAGE_DE;
1696 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001697 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001698 return false;
1699 }
1700 return true;
1701}
1702
Calin Juravlec9eab382017-01-25 01:17:17 -08001703// 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 -08001704// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1705// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001706// When returning true, the output parameters will be:
1707// - is_public_out: whether or not the oat file should not be made public
1708// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1709// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001710static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001711 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001712 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001713 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
1714 /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001715 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001716 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001717 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1718 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001719 return false;
1720 }
Calin Juravle7d765462017-09-04 15:57:10 -07001721 // Compute the oat dir as it's not easy to extract it from the child computation.
1722 char oat_path[PKG_PATH_MAX];
1723 char oat_dir[PKG_PATH_MAX];
1724 char oat_isa_dir[PKG_PATH_MAX];
1725 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001726 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1727 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001728 return false;
1729 }
Calin Juravle7d765462017-09-04 15:57:10 -07001730 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001731
Calin Juravle80a21252017-01-17 14:43:25 -08001732 pid_t pid = fork();
1733 if (pid == 0) {
1734 // child -- drop privileges before continuing.
1735 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001736
1737 // Validate the path structure.
1738 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1739 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001740 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001741 }
1742
1743 // Open the dex file.
1744 unique_fd zip_fd;
1745 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1746 if (zip_fd.get() < 0) {
1747 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001748 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001749 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001750 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001751 }
1752 }
1753
1754 // Prepare the oat directories.
1755 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001756 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001757 }
1758
1759 // Open the vdex/oat files if any.
1760 unique_fd oat_file_fd;
1761 unique_fd vdex_file_fd;
1762 if (!maybe_open_oat_and_vdex_file(dex_path,
1763 *oat_dir_out,
1764 instruction_set,
1765 true /* is_secondary_dex */,
1766 &oat_file_fd,
1767 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001768 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001769 }
1770
1771 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001772 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1773 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001774
1775 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001776 // Note that we do not do it before the fork since opening the files is required to happen
1777 // after forking.
1778 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1779 vdex_file_fd.get(),
1780 oat_file_fd.get(),
1781 zip_fd.get(),
1782 instruction_set,
1783 compiler_filter, profile_was_updated,
1784 downgrade,
1785 class_loader_context);
1786 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001787 }
1788
1789 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001790 int result = wait_child(pid);
1791 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001792 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1793 dex_path.c_str(),
1794 result);
1795 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001796 return false;
1797 }
1798 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001799 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001800 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1801 result,
1802 dexopt_needed_out,
1803 error_msg);
1804 if (!success) {
1805 LOG(ERROR) << *error_msg;
1806 }
Calin Juravle7d765462017-09-04 15:57:10 -07001807
1808 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1809
Calin Juravle80a21252017-01-17 14:43:25 -08001810 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001811 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1812 // makes the code simpler; force compilation is only needed during tests).
1813 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001814 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001815 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001816 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1817 }
1818
Calin Juravle7d765462017-09-04 15:57:10 -07001819 // Check if we should make the oat file public.
1820 // Note that if the dex file is not public the compiled code cannot be made public.
1821 // It is ok to check this flag outside in the parent process.
1822 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1823
Calin Juravle80a21252017-01-17 14:43:25 -08001824 return success;
1825}
1826
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001827static std::string format_dexopt_error(int status, const char* dex_path) {
1828 if (WIFEXITED(status)) {
1829 int int_code = WEXITSTATUS(status);
1830 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1831 if (code_name != nullptr) {
1832 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1833 }
1834 }
1835 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001836}
1837
Calin Juravlec9eab382017-01-25 01:17:17 -08001838int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001839 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001840 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001841 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001842 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001843 CHECK(pkgname != nullptr);
1844 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001845 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001846 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1847 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001848
Calin Juravled23dee72017-07-06 16:29:11 -07001849 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001850 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001851 return -1;
1852 }
1853
1854 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001855 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1856 class_loader_context);
1857 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001858 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001859 }
1860
Calin Juravleebc8a792017-04-04 20:21:05 -07001861 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001862 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1863 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1864 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001865 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001866 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001867 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001868 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001869 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001870
1871 // Check if we're dealing with a secondary dex file and if we need to compile it.
1872 std::string oat_dir_str;
1873 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001874 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001875 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Andreas Gampe194fe422018-02-28 20:16:19 -08001876 downgrade, class_loader_context, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001877 oat_dir = oat_dir_str.c_str();
1878 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1879 return 0; // Nothing to do, report success.
1880 }
1881 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001882 if (error_msg->empty()) { // TODO: Make this a CHECK.
1883 *error_msg = "Failed processing secondary.";
1884 }
Calin Juravle80a21252017-01-17 14:43:25 -08001885 return -1; // We had an error, logged in the process method.
1886 }
1887 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001888 // Currently these flags are only use for secondary dex files.
1889 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001890 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1891 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1892 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001893
1894 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001895 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001896 if (input_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001897 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1898 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001899 return -1;
1900 }
1901
1902 // Create the output OAT file.
1903 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001904 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001905 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001906 if (out_oat_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001907 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001908 return -1;
1909 }
1910
1911 // Open vdex files.
1912 Dex2oatFileWrapper in_vdex_fd;
1913 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001914 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1915 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001916 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001917 return -1;
1918 }
1919
Calin Juravlecb556e32017-04-04 20:22:50 -07001920 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1921 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1922 // fully inherit their parent context).
1923 // Note that for primary apk the oat files are created before, in a separate installd
1924 // call which also does the restorecon. TODO(calin): unify the paths.
1925 if (is_secondary_dex) {
1926 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1927 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001928 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1929 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001930 return -1;
1931 }
1932 }
1933
Jeff Sharkey90aff262016-12-12 14:28:24 -07001934 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001935 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001936
Calin Juravle7a570e82017-01-14 16:23:30 -08001937 // Create the app image file if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001938 Dex2oatFileWrapper image_fd = maybe_open_app_image(
1939 out_oat_path, generate_app_image, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001940
Calin Juravle7a570e82017-01-14 16:23:30 -08001941 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001942 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001943 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001944
Calin Juravle62c5a372018-02-01 17:03:23 +00001945 unique_fd dex_metadata_fd;
1946 if (dex_metadata_path != nullptr) {
1947 dex_metadata_fd.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)));
1948 if (dex_metadata_fd.get() < 0) {
1949 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1950 }
1951 }
1952
Andreas Gampe023b2242018-02-28 16:03:25 -08001953 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001954
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001955 RunDex2Oat runner(input_fd.get(),
1956 out_oat_fd.get(),
1957 in_vdex_fd.get(),
1958 out_vdex_fd.get(),
1959 image_fd.get(),
1960 dex_path,
1961 out_oat_path,
1962 swap_fd.get(),
1963 instruction_set,
1964 compiler_filter,
1965 debuggable,
1966 boot_complete,
1967 background_job_compile,
1968 reference_profile_fd.get(),
1969 class_loader_context,
1970 target_sdk_version,
1971 enable_hidden_api_checks,
1972 generate_compact_dex,
1973 dex_metadata_fd.get(),
1974 compilation_reason);
1975
Jeff Sharkey90aff262016-12-12 14:28:24 -07001976 pid_t pid = fork();
1977 if (pid == 0) {
1978 /* child -- drop privileges before continuing */
1979 drop_capabilities(uid);
1980
Richard Uhler76cc0272016-12-08 10:46:35 +00001981 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001982 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001983 PLOG(ERROR) << "flock(" << out_oat_path << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001984 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001985 }
1986
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001987 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001988 } else {
1989 int res = wait_child(pid);
1990 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001991 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001992 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001993 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1994 << std::hex << std::setw(4) << res << ", process failed";
1995 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001996 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001997 }
1998 }
1999
Calin Juravlec9eab382017-01-25 01:17:17 -08002000 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002001
2002 // We've been successful, don't delete output.
2003 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08002004 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002005 image_fd.SetCleanup(false);
2006 reference_profile_fd.SetCleanup(false);
2007
2008 return 0;
2009}
2010
Calin Juravlec9eab382017-01-25 01:17:17 -08002011// Try to remove the given directory. Log an error if the directory exists
2012// and is empty but could not be removed.
2013static bool rmdir_if_empty(const char* dir) {
2014 if (rmdir(dir) == 0) {
2015 return true;
2016 }
2017 if (errno == ENOENT || errno == ENOTEMPTY) {
2018 return true;
2019 }
2020 PLOG(ERROR) << "Failed to remove dir: " << dir;
2021 return false;
2022}
2023
2024// Try to unlink the given file. Log an error if the file exists and could not
2025// be unlinked.
2026static bool unlink_if_exists(const std::string& file) {
2027 if (unlink(file.c_str()) == 0) {
2028 return true;
2029 }
2030 if (errno == ENOENT) {
2031 return true;
2032
2033 }
2034 PLOG(ERROR) << "Could not unlink: " << file;
2035 return false;
2036}
2037
Calin Juravle7d765462017-09-04 15:57:10 -07002038enum ReconcileSecondaryDexResult {
2039 kReconcileSecondaryDexExists = 0,
2040 kReconcileSecondaryDexCleanedUp = 1,
2041 kReconcileSecondaryDexValidationError = 2,
2042 kReconcileSecondaryDexCleanUpError = 3,
2043 kReconcileSecondaryDexAccessIOError = 4,
2044};
Calin Juravlec9eab382017-01-25 01:17:17 -08002045
2046// Reconcile the secondary dex 'dex_path' and its generated oat files.
2047// Return true if all the parameters are valid and the secondary dex file was
2048// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
2049// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
2050// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
2051// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
2052// Return false if there were errors during processing. In this case
2053// out_secondary_dex_exists will be set to false.
2054bool reconcile_secondary_dex_file(const std::string& dex_path,
2055 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
2056 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2057 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07002058 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08002059 if (isas.size() == 0) {
2060 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
2061 return false;
2062 }
2063
Calin Juravle7d765462017-09-04 15:57:10 -07002064 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2065 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2066 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002067 return false;
2068 }
2069
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002070 // As a security measure we want to unlink art artifacts with the reduced capabilities
2071 // of the package user id. So we fork and drop capabilities in the child.
2072 pid_t pid = fork();
2073 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002074 /* child -- drop privileges before continuing */
2075 drop_capabilities(uid);
2076
2077 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2078 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2079 uid, storage_flag)) {
2080 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2081 _exit(kReconcileSecondaryDexValidationError);
2082 }
2083
2084 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2085 switch (access_check) {
2086 case kSecondaryDexAccessDoesNotExist:
2087 // File does not exist. Proceed with cleaning.
2088 break;
2089 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2090 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2091 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2092 default:
2093 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2094 _exit(kReconcileSecondaryDexValidationError);
2095 }
2096
2097 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002098 char oat_path[PKG_PATH_MAX];
2099 char oat_dir[PKG_PATH_MAX];
2100 char oat_isa_dir[PKG_PATH_MAX];
2101 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002102 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08002103 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002104 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08002105 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
2106 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002107 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002108 }
Calin Juravle51314092017-05-18 15:33:05 -07002109
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002110 // Delete oat/vdex/art files.
2111 result = unlink_if_exists(oat_path) && result;
2112 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2113 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002114
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002115 // Delete profiles.
2116 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002117 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002118 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002119 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002120 result = unlink_if_exists(current_profile) && result;
2121 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002122
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002123 // We upgraded once the location of current profile for secondary dex files.
2124 // Check for any previous left-overs and remove them as well.
2125 std::string old_current_profile = dex_path + ".prof";
2126 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002127
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002128 // Try removing the directories as well, they might be empty.
2129 result = rmdir_if_empty(oat_isa_dir) && result;
2130 result = rmdir_if_empty(oat_dir) && result;
2131 }
Calin Juravle7d765462017-09-04 15:57:10 -07002132 if (!result) {
2133 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2134 }
2135 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002136 }
2137
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002138 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002139 if (!WIFEXITED(return_code)) {
2140 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2141 } else {
2142 return_code = WEXITSTATUS(return_code);
2143 }
2144
2145 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2146
2147 switch (return_code) {
2148 case kReconcileSecondaryDexCleanedUp:
2149 case kReconcileSecondaryDexValidationError:
2150 // If we couldn't validate assume the dex file does not exist.
2151 // This will purge the entry from the PM records.
2152 *out_secondary_dex_exists = false;
2153 return true;
2154 case kReconcileSecondaryDexExists:
2155 *out_secondary_dex_exists = true;
2156 return true;
2157 case kReconcileSecondaryDexAccessIOError:
2158 // We had an access IO error.
2159 // Return false so that we can try again.
2160 // The value of out_secondary_dex_exists does not matter in this case and by convention
2161 // is set to false.
2162 *out_secondary_dex_exists = false;
2163 return false;
2164 default:
2165 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2166 *out_secondary_dex_exists = false;
2167 return false;
2168 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002169}
2170
Alan Stokesa25d90c2017-10-16 10:56:00 +01002171// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2172// Returns true if all parameters are valid and the hash successfully computed and stored in
2173// out_secondary_dex_hash.
2174// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2175// the app.
2176// For any other errors (e.g. if any of the parameters are invalid) returns false.
2177bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2178 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2179 std::vector<uint8_t>* out_secondary_dex_hash) {
2180 out_secondary_dex_hash->clear();
2181
2182 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2183
2184 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2185 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2186 << storage_flag;
2187 return false;
2188 }
2189
2190 // Pipe to get the hash result back from our child process.
2191 unique_fd pipe_read, pipe_write;
2192 if (!Pipe(&pipe_read, &pipe_write)) {
2193 PLOG(ERROR) << "Failed to create pipe";
2194 return false;
2195 }
2196
2197 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2198 // access data the app itself can access.
2199 pid_t pid = fork();
2200 if (pid == 0) {
2201 // child -- drop privileges before continuing
2202 drop_capabilities(uid);
2203 pipe_read.reset();
2204
2205 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2206 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002207 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002208 }
2209
2210 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2211 if (fd == -1) {
2212 if (errno == EACCES || errno == ENOENT) {
2213 // Not treated as an error.
2214 _exit(0);
2215 }
2216 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002217 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002218 }
2219
2220 SHA256_CTX ctx;
2221 SHA256_Init(&ctx);
2222
2223 std::vector<uint8_t> buffer(65536);
2224 while (true) {
2225 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2226 if (bytes_read == 0) {
2227 break;
2228 } else if (bytes_read == -1) {
2229 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002230 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002231 }
2232
2233 SHA256_Update(&ctx, buffer.data(), bytes_read);
2234 }
2235
2236 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2237 SHA256_Final(hash.data(), &ctx);
2238 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002239 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002240 }
2241
2242 _exit(0);
2243 }
2244
2245 // parent
2246 pipe_write.reset();
2247
2248 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2249 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2250 out_secondary_dex_hash->clear();
2251 }
2252 return wait_child(pid) == 0;
2253}
2254
Jeff Sharkey90aff262016-12-12 14:28:24 -07002255// Helper for move_ab, so that we can have common failure-case cleanup.
2256static bool unlink_and_rename(const char* from, const char* to) {
2257 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2258 // return a failure.
2259 struct stat s;
2260 if (stat(to, &s) == 0) {
2261 if (!S_ISREG(s.st_mode)) {
2262 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2263 return false;
2264 }
2265 if (unlink(to) != 0) {
2266 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2267 return false;
2268 }
2269 } else {
2270 // This may be a permission problem. We could investigate the error code, but we'll just
2271 // let the rename failure do the work for us.
2272 }
2273
2274 // Try to rename "to" to "from."
2275 if (rename(from, to) != 0) {
2276 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2277 return false;
2278 }
2279 return true;
2280}
2281
2282// Move/rename a B artifact (from) to an A artifact (to).
2283static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2284 // Check whether B exists.
2285 {
2286 struct stat s;
2287 if (stat(b_path.c_str(), &s) != 0) {
2288 // Silently ignore for now. The service calling this isn't smart enough to understand
2289 // lack of artifacts at the moment.
2290 return false;
2291 }
2292 if (!S_ISREG(s.st_mode)) {
2293 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2294 // Try to unlink, but swallow errors.
2295 unlink(b_path.c_str());
2296 return false;
2297 }
2298 }
2299
2300 // Rename B to A.
2301 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2302 // Delete the b_path so we don't try again (or fail earlier).
2303 if (unlink(b_path.c_str()) != 0) {
2304 PLOG(ERROR) << "Could not unlink " << b_path;
2305 }
2306
2307 return false;
2308 }
2309
2310 return true;
2311}
2312
2313bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2314 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002315 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2316 if (slot_suffix.empty()) {
2317 return false;
2318 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002319
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002320 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2321 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2322 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002323 }
2324
2325 // Validate other inputs.
2326 if (validate_apk_path(apk_path) != 0) {
2327 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2328 return false;
2329 }
2330 if (validate_apk_path(oat_dir) != 0) {
2331 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2332 return false;
2333 }
2334
2335 char a_path[PKG_PATH_MAX];
2336 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2337 return false;
2338 }
2339 const std::string a_vdex_path = create_vdex_filename(a_path);
2340 const std::string a_image_path = create_image_filename(a_path);
2341
2342 // B path = A path + slot suffix.
2343 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2344 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2345 const std::string b_image_path = StringPrintf("%s.%s",
2346 a_image_path.c_str(),
2347 slot_suffix.c_str());
2348
2349 bool success = true;
2350 if (move_ab_path(b_path, a_path)) {
2351 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2352 // Note: we can live without an app image. As such, ignore failure to move the image file.
2353 // If we decide to require the app image, or the app image being moved correctly,
2354 // then change accordingly.
2355 constexpr bool kIgnoreAppImageFailure = true;
2356
2357 if (!a_image_path.empty()) {
2358 if (!move_ab_path(b_image_path, a_image_path)) {
2359 unlink(a_image_path.c_str());
2360 if (!kIgnoreAppImageFailure) {
2361 success = false;
2362 }
2363 }
2364 }
2365 } else {
2366 // Cleanup: delete B image, ignore errors.
2367 unlink(b_image_path.c_str());
2368 success = false;
2369 }
2370 } else {
2371 // Cleanup: delete B image, ignore errors.
2372 unlink(b_vdex_path.c_str());
2373 unlink(b_image_path.c_str());
2374 success = false;
2375 }
2376 return success;
2377}
2378
2379bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2380 // Delete the oat/odex file.
2381 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002382 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002383 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002384 return false;
2385 }
2386
2387 // In case of a permission failure report the issue. Otherwise just print a warning.
2388 auto unlink_and_check = [](const char* path) -> bool {
2389 int result = unlink(path);
2390 if (result != 0) {
2391 if (errno == EACCES || errno == EPERM) {
2392 PLOG(ERROR) << "Could not unlink " << path;
2393 return false;
2394 }
2395 PLOG(WARNING) << "Could not unlink " << path;
2396 }
2397 return true;
2398 };
2399
2400 // Delete the oat/odex file.
2401 bool return_value_oat = unlink_and_check(out_path);
2402
2403 // Derive and delete the app image.
2404 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2405
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002406 // Derive and delete the vdex file.
2407 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2408
Jeff Sharkey90aff262016-12-12 14:28:24 -07002409 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002410 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002411}
2412
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002413static bool is_absolute_path(const std::string& path) {
2414 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2415 LOG(ERROR) << "Invalid absolute path " << path;
2416 return false;
2417 } else {
2418 return true;
2419 }
2420}
2421
2422static bool is_valid_instruction_set(const std::string& instruction_set) {
2423 // TODO: add explicit whitelisting of instruction sets
2424 if (instruction_set.find('/') != std::string::npos) {
2425 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2426 return false;
2427 } else {
2428 return true;
2429 }
2430}
2431
2432bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2433 const char *apk_path, const char *instruction_set) {
2434 std::string oat_dir_ = oat_dir;
2435 std::string apk_path_ = apk_path;
2436 std::string instruction_set_ = instruction_set;
2437
2438 if (!is_absolute_path(oat_dir_)) return false;
2439 if (!is_absolute_path(apk_path_)) return false;
2440 if (!is_valid_instruction_set(instruction_set_)) return false;
2441
2442 std::string::size_type end = apk_path_.rfind('.');
2443 std::string::size_type start = apk_path_.rfind('/', end);
2444 if (end == std::string::npos || start == std::string::npos) {
2445 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2446 return false;
2447 }
2448
2449 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2450 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2451 const char* res = res_.c_str();
2452 if (strlen(res) >= PKG_PATH_MAX) {
2453 LOG(ERROR) << "Result too large";
2454 return false;
2455 } else {
2456 strlcpy(path, res, PKG_PATH_MAX);
2457 return true;
2458 }
2459}
2460
2461bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2462 const char *instruction_set) {
2463 std::string apk_path_ = apk_path;
2464 std::string instruction_set_ = instruction_set;
2465
2466 if (!is_absolute_path(apk_path_)) return false;
2467 if (!is_valid_instruction_set(instruction_set_)) return false;
2468
2469 std::string::size_type end = apk_path_.rfind('.');
2470 std::string::size_type start = apk_path_.rfind('/', end);
2471 if (end == std::string::npos || start == std::string::npos) {
2472 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2473 return false;
2474 }
2475
2476 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2477 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2478}
2479
2480bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2481 const char *instruction_set) {
2482 std::string src_ = src;
2483 std::string instruction_set_ = instruction_set;
2484
2485 if (!is_absolute_path(src_)) return false;
2486 if (!is_valid_instruction_set(instruction_set_)) return false;
2487
2488 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2489 if (*it == '/') {
2490 *it = '@';
2491 }
2492 }
2493
2494 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2495 + DALVIK_CACHE_POSTFIX;
2496 const char* res = res_.c_str();
2497 if (strlen(res) >= PKG_PATH_MAX) {
2498 LOG(ERROR) << "Result too large";
2499 return false;
2500 } else {
2501 strlcpy(path, res, PKG_PATH_MAX);
2502 return true;
2503 }
2504}
2505
Calin Juravle59f7ab82018-04-27 17:50:23 -07002506bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2507 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002508 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2509 for (const std::string& elem : classpaths_elems) {
2510 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2511 if (fd < 0) {
2512 PLOG(ERROR) << "Could not open classpath elem " << elem;
2513 return false;
2514 } else {
2515 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002516 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002517 }
2518 }
2519 return true;
2520}
2521
2522static bool create_app_profile_snapshot(int32_t app_id,
2523 const std::string& package_name,
2524 const std::string& profile_name,
2525 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002526 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2527
Calin Juravle824a64d2018-01-18 20:23:17 -08002528 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002529 if (snapshot_fd < 0) {
2530 return false;
2531 }
2532
2533 std::vector<unique_fd> profiles_fd;
2534 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002535 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2536 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002537 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2538 return false;
2539 }
2540
2541 profiles_fd.push_back(std::move(reference_profile_fd));
2542
Calin Juravle0d0a4922018-01-23 19:54:11 -08002543 // Open the class paths elements. These will be used to filter out profile data that does
2544 // not belong to the classpath during merge.
2545 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002546 std::vector<std::string> dex_locations;
2547 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002548 return false;
2549 }
2550
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002551 RunProfman args;
2552 args.SetupMerge(profiles_fd, snapshot_fd, apk_fds, dex_locations);
Calin Juravle29591732017-11-20 17:46:19 -08002553 pid_t pid = fork();
2554 if (pid == 0) {
2555 /* child -- drop privileges before continuing */
2556 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002557 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002558 }
2559
2560 /* parent */
2561 int return_code = wait_child(pid);
2562 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002563 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002564 return false;
2565 }
2566
2567 return true;
2568}
2569
Calin Juravle0d0a4922018-01-23 19:54:11 -08002570static bool create_boot_image_profile_snapshot(const std::string& package_name,
2571 const std::string& profile_name,
2572 const std::string& classpath) {
2573 // The reference profile directory for the android package might not be prepared. Do it now.
2574 const std::string ref_profile_dir =
2575 create_primary_reference_profile_package_dir_path(package_name);
2576 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2577 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2578 return false;
2579 }
2580
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002581 // Return false for empty class path since it may otherwise return true below if profiles is
2582 // empty.
2583 if (classpath.empty()) {
2584 PLOG(ERROR) << "Class path is empty";
2585 return false;
2586 }
2587
Calin Juravle0d0a4922018-01-23 19:54:11 -08002588 // Open and create the snapshot profile.
2589 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2590
2591 // Collect all non empty profiles.
2592 // The collection will traverse all applications profiles and find the non empty files.
2593 // This has the potential of inspecting a large number of files and directories (depending
2594 // on the number of applications and users). So there is a slight increase in the chance
2595 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2596 // fail the snapshot and aggregate whatever profile we could open.
2597 //
2598 // The profile snapshot is a best effort based on available data it's ok if some data
2599 // from some apps is missing. It will be counter productive for the snapshot to fail
2600 // because we could not open or read some of the files.
2601 std::vector<std::string> profiles;
2602 if (!collect_profiles(&profiles)) {
2603 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2604 }
2605
2606 // If we have no profiles return early.
2607 if (profiles.empty()) {
2608 return true;
2609 }
2610
2611 // Open the classpath elements. These will be used to filter out profile data that does
2612 // not belong to the classpath during merge.
2613 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002614 std::vector<std::string> dex_locations;
2615 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002616 return false;
2617 }
2618
2619 // If we could not open any files from the classpath return an error.
2620 if (apk_fds.empty()) {
2621 LOG(ERROR) << "Could not open any of the classpath elements.";
2622 return false;
2623 }
2624
2625 // Aggregate the profiles in batches of kAggregationBatchSize.
2626 // We do this to avoid opening a huge a amount of files.
2627 static constexpr size_t kAggregationBatchSize = 10;
2628
2629 std::vector<unique_fd> profiles_fd;
2630 for (size_t i = 0; i < profiles.size(); ) {
2631 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2632 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2633 if (fd.get() >= 0) {
2634 profiles_fd.push_back(std::move(fd));
2635 }
2636 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002637 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002638 args.SetupMerge(profiles_fd,
2639 snapshot_fd,
2640 apk_fds,
2641 dex_locations,
2642 /*store_aggregation_counters=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002643 pid_t pid = fork();
2644 if (pid == 0) {
2645 /* child -- drop privileges before continuing */
2646 drop_capabilities(AID_SYSTEM);
2647
Calin Juravle59f7ab82018-04-27 17:50:23 -07002648 // The introduction of new access flags into boot jars causes them to
2649 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002650 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002651 }
2652
2653 /* parent */
2654 int return_code = wait_child(pid);
2655 if (!WIFEXITED(return_code)) {
2656 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2657 return false;
2658 }
2659 return true;
2660 }
2661 return true;
2662}
2663
2664bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2665 const std::string& profile_name, const std::string& classpath) {
2666 if (app_id == -1) {
2667 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2668 } else {
2669 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2670 }
2671}
2672
Calin Juravlec3b049e2018-01-18 22:32:58 -08002673bool prepare_app_profile(const std::string& package_name,
2674 userid_t user_id,
2675 appid_t app_id,
2676 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002677 const std::string& code_path,
Calin Juravlec3b049e2018-01-18 22:32:58 -08002678 const std::unique_ptr<std::string>& dex_metadata) {
2679 // Prepare the current profile.
2680 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2681 /*is_secondary_dex*/ false);
2682 uid_t uid = multiuser_get_uid(user_id, app_id);
2683 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2684 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2685 return false;
2686 }
2687
2688 // Check if we need to install the profile from the dex metadata.
2689 if (dex_metadata == nullptr) {
2690 return true;
2691 }
2692
2693 // We have a dex metdata. Merge the profile into the reference profile.
2694 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2695 /*read_write*/ true, /*is_secondary_dex*/ false);
2696 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2697 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002698 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2699 if (apk_fd < 0) {
2700 PLOG(ERROR) << "Could not open code path " << code_path;
2701 return false;
2702 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002703
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002704 RunProfman args;
2705 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2706 std::move(ref_profile_fd),
2707 std::move(apk_fd),
2708 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002709 pid_t pid = fork();
2710 if (pid == 0) {
2711 /* child -- drop privileges before continuing */
2712 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2713 drop_capabilities(app_shared_gid);
2714
Calin Juravlef63d4792018-01-30 17:43:34 +00002715 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002716 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002717 }
2718
2719 /* parent */
2720 int return_code = wait_child(pid);
2721 if (!WIFEXITED(return_code)) {
2722 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2723 return false;
2724 }
2725 return true;
2726}
2727
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002728} // namespace installd
2729} // namespace android