blob: 32c1313f65607bd9649c9284643857dcce3549bd [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.
Andreas Gampe3a77feb2018-12-10 23:13:49 +0000335 const char* dex2oat_bin = "/system/bin/dex2oat";
336 constexpr const char* kDex2oatDebugPath = "/system/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 =
Andreas Gampe3a77feb2018-12-10 23:13:49 +0000666 is_debug_runtime() ? "/system/bin/profmand" : "/system/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700667
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800668 if (copy_and_update) {
669 CHECK_EQ(1u, profile_fds.size());
670 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000671 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800672 if (reference_profile_fd != -1) {
673 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000674 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800675
676 for (const unique_fd& fd : profile_fds) {
677 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
678 }
679
680 for (const unique_fd& fd : apk_fds) {
681 AddArg("--apk-fd=" + std::to_string(fd.get()));
682 }
683
684 for (const std::string& dex_location : dex_locations) {
685 AddArg("--dex-location=" + dex_location);
686 }
687
688 if (copy_and_update) {
689 AddArg("--copy-and-update-profile-key");
690 }
691
Calin Juravleb3a929d2018-12-11 14:40:00 -0800692 if (store_aggregation_counters) {
693 AddArg("--store-aggregation-counters");
694 }
695
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800696 // Do not add after dex2oat_flags, they should override others for debugging.
697 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800698 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700699
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800700 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
701 const unique_fd& reference_profile_fd,
702 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravleb3a929d2018-12-11 14:40:00 -0800703 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
704 bool store_aggregation_counters = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800705 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800706 reference_profile_fd,
707 apk_fds,
708 dex_locations,
709 /*copy_and_update=*/false,
710 store_aggregation_counters);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800711 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700712
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800713 void SetupCopyAndUpdate(unique_fd&& profile_fd,
714 unique_fd&& reference_profile_fd,
715 unique_fd&& apk_fd,
716 const std::string& dex_location) {
717 // The fds need to stay open longer than the scope of the function, so put them into a local
718 // variable vector.
719 profiles_fd_.push_back(std::move(profile_fd));
720 apk_fds_.push_back(std::move(apk_fd));
721 reference_profile_fd_ = std::move(reference_profile_fd);
722 std::vector<std::string> dex_locations = {dex_location};
Calin Juravleb3a929d2018-12-11 14:40:00 -0800723 SetupArgs(profiles_fd_,
724 reference_profile_fd_,
725 apk_fds_,
726 dex_locations,
727 /*copy_and_update=*/true,
728 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800729 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000730
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800731 void SetupDump(const std::vector<unique_fd>& profiles_fd,
732 const unique_fd& reference_profile_fd,
733 const std::vector<std::string>& dex_locations,
734 const std::vector<unique_fd>& apk_fds,
735 const unique_fd& output_fd) {
736 AddArg("--dump-only");
737 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800738 SetupArgs(profiles_fd,
739 reference_profile_fd,
740 apk_fds,
741 dex_locations,
742 /*copy_and_update=*/false,
743 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800744 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000745
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800746 void Exec() {
747 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
748 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000749
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800750 private:
751 unique_fd reference_profile_fd_;
752 std::vector<unique_fd> profiles_fd_;
753 std::vector<unique_fd> apk_fds_;
754};
Mathieu Chartier31636522018-11-09 23:53:07 +0000755
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800756
Calin Juravlef63d4792018-01-30 17:43:34 +0000757
Jeff Sharkey90aff262016-12-12 14:28:24 -0700758// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800759// The location is the package name for primary apks or the dex path for secondary dex files.
760// Returns true if there is enough information in the current profiles that makes it
761// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700762// If the return value is true all the current profiles would have been merged into
763// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800764static bool analyze_profiles(uid_t uid, const std::string& package_name,
765 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800766 std::vector<unique_fd> profiles_fd;
767 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800768 open_profile_files(uid, package_name, location, is_secondary_dex,
769 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800770 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700771 // Skip profile guided compilation because no profiles were found.
772 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700773 return false;
774 }
775
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800776 RunProfman profman_merge;
777 profman_merge.SetupMerge(profiles_fd, reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700778 pid_t pid = fork();
779 if (pid == 0) {
780 /* child -- drop privileges before continuing */
781 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800782 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700783 }
784 /* parent */
785 int return_code = wait_child(pid);
786 bool need_to_compile = false;
787 bool should_clear_current_profiles = false;
788 bool should_clear_reference_profile = false;
789 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800790 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700791 } else {
792 return_code = WEXITSTATUS(return_code);
793 switch (return_code) {
794 case PROFMAN_BIN_RETURN_CODE_COMPILE:
795 need_to_compile = true;
796 should_clear_current_profiles = true;
797 should_clear_reference_profile = false;
798 break;
799 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
800 need_to_compile = false;
801 should_clear_current_profiles = false;
802 should_clear_reference_profile = false;
803 break;
804 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800805 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700806 need_to_compile = false;
807 should_clear_current_profiles = true;
808 should_clear_reference_profile = true;
809 break;
810 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
811 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
812 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800813 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700814 need_to_compile = false;
815 should_clear_current_profiles = false;
816 should_clear_reference_profile = false;
817 break;
818 default:
819 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800820 LOG(WARNING) << "Unknown error code while processing profiles for location "
821 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700822 need_to_compile = false;
823 should_clear_current_profiles = true;
824 should_clear_reference_profile = true;
825 break;
826 }
827 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800828
Jeff Sharkey90aff262016-12-12 14:28:24 -0700829 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800830 if (is_secondary_dex) {
831 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800832 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
833 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800834 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800835 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800836 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700837 }
838 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800839 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700840 }
841 return need_to_compile;
842}
843
Calin Juravle114f0812017-03-08 19:05:07 -0800844// Decides if profile guided compilation is needed or not based on existing profiles.
845// The analysis is done for the primary apks of the given package.
846// Returns true if there is enough information in the current profiles that makes it
847// worth to recompile the package.
848// If the return value is true all the current profiles would have been merged into
849// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800850bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
851 const std::string& profile_name) {
852 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800853}
854
Calin Juravle408cd4a2018-01-20 23:34:18 -0800855bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
856 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800857 std::vector<unique_fd> profile_fds;
858 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800859 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
860 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700861
Calin Juravle408cd4a2018-01-20 23:34:18 -0800862 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800863 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700864
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800865 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700866 const bool has_profiles = !profile_fds.empty();
867
868 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800869 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700870 return false;
871 }
872
Calin Juravle114f0812017-03-08 19:05:07 -0800873 unique_fd output_fd(open(out_file_name.c_str(),
874 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700875 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800876 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700877 return false;
878 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800879
Jeff Sharkey90aff262016-12-12 14:28:24 -0700880 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800881 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800882 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
883 if (apk_fd == -1) {
884 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
885 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700886 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800887 dex_locations.push_back(get_location_from_path(code_path.c_str()));
888 apk_fds.push_back(std::move(apk_fd));
889
Jeff Sharkey90aff262016-12-12 14:28:24 -0700890
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800891 RunProfman profman_dump;
892 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700893 pid_t pid = fork();
894 if (pid == 0) {
895 /* child -- drop privileges before continuing */
896 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800897 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700898 }
899 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700900 int return_code = wait_child(pid);
901 if (!WIFEXITED(return_code)) {
902 LOG(WARNING) << "profman failed for package " << pkgname << ": "
903 << return_code;
904 return false;
905 }
906 return true;
907}
908
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700909bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800910 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700911 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
912 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800913 package_name,
914 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700915 /*read_write*/ true,
916 /*secondary*/ false));
917 if (in_fd.get() < 0) {
918 PLOG(WARNING) << "Could not open profile " << system_profile;
919 return false;
920 }
921 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800922 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700923 return false;
924 }
925
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700926 // As a security measure we want to write the profile information with the reduced capabilities
927 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700928 pid_t pid = fork();
929 if (pid == 0) {
930 /* child -- drop privileges before continuing */
931 drop_capabilities(packageUid);
932
933 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
934 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800935 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700936 }
937 // This implies that the app owning this profile is running
938 // (and has acquired the lock).
939 //
940 // The app never acquires the lock for the reference profiles of primary apks.
941 // Only dex2oat from installd will do that. Since installd is single threaded
942 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800943 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700944 return false;
945 }
946
947 bool truncated = ftruncate(out_fd.get(), 0) == 0;
948 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800949 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700950 }
951
952 // Copy over data.
953 static constexpr size_t kBufferSize = 4 * 1024;
954 char buffer[kBufferSize];
955 while (true) {
956 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
957 if (bytes == 0) {
958 break;
959 }
960 write(out_fd.get(), buffer, bytes);
961 }
962 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800963 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700964 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700965 // Use _exit since we don't want to run the global destructors in the child.
966 // b/62597429
967 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700968 }
969 /* parent */
970 int return_code = wait_child(pid);
971 return return_code == 0;
972}
973
Jeff Sharkey90aff262016-12-12 14:28:24 -0700974static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
975 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
976 if (EndsWith(oat_path, ".dex")) {
977 std::string new_path = oat_path;
978 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800979 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700980 return new_path;
981 }
982
983 // An odex entry. Not that this may not be an extension, e.g., in the OTA
984 // case (where the base name will have an extension for the B artifact).
985 size_t odex_pos = oat_path.rfind(".odex");
986 if (odex_pos != std::string::npos) {
987 std::string new_path = oat_path;
988 new_path.replace(odex_pos, strlen(".odex"), new_ext);
989 CHECK_NE(new_path.find(new_ext), std::string::npos);
990 return new_path;
991 }
992
993 // Don't know how to handle this.
994 return "";
995}
996
997// Translate the given oat path to an art (app image) path. An empty string
998// denotes an error.
999static std::string create_image_filename(const std::string& oat_path) {
1000 return replace_file_extension(oat_path, ".art");
1001}
1002
1003// Translate the given oat path to a vdex path. An empty string denotes an error.
1004static std::string create_vdex_filename(const std::string& oat_path) {
1005 return replace_file_extension(oat_path, ".vdex");
1006}
1007
Jeff Sharkey90aff262016-12-12 14:28:24 -07001008static int open_output_file(const char* file_name, bool recreate, int permissions) {
1009 int flags = O_RDWR | O_CREAT;
1010 if (recreate) {
1011 if (unlink(file_name) < 0) {
1012 if (errno != ENOENT) {
1013 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1014 }
1015 }
1016 flags |= O_EXCL;
1017 }
1018 return open(file_name, flags, permissions);
1019}
1020
Calin Juravle2289c0a2017-02-15 12:44:14 -08001021static bool set_permissions_and_ownership(
1022 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1023 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1024 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001025 if (fchmod(fd,
1026 S_IRUSR|S_IWUSR|S_IRGRP |
1027 (is_public ? S_IROTH : 0)) < 0) {
1028 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1029 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001030 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001031 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1032 return false;
1033 }
1034 return true;
1035}
1036
1037static bool IsOutputDalvikCache(const char* oat_dir) {
1038 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1039 // into '!'. Play it safe by handling it both.
1040 // TODO: ensure we never get null.
1041 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1042 return oat_dir == nullptr || oat_dir[0] == '!';
1043}
1044
Calin Juravled23dee72017-07-06 16:29:11 -07001045// Best-effort check whether we can fit the the path into our buffers.
1046// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1047// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1048// extension to the cache path (5 bytes).
1049// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1050static bool validate_dex_path_size(const std::string& dex_path) {
1051 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1052 LOG(ERROR) << "dex_path too long: " << dex_path;
1053 return false;
1054 }
1055 return true;
1056}
1057
Jeff Sharkey90aff262016-12-12 14:28:24 -07001058static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001059 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001060 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001061 return false;
1062 }
1063
1064 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001065 // Oat dirs for secondary dex files are already validated.
1066 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001067 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1068 return false;
1069 }
1070 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1071 return false;
1072 }
1073 } else {
1074 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1075 return false;
1076 }
1077 }
1078 return true;
1079}
1080
1081// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1082// on destruction. It will also run the given cleanup (unless told not to) after closing.
1083//
1084// Usage example:
1085//
Calin Juravle7a570e82017-01-14 16:23:30 -08001086// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001087// [name]() {
1088// unlink(name.c_str());
1089// });
1090// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1091// wrapper if captured as a reference.
1092//
1093// if (file.get() == -1) {
1094// // Error opening...
1095// }
1096//
1097// ...
1098// if (error) {
1099// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1100// // and delete the file (after the fd is closed).
1101// return -1;
1102// }
1103//
1104// (Success case)
1105// file.SetCleanup(false);
1106// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1107// // (leaving the file around; after the fd is closed).
1108//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001109class Dex2oatFileWrapper {
1110 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001111 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001112 }
1113
Calin Juravle7a570e82017-01-14 16:23:30 -08001114 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1115 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1116
1117 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1118 value_ = other.value_;
1119 cleanup_ = other.cleanup_;
1120 do_cleanup_ = other.do_cleanup_;
1121 auto_close_ = other.auto_close_;
1122 other.release();
1123 }
1124
1125 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1126 value_ = other.value_;
1127 cleanup_ = other.cleanup_;
1128 do_cleanup_ = other.do_cleanup_;
1129 auto_close_ = other.auto_close_;
1130 other.release();
1131 return *this;
1132 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001133
1134 ~Dex2oatFileWrapper() {
1135 reset(-1);
1136 }
1137
1138 int get() {
1139 return value_;
1140 }
1141
1142 void SetCleanup(bool cleanup) {
1143 do_cleanup_ = cleanup;
1144 }
1145
1146 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001147 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001148 close(value_);
1149 }
1150 if (do_cleanup_ && cleanup_ != nullptr) {
1151 cleanup_();
1152 }
1153
1154 value_ = new_value;
1155 }
1156
Calin Juravle7a570e82017-01-14 16:23:30 -08001157 void reset(int new_value, std::function<void ()> new_cleanup) {
1158 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001159 close(value_);
1160 }
1161 if (do_cleanup_ && cleanup_ != nullptr) {
1162 cleanup_();
1163 }
1164
1165 value_ = new_value;
1166 cleanup_ = new_cleanup;
1167 }
1168
Calin Juravle7a570e82017-01-14 16:23:30 -08001169 void DisableAutoClose() {
1170 auto_close_ = false;
1171 }
1172
Jeff Sharkey90aff262016-12-12 14:28:24 -07001173 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001174 void release() {
1175 value_ = -1;
1176 do_cleanup_ = false;
1177 cleanup_ = nullptr;
1178 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001179 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001180 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001181 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001182 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001183};
1184
Calin Juravle7a570e82017-01-14 16:23:30 -08001185// (re)Creates the app image if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001186Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path,
1187 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001188
1189 // We don't create an image for secondary dex files.
1190 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001191 return Dex2oatFileWrapper();
1192 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001193
Calin Juravle7a570e82017-01-14 16:23:30 -08001194 const std::string image_path = create_image_filename(out_oat_path);
1195 if (image_path.empty()) {
1196 // Happens when the out_oat_path has an unknown extension.
1197 return Dex2oatFileWrapper();
1198 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001199
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001200 // In case there is a stale image, remove it now. Ignore any error.
1201 unlink(image_path.c_str());
1202
1203 // Not enabled, exit.
1204 if (!generate_app_image) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001205 return Dex2oatFileWrapper();
1206 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -07001207 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
1208 if (app_image_format.empty()) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001209 return Dex2oatFileWrapper();
1210 }
1211 // Recreate is true since we do not want to modify a mapped image. If the app is
1212 // already running and we modify the image file, it can cause crashes (b/27493510).
1213 Dex2oatFileWrapper wrapper_fd(
1214 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1215 [image_path]() { unlink(image_path.c_str()); });
1216 if (wrapper_fd.get() < 0) {
1217 // Could not create application image file. Go on since we can compile without it.
1218 LOG(ERROR) << "installd could not create '" << image_path
1219 << "' for image file during dexopt";
1220 // If we have a valid image file path but no image fd, explicitly erase the image file.
1221 if (unlink(image_path.c_str()) < 0) {
1222 if (errno != ENOENT) {
1223 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1224 }
1225 }
1226 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001227 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001228 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1229 wrapper_fd.reset(-1);
1230 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001231
Calin Juravle7a570e82017-01-14 16:23:30 -08001232 return wrapper_fd;
1233}
1234
1235// Creates the dexopt swap file if necessary and return its fd.
1236// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001237unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001238 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001239 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001240 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001241 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001242 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001243 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001244 if (swap_fd.get() < 0) {
1245 // Could not create swap file. Optimistically go on and hope that we can compile
1246 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001247 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001248 } else {
1249 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001250 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001251 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1252 }
1253 }
1254 return swap_fd;
1255}
1256
1257// Opens the reference profiles if needed.
1258// 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 -08001259Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001260 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -08001261 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +00001262 // If we are not profile guided compilation, or we are compiling system server
1263 // do not bother to open the profiles; we won't be using them.
1264 if (!profile_guided || (pkgname[0] == '*')) {
1265 return Dex2oatFileWrapper();
1266 }
1267
1268 // If this is a secondary dex path which is public do not open the profile.
1269 // We cannot compile public secondary dex paths with profiles. That's because
1270 // it will expose how the dex files are used by their owner.
1271 //
1272 // Note that the PackageManager is responsible to set the is_public flag for
1273 // primary apks and we do not check it here. In some cases, e.g. when
1274 // compiling with a public profile from the .dm file the PackageManager will
1275 // set is_public toghether with the profile guided compilation.
1276 if (is_secondary_dex && is_public) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001277 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001278 }
Calin Juravle114f0812017-03-08 19:05:07 -08001279
1280 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001281 std::string location;
1282 if (is_secondary_dex) {
1283 location = dex_path;
1284 } else {
1285 if (profile_name == nullptr) {
1286 // This path is taken for system server re-compilation lunched from ZygoteInit.
1287 return Dex2oatFileWrapper();
1288 } else {
1289 location = profile_name;
1290 }
1291 }
Calin Juravle824a64d2018-01-18 20:23:17 -08001292 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1293 is_secondary_dex);
1294 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1295 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001296 };
1297 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001298}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001299
Calin Juravle7a570e82017-01-14 16:23:30 -08001300// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1301// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001302bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001303 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001304 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001305 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1306 CHECK(in_vdex_wrapper_fd != nullptr);
1307 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001308 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1309 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001310 char in_odex_path[PKG_PATH_MAX];
1311 int dexopt_action = abs(dexopt_needed);
1312 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001313 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001314
1315 // Infer the name of the output VDEX.
1316 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1317 if (out_vdex_path_str.empty()) {
1318 return false;
1319 }
1320
1321 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001322 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001323 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1324 const char* path = nullptr;
1325 if (is_odex_location) {
1326 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1327 path = in_odex_path;
1328 } else {
1329 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001330 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001331 }
1332 } else {
1333 path = out_oat_path;
1334 }
1335 in_vdex_path_str = create_vdex_filename(path);
1336 if (in_vdex_path_str.empty()) {
1337 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001338 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001339 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001340 // We can update in place when all these conditions are met:
1341 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1342 // on /system typically cannot be updated in place).
1343 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1344 // cannot be currently used by a running process.
1345 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1346 // different vdex files to operate.
1347 update_vdex_in_place =
1348 (in_vdex_path_str == out_vdex_path_str) &&
1349 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1350 !profile_guided;
1351 if (update_vdex_in_place) {
1352 // Open the file read-write to be able to update it.
1353 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1354 if (in_vdex_wrapper_fd->get() == -1) {
1355 // If we failed to open the file, we cannot update it in place.
1356 update_vdex_in_place = false;
1357 }
1358 } else {
1359 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1360 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001361 }
1362
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001363 // If we are updating the vdex in place, we do not need to recreate a vdex,
1364 // and can use the same existing one.
1365 if (update_vdex_in_place) {
1366 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1367 // have bogus stale vdex files.
1368 out_vdex_wrapper_fd->reset(
1369 in_vdex_wrapper_fd->get(),
1370 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1371 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1372 // wrapper).
1373 in_vdex_wrapper_fd->DisableAutoClose();
1374 } else {
1375 out_vdex_wrapper_fd->reset(
1376 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1377 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1378 if (out_vdex_wrapper_fd->get() < 0) {
1379 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1380 return false;
1381 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001382 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001383 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001384 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001385 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1386 return false;
1387 }
1388
1389 // If we got here we successfully opened the vdex files.
1390 return true;
1391}
1392
1393// Opens the output oat file for the given apk.
1394// If successful it stores the output path into out_oat_path and returns true.
1395Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001396 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1397 char* out_oat_path) {
1398 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001399 return Dex2oatFileWrapper();
1400 }
1401 const std::string out_oat_path_str(out_oat_path);
1402 Dex2oatFileWrapper wrapper_fd(
1403 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1404 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1405 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001406 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001407 } else if (!set_permissions_and_ownership(
1408 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001409 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1410 wrapper_fd.reset(-1);
1411 }
1412 return wrapper_fd;
1413}
1414
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001415// Creates RDONLY fds for oat and vdex files, if exist.
1416// Returns false if it fails to create oat out path for the given apk path.
1417// Note that the method returns true even if the files could not be opened.
1418bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1419 const std::string& oat_dir,
1420 const std::string& instruction_set,
1421 bool is_secondary_dex,
1422 unique_fd* oat_file_fd,
1423 unique_fd* vdex_file_fd) {
1424 char oat_path[PKG_PATH_MAX];
1425 if (!create_oat_out_path(apk_path.c_str(),
1426 instruction_set.c_str(),
1427 oat_dir.c_str(),
1428 is_secondary_dex,
1429 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001430 LOG(ERROR) << "Could not create oat out path for "
1431 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001432 return false;
1433 }
1434 oat_file_fd->reset(open(oat_path, O_RDONLY));
1435 if (oat_file_fd->get() < 0) {
1436 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1437 }
1438
1439 std::string vdex_filename = create_vdex_filename(oat_path);
1440 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1441 if (vdex_file_fd->get() < 0) {
1442 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1443 }
1444
1445 return true;
1446}
1447
Calin Juravle7a570e82017-01-14 16:23:30 -08001448// Updates the access times of out_oat_path based on those from apk_path.
1449void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1450 struct stat input_stat;
1451 memset(&input_stat, 0, sizeof(input_stat));
1452 if (stat(apk_path, &input_stat) != 0) {
1453 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1454 return;
1455 }
1456
1457 struct utimbuf ut;
1458 ut.actime = input_stat.st_atime;
1459 ut.modtime = input_stat.st_mtime;
1460 if (utime(out_oat_path, &ut) != 0) {
1461 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1462 }
1463}
1464
Calin Juravle80a21252017-01-17 14:43:25 -08001465// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001466// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1467// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1468// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001469class RunDexoptAnalyzer : public ExecVHelper {
1470 public:
1471 RunDexoptAnalyzer(const std::string& dex_file,
1472 int vdex_fd,
1473 int oat_fd,
1474 int zip_fd,
1475 const std::string& instruction_set,
1476 const std::string& compiler_filter,
1477 bool profile_was_updated,
1478 bool downgrade,
1479 const char* class_loader_context) {
1480 CHECK_GE(zip_fd, 0);
1481 const char* dexoptanalyzer_bin =
Andreas Gampe3a77feb2018-12-10 23:13:49 +00001482 is_debug_runtime()
1483 ? "/system/bin/dexoptanalyzerd"
1484 : "/system/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001485
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001486 std::string dex_file_arg = "--dex-file=" + dex_file;
1487 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1488 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1489 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1490 std::string isa_arg = "--isa=" + instruction_set;
1491 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1492 const char* assume_profile_changed = "--assume-profile-changed";
1493 const char* downgrade_flag = "--downgrade";
1494 std::string class_loader_context_arg = "--class-loader-context=";
1495 if (class_loader_context != nullptr) {
1496 class_loader_context_arg += class_loader_context;
1497 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001498
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001499 // program name, dex file, isa, filter
1500 AddArg(dex_file_arg);
1501 AddArg(isa_arg);
1502 AddArg(compiler_filter_arg);
1503 if (oat_fd >= 0) {
1504 AddArg(oat_fd_arg);
1505 }
1506 if (vdex_fd >= 0) {
1507 AddArg(vdex_fd_arg);
1508 }
1509 AddArg(zip_fd_arg.c_str());
1510 if (profile_was_updated) {
1511 AddArg(assume_profile_changed);
1512 }
1513 if (downgrade) {
1514 AddArg(downgrade_flag);
1515 }
1516 if (class_loader_context != nullptr) {
1517 AddArg(class_loader_context_arg.c_str());
1518 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001519
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001520 PrepareArgs(dexoptanalyzer_bin);
1521 }
1522};
Calin Juravle80a21252017-01-17 14:43:25 -08001523
1524// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001525static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001526 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001527 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001528 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001529 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001530 return false;
1531 }
Calin Juravle114f0812017-03-08 19:05:07 -08001532 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001533
Calin Juravle80a21252017-01-17 14:43:25 -08001534 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001535 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1536 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001537 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001538 return false;
1539 }
1540
1541 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001542 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001543
Calin Juravle7d765462017-09-04 15:57:10 -07001544 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001545 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001546 return false;
1547 }
1548
1549 return true;
1550}
1551
Calin Juravle7d765462017-09-04 15:57:10 -07001552// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1553// secondary dex files. This return codes are returned by the child process created for
1554// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001555
Andreas Gampe194fe422018-02-28 20:16:19 -08001556enum DexoptAnalyzerSkipCodes {
1557 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001558 // Specific errors are encoded in the name.
1559 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1560 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1561 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1562 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1563 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001564 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001565 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001566};
Calin Juravle7d765462017-09-04 15:57:10 -07001567
1568// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001569// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1570// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001571// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1572// of dexoptanalyzer.
1573static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001574 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001575 // The result values are defined in dexoptanalyzer.
1576 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001577 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001578 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001579 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001580 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001581 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001582 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001583 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001584 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001585 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1586 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001587 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1588 " Expected odex file status for secondary dex %s"
1589 " : dexoptanalyzer result=%d",
1590 dex_path.c_str(),
1591 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001592 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001593 }
1594
1595 // Use a second switch for enum switch-case analysis.
1596 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001597 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001598 // If the file does not exist there's no need for dexopt.
1599 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1600 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001601
1602 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1603 *error_msg = "Dexoptanalyzer path validation failed";
1604 return false;
1605 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1606 *error_msg = "Dexoptanalyzer open zip failed";
1607 return false;
1608 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1609 *error_msg = "Dexoptanalyzer dir preparation failed";
1610 return false;
1611 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1612 *error_msg = "Dexoptanalyzer open output failed";
1613 return false;
1614 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1615 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001616 return false;
1617 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001618
1619 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1620 dex_path.c_str(),
1621 result);
1622 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001623}
1624
Calin Juravle7d765462017-09-04 15:57:10 -07001625enum SecondaryDexAccess {
1626 kSecondaryDexAccessReadOk = 0,
1627 kSecondaryDexAccessDoesNotExist = 1,
1628 kSecondaryDexAccessPermissionError = 2,
1629 kSecondaryDexAccessIOError = 3
1630};
1631
1632static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1633 // Check if the path exists and can be read. If not, there's nothing to do.
1634 if (access(dex_path.c_str(), R_OK) == 0) {
1635 return kSecondaryDexAccessReadOk;
1636 } else {
1637 if (errno == ENOENT) {
1638 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1639 return kSecondaryDexAccessDoesNotExist;
1640 } else {
1641 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1642 return errno == EACCES
1643 ? kSecondaryDexAccessPermissionError
1644 : kSecondaryDexAccessIOError;
1645 }
1646 }
1647}
1648
1649static bool is_file_public(const std::string& filename) {
1650 struct stat file_stat;
1651 if (stat(filename.c_str(), &file_stat) == 0) {
1652 return (file_stat.st_mode & S_IROTH) != 0;
1653 }
1654 return false;
1655}
1656
1657// Create the oat file structure for the secondary dex 'dex_path' and assign
1658// the individual path component to the 'out_' parameters.
1659static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001660 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001661 size_t dirIndex = dex_path.rfind('/');
1662 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001663 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001664 return false;
1665 }
1666 // TODO(calin): we have similar computations in at lest 3 other places
1667 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1668 // using string append.
1669 std::string apk_dir = dex_path.substr(0, dirIndex);
1670 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1671 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1672
1673 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1674 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001675 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001676 return false;
1677 }
1678 return true;
1679}
1680
1681// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1682// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001683static bool validate_dexopt_storage_flags(int dexopt_flags,
1684 int* out_storage_flag,
1685 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001686 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1687 *out_storage_flag = FLAG_STORAGE_CE;
1688 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001689 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001690 return false;
1691 }
1692 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1693 *out_storage_flag = FLAG_STORAGE_DE;
1694 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001695 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001696 return false;
1697 }
1698 return true;
1699}
1700
Calin Juravlec9eab382017-01-25 01:17:17 -08001701// 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 -08001702// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1703// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001704// When returning true, the output parameters will be:
1705// - is_public_out: whether or not the oat file should not be made public
1706// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1707// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001708static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001709 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001710 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001711 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
1712 /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001713 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001714 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001715 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1716 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001717 return false;
1718 }
Calin Juravle7d765462017-09-04 15:57:10 -07001719 // Compute the oat dir as it's not easy to extract it from the child computation.
1720 char oat_path[PKG_PATH_MAX];
1721 char oat_dir[PKG_PATH_MAX];
1722 char oat_isa_dir[PKG_PATH_MAX];
1723 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001724 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1725 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001726 return false;
1727 }
Calin Juravle7d765462017-09-04 15:57:10 -07001728 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001729
Calin Juravle80a21252017-01-17 14:43:25 -08001730 pid_t pid = fork();
1731 if (pid == 0) {
1732 // child -- drop privileges before continuing.
1733 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001734
1735 // Validate the path structure.
1736 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1737 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001738 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001739 }
1740
1741 // Open the dex file.
1742 unique_fd zip_fd;
1743 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1744 if (zip_fd.get() < 0) {
1745 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001746 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001747 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001748 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001749 }
1750 }
1751
1752 // Prepare the oat directories.
1753 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001754 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001755 }
1756
1757 // Open the vdex/oat files if any.
1758 unique_fd oat_file_fd;
1759 unique_fd vdex_file_fd;
1760 if (!maybe_open_oat_and_vdex_file(dex_path,
1761 *oat_dir_out,
1762 instruction_set,
1763 true /* is_secondary_dex */,
1764 &oat_file_fd,
1765 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001766 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001767 }
1768
1769 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001770 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1771 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001772
1773 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001774 // Note that we do not do it before the fork since opening the files is required to happen
1775 // after forking.
1776 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1777 vdex_file_fd.get(),
1778 oat_file_fd.get(),
1779 zip_fd.get(),
1780 instruction_set,
1781 compiler_filter, profile_was_updated,
1782 downgrade,
1783 class_loader_context);
1784 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001785 }
1786
1787 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001788 int result = wait_child(pid);
1789 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001790 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1791 dex_path.c_str(),
1792 result);
1793 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001794 return false;
1795 }
1796 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001797 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001798 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1799 result,
1800 dexopt_needed_out,
1801 error_msg);
1802 if (!success) {
1803 LOG(ERROR) << *error_msg;
1804 }
Calin Juravle7d765462017-09-04 15:57:10 -07001805
1806 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1807
Calin Juravle80a21252017-01-17 14:43:25 -08001808 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001809 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1810 // makes the code simpler; force compilation is only needed during tests).
1811 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001812 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001813 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001814 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1815 }
1816
Calin Juravle7d765462017-09-04 15:57:10 -07001817 // Check if we should make the oat file public.
1818 // Note that if the dex file is not public the compiled code cannot be made public.
1819 // It is ok to check this flag outside in the parent process.
1820 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1821
Calin Juravle80a21252017-01-17 14:43:25 -08001822 return success;
1823}
1824
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001825static std::string format_dexopt_error(int status, const char* dex_path) {
1826 if (WIFEXITED(status)) {
1827 int int_code = WEXITSTATUS(status);
1828 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1829 if (code_name != nullptr) {
1830 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1831 }
1832 }
1833 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001834}
1835
Calin Juravlec9eab382017-01-25 01:17:17 -08001836int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001837 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001838 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001839 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001840 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001841 CHECK(pkgname != nullptr);
1842 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001843 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001844 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1845 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001846
Calin Juravled23dee72017-07-06 16:29:11 -07001847 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001848 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001849 return -1;
1850 }
1851
1852 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001853 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1854 class_loader_context);
1855 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001856 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001857 }
1858
Calin Juravleebc8a792017-04-04 20:21:05 -07001859 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001860 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1861 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1862 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001863 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001864 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001865 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001866 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001867 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001868
1869 // Check if we're dealing with a secondary dex file and if we need to compile it.
1870 std::string oat_dir_str;
1871 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001872 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001873 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Andreas Gampe194fe422018-02-28 20:16:19 -08001874 downgrade, class_loader_context, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001875 oat_dir = oat_dir_str.c_str();
1876 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1877 return 0; // Nothing to do, report success.
1878 }
1879 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001880 if (error_msg->empty()) { // TODO: Make this a CHECK.
1881 *error_msg = "Failed processing secondary.";
1882 }
Calin Juravle80a21252017-01-17 14:43:25 -08001883 return -1; // We had an error, logged in the process method.
1884 }
1885 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001886 // Currently these flags are only use for secondary dex files.
1887 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001888 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1889 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1890 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001891
1892 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001893 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001894 if (input_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001895 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1896 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001897 return -1;
1898 }
1899
1900 // Create the output OAT file.
1901 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001902 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001903 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001904 if (out_oat_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001905 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001906 return -1;
1907 }
1908
1909 // Open vdex files.
1910 Dex2oatFileWrapper in_vdex_fd;
1911 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001912 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1913 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001914 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001915 return -1;
1916 }
1917
Calin Juravlecb556e32017-04-04 20:22:50 -07001918 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1919 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1920 // fully inherit their parent context).
1921 // Note that for primary apk the oat files are created before, in a separate installd
1922 // call which also does the restorecon. TODO(calin): unify the paths.
1923 if (is_secondary_dex) {
1924 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1925 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001926 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1927 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001928 return -1;
1929 }
1930 }
1931
Jeff Sharkey90aff262016-12-12 14:28:24 -07001932 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001933 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001934
Calin Juravle7a570e82017-01-14 16:23:30 -08001935 // Create the app image file if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001936 Dex2oatFileWrapper image_fd = maybe_open_app_image(
1937 out_oat_path, generate_app_image, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001938
Calin Juravle7a570e82017-01-14 16:23:30 -08001939 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001940 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001941 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001942
Calin Juravle62c5a372018-02-01 17:03:23 +00001943 unique_fd dex_metadata_fd;
1944 if (dex_metadata_path != nullptr) {
1945 dex_metadata_fd.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)));
1946 if (dex_metadata_fd.get() < 0) {
1947 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1948 }
1949 }
1950
Andreas Gampe023b2242018-02-28 16:03:25 -08001951 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001952
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001953 RunDex2Oat runner(input_fd.get(),
1954 out_oat_fd.get(),
1955 in_vdex_fd.get(),
1956 out_vdex_fd.get(),
1957 image_fd.get(),
1958 dex_path,
1959 out_oat_path,
1960 swap_fd.get(),
1961 instruction_set,
1962 compiler_filter,
1963 debuggable,
1964 boot_complete,
1965 background_job_compile,
1966 reference_profile_fd.get(),
1967 class_loader_context,
1968 target_sdk_version,
1969 enable_hidden_api_checks,
1970 generate_compact_dex,
1971 dex_metadata_fd.get(),
1972 compilation_reason);
1973
Jeff Sharkey90aff262016-12-12 14:28:24 -07001974 pid_t pid = fork();
1975 if (pid == 0) {
1976 /* child -- drop privileges before continuing */
1977 drop_capabilities(uid);
1978
Richard Uhler76cc0272016-12-08 10:46:35 +00001979 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001980 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001981 PLOG(ERROR) << "flock(" << out_oat_path << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001982 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001983 }
1984
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001985 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001986 } else {
1987 int res = wait_child(pid);
1988 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001989 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001990 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001991 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1992 << std::hex << std::setw(4) << res << ", process failed";
1993 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001994 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001995 }
1996 }
1997
Calin Juravlec9eab382017-01-25 01:17:17 -08001998 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001999
2000 // We've been successful, don't delete output.
2001 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08002002 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002003 image_fd.SetCleanup(false);
2004 reference_profile_fd.SetCleanup(false);
2005
2006 return 0;
2007}
2008
Calin Juravlec9eab382017-01-25 01:17:17 -08002009// Try to remove the given directory. Log an error if the directory exists
2010// and is empty but could not be removed.
2011static bool rmdir_if_empty(const char* dir) {
2012 if (rmdir(dir) == 0) {
2013 return true;
2014 }
2015 if (errno == ENOENT || errno == ENOTEMPTY) {
2016 return true;
2017 }
2018 PLOG(ERROR) << "Failed to remove dir: " << dir;
2019 return false;
2020}
2021
2022// Try to unlink the given file. Log an error if the file exists and could not
2023// be unlinked.
2024static bool unlink_if_exists(const std::string& file) {
2025 if (unlink(file.c_str()) == 0) {
2026 return true;
2027 }
2028 if (errno == ENOENT) {
2029 return true;
2030
2031 }
2032 PLOG(ERROR) << "Could not unlink: " << file;
2033 return false;
2034}
2035
Calin Juravle7d765462017-09-04 15:57:10 -07002036enum ReconcileSecondaryDexResult {
2037 kReconcileSecondaryDexExists = 0,
2038 kReconcileSecondaryDexCleanedUp = 1,
2039 kReconcileSecondaryDexValidationError = 2,
2040 kReconcileSecondaryDexCleanUpError = 3,
2041 kReconcileSecondaryDexAccessIOError = 4,
2042};
Calin Juravlec9eab382017-01-25 01:17:17 -08002043
2044// Reconcile the secondary dex 'dex_path' and its generated oat files.
2045// Return true if all the parameters are valid and the secondary dex file was
2046// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
2047// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
2048// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
2049// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
2050// Return false if there were errors during processing. In this case
2051// out_secondary_dex_exists will be set to false.
2052bool reconcile_secondary_dex_file(const std::string& dex_path,
2053 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
2054 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2055 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07002056 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08002057 if (isas.size() == 0) {
2058 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
2059 return false;
2060 }
2061
Calin Juravle7d765462017-09-04 15:57:10 -07002062 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2063 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2064 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002065 return false;
2066 }
2067
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002068 // As a security measure we want to unlink art artifacts with the reduced capabilities
2069 // of the package user id. So we fork and drop capabilities in the child.
2070 pid_t pid = fork();
2071 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002072 /* child -- drop privileges before continuing */
2073 drop_capabilities(uid);
2074
2075 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2076 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2077 uid, storage_flag)) {
2078 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2079 _exit(kReconcileSecondaryDexValidationError);
2080 }
2081
2082 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2083 switch (access_check) {
2084 case kSecondaryDexAccessDoesNotExist:
2085 // File does not exist. Proceed with cleaning.
2086 break;
2087 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2088 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2089 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2090 default:
2091 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2092 _exit(kReconcileSecondaryDexValidationError);
2093 }
2094
2095 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002096 char oat_path[PKG_PATH_MAX];
2097 char oat_dir[PKG_PATH_MAX];
2098 char oat_isa_dir[PKG_PATH_MAX];
2099 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002100 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08002101 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002102 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08002103 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
2104 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002105 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002106 }
Calin Juravle51314092017-05-18 15:33:05 -07002107
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002108 // Delete oat/vdex/art files.
2109 result = unlink_if_exists(oat_path) && result;
2110 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2111 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002112
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002113 // Delete profiles.
2114 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002115 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002116 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002117 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002118 result = unlink_if_exists(current_profile) && result;
2119 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002120
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002121 // We upgraded once the location of current profile for secondary dex files.
2122 // Check for any previous left-overs and remove them as well.
2123 std::string old_current_profile = dex_path + ".prof";
2124 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002125
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002126 // Try removing the directories as well, they might be empty.
2127 result = rmdir_if_empty(oat_isa_dir) && result;
2128 result = rmdir_if_empty(oat_dir) && result;
2129 }
Calin Juravle7d765462017-09-04 15:57:10 -07002130 if (!result) {
2131 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2132 }
2133 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002134 }
2135
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002136 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002137 if (!WIFEXITED(return_code)) {
2138 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2139 } else {
2140 return_code = WEXITSTATUS(return_code);
2141 }
2142
2143 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2144
2145 switch (return_code) {
2146 case kReconcileSecondaryDexCleanedUp:
2147 case kReconcileSecondaryDexValidationError:
2148 // If we couldn't validate assume the dex file does not exist.
2149 // This will purge the entry from the PM records.
2150 *out_secondary_dex_exists = false;
2151 return true;
2152 case kReconcileSecondaryDexExists:
2153 *out_secondary_dex_exists = true;
2154 return true;
2155 case kReconcileSecondaryDexAccessIOError:
2156 // We had an access IO error.
2157 // Return false so that we can try again.
2158 // The value of out_secondary_dex_exists does not matter in this case and by convention
2159 // is set to false.
2160 *out_secondary_dex_exists = false;
2161 return false;
2162 default:
2163 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2164 *out_secondary_dex_exists = false;
2165 return false;
2166 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002167}
2168
Alan Stokesa25d90c2017-10-16 10:56:00 +01002169// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2170// Returns true if all parameters are valid and the hash successfully computed and stored in
2171// out_secondary_dex_hash.
2172// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2173// the app.
2174// For any other errors (e.g. if any of the parameters are invalid) returns false.
2175bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2176 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2177 std::vector<uint8_t>* out_secondary_dex_hash) {
2178 out_secondary_dex_hash->clear();
2179
2180 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2181
2182 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2183 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2184 << storage_flag;
2185 return false;
2186 }
2187
2188 // Pipe to get the hash result back from our child process.
2189 unique_fd pipe_read, pipe_write;
2190 if (!Pipe(&pipe_read, &pipe_write)) {
2191 PLOG(ERROR) << "Failed to create pipe";
2192 return false;
2193 }
2194
2195 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2196 // access data the app itself can access.
2197 pid_t pid = fork();
2198 if (pid == 0) {
2199 // child -- drop privileges before continuing
2200 drop_capabilities(uid);
2201 pipe_read.reset();
2202
2203 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2204 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002205 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002206 }
2207
2208 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2209 if (fd == -1) {
2210 if (errno == EACCES || errno == ENOENT) {
2211 // Not treated as an error.
2212 _exit(0);
2213 }
2214 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002215 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002216 }
2217
2218 SHA256_CTX ctx;
2219 SHA256_Init(&ctx);
2220
2221 std::vector<uint8_t> buffer(65536);
2222 while (true) {
2223 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2224 if (bytes_read == 0) {
2225 break;
2226 } else if (bytes_read == -1) {
2227 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002228 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002229 }
2230
2231 SHA256_Update(&ctx, buffer.data(), bytes_read);
2232 }
2233
2234 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2235 SHA256_Final(hash.data(), &ctx);
2236 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002237 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002238 }
2239
2240 _exit(0);
2241 }
2242
2243 // parent
2244 pipe_write.reset();
2245
2246 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2247 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2248 out_secondary_dex_hash->clear();
2249 }
2250 return wait_child(pid) == 0;
2251}
2252
Jeff Sharkey90aff262016-12-12 14:28:24 -07002253// Helper for move_ab, so that we can have common failure-case cleanup.
2254static bool unlink_and_rename(const char* from, const char* to) {
2255 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2256 // return a failure.
2257 struct stat s;
2258 if (stat(to, &s) == 0) {
2259 if (!S_ISREG(s.st_mode)) {
2260 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2261 return false;
2262 }
2263 if (unlink(to) != 0) {
2264 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2265 return false;
2266 }
2267 } else {
2268 // This may be a permission problem. We could investigate the error code, but we'll just
2269 // let the rename failure do the work for us.
2270 }
2271
2272 // Try to rename "to" to "from."
2273 if (rename(from, to) != 0) {
2274 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2275 return false;
2276 }
2277 return true;
2278}
2279
2280// Move/rename a B artifact (from) to an A artifact (to).
2281static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2282 // Check whether B exists.
2283 {
2284 struct stat s;
2285 if (stat(b_path.c_str(), &s) != 0) {
2286 // Silently ignore for now. The service calling this isn't smart enough to understand
2287 // lack of artifacts at the moment.
2288 return false;
2289 }
2290 if (!S_ISREG(s.st_mode)) {
2291 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2292 // Try to unlink, but swallow errors.
2293 unlink(b_path.c_str());
2294 return false;
2295 }
2296 }
2297
2298 // Rename B to A.
2299 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2300 // Delete the b_path so we don't try again (or fail earlier).
2301 if (unlink(b_path.c_str()) != 0) {
2302 PLOG(ERROR) << "Could not unlink " << b_path;
2303 }
2304
2305 return false;
2306 }
2307
2308 return true;
2309}
2310
2311bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2312 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002313 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2314 if (slot_suffix.empty()) {
2315 return false;
2316 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002317
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002318 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2319 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2320 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002321 }
2322
2323 // Validate other inputs.
2324 if (validate_apk_path(apk_path) != 0) {
2325 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2326 return false;
2327 }
2328 if (validate_apk_path(oat_dir) != 0) {
2329 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2330 return false;
2331 }
2332
2333 char a_path[PKG_PATH_MAX];
2334 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2335 return false;
2336 }
2337 const std::string a_vdex_path = create_vdex_filename(a_path);
2338 const std::string a_image_path = create_image_filename(a_path);
2339
2340 // B path = A path + slot suffix.
2341 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2342 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2343 const std::string b_image_path = StringPrintf("%s.%s",
2344 a_image_path.c_str(),
2345 slot_suffix.c_str());
2346
2347 bool success = true;
2348 if (move_ab_path(b_path, a_path)) {
2349 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2350 // Note: we can live without an app image. As such, ignore failure to move the image file.
2351 // If we decide to require the app image, or the app image being moved correctly,
2352 // then change accordingly.
2353 constexpr bool kIgnoreAppImageFailure = true;
2354
2355 if (!a_image_path.empty()) {
2356 if (!move_ab_path(b_image_path, a_image_path)) {
2357 unlink(a_image_path.c_str());
2358 if (!kIgnoreAppImageFailure) {
2359 success = false;
2360 }
2361 }
2362 }
2363 } else {
2364 // Cleanup: delete B image, ignore errors.
2365 unlink(b_image_path.c_str());
2366 success = false;
2367 }
2368 } else {
2369 // Cleanup: delete B image, ignore errors.
2370 unlink(b_vdex_path.c_str());
2371 unlink(b_image_path.c_str());
2372 success = false;
2373 }
2374 return success;
2375}
2376
2377bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2378 // Delete the oat/odex file.
2379 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002380 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002381 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002382 return false;
2383 }
2384
2385 // In case of a permission failure report the issue. Otherwise just print a warning.
2386 auto unlink_and_check = [](const char* path) -> bool {
2387 int result = unlink(path);
2388 if (result != 0) {
2389 if (errno == EACCES || errno == EPERM) {
2390 PLOG(ERROR) << "Could not unlink " << path;
2391 return false;
2392 }
2393 PLOG(WARNING) << "Could not unlink " << path;
2394 }
2395 return true;
2396 };
2397
2398 // Delete the oat/odex file.
2399 bool return_value_oat = unlink_and_check(out_path);
2400
2401 // Derive and delete the app image.
2402 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2403
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002404 // Derive and delete the vdex file.
2405 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2406
Jeff Sharkey90aff262016-12-12 14:28:24 -07002407 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002408 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002409}
2410
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002411static bool is_absolute_path(const std::string& path) {
2412 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2413 LOG(ERROR) << "Invalid absolute path " << path;
2414 return false;
2415 } else {
2416 return true;
2417 }
2418}
2419
2420static bool is_valid_instruction_set(const std::string& instruction_set) {
2421 // TODO: add explicit whitelisting of instruction sets
2422 if (instruction_set.find('/') != std::string::npos) {
2423 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2424 return false;
2425 } else {
2426 return true;
2427 }
2428}
2429
2430bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2431 const char *apk_path, const char *instruction_set) {
2432 std::string oat_dir_ = oat_dir;
2433 std::string apk_path_ = apk_path;
2434 std::string instruction_set_ = instruction_set;
2435
2436 if (!is_absolute_path(oat_dir_)) return false;
2437 if (!is_absolute_path(apk_path_)) return false;
2438 if (!is_valid_instruction_set(instruction_set_)) return false;
2439
2440 std::string::size_type end = apk_path_.rfind('.');
2441 std::string::size_type start = apk_path_.rfind('/', end);
2442 if (end == std::string::npos || start == std::string::npos) {
2443 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2444 return false;
2445 }
2446
2447 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2448 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2449 const char* res = res_.c_str();
2450 if (strlen(res) >= PKG_PATH_MAX) {
2451 LOG(ERROR) << "Result too large";
2452 return false;
2453 } else {
2454 strlcpy(path, res, PKG_PATH_MAX);
2455 return true;
2456 }
2457}
2458
2459bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2460 const char *instruction_set) {
2461 std::string apk_path_ = apk_path;
2462 std::string instruction_set_ = instruction_set;
2463
2464 if (!is_absolute_path(apk_path_)) return false;
2465 if (!is_valid_instruction_set(instruction_set_)) return false;
2466
2467 std::string::size_type end = apk_path_.rfind('.');
2468 std::string::size_type start = apk_path_.rfind('/', end);
2469 if (end == std::string::npos || start == std::string::npos) {
2470 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2471 return false;
2472 }
2473
2474 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2475 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2476}
2477
2478bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2479 const char *instruction_set) {
2480 std::string src_ = src;
2481 std::string instruction_set_ = instruction_set;
2482
2483 if (!is_absolute_path(src_)) return false;
2484 if (!is_valid_instruction_set(instruction_set_)) return false;
2485
2486 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2487 if (*it == '/') {
2488 *it = '@';
2489 }
2490 }
2491
2492 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2493 + DALVIK_CACHE_POSTFIX;
2494 const char* res = res_.c_str();
2495 if (strlen(res) >= PKG_PATH_MAX) {
2496 LOG(ERROR) << "Result too large";
2497 return false;
2498 } else {
2499 strlcpy(path, res, PKG_PATH_MAX);
2500 return true;
2501 }
2502}
2503
Calin Juravle59f7ab82018-04-27 17:50:23 -07002504bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2505 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002506 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2507 for (const std::string& elem : classpaths_elems) {
2508 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2509 if (fd < 0) {
2510 PLOG(ERROR) << "Could not open classpath elem " << elem;
2511 return false;
2512 } else {
2513 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002514 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002515 }
2516 }
2517 return true;
2518}
2519
2520static bool create_app_profile_snapshot(int32_t app_id,
2521 const std::string& package_name,
2522 const std::string& profile_name,
2523 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002524 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2525
Calin Juravle824a64d2018-01-18 20:23:17 -08002526 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002527 if (snapshot_fd < 0) {
2528 return false;
2529 }
2530
2531 std::vector<unique_fd> profiles_fd;
2532 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002533 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2534 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002535 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2536 return false;
2537 }
2538
2539 profiles_fd.push_back(std::move(reference_profile_fd));
2540
Calin Juravle0d0a4922018-01-23 19:54:11 -08002541 // Open the class paths elements. These will be used to filter out profile data that does
2542 // not belong to the classpath during merge.
2543 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002544 std::vector<std::string> dex_locations;
2545 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002546 return false;
2547 }
2548
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002549 RunProfman args;
2550 args.SetupMerge(profiles_fd, snapshot_fd, apk_fds, dex_locations);
Calin Juravle29591732017-11-20 17:46:19 -08002551 pid_t pid = fork();
2552 if (pid == 0) {
2553 /* child -- drop privileges before continuing */
2554 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002555 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002556 }
2557
2558 /* parent */
2559 int return_code = wait_child(pid);
2560 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002561 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002562 return false;
2563 }
2564
2565 return true;
2566}
2567
Calin Juravle0d0a4922018-01-23 19:54:11 -08002568static bool create_boot_image_profile_snapshot(const std::string& package_name,
2569 const std::string& profile_name,
2570 const std::string& classpath) {
2571 // The reference profile directory for the android package might not be prepared. Do it now.
2572 const std::string ref_profile_dir =
2573 create_primary_reference_profile_package_dir_path(package_name);
2574 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2575 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2576 return false;
2577 }
2578
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002579 // Return false for empty class path since it may otherwise return true below if profiles is
2580 // empty.
2581 if (classpath.empty()) {
2582 PLOG(ERROR) << "Class path is empty";
2583 return false;
2584 }
2585
Calin Juravle0d0a4922018-01-23 19:54:11 -08002586 // Open and create the snapshot profile.
2587 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2588
2589 // Collect all non empty profiles.
2590 // The collection will traverse all applications profiles and find the non empty files.
2591 // This has the potential of inspecting a large number of files and directories (depending
2592 // on the number of applications and users). So there is a slight increase in the chance
2593 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2594 // fail the snapshot and aggregate whatever profile we could open.
2595 //
2596 // The profile snapshot is a best effort based on available data it's ok if some data
2597 // from some apps is missing. It will be counter productive for the snapshot to fail
2598 // because we could not open or read some of the files.
2599 std::vector<std::string> profiles;
2600 if (!collect_profiles(&profiles)) {
2601 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2602 }
2603
2604 // If we have no profiles return early.
2605 if (profiles.empty()) {
2606 return true;
2607 }
2608
2609 // Open the classpath elements. These will be used to filter out profile data that does
2610 // not belong to the classpath during merge.
2611 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002612 std::vector<std::string> dex_locations;
2613 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002614 return false;
2615 }
2616
2617 // If we could not open any files from the classpath return an error.
2618 if (apk_fds.empty()) {
2619 LOG(ERROR) << "Could not open any of the classpath elements.";
2620 return false;
2621 }
2622
2623 // Aggregate the profiles in batches of kAggregationBatchSize.
2624 // We do this to avoid opening a huge a amount of files.
2625 static constexpr size_t kAggregationBatchSize = 10;
2626
2627 std::vector<unique_fd> profiles_fd;
2628 for (size_t i = 0; i < profiles.size(); ) {
2629 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2630 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2631 if (fd.get() >= 0) {
2632 profiles_fd.push_back(std::move(fd));
2633 }
2634 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002635 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002636 args.SetupMerge(profiles_fd,
2637 snapshot_fd,
2638 apk_fds,
2639 dex_locations,
2640 /*store_aggregation_counters=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002641 pid_t pid = fork();
2642 if (pid == 0) {
2643 /* child -- drop privileges before continuing */
2644 drop_capabilities(AID_SYSTEM);
2645
Calin Juravle59f7ab82018-04-27 17:50:23 -07002646 // The introduction of new access flags into boot jars causes them to
2647 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002648 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002649 }
2650
2651 /* parent */
2652 int return_code = wait_child(pid);
2653 if (!WIFEXITED(return_code)) {
2654 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2655 return false;
2656 }
2657 return true;
2658 }
2659 return true;
2660}
2661
2662bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2663 const std::string& profile_name, const std::string& classpath) {
2664 if (app_id == -1) {
2665 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2666 } else {
2667 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2668 }
2669}
2670
Calin Juravlec3b049e2018-01-18 22:32:58 -08002671bool prepare_app_profile(const std::string& package_name,
2672 userid_t user_id,
2673 appid_t app_id,
2674 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002675 const std::string& code_path,
Calin Juravlec3b049e2018-01-18 22:32:58 -08002676 const std::unique_ptr<std::string>& dex_metadata) {
2677 // Prepare the current profile.
2678 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2679 /*is_secondary_dex*/ false);
2680 uid_t uid = multiuser_get_uid(user_id, app_id);
2681 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2682 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2683 return false;
2684 }
2685
2686 // Check if we need to install the profile from the dex metadata.
2687 if (dex_metadata == nullptr) {
2688 return true;
2689 }
2690
2691 // We have a dex metdata. Merge the profile into the reference profile.
2692 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2693 /*read_write*/ true, /*is_secondary_dex*/ false);
2694 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2695 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002696 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2697 if (apk_fd < 0) {
2698 PLOG(ERROR) << "Could not open code path " << code_path;
2699 return false;
2700 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002701
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002702 RunProfman args;
2703 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2704 std::move(ref_profile_fd),
2705 std::move(apk_fd),
2706 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002707 pid_t pid = fork();
2708 if (pid == 0) {
2709 /* child -- drop privileges before continuing */
2710 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2711 drop_capabilities(app_shared_gid);
2712
Calin Juravlef63d4792018-01-30 17:43:34 +00002713 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002714 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002715 }
2716
2717 /* parent */
2718 int return_code = wait_child(pid);
2719 if (!WIFEXITED(return_code)) {
2720 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2721 return false;
2722 }
2723 return true;
2724}
2725
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002726} // namespace installd
2727} // namespace android