blob: 645e211233d988097dd3358173fbabc819ac11ba [file] [log] [blame]
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Alan Stokescb27c342018-04-20 17:09:25 +010016#define LOG_TAG "installd"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070017
Alan Stokesa25d90c2017-10-16 10:56:00 +010018#include <array>
Jeff Sharkey90aff262016-12-12 14:28:24 -070019#include <fcntl.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070020#include <stdlib.h>
21#include <string.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070022#include <sys/capability.h>
23#include <sys/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070024#include <sys/stat.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070025#include <sys/time.h>
26#include <sys/types.h>
27#include <sys/resource.h>
28#include <sys/wait.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070029#include <unistd.h>
30
Andreas Gampe023b2242018-02-28 16:03:25 -080031#include <iomanip>
32
Alan Stokesa25d90c2017-10-16 10:56:00 +010033#include <android-base/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070034#include <android-base/logging.h>
Andreas Gampe6a9cf722017-07-24 16:49:10 -070035#include <android-base/properties.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070036#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070037#include <android-base/strings.h>
38#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080039#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070040#include <cutils/properties.h>
41#include <cutils/sched_policy.h>
Andreas Gampefa2dadd2018-02-28 19:52:47 -080042#include <dex2oat_return_codes.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070043#include <log/log.h> // TODO: Move everything to base/logging.
Alan Stokesa25d90c2017-10-16 10:56:00 +010044#include <openssl/sha.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070045#include <private/android_filesystem_config.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070046#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070047#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070048
49#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080050#include "dexopt_return_codes.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060051#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070052#include "installd_deps.h"
53#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070054#include "utils.h"
55
Jeff Sharkey90aff262016-12-12 14:28:24 -070056using android::base::EndsWith;
Mathieu Chartier9b2da082018-10-26 13:23:11 -070057using android::base::GetBoolProperty;
58using android::base::GetProperty;
Alan Stokesa25d90c2017-10-16 10:56:00 +010059using android::base::ReadFully;
60using android::base::StringPrintf;
61using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080062using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070063
64namespace android {
65namespace installd {
66
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070067// Should minidebug info be included in compiled artifacts? Even if this value is
68// "true," usage might still be conditional to other constraints, e.g., system
69// property overrides.
70static constexpr bool kEnableMinidebugInfo = true;
71
72static constexpr const char* kMinidebugInfoSystemProperty = "dalvik.vm.dex2oat-minidebuginfo";
73static constexpr bool kMinidebugInfoSystemPropertyDefault = false;
74static constexpr const char* kMinidebugDex2oatFlag = "--generate-mini-debug-info";
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -080075static constexpr const char* kDisableCompactDexFlag = "--compact-dex-level=none";
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070076
Andreas Gampefa2dadd2018-02-28 19:52:47 -080077
Calin Juravle114f0812017-03-08 19:05:07 -080078// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
79struct FreeDelete {
80 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
81 void operator()(const void* ptr) const {
82 free(const_cast<void*>(ptr));
83 }
84};
85
86// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
87template <typename T>
88using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
89
Calin Juravle1a0af3b2017-03-09 14:33:33 -080090static unique_fd invalid_unique_fd() {
91 return unique_fd(-1);
92}
93
Andreas Gampe6a9cf722017-07-24 16:49:10 -070094static bool is_debug_runtime() {
95 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
96}
97
David Sehra3b5ab62017-10-25 14:27:29 -070098static bool is_debuggable_build() {
99 return android::base::GetBoolProperty("ro.debuggable", false);
100}
101
Jeff Sharkey90aff262016-12-12 14:28:24 -0700102static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800103 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700104 if (ufd.get() < 0) {
105 if (errno != ENOENT) {
106 PLOG(WARNING) << "Could not open profile " << profile;
107 return false;
108 } else {
109 // Nothing to clear. That's ok.
110 return true;
111 }
112 }
113
114 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
115 if (errno != EWOULDBLOCK) {
116 PLOG(WARNING) << "Error locking profile " << profile;
117 }
118 // This implies that the app owning this profile is running
119 // (and has acquired the lock).
120 //
121 // If we can't acquire the lock bail out since clearing is useless anyway
122 // (the app will write again to the profile).
123 //
124 // Note:
125 // This does not impact the this is not an issue for the profiling correctness.
126 // In case this is needed because of an app upgrade, profiles will still be
127 // eventually cleared by the app itself due to checksum mismatch.
128 // If this is needed because profman advised, then keeping the data around
129 // until the next run is again not an issue.
130 //
131 // If the app attempts to acquire a lock while we've held one here,
132 // it will simply skip the current write cycle.
133 return false;
134 }
135
136 bool truncated = ftruncate(ufd.get(), 0) == 0;
137 if (!truncated) {
138 PLOG(WARNING) << "Could not truncate " << profile;
139 }
140 if (flock(ufd.get(), LOCK_UN) != 0) {
141 PLOG(WARNING) << "Error unlocking profile " << profile;
142 }
143 return truncated;
144}
145
Calin Juravle114f0812017-03-08 19:05:07 -0800146// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800147// The location is the profile name for primary apks or the dex path for secondary dex files.
148static bool clear_reference_profile(const std::string& package_name, const std::string& location,
149 bool is_secondary_dex) {
150 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700151}
152
Calin Juravle114f0812017-03-08 19:05:07 -0800153// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800154// The location is the profile name for primary apks or the dex path for secondary dex files.
155static bool clear_current_profile(const std::string& package_name, const std::string& location,
156 userid_t user, bool is_secondary_dex) {
157 return clear_profile(create_current_profile_path(user, package_name, location,
158 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700159}
160
Calin Juravle114f0812017-03-08 19:05:07 -0800161// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800162// The location is the profile name for primary apks or the dex path for secondary dex files.
163bool clear_primary_reference_profile(const std::string& package_name,
164 const std::string& location) {
165 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800166}
167
168// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800169// The location is the profile name for primary apks or the dex path for secondary dex files.
170bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700171 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800172 // For secondary dex files, we don't really need the user but we use it for sanity checks.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700173 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
174 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800175 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700176 }
177 return success;
178}
179
Calin Juravle114f0812017-03-08 19:05:07 -0800180// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800181bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
182 userid_t user) {
183 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800184}
185
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700186static std::vector<std::string> SplitBySpaces(const std::string& str) {
187 if (str.empty()) {
188 return {};
189 }
190 return android::base::Split(str, " ");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700191}
192
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700193static const char* get_location_from_path(const char* path) {
194 static constexpr char kLocationSeparator = '/';
195 const char *location = strrchr(path, kLocationSeparator);
Yi Kong954cf642018-07-17 16:16:24 -0700196 if (location == nullptr) {
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700197 return path;
198 } else {
199 // Skip the separator character.
200 return location + 1;
201 }
202}
203
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800204// ExecVHelper prepares and holds pointers to parsed command line arguments so that no allocations
205// need to be performed between the fork and exec.
206class ExecVHelper {
207 public:
208 // Store a placeholder for the binary name.
209 ExecVHelper() : args_(1u, std::string()) {}
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800210
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800211 void PrepareArgs(const std::string& bin) {
212 CHECK(!args_.empty());
213 CHECK(args_[0].empty());
214 args_[0] = bin;
215 // Write char* into array.
216 for (const std::string& arg : args_) {
217 argv_.push_back(arg.c_str());
218 }
219 argv_.push_back(nullptr); // Add null terminator.
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800220 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800221
222 [[ noreturn ]]
223 void Exec(int exit_code) {
224 execv(argv_[0], (char * const *)&argv_[0]);
225 PLOG(ERROR) << "execv(" << argv_[0] << ") failed";
226 exit(exit_code);
227 }
228
229 // Add an arg if it's not empty.
230 void AddArg(const std::string& arg) {
231 if (!arg.empty()) {
232 args_.push_back(arg);
233 }
234 }
235
236 // Add a runtime arg if it's not empty.
237 void AddRuntimeArg(const std::string& arg) {
238 if (!arg.empty()) {
239 args_.push_back("--runtime-arg");
240 args_.push_back(arg);
241 }
242 }
243
244 protected:
245 // Holder arrays for backing arg storage.
246 std::vector<std::string> args_;
247
248 // Argument poiners.
249 std::vector<const char*> argv_;
250};
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700251
252static std::string MapPropertyToArg(const std::string& property,
253 const std::string& format,
254 const std::string& default_value = "") {
255 std::string prop = GetProperty(property, default_value);
256 if (!prop.empty()) {
257 return StringPrintf(format.c_str(), prop.c_str());
258 }
259 return "";
260}
261
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800262class RunDex2Oat : public ExecVHelper {
263 public:
264 RunDex2Oat(int zip_fd,
265 int oat_fd,
266 int input_vdex_fd,
267 int output_vdex_fd,
268 int image_fd,
269 const char* input_file_name,
270 const char* output_file_name,
271 int swap_fd,
272 const char* instruction_set,
273 const char* compiler_filter,
274 bool debuggable,
275 bool post_bootcomplete,
276 bool background_job_compile,
277 int profile_fd,
278 const char* class_loader_context,
279 int target_sdk_version,
280 bool enable_hidden_api_checks,
281 bool generate_compact_dex,
282 int dex_metadata_fd,
283 const char* compilation_reason) {
284 // Get the relative path to the input file.
285 const char* relative_input_file_name = get_location_from_path(input_file_name);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700286
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800287 std::string dex2oat_Xms_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xms", "-Xms%s");
288 std::string dex2oat_Xmx_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xmx", "-Xmx%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700289
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800290 const char* threads_property = post_bootcomplete
291 ? "dalvik.vm.dex2oat-threads"
292 : "dalvik.vm.boot-dex2oat-threads";
293 std::string dex2oat_threads_arg = MapPropertyToArg(threads_property, "-j%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700294
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800295 const std::string dex2oat_isa_features_key =
296 StringPrintf("dalvik.vm.isa.%s.features", instruction_set);
297 std::string instruction_set_features_arg =
298 MapPropertyToArg(dex2oat_isa_features_key, "--instruction-set-features=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700299
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800300 const std::string dex2oat_isa_variant_key =
301 StringPrintf("dalvik.vm.isa.%s.variant", instruction_set);
302 std::string instruction_set_variant_arg =
303 MapPropertyToArg(dex2oat_isa_variant_key, "--instruction-set-variant=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700304
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800305 const char* dex2oat_norelocation = "-Xnorelocate";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700306
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800307 const std::string dex2oat_flags = GetProperty("dalvik.vm.dex2oat-flags", "");
308 std::vector<std::string> dex2oat_flags_args = SplitBySpaces(dex2oat_flags);
309 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700310
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800311 // If we are booting without the real /data, don't spend time compiling.
312 std::string vold_decrypt = GetProperty("vold.decrypt", "");
313 bool skip_compilation = vold_decrypt == "trigger_restart_min_framework" ||
314 vold_decrypt == "1";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700315
Mathieu Chartier5880c032018-11-28 19:15:41 -0800316 const std::string resolve_startup_string_arg =
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800317 MapPropertyToArg("dalvik.vm.dex2oat-resolve-startup-strings",
318 "--resolve-startup-const-strings=%s");
Mathieu Chartier5880c032018-11-28 19:15:41 -0800319
320 const std::string image_block_size_arg =
321 MapPropertyToArg("dalvik.vm.dex2oat-max-image-block-size",
322 "--max-image-block-size=%s");
323
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800324 const bool generate_debug_info = GetBoolProperty("debug.generate-debug-info", false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700325
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800326 std::string image_format_arg;
327 if (image_fd >= 0) {
328 image_format_arg = MapPropertyToArg("dalvik.vm.appimageformat", "--image-format=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000329 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000330
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800331 std::string dex2oat_large_app_threshold_arg =
332 MapPropertyToArg("dalvik.vm.dex2oat-very-large", "--very-large-app-threshold=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000333
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800334 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
Roland Levillainb8f50cd2018-11-02 18:43:17 +0000335 const char* dex2oat_bin = "/apex/com.android.runtime/bin/dex2oat";
336 constexpr const char* kDex2oatDebugPath = "/apex/com.android.runtime/bin/dex2oatd";
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800337 // Do not use dex2oatd for release candidates (give dex2oat more soak time).
338 bool is_release = android::base::GetProperty("ro.build.version.codename", "") == "REL";
339 if (is_debug_runtime() ||
340 (background_job_compile && is_debuggable_build() && !is_release)) {
341 if (access(kDex2oatDebugPath, X_OK) == 0) {
342 dex2oat_bin = kDex2oatDebugPath;
343 }
344 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000345
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800346 bool generate_minidebug_info = kEnableMinidebugInfo &&
347 GetBoolProperty(kMinidebugInfoSystemProperty, kMinidebugInfoSystemPropertyDefault);
Mathieu Chartier31636522018-11-09 23:53:07 +0000348
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800349 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
350 // use arraysize instead.
351 std::string zip_fd_arg = StringPrintf("--zip-fd=%d", zip_fd);
352 std::string zip_location_arg = StringPrintf("--zip-location=%s", relative_input_file_name);
353 std::string input_vdex_fd_arg = StringPrintf("--input-vdex-fd=%d", input_vdex_fd);
354 std::string output_vdex_fd_arg = StringPrintf("--output-vdex-fd=%d", output_vdex_fd);
355 std::string oat_fd_arg = StringPrintf("--oat-fd=%d", oat_fd);
356 std::string oat_location_arg = StringPrintf("--oat-location=%s", output_file_name);
357 std::string instruction_set_arg = StringPrintf("--instruction-set=%s", instruction_set);
358 std::string dex2oat_compiler_filter_arg;
359 std::string dex2oat_swap_fd;
360 std::string dex2oat_image_fd;
361 std::string target_sdk_version_arg;
362 if (target_sdk_version != 0) {
363 StringPrintf("-Xtarget-sdk-version:%d", target_sdk_version);
364 }
365 std::string class_loader_context_arg;
366 if (class_loader_context != nullptr) {
367 class_loader_context_arg = StringPrintf("--class-loader-context=%s",
368 class_loader_context);
369 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000370
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800371 if (swap_fd >= 0) {
372 dex2oat_swap_fd = StringPrintf("--swap-fd=%d", swap_fd);
373 }
374 if (image_fd >= 0) {
375 dex2oat_image_fd = StringPrintf("--app-image-fd=%d", image_fd);
376 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000377
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800378 // Compute compiler filter.
379 bool have_dex2oat_relocation_skip_flag = false;
380 if (skip_compilation) {
381 dex2oat_compiler_filter_arg = "--compiler-filter=extract";
382 have_dex2oat_relocation_skip_flag = true;
383 } else if (compiler_filter != nullptr) {
384 dex2oat_compiler_filter_arg = StringPrintf("--compiler-filter=%s", compiler_filter);
385 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000386
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800387 if (dex2oat_compiler_filter_arg.empty()) {
388 dex2oat_compiler_filter_arg = MapPropertyToArg("dalvik.vm.dex2oat-filter",
389 "--compiler-filter=%s");
390 }
391
392 // Check whether all apps should be compiled debuggable.
393 if (!debuggable) {
394 debuggable = GetProperty("dalvik.vm.always_debuggable", "") == "1";
395 }
396 std::string profile_arg;
397 if (profile_fd != -1) {
398 profile_arg = StringPrintf("--profile-file-fd=%d", profile_fd);
399 }
400
401 // Get the directory of the apk to pass as a base classpath directory.
402 std::string base_dir;
403 std::string apk_dir(input_file_name);
404 unsigned long dir_index = apk_dir.rfind('/');
405 bool has_base_dir = dir_index != std::string::npos;
406 if (has_base_dir) {
407 apk_dir = apk_dir.substr(0, dir_index);
408 base_dir = StringPrintf("--classpath-dir=%s", apk_dir.c_str());
409 }
410
411 std::string dex_metadata_fd_arg = "--dm-fd=" + std::to_string(dex_metadata_fd);
412
413 std::string compilation_reason_arg = compilation_reason == nullptr
414 ? ""
415 : std::string("--compilation-reason=") + compilation_reason;
416
417 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
418
419 // Disable cdex if update input vdex is true since this combination of options is not
420 // supported.
421 const bool disable_cdex = !generate_compact_dex || (input_vdex_fd == output_vdex_fd);
422
423 AddArg(zip_fd_arg);
424 AddArg(zip_location_arg);
425 AddArg(input_vdex_fd_arg);
426 AddArg(output_vdex_fd_arg);
427 AddArg(oat_fd_arg);
428 AddArg(oat_location_arg);
429 AddArg(instruction_set_arg);
430
431 AddArg(instruction_set_variant_arg);
432 AddArg(instruction_set_features_arg);
433
434 AddRuntimeArg(dex2oat_Xms_arg);
435 AddRuntimeArg(dex2oat_Xmx_arg);
436
437 AddArg(resolve_startup_string_arg);
Mathieu Chartier5880c032018-11-28 19:15:41 -0800438 AddArg(image_block_size_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800439 AddArg(dex2oat_compiler_filter_arg);
440 AddArg(dex2oat_threads_arg);
441 AddArg(dex2oat_swap_fd);
442 AddArg(dex2oat_image_fd);
443
444 if (generate_debug_info) {
445 AddArg("--generate-debug-info");
446 }
447 if (debuggable) {
448 AddArg("--debuggable");
449 }
450 AddArg(image_format_arg);
451 AddArg(dex2oat_large_app_threshold_arg);
452
453 if (have_dex2oat_relocation_skip_flag) {
454 AddRuntimeArg(dex2oat_norelocation);
455 }
456 AddArg(profile_arg);
457 AddArg(base_dir);
458 AddArg(class_loader_context_arg);
459 if (generate_minidebug_info) {
460 AddArg(kMinidebugDex2oatFlag);
461 }
462 if (disable_cdex) {
463 AddArg(kDisableCompactDexFlag);
464 }
465 AddArg(target_sdk_version_arg);
466 if (enable_hidden_api_checks) {
467 AddRuntimeArg("-Xhidden-api-checks");
468 }
469
470 if (dex_metadata_fd > -1) {
471 AddArg(dex_metadata_fd_arg);
472 }
473
474 AddArg(compilation_reason_arg);
475
476 // Do not add args after dex2oat_flags, they should override others for debugging.
477 args_.insert(args_.end(), dex2oat_flags_args.begin(), dex2oat_flags_args.end());
478
479 PrepareArgs(dex2oat_bin);
Mathieu Chartier31636522018-11-09 23:53:07 +0000480 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800481};
Jeff Sharkey90aff262016-12-12 14:28:24 -0700482
483/*
484 * Whether dexopt should use a swap file when compiling an APK.
485 *
486 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
487 * itself, anyways).
488 *
489 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
490 *
491 * Otherwise, return true if this is a low-mem device.
492 *
493 * Otherwise, return default value.
494 */
495static bool kAlwaysProvideSwapFile = false;
496static bool kDefaultProvideSwapFile = true;
497
498static bool ShouldUseSwapFileForDexopt() {
499 if (kAlwaysProvideSwapFile) {
500 return true;
501 }
502
503 // Check the "override" property. If it exists, return value == "true".
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700504 std::string dex2oat_prop_buf = GetProperty("dalvik.vm.dex2oat-swap", "");
505 if (!dex2oat_prop_buf.empty()) {
506 return dex2oat_prop_buf == "true";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700507 }
508
509 // Shortcut for default value. This is an implementation optimization for the process sketched
510 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
511 // as low-mem is never returning false. The compiler will optimize this away if it can.
512 if (kDefaultProvideSwapFile) {
513 return true;
514 }
515
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700516 if (GetBoolProperty("ro.config.low_ram", false)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700517 return true;
518 }
519
520 // Default value must be false here.
521 return kDefaultProvideSwapFile;
522}
523
Richard Uhler76cc0272016-12-08 10:46:35 +0000524static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700525 if (set_to_bg) {
526 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800527 PLOG(ERROR) << "set_sched_policy failed";
528 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700529 }
530 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800531 PLOG(ERROR) << "setpriority failed";
532 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700533 }
534 }
535}
536
Calin Juravle29591732017-11-20 17:46:19 -0800537static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
538 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800539 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800540 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800541 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800542 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800543 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700544 }
Calin Juravle114f0812017-03-08 19:05:07 -0800545 // Profiles should belong to the app; make sure of that by giving ownership to
546 // the app uid. If we cannot do that, there's no point in returning the fd
547 // since dex2oat/profman will fail with SElinux denials.
548 if (fchown(fd.get(), uid, uid) < 0) {
549 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800550 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800551 }
Calin Juravle29591732017-11-20 17:46:19 -0800552 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800553}
554
Calin Juravle29591732017-11-20 17:46:19 -0800555static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800556 // Do not follow symlinks when opening a profile:
557 // - primary profiles should not contain symlinks in their paths
558 // - secondary dex paths should have been already resolved and validated
559 flags |= O_NOFOLLOW;
560
Calin Juravle29591732017-11-20 17:46:19 -0800561 // Check if we need to create the profile
562 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
563 unique_fd fd;
564 if ((flags & O_CREAT) != 0) {
565 fd = create_profile(uid, profile, flags);
566 } else {
567 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
568 }
569
Calin Juravle114f0812017-03-08 19:05:07 -0800570 if (fd.get() < 0) {
571 if (errno != ENOENT) {
572 // Profiles might be missing for various reasons. For example, in a
573 // multi-user environment, the profile directory for one user can be created
574 // after we start a merge. In this case the current profile for that user
575 // will not be found.
576 // Also, the secondary dex profiles might be deleted by the app at any time,
577 // so we can't we need to prepare if they are missing.
578 PLOG(ERROR) << "Failed to open profile " << profile;
579 }
580 return invalid_unique_fd();
581 }
582
Jeff Sharkey90aff262016-12-12 14:28:24 -0700583 return fd;
584}
585
Calin Juravle824a64d2018-01-18 20:23:17 -0800586static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
587 const std::string& location, bool is_secondary_dex) {
588 std::string profile = create_current_profile_path(user, package_name, location,
589 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800590 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800591}
592
Calin Juravle824a64d2018-01-18 20:23:17 -0800593static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
594 const std::string& location, bool read_write, bool is_secondary_dex) {
595 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800596 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
597}
598
599static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800600 const std::string& location) {
601 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800602 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800603}
604
Calin Juravle824a64d2018-01-18 20:23:17 -0800605static void open_profile_files(uid_t uid, const std::string& package_name,
606 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800607 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700608 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800609 *reference_profile_fd = open_reference_profile(uid, package_name, location,
610 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700611
Calin Juravle114f0812017-03-08 19:05:07 -0800612 // For secondary dex files, we don't really need the user but we use it for sanity checks.
613 // Note: the user owning the dex file should be the current user.
614 std::vector<userid_t> users;
615 if (is_secondary_dex){
616 users.push_back(multiuser_get_user_id(uid));
617 } else {
618 users = get_known_users(/*volume_uuid*/ nullptr);
619 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700620 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800621 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
622 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700623 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800624 if (profile_fd.get() >= 0) {
625 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700626 }
627 }
628}
629
630static void drop_capabilities(uid_t uid) {
631 if (setgid(uid) != 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800632 PLOG(ERROR) << "setgid(" << uid << ") failed in installd during dexopt";
633 exit(DexoptReturnCodes::kSetGid);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700634 }
635 if (setuid(uid) != 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800636 PLOG(ERROR) << "setuid(" << uid << ") failed in installd during dexopt";
637 exit(DexoptReturnCodes::kSetUid);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700638 }
639 // drop capabilities
640 struct __user_cap_header_struct capheader;
641 struct __user_cap_data_struct capdata[2];
642 memset(&capheader, 0, sizeof(capheader));
643 memset(&capdata, 0, sizeof(capdata));
644 capheader.version = _LINUX_CAPABILITY_VERSION_3;
645 if (capset(&capheader, &capdata[0]) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800646 PLOG(ERROR) << "capset failed";
647 exit(DexoptReturnCodes::kCapSet);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700648 }
649}
650
651static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
652static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
653static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
654static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
655static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
656
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800657class RunProfman : public ExecVHelper {
658 public:
659 void SetupArgs(const std::vector<unique_fd>& profile_fds,
660 const unique_fd& reference_profile_fd,
661 const std::vector<unique_fd>& apk_fds,
662 const std::vector<std::string>& dex_locations,
663 bool copy_and_update) {
664 const char* profman_bin =
Roland Levillainb8f50cd2018-11-02 18:43:17 +0000665 is_debug_runtime()
666 ? "/apex/com.android.runtime/bin/profmand"
667 : "/apex/com.android.runtime/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700668
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800669 if (copy_and_update) {
670 CHECK_EQ(1u, profile_fds.size());
671 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000672 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800673 if (reference_profile_fd != -1) {
674 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000675 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800676
677 for (const unique_fd& fd : profile_fds) {
678 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
679 }
680
681 for (const unique_fd& fd : apk_fds) {
682 AddArg("--apk-fd=" + std::to_string(fd.get()));
683 }
684
685 for (const std::string& dex_location : dex_locations) {
686 AddArg("--dex-location=" + dex_location);
687 }
688
689 if (copy_and_update) {
690 AddArg("--copy-and-update-profile-key");
691 }
692
693 // Do not add after dex2oat_flags, they should override others for debugging.
694 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800695 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700696
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800697 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
698 const unique_fd& reference_profile_fd,
699 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
700 const std::vector<std::string>& dex_locations = std::vector<std::string>()) {
701 SetupArgs(profiles_fd,
702 reference_profile_fd,
703 apk_fds,
704 dex_locations,
705 /*copy_and_update=*/false);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800706 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700707
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800708 void SetupCopyAndUpdate(unique_fd&& profile_fd,
709 unique_fd&& reference_profile_fd,
710 unique_fd&& apk_fd,
711 const std::string& dex_location) {
712 // The fds need to stay open longer than the scope of the function, so put them into a local
713 // variable vector.
714 profiles_fd_.push_back(std::move(profile_fd));
715 apk_fds_.push_back(std::move(apk_fd));
716 reference_profile_fd_ = std::move(reference_profile_fd);
717 std::vector<std::string> dex_locations = {dex_location};
718 SetupArgs(profiles_fd_, reference_profile_fd_, apk_fds_, dex_locations,
719 /*copy_and_update=*/true);
720 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000721
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800722 void SetupDump(const std::vector<unique_fd>& profiles_fd,
723 const unique_fd& reference_profile_fd,
724 const std::vector<std::string>& dex_locations,
725 const std::vector<unique_fd>& apk_fds,
726 const unique_fd& output_fd) {
727 AddArg("--dump-only");
728 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
729 SetupArgs(profiles_fd, reference_profile_fd, apk_fds, dex_locations,
730 /*copy_and_update=*/false);
731 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000732
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800733 void Exec() {
734 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
735 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000736
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800737 private:
738 unique_fd reference_profile_fd_;
739 std::vector<unique_fd> profiles_fd_;
740 std::vector<unique_fd> apk_fds_;
741};
Mathieu Chartier31636522018-11-09 23:53:07 +0000742
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800743
Calin Juravlef63d4792018-01-30 17:43:34 +0000744
Jeff Sharkey90aff262016-12-12 14:28:24 -0700745// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800746// The location is the package name for primary apks or the dex path for secondary dex files.
747// Returns true if there is enough information in the current profiles that makes it
748// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700749// If the return value is true all the current profiles would have been merged into
750// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800751static bool analyze_profiles(uid_t uid, const std::string& package_name,
752 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800753 std::vector<unique_fd> profiles_fd;
754 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800755 open_profile_files(uid, package_name, location, is_secondary_dex,
756 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800757 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700758 // Skip profile guided compilation because no profiles were found.
759 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700760 return false;
761 }
762
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800763 RunProfman profman_merge;
764 profman_merge.SetupMerge(profiles_fd, reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700765 pid_t pid = fork();
766 if (pid == 0) {
767 /* child -- drop privileges before continuing */
768 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800769 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700770 }
771 /* parent */
772 int return_code = wait_child(pid);
773 bool need_to_compile = false;
774 bool should_clear_current_profiles = false;
775 bool should_clear_reference_profile = false;
776 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800777 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700778 } else {
779 return_code = WEXITSTATUS(return_code);
780 switch (return_code) {
781 case PROFMAN_BIN_RETURN_CODE_COMPILE:
782 need_to_compile = true;
783 should_clear_current_profiles = true;
784 should_clear_reference_profile = false;
785 break;
786 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
787 need_to_compile = false;
788 should_clear_current_profiles = false;
789 should_clear_reference_profile = false;
790 break;
791 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800792 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700793 need_to_compile = false;
794 should_clear_current_profiles = true;
795 should_clear_reference_profile = true;
796 break;
797 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
798 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
799 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800800 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700801 need_to_compile = false;
802 should_clear_current_profiles = false;
803 should_clear_reference_profile = false;
804 break;
805 default:
806 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800807 LOG(WARNING) << "Unknown error code while processing profiles for location "
808 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700809 need_to_compile = false;
810 should_clear_current_profiles = true;
811 should_clear_reference_profile = true;
812 break;
813 }
814 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800815
Jeff Sharkey90aff262016-12-12 14:28:24 -0700816 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800817 if (is_secondary_dex) {
818 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800819 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
820 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800821 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800822 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800823 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700824 }
825 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800826 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700827 }
828 return need_to_compile;
829}
830
Calin Juravle114f0812017-03-08 19:05:07 -0800831// Decides if profile guided compilation is needed or not based on existing profiles.
832// The analysis is done for the primary apks of the given package.
833// Returns true if there is enough information in the current profiles that makes it
834// worth to recompile the package.
835// If the return value is true all the current profiles would have been merged into
836// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800837bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
838 const std::string& profile_name) {
839 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800840}
841
Calin Juravle408cd4a2018-01-20 23:34:18 -0800842bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
843 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800844 std::vector<unique_fd> profile_fds;
845 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800846 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
847 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700848
Calin Juravle408cd4a2018-01-20 23:34:18 -0800849 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800850 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700851
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800852 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700853 const bool has_profiles = !profile_fds.empty();
854
855 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800856 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700857 return false;
858 }
859
Calin Juravle114f0812017-03-08 19:05:07 -0800860 unique_fd output_fd(open(out_file_name.c_str(),
861 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700862 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800863 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700864 return false;
865 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800866
Jeff Sharkey90aff262016-12-12 14:28:24 -0700867 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800868 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800869 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
870 if (apk_fd == -1) {
871 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
872 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700873 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800874 dex_locations.push_back(get_location_from_path(code_path.c_str()));
875 apk_fds.push_back(std::move(apk_fd));
876
Jeff Sharkey90aff262016-12-12 14:28:24 -0700877
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800878 RunProfman profman_dump;
879 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700880 pid_t pid = fork();
881 if (pid == 0) {
882 /* child -- drop privileges before continuing */
883 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800884 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700885 }
886 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700887 int return_code = wait_child(pid);
888 if (!WIFEXITED(return_code)) {
889 LOG(WARNING) << "profman failed for package " << pkgname << ": "
890 << return_code;
891 return false;
892 }
893 return true;
894}
895
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700896bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800897 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700898 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
899 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800900 package_name,
901 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700902 /*read_write*/ true,
903 /*secondary*/ false));
904 if (in_fd.get() < 0) {
905 PLOG(WARNING) << "Could not open profile " << system_profile;
906 return false;
907 }
908 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800909 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700910 return false;
911 }
912
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700913 // As a security measure we want to write the profile information with the reduced capabilities
914 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700915 pid_t pid = fork();
916 if (pid == 0) {
917 /* child -- drop privileges before continuing */
918 drop_capabilities(packageUid);
919
920 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
921 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800922 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700923 }
924 // This implies that the app owning this profile is running
925 // (and has acquired the lock).
926 //
927 // The app never acquires the lock for the reference profiles of primary apks.
928 // Only dex2oat from installd will do that. Since installd is single threaded
929 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800930 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700931 return false;
932 }
933
934 bool truncated = ftruncate(out_fd.get(), 0) == 0;
935 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800936 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700937 }
938
939 // Copy over data.
940 static constexpr size_t kBufferSize = 4 * 1024;
941 char buffer[kBufferSize];
942 while (true) {
943 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
944 if (bytes == 0) {
945 break;
946 }
947 write(out_fd.get(), buffer, bytes);
948 }
949 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800950 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700951 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700952 // Use _exit since we don't want to run the global destructors in the child.
953 // b/62597429
954 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700955 }
956 /* parent */
957 int return_code = wait_child(pid);
958 return return_code == 0;
959}
960
Jeff Sharkey90aff262016-12-12 14:28:24 -0700961static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
962 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
963 if (EndsWith(oat_path, ".dex")) {
964 std::string new_path = oat_path;
965 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800966 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700967 return new_path;
968 }
969
970 // An odex entry. Not that this may not be an extension, e.g., in the OTA
971 // case (where the base name will have an extension for the B artifact).
972 size_t odex_pos = oat_path.rfind(".odex");
973 if (odex_pos != std::string::npos) {
974 std::string new_path = oat_path;
975 new_path.replace(odex_pos, strlen(".odex"), new_ext);
976 CHECK_NE(new_path.find(new_ext), std::string::npos);
977 return new_path;
978 }
979
980 // Don't know how to handle this.
981 return "";
982}
983
984// Translate the given oat path to an art (app image) path. An empty string
985// denotes an error.
986static std::string create_image_filename(const std::string& oat_path) {
987 return replace_file_extension(oat_path, ".art");
988}
989
990// Translate the given oat path to a vdex path. An empty string denotes an error.
991static std::string create_vdex_filename(const std::string& oat_path) {
992 return replace_file_extension(oat_path, ".vdex");
993}
994
Jeff Sharkey90aff262016-12-12 14:28:24 -0700995static int open_output_file(const char* file_name, bool recreate, int permissions) {
996 int flags = O_RDWR | O_CREAT;
997 if (recreate) {
998 if (unlink(file_name) < 0) {
999 if (errno != ENOENT) {
1000 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1001 }
1002 }
1003 flags |= O_EXCL;
1004 }
1005 return open(file_name, flags, permissions);
1006}
1007
Calin Juravle2289c0a2017-02-15 12:44:14 -08001008static bool set_permissions_and_ownership(
1009 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1010 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1011 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001012 if (fchmod(fd,
1013 S_IRUSR|S_IWUSR|S_IRGRP |
1014 (is_public ? S_IROTH : 0)) < 0) {
1015 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1016 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001017 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001018 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1019 return false;
1020 }
1021 return true;
1022}
1023
1024static bool IsOutputDalvikCache(const char* oat_dir) {
1025 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1026 // into '!'. Play it safe by handling it both.
1027 // TODO: ensure we never get null.
1028 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1029 return oat_dir == nullptr || oat_dir[0] == '!';
1030}
1031
Calin Juravled23dee72017-07-06 16:29:11 -07001032// Best-effort check whether we can fit the the path into our buffers.
1033// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1034// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1035// extension to the cache path (5 bytes).
1036// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1037static bool validate_dex_path_size(const std::string& dex_path) {
1038 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1039 LOG(ERROR) << "dex_path too long: " << dex_path;
1040 return false;
1041 }
1042 return true;
1043}
1044
Jeff Sharkey90aff262016-12-12 14:28:24 -07001045static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001046 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001047 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001048 return false;
1049 }
1050
1051 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001052 // Oat dirs for secondary dex files are already validated.
1053 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001054 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1055 return false;
1056 }
1057 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1058 return false;
1059 }
1060 } else {
1061 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1062 return false;
1063 }
1064 }
1065 return true;
1066}
1067
1068// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1069// on destruction. It will also run the given cleanup (unless told not to) after closing.
1070//
1071// Usage example:
1072//
Calin Juravle7a570e82017-01-14 16:23:30 -08001073// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001074// [name]() {
1075// unlink(name.c_str());
1076// });
1077// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1078// wrapper if captured as a reference.
1079//
1080// if (file.get() == -1) {
1081// // Error opening...
1082// }
1083//
1084// ...
1085// if (error) {
1086// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1087// // and delete the file (after the fd is closed).
1088// return -1;
1089// }
1090//
1091// (Success case)
1092// file.SetCleanup(false);
1093// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1094// // (leaving the file around; after the fd is closed).
1095//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001096class Dex2oatFileWrapper {
1097 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001098 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001099 }
1100
Calin Juravle7a570e82017-01-14 16:23:30 -08001101 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1102 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1103
1104 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1105 value_ = other.value_;
1106 cleanup_ = other.cleanup_;
1107 do_cleanup_ = other.do_cleanup_;
1108 auto_close_ = other.auto_close_;
1109 other.release();
1110 }
1111
1112 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1113 value_ = other.value_;
1114 cleanup_ = other.cleanup_;
1115 do_cleanup_ = other.do_cleanup_;
1116 auto_close_ = other.auto_close_;
1117 other.release();
1118 return *this;
1119 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001120
1121 ~Dex2oatFileWrapper() {
1122 reset(-1);
1123 }
1124
1125 int get() {
1126 return value_;
1127 }
1128
1129 void SetCleanup(bool cleanup) {
1130 do_cleanup_ = cleanup;
1131 }
1132
1133 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001134 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001135 close(value_);
1136 }
1137 if (do_cleanup_ && cleanup_ != nullptr) {
1138 cleanup_();
1139 }
1140
1141 value_ = new_value;
1142 }
1143
Calin Juravle7a570e82017-01-14 16:23:30 -08001144 void reset(int new_value, std::function<void ()> new_cleanup) {
1145 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001146 close(value_);
1147 }
1148 if (do_cleanup_ && cleanup_ != nullptr) {
1149 cleanup_();
1150 }
1151
1152 value_ = new_value;
1153 cleanup_ = new_cleanup;
1154 }
1155
Calin Juravle7a570e82017-01-14 16:23:30 -08001156 void DisableAutoClose() {
1157 auto_close_ = false;
1158 }
1159
Jeff Sharkey90aff262016-12-12 14:28:24 -07001160 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001161 void release() {
1162 value_ = -1;
1163 do_cleanup_ = false;
1164 cleanup_ = nullptr;
1165 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001166 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001167 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001168 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001169 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001170};
1171
Calin Juravle7a570e82017-01-14 16:23:30 -08001172// (re)Creates the app image if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001173Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path,
1174 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001175
1176 // We don't create an image for secondary dex files.
1177 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001178 return Dex2oatFileWrapper();
1179 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001180
Calin Juravle7a570e82017-01-14 16:23:30 -08001181 const std::string image_path = create_image_filename(out_oat_path);
1182 if (image_path.empty()) {
1183 // Happens when the out_oat_path has an unknown extension.
1184 return Dex2oatFileWrapper();
1185 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001186
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001187 // In case there is a stale image, remove it now. Ignore any error.
1188 unlink(image_path.c_str());
1189
1190 // Not enabled, exit.
1191 if (!generate_app_image) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001192 return Dex2oatFileWrapper();
1193 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -07001194 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
1195 if (app_image_format.empty()) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001196 return Dex2oatFileWrapper();
1197 }
1198 // Recreate is true since we do not want to modify a mapped image. If the app is
1199 // already running and we modify the image file, it can cause crashes (b/27493510).
1200 Dex2oatFileWrapper wrapper_fd(
1201 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1202 [image_path]() { unlink(image_path.c_str()); });
1203 if (wrapper_fd.get() < 0) {
1204 // Could not create application image file. Go on since we can compile without it.
1205 LOG(ERROR) << "installd could not create '" << image_path
1206 << "' for image file during dexopt";
1207 // If we have a valid image file path but no image fd, explicitly erase the image file.
1208 if (unlink(image_path.c_str()) < 0) {
1209 if (errno != ENOENT) {
1210 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1211 }
1212 }
1213 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001214 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001215 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1216 wrapper_fd.reset(-1);
1217 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001218
Calin Juravle7a570e82017-01-14 16:23:30 -08001219 return wrapper_fd;
1220}
1221
1222// Creates the dexopt swap file if necessary and return its fd.
1223// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001224unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001225 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001226 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001227 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001228 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001229 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001230 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001231 if (swap_fd.get() < 0) {
1232 // Could not create swap file. Optimistically go on and hope that we can compile
1233 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001234 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001235 } else {
1236 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001237 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001238 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1239 }
1240 }
1241 return swap_fd;
1242}
1243
1244// Opens the reference profiles if needed.
1245// Note that the reference profile might not exist so it's OK if the fd will be -1.
Calin Juravle114f0812017-03-08 19:05:07 -08001246Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001247 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -08001248 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +00001249 // If we are not profile guided compilation, or we are compiling system server
1250 // do not bother to open the profiles; we won't be using them.
1251 if (!profile_guided || (pkgname[0] == '*')) {
1252 return Dex2oatFileWrapper();
1253 }
1254
1255 // If this is a secondary dex path which is public do not open the profile.
1256 // We cannot compile public secondary dex paths with profiles. That's because
1257 // it will expose how the dex files are used by their owner.
1258 //
1259 // Note that the PackageManager is responsible to set the is_public flag for
1260 // primary apks and we do not check it here. In some cases, e.g. when
1261 // compiling with a public profile from the .dm file the PackageManager will
1262 // set is_public toghether with the profile guided compilation.
1263 if (is_secondary_dex && is_public) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001264 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001265 }
Calin Juravle114f0812017-03-08 19:05:07 -08001266
1267 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001268 std::string location;
1269 if (is_secondary_dex) {
1270 location = dex_path;
1271 } else {
1272 if (profile_name == nullptr) {
1273 // This path is taken for system server re-compilation lunched from ZygoteInit.
1274 return Dex2oatFileWrapper();
1275 } else {
1276 location = profile_name;
1277 }
1278 }
Calin Juravle824a64d2018-01-18 20:23:17 -08001279 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1280 is_secondary_dex);
1281 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1282 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001283 };
1284 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001285}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001286
Calin Juravle7a570e82017-01-14 16:23:30 -08001287// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1288// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001289bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001290 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001291 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001292 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1293 CHECK(in_vdex_wrapper_fd != nullptr);
1294 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001295 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1296 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001297 char in_odex_path[PKG_PATH_MAX];
1298 int dexopt_action = abs(dexopt_needed);
1299 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001300 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001301
1302 // Infer the name of the output VDEX.
1303 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1304 if (out_vdex_path_str.empty()) {
1305 return false;
1306 }
1307
1308 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001309 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001310 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1311 const char* path = nullptr;
1312 if (is_odex_location) {
1313 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1314 path = in_odex_path;
1315 } else {
1316 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001317 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001318 }
1319 } else {
1320 path = out_oat_path;
1321 }
1322 in_vdex_path_str = create_vdex_filename(path);
1323 if (in_vdex_path_str.empty()) {
1324 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001325 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001326 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001327 // We can update in place when all these conditions are met:
1328 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1329 // on /system typically cannot be updated in place).
1330 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1331 // cannot be currently used by a running process.
1332 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1333 // different vdex files to operate.
1334 update_vdex_in_place =
1335 (in_vdex_path_str == out_vdex_path_str) &&
1336 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1337 !profile_guided;
1338 if (update_vdex_in_place) {
1339 // Open the file read-write to be able to update it.
1340 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1341 if (in_vdex_wrapper_fd->get() == -1) {
1342 // If we failed to open the file, we cannot update it in place.
1343 update_vdex_in_place = false;
1344 }
1345 } else {
1346 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1347 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001348 }
1349
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001350 // If we are updating the vdex in place, we do not need to recreate a vdex,
1351 // and can use the same existing one.
1352 if (update_vdex_in_place) {
1353 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1354 // have bogus stale vdex files.
1355 out_vdex_wrapper_fd->reset(
1356 in_vdex_wrapper_fd->get(),
1357 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1358 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1359 // wrapper).
1360 in_vdex_wrapper_fd->DisableAutoClose();
1361 } else {
1362 out_vdex_wrapper_fd->reset(
1363 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1364 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1365 if (out_vdex_wrapper_fd->get() < 0) {
1366 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1367 return false;
1368 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001369 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001370 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001371 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001372 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1373 return false;
1374 }
1375
1376 // If we got here we successfully opened the vdex files.
1377 return true;
1378}
1379
1380// Opens the output oat file for the given apk.
1381// If successful it stores the output path into out_oat_path and returns true.
1382Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001383 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1384 char* out_oat_path) {
1385 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001386 return Dex2oatFileWrapper();
1387 }
1388 const std::string out_oat_path_str(out_oat_path);
1389 Dex2oatFileWrapper wrapper_fd(
1390 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1391 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1392 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001393 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001394 } else if (!set_permissions_and_ownership(
1395 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001396 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1397 wrapper_fd.reset(-1);
1398 }
1399 return wrapper_fd;
1400}
1401
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001402// Creates RDONLY fds for oat and vdex files, if exist.
1403// Returns false if it fails to create oat out path for the given apk path.
1404// Note that the method returns true even if the files could not be opened.
1405bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1406 const std::string& oat_dir,
1407 const std::string& instruction_set,
1408 bool is_secondary_dex,
1409 unique_fd* oat_file_fd,
1410 unique_fd* vdex_file_fd) {
1411 char oat_path[PKG_PATH_MAX];
1412 if (!create_oat_out_path(apk_path.c_str(),
1413 instruction_set.c_str(),
1414 oat_dir.c_str(),
1415 is_secondary_dex,
1416 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001417 LOG(ERROR) << "Could not create oat out path for "
1418 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001419 return false;
1420 }
1421 oat_file_fd->reset(open(oat_path, O_RDONLY));
1422 if (oat_file_fd->get() < 0) {
1423 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1424 }
1425
1426 std::string vdex_filename = create_vdex_filename(oat_path);
1427 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1428 if (vdex_file_fd->get() < 0) {
1429 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1430 }
1431
1432 return true;
1433}
1434
Calin Juravle7a570e82017-01-14 16:23:30 -08001435// Updates the access times of out_oat_path based on those from apk_path.
1436void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1437 struct stat input_stat;
1438 memset(&input_stat, 0, sizeof(input_stat));
1439 if (stat(apk_path, &input_stat) != 0) {
1440 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1441 return;
1442 }
1443
1444 struct utimbuf ut;
1445 ut.actime = input_stat.st_atime;
1446 ut.modtime = input_stat.st_mtime;
1447 if (utime(out_oat_path, &ut) != 0) {
1448 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1449 }
1450}
1451
Calin Juravle80a21252017-01-17 14:43:25 -08001452// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001453// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1454// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1455// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001456class RunDexoptAnalyzer : public ExecVHelper {
1457 public:
1458 RunDexoptAnalyzer(const std::string& dex_file,
1459 int vdex_fd,
1460 int oat_fd,
1461 int zip_fd,
1462 const std::string& instruction_set,
1463 const std::string& compiler_filter,
1464 bool profile_was_updated,
1465 bool downgrade,
1466 const char* class_loader_context) {
1467 CHECK_GE(zip_fd, 0);
1468 const char* dexoptanalyzer_bin =
Roland Levillainb8f50cd2018-11-02 18:43:17 +00001469 is_debug_runtime()
1470 ? "/apex/com.android.runtime/bin/dexoptanalyzerd"
1471 : "/apex/com.android.runtime/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001472
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001473 std::string dex_file_arg = "--dex-file=" + dex_file;
1474 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1475 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1476 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1477 std::string isa_arg = "--isa=" + instruction_set;
1478 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1479 const char* assume_profile_changed = "--assume-profile-changed";
1480 const char* downgrade_flag = "--downgrade";
1481 std::string class_loader_context_arg = "--class-loader-context=";
1482 if (class_loader_context != nullptr) {
1483 class_loader_context_arg += class_loader_context;
1484 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001485
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001486 // program name, dex file, isa, filter
1487 AddArg(dex_file_arg);
1488 AddArg(isa_arg);
1489 AddArg(compiler_filter_arg);
1490 if (oat_fd >= 0) {
1491 AddArg(oat_fd_arg);
1492 }
1493 if (vdex_fd >= 0) {
1494 AddArg(vdex_fd_arg);
1495 }
1496 AddArg(zip_fd_arg.c_str());
1497 if (profile_was_updated) {
1498 AddArg(assume_profile_changed);
1499 }
1500 if (downgrade) {
1501 AddArg(downgrade_flag);
1502 }
1503 if (class_loader_context != nullptr) {
1504 AddArg(class_loader_context_arg.c_str());
1505 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001506
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001507 PrepareArgs(dexoptanalyzer_bin);
1508 }
1509};
Calin Juravle80a21252017-01-17 14:43:25 -08001510
1511// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001512static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001513 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001514 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001515 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001516 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001517 return false;
1518 }
Calin Juravle114f0812017-03-08 19:05:07 -08001519 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001520
Calin Juravle80a21252017-01-17 14:43:25 -08001521 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001522 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1523 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001524 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001525 return false;
1526 }
1527
1528 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001529 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001530
Calin Juravle7d765462017-09-04 15:57:10 -07001531 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001532 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001533 return false;
1534 }
1535
1536 return true;
1537}
1538
Calin Juravle7d765462017-09-04 15:57:10 -07001539// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1540// secondary dex files. This return codes are returned by the child process created for
1541// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001542
Andreas Gampe194fe422018-02-28 20:16:19 -08001543enum DexoptAnalyzerSkipCodes {
1544 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001545 // Specific errors are encoded in the name.
1546 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1547 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1548 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1549 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1550 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001551 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001552 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001553};
Calin Juravle7d765462017-09-04 15:57:10 -07001554
1555// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001556// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1557// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001558// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1559// of dexoptanalyzer.
1560static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001561 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001562 // The result values are defined in dexoptanalyzer.
1563 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001564 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001565 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001566 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001567 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001568 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001569 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001570 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001571 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001572 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1573 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001574 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1575 " Expected odex file status for secondary dex %s"
1576 " : dexoptanalyzer result=%d",
1577 dex_path.c_str(),
1578 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001579 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001580 }
1581
1582 // Use a second switch for enum switch-case analysis.
1583 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001584 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001585 // If the file does not exist there's no need for dexopt.
1586 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1587 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001588
1589 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1590 *error_msg = "Dexoptanalyzer path validation failed";
1591 return false;
1592 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1593 *error_msg = "Dexoptanalyzer open zip failed";
1594 return false;
1595 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1596 *error_msg = "Dexoptanalyzer dir preparation failed";
1597 return false;
1598 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1599 *error_msg = "Dexoptanalyzer open output failed";
1600 return false;
1601 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1602 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001603 return false;
1604 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001605
1606 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1607 dex_path.c_str(),
1608 result);
1609 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001610}
1611
Calin Juravle7d765462017-09-04 15:57:10 -07001612enum SecondaryDexAccess {
1613 kSecondaryDexAccessReadOk = 0,
1614 kSecondaryDexAccessDoesNotExist = 1,
1615 kSecondaryDexAccessPermissionError = 2,
1616 kSecondaryDexAccessIOError = 3
1617};
1618
1619static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1620 // Check if the path exists and can be read. If not, there's nothing to do.
1621 if (access(dex_path.c_str(), R_OK) == 0) {
1622 return kSecondaryDexAccessReadOk;
1623 } else {
1624 if (errno == ENOENT) {
1625 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1626 return kSecondaryDexAccessDoesNotExist;
1627 } else {
1628 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1629 return errno == EACCES
1630 ? kSecondaryDexAccessPermissionError
1631 : kSecondaryDexAccessIOError;
1632 }
1633 }
1634}
1635
1636static bool is_file_public(const std::string& filename) {
1637 struct stat file_stat;
1638 if (stat(filename.c_str(), &file_stat) == 0) {
1639 return (file_stat.st_mode & S_IROTH) != 0;
1640 }
1641 return false;
1642}
1643
1644// Create the oat file structure for the secondary dex 'dex_path' and assign
1645// the individual path component to the 'out_' parameters.
1646static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001647 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001648 size_t dirIndex = dex_path.rfind('/');
1649 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001650 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001651 return false;
1652 }
1653 // TODO(calin): we have similar computations in at lest 3 other places
1654 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1655 // using string append.
1656 std::string apk_dir = dex_path.substr(0, dirIndex);
1657 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1658 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1659
1660 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1661 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001662 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001663 return false;
1664 }
1665 return true;
1666}
1667
1668// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1669// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001670static bool validate_dexopt_storage_flags(int dexopt_flags,
1671 int* out_storage_flag,
1672 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001673 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1674 *out_storage_flag = FLAG_STORAGE_CE;
1675 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001676 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001677 return false;
1678 }
1679 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1680 *out_storage_flag = FLAG_STORAGE_DE;
1681 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001682 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001683 return false;
1684 }
1685 return true;
1686}
1687
Calin Juravlec9eab382017-01-25 01:17:17 -08001688// 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 -08001689// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1690// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001691// When returning true, the output parameters will be:
1692// - is_public_out: whether or not the oat file should not be made public
1693// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1694// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001695static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001696 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001697 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001698 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
1699 /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001700 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001701 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001702 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1703 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001704 return false;
1705 }
Calin Juravle7d765462017-09-04 15:57:10 -07001706 // Compute the oat dir as it's not easy to extract it from the child computation.
1707 char oat_path[PKG_PATH_MAX];
1708 char oat_dir[PKG_PATH_MAX];
1709 char oat_isa_dir[PKG_PATH_MAX];
1710 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001711 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1712 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001713 return false;
1714 }
Calin Juravle7d765462017-09-04 15:57:10 -07001715 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001716
Calin Juravle80a21252017-01-17 14:43:25 -08001717 pid_t pid = fork();
1718 if (pid == 0) {
1719 // child -- drop privileges before continuing.
1720 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001721
1722 // Validate the path structure.
1723 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1724 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001725 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001726 }
1727
1728 // Open the dex file.
1729 unique_fd zip_fd;
1730 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1731 if (zip_fd.get() < 0) {
1732 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001733 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001734 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001735 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001736 }
1737 }
1738
1739 // Prepare the oat directories.
1740 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001741 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001742 }
1743
1744 // Open the vdex/oat files if any.
1745 unique_fd oat_file_fd;
1746 unique_fd vdex_file_fd;
1747 if (!maybe_open_oat_and_vdex_file(dex_path,
1748 *oat_dir_out,
1749 instruction_set,
1750 true /* is_secondary_dex */,
1751 &oat_file_fd,
1752 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001753 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001754 }
1755
1756 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001757 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1758 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001759
1760 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001761 // Note that we do not do it before the fork since opening the files is required to happen
1762 // after forking.
1763 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1764 vdex_file_fd.get(),
1765 oat_file_fd.get(),
1766 zip_fd.get(),
1767 instruction_set,
1768 compiler_filter, profile_was_updated,
1769 downgrade,
1770 class_loader_context);
1771 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001772 }
1773
1774 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001775 int result = wait_child(pid);
1776 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001777 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1778 dex_path.c_str(),
1779 result);
1780 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001781 return false;
1782 }
1783 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001784 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001785 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1786 result,
1787 dexopt_needed_out,
1788 error_msg);
1789 if (!success) {
1790 LOG(ERROR) << *error_msg;
1791 }
Calin Juravle7d765462017-09-04 15:57:10 -07001792
1793 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1794
Calin Juravle80a21252017-01-17 14:43:25 -08001795 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001796 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1797 // makes the code simpler; force compilation is only needed during tests).
1798 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001799 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001800 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001801 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1802 }
1803
Calin Juravle7d765462017-09-04 15:57:10 -07001804 // Check if we should make the oat file public.
1805 // Note that if the dex file is not public the compiled code cannot be made public.
1806 // It is ok to check this flag outside in the parent process.
1807 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1808
Calin Juravle80a21252017-01-17 14:43:25 -08001809 return success;
1810}
1811
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001812static std::string format_dexopt_error(int status, const char* dex_path) {
1813 if (WIFEXITED(status)) {
1814 int int_code = WEXITSTATUS(status);
1815 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1816 if (code_name != nullptr) {
1817 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1818 }
1819 }
1820 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001821}
1822
Calin Juravlec9eab382017-01-25 01:17:17 -08001823int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001824 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001825 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001826 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001827 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001828 CHECK(pkgname != nullptr);
1829 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001830 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001831 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1832 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001833
Calin Juravled23dee72017-07-06 16:29:11 -07001834 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001835 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001836 return -1;
1837 }
1838
1839 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001840 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1841 class_loader_context);
1842 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001843 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001844 }
1845
Calin Juravleebc8a792017-04-04 20:21:05 -07001846 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001847 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1848 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1849 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001850 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001851 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001852 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001853 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001854 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001855
1856 // Check if we're dealing with a secondary dex file and if we need to compile it.
1857 std::string oat_dir_str;
1858 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001859 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001860 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Andreas Gampe194fe422018-02-28 20:16:19 -08001861 downgrade, class_loader_context, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001862 oat_dir = oat_dir_str.c_str();
1863 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1864 return 0; // Nothing to do, report success.
1865 }
1866 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001867 if (error_msg->empty()) { // TODO: Make this a CHECK.
1868 *error_msg = "Failed processing secondary.";
1869 }
Calin Juravle80a21252017-01-17 14:43:25 -08001870 return -1; // We had an error, logged in the process method.
1871 }
1872 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001873 // Currently these flags are only use for secondary dex files.
1874 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001875 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1876 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1877 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001878
1879 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001880 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001881 if (input_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001882 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1883 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001884 return -1;
1885 }
1886
1887 // Create the output OAT file.
1888 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001889 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001890 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001891 if (out_oat_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001892 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001893 return -1;
1894 }
1895
1896 // Open vdex files.
1897 Dex2oatFileWrapper in_vdex_fd;
1898 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001899 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1900 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001901 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001902 return -1;
1903 }
1904
Calin Juravlecb556e32017-04-04 20:22:50 -07001905 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1906 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1907 // fully inherit their parent context).
1908 // Note that for primary apk the oat files are created before, in a separate installd
1909 // call which also does the restorecon. TODO(calin): unify the paths.
1910 if (is_secondary_dex) {
1911 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1912 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001913 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1914 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001915 return -1;
1916 }
1917 }
1918
Jeff Sharkey90aff262016-12-12 14:28:24 -07001919 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001920 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001921
Calin Juravle7a570e82017-01-14 16:23:30 -08001922 // Create the app image file if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001923 Dex2oatFileWrapper image_fd = maybe_open_app_image(
1924 out_oat_path, generate_app_image, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001925
Calin Juravle7a570e82017-01-14 16:23:30 -08001926 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001927 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001928 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001929
Calin Juravle62c5a372018-02-01 17:03:23 +00001930 unique_fd dex_metadata_fd;
1931 if (dex_metadata_path != nullptr) {
1932 dex_metadata_fd.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)));
1933 if (dex_metadata_fd.get() < 0) {
1934 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1935 }
1936 }
1937
Andreas Gampe023b2242018-02-28 16:03:25 -08001938 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001939
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001940 RunDex2Oat runner(input_fd.get(),
1941 out_oat_fd.get(),
1942 in_vdex_fd.get(),
1943 out_vdex_fd.get(),
1944 image_fd.get(),
1945 dex_path,
1946 out_oat_path,
1947 swap_fd.get(),
1948 instruction_set,
1949 compiler_filter,
1950 debuggable,
1951 boot_complete,
1952 background_job_compile,
1953 reference_profile_fd.get(),
1954 class_loader_context,
1955 target_sdk_version,
1956 enable_hidden_api_checks,
1957 generate_compact_dex,
1958 dex_metadata_fd.get(),
1959 compilation_reason);
1960
Jeff Sharkey90aff262016-12-12 14:28:24 -07001961 pid_t pid = fork();
1962 if (pid == 0) {
1963 /* child -- drop privileges before continuing */
1964 drop_capabilities(uid);
1965
Richard Uhler76cc0272016-12-08 10:46:35 +00001966 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001967 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001968 PLOG(ERROR) << "flock(" << out_oat_path << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001969 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001970 }
1971
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001972 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001973 } else {
1974 int res = wait_child(pid);
1975 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001976 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001977 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001978 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1979 << std::hex << std::setw(4) << res << ", process failed";
1980 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001981 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001982 }
1983 }
1984
Calin Juravlec9eab382017-01-25 01:17:17 -08001985 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001986
1987 // We've been successful, don't delete output.
1988 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001989 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001990 image_fd.SetCleanup(false);
1991 reference_profile_fd.SetCleanup(false);
1992
1993 return 0;
1994}
1995
Calin Juravlec9eab382017-01-25 01:17:17 -08001996// Try to remove the given directory. Log an error if the directory exists
1997// and is empty but could not be removed.
1998static bool rmdir_if_empty(const char* dir) {
1999 if (rmdir(dir) == 0) {
2000 return true;
2001 }
2002 if (errno == ENOENT || errno == ENOTEMPTY) {
2003 return true;
2004 }
2005 PLOG(ERROR) << "Failed to remove dir: " << dir;
2006 return false;
2007}
2008
2009// Try to unlink the given file. Log an error if the file exists and could not
2010// be unlinked.
2011static bool unlink_if_exists(const std::string& file) {
2012 if (unlink(file.c_str()) == 0) {
2013 return true;
2014 }
2015 if (errno == ENOENT) {
2016 return true;
2017
2018 }
2019 PLOG(ERROR) << "Could not unlink: " << file;
2020 return false;
2021}
2022
Calin Juravle7d765462017-09-04 15:57:10 -07002023enum ReconcileSecondaryDexResult {
2024 kReconcileSecondaryDexExists = 0,
2025 kReconcileSecondaryDexCleanedUp = 1,
2026 kReconcileSecondaryDexValidationError = 2,
2027 kReconcileSecondaryDexCleanUpError = 3,
2028 kReconcileSecondaryDexAccessIOError = 4,
2029};
Calin Juravlec9eab382017-01-25 01:17:17 -08002030
2031// Reconcile the secondary dex 'dex_path' and its generated oat files.
2032// Return true if all the parameters are valid and the secondary dex file was
2033// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
2034// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
2035// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
2036// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
2037// Return false if there were errors during processing. In this case
2038// out_secondary_dex_exists will be set to false.
2039bool reconcile_secondary_dex_file(const std::string& dex_path,
2040 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
2041 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2042 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07002043 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08002044 if (isas.size() == 0) {
2045 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
2046 return false;
2047 }
2048
Calin Juravle7d765462017-09-04 15:57:10 -07002049 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2050 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2051 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002052 return false;
2053 }
2054
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002055 // As a security measure we want to unlink art artifacts with the reduced capabilities
2056 // of the package user id. So we fork and drop capabilities in the child.
2057 pid_t pid = fork();
2058 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002059 /* child -- drop privileges before continuing */
2060 drop_capabilities(uid);
2061
2062 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2063 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2064 uid, storage_flag)) {
2065 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2066 _exit(kReconcileSecondaryDexValidationError);
2067 }
2068
2069 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2070 switch (access_check) {
2071 case kSecondaryDexAccessDoesNotExist:
2072 // File does not exist. Proceed with cleaning.
2073 break;
2074 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2075 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2076 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2077 default:
2078 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2079 _exit(kReconcileSecondaryDexValidationError);
2080 }
2081
2082 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002083 char oat_path[PKG_PATH_MAX];
2084 char oat_dir[PKG_PATH_MAX];
2085 char oat_isa_dir[PKG_PATH_MAX];
2086 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002087 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08002088 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002089 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08002090 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
2091 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002092 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002093 }
Calin Juravle51314092017-05-18 15:33:05 -07002094
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002095 // Delete oat/vdex/art files.
2096 result = unlink_if_exists(oat_path) && result;
2097 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2098 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002099
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002100 // Delete profiles.
2101 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002102 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002103 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002104 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002105 result = unlink_if_exists(current_profile) && result;
2106 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002107
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002108 // We upgraded once the location of current profile for secondary dex files.
2109 // Check for any previous left-overs and remove them as well.
2110 std::string old_current_profile = dex_path + ".prof";
2111 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002112
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002113 // Try removing the directories as well, they might be empty.
2114 result = rmdir_if_empty(oat_isa_dir) && result;
2115 result = rmdir_if_empty(oat_dir) && result;
2116 }
Calin Juravle7d765462017-09-04 15:57:10 -07002117 if (!result) {
2118 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2119 }
2120 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002121 }
2122
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002123 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002124 if (!WIFEXITED(return_code)) {
2125 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2126 } else {
2127 return_code = WEXITSTATUS(return_code);
2128 }
2129
2130 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2131
2132 switch (return_code) {
2133 case kReconcileSecondaryDexCleanedUp:
2134 case kReconcileSecondaryDexValidationError:
2135 // If we couldn't validate assume the dex file does not exist.
2136 // This will purge the entry from the PM records.
2137 *out_secondary_dex_exists = false;
2138 return true;
2139 case kReconcileSecondaryDexExists:
2140 *out_secondary_dex_exists = true;
2141 return true;
2142 case kReconcileSecondaryDexAccessIOError:
2143 // We had an access IO error.
2144 // Return false so that we can try again.
2145 // The value of out_secondary_dex_exists does not matter in this case and by convention
2146 // is set to false.
2147 *out_secondary_dex_exists = false;
2148 return false;
2149 default:
2150 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2151 *out_secondary_dex_exists = false;
2152 return false;
2153 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002154}
2155
Alan Stokesa25d90c2017-10-16 10:56:00 +01002156// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2157// Returns true if all parameters are valid and the hash successfully computed and stored in
2158// out_secondary_dex_hash.
2159// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2160// the app.
2161// For any other errors (e.g. if any of the parameters are invalid) returns false.
2162bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2163 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2164 std::vector<uint8_t>* out_secondary_dex_hash) {
2165 out_secondary_dex_hash->clear();
2166
2167 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2168
2169 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2170 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2171 << storage_flag;
2172 return false;
2173 }
2174
2175 // Pipe to get the hash result back from our child process.
2176 unique_fd pipe_read, pipe_write;
2177 if (!Pipe(&pipe_read, &pipe_write)) {
2178 PLOG(ERROR) << "Failed to create pipe";
2179 return false;
2180 }
2181
2182 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2183 // access data the app itself can access.
2184 pid_t pid = fork();
2185 if (pid == 0) {
2186 // child -- drop privileges before continuing
2187 drop_capabilities(uid);
2188 pipe_read.reset();
2189
2190 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2191 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002192 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002193 }
2194
2195 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2196 if (fd == -1) {
2197 if (errno == EACCES || errno == ENOENT) {
2198 // Not treated as an error.
2199 _exit(0);
2200 }
2201 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002202 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002203 }
2204
2205 SHA256_CTX ctx;
2206 SHA256_Init(&ctx);
2207
2208 std::vector<uint8_t> buffer(65536);
2209 while (true) {
2210 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2211 if (bytes_read == 0) {
2212 break;
2213 } else if (bytes_read == -1) {
2214 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002215 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002216 }
2217
2218 SHA256_Update(&ctx, buffer.data(), bytes_read);
2219 }
2220
2221 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2222 SHA256_Final(hash.data(), &ctx);
2223 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002224 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002225 }
2226
2227 _exit(0);
2228 }
2229
2230 // parent
2231 pipe_write.reset();
2232
2233 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2234 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2235 out_secondary_dex_hash->clear();
2236 }
2237 return wait_child(pid) == 0;
2238}
2239
Jeff Sharkey90aff262016-12-12 14:28:24 -07002240// Helper for move_ab, so that we can have common failure-case cleanup.
2241static bool unlink_and_rename(const char* from, const char* to) {
2242 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2243 // return a failure.
2244 struct stat s;
2245 if (stat(to, &s) == 0) {
2246 if (!S_ISREG(s.st_mode)) {
2247 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2248 return false;
2249 }
2250 if (unlink(to) != 0) {
2251 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2252 return false;
2253 }
2254 } else {
2255 // This may be a permission problem. We could investigate the error code, but we'll just
2256 // let the rename failure do the work for us.
2257 }
2258
2259 // Try to rename "to" to "from."
2260 if (rename(from, to) != 0) {
2261 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2262 return false;
2263 }
2264 return true;
2265}
2266
2267// Move/rename a B artifact (from) to an A artifact (to).
2268static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2269 // Check whether B exists.
2270 {
2271 struct stat s;
2272 if (stat(b_path.c_str(), &s) != 0) {
2273 // Silently ignore for now. The service calling this isn't smart enough to understand
2274 // lack of artifacts at the moment.
2275 return false;
2276 }
2277 if (!S_ISREG(s.st_mode)) {
2278 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2279 // Try to unlink, but swallow errors.
2280 unlink(b_path.c_str());
2281 return false;
2282 }
2283 }
2284
2285 // Rename B to A.
2286 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2287 // Delete the b_path so we don't try again (or fail earlier).
2288 if (unlink(b_path.c_str()) != 0) {
2289 PLOG(ERROR) << "Could not unlink " << b_path;
2290 }
2291
2292 return false;
2293 }
2294
2295 return true;
2296}
2297
2298bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2299 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002300 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2301 if (slot_suffix.empty()) {
2302 return false;
2303 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002304
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002305 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2306 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2307 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002308 }
2309
2310 // Validate other inputs.
2311 if (validate_apk_path(apk_path) != 0) {
2312 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2313 return false;
2314 }
2315 if (validate_apk_path(oat_dir) != 0) {
2316 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2317 return false;
2318 }
2319
2320 char a_path[PKG_PATH_MAX];
2321 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2322 return false;
2323 }
2324 const std::string a_vdex_path = create_vdex_filename(a_path);
2325 const std::string a_image_path = create_image_filename(a_path);
2326
2327 // B path = A path + slot suffix.
2328 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2329 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2330 const std::string b_image_path = StringPrintf("%s.%s",
2331 a_image_path.c_str(),
2332 slot_suffix.c_str());
2333
2334 bool success = true;
2335 if (move_ab_path(b_path, a_path)) {
2336 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2337 // Note: we can live without an app image. As such, ignore failure to move the image file.
2338 // If we decide to require the app image, or the app image being moved correctly,
2339 // then change accordingly.
2340 constexpr bool kIgnoreAppImageFailure = true;
2341
2342 if (!a_image_path.empty()) {
2343 if (!move_ab_path(b_image_path, a_image_path)) {
2344 unlink(a_image_path.c_str());
2345 if (!kIgnoreAppImageFailure) {
2346 success = false;
2347 }
2348 }
2349 }
2350 } else {
2351 // Cleanup: delete B image, ignore errors.
2352 unlink(b_image_path.c_str());
2353 success = false;
2354 }
2355 } else {
2356 // Cleanup: delete B image, ignore errors.
2357 unlink(b_vdex_path.c_str());
2358 unlink(b_image_path.c_str());
2359 success = false;
2360 }
2361 return success;
2362}
2363
2364bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2365 // Delete the oat/odex file.
2366 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002367 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002368 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002369 return false;
2370 }
2371
2372 // In case of a permission failure report the issue. Otherwise just print a warning.
2373 auto unlink_and_check = [](const char* path) -> bool {
2374 int result = unlink(path);
2375 if (result != 0) {
2376 if (errno == EACCES || errno == EPERM) {
2377 PLOG(ERROR) << "Could not unlink " << path;
2378 return false;
2379 }
2380 PLOG(WARNING) << "Could not unlink " << path;
2381 }
2382 return true;
2383 };
2384
2385 // Delete the oat/odex file.
2386 bool return_value_oat = unlink_and_check(out_path);
2387
2388 // Derive and delete the app image.
2389 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2390
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002391 // Derive and delete the vdex file.
2392 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2393
Jeff Sharkey90aff262016-12-12 14:28:24 -07002394 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002395 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002396}
2397
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002398static bool is_absolute_path(const std::string& path) {
2399 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2400 LOG(ERROR) << "Invalid absolute path " << path;
2401 return false;
2402 } else {
2403 return true;
2404 }
2405}
2406
2407static bool is_valid_instruction_set(const std::string& instruction_set) {
2408 // TODO: add explicit whitelisting of instruction sets
2409 if (instruction_set.find('/') != std::string::npos) {
2410 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2411 return false;
2412 } else {
2413 return true;
2414 }
2415}
2416
2417bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2418 const char *apk_path, const char *instruction_set) {
2419 std::string oat_dir_ = oat_dir;
2420 std::string apk_path_ = apk_path;
2421 std::string instruction_set_ = instruction_set;
2422
2423 if (!is_absolute_path(oat_dir_)) return false;
2424 if (!is_absolute_path(apk_path_)) return false;
2425 if (!is_valid_instruction_set(instruction_set_)) return false;
2426
2427 std::string::size_type end = apk_path_.rfind('.');
2428 std::string::size_type start = apk_path_.rfind('/', end);
2429 if (end == std::string::npos || start == std::string::npos) {
2430 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2431 return false;
2432 }
2433
2434 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2435 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2436 const char* res = res_.c_str();
2437 if (strlen(res) >= PKG_PATH_MAX) {
2438 LOG(ERROR) << "Result too large";
2439 return false;
2440 } else {
2441 strlcpy(path, res, PKG_PATH_MAX);
2442 return true;
2443 }
2444}
2445
2446bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2447 const char *instruction_set) {
2448 std::string apk_path_ = apk_path;
2449 std::string instruction_set_ = instruction_set;
2450
2451 if (!is_absolute_path(apk_path_)) return false;
2452 if (!is_valid_instruction_set(instruction_set_)) return false;
2453
2454 std::string::size_type end = apk_path_.rfind('.');
2455 std::string::size_type start = apk_path_.rfind('/', end);
2456 if (end == std::string::npos || start == std::string::npos) {
2457 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2458 return false;
2459 }
2460
2461 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2462 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2463}
2464
2465bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2466 const char *instruction_set) {
2467 std::string src_ = src;
2468 std::string instruction_set_ = instruction_set;
2469
2470 if (!is_absolute_path(src_)) return false;
2471 if (!is_valid_instruction_set(instruction_set_)) return false;
2472
2473 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2474 if (*it == '/') {
2475 *it = '@';
2476 }
2477 }
2478
2479 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2480 + DALVIK_CACHE_POSTFIX;
2481 const char* res = res_.c_str();
2482 if (strlen(res) >= PKG_PATH_MAX) {
2483 LOG(ERROR) << "Result too large";
2484 return false;
2485 } else {
2486 strlcpy(path, res, PKG_PATH_MAX);
2487 return true;
2488 }
2489}
2490
Calin Juravle59f7ab82018-04-27 17:50:23 -07002491bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2492 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002493 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2494 for (const std::string& elem : classpaths_elems) {
2495 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2496 if (fd < 0) {
2497 PLOG(ERROR) << "Could not open classpath elem " << elem;
2498 return false;
2499 } else {
2500 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002501 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002502 }
2503 }
2504 return true;
2505}
2506
2507static bool create_app_profile_snapshot(int32_t app_id,
2508 const std::string& package_name,
2509 const std::string& profile_name,
2510 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002511 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2512
Calin Juravle824a64d2018-01-18 20:23:17 -08002513 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002514 if (snapshot_fd < 0) {
2515 return false;
2516 }
2517
2518 std::vector<unique_fd> profiles_fd;
2519 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002520 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2521 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002522 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2523 return false;
2524 }
2525
2526 profiles_fd.push_back(std::move(reference_profile_fd));
2527
Calin Juravle0d0a4922018-01-23 19:54:11 -08002528 // Open the class paths elements. These will be used to filter out profile data that does
2529 // not belong to the classpath during merge.
2530 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002531 std::vector<std::string> dex_locations;
2532 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002533 return false;
2534 }
2535
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002536 RunProfman args;
2537 args.SetupMerge(profiles_fd, snapshot_fd, apk_fds, dex_locations);
Calin Juravle29591732017-11-20 17:46:19 -08002538 pid_t pid = fork();
2539 if (pid == 0) {
2540 /* child -- drop privileges before continuing */
2541 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002542 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002543 }
2544
2545 /* parent */
2546 int return_code = wait_child(pid);
2547 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002548 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002549 return false;
2550 }
2551
2552 return true;
2553}
2554
Calin Juravle0d0a4922018-01-23 19:54:11 -08002555static bool create_boot_image_profile_snapshot(const std::string& package_name,
2556 const std::string& profile_name,
2557 const std::string& classpath) {
2558 // The reference profile directory for the android package might not be prepared. Do it now.
2559 const std::string ref_profile_dir =
2560 create_primary_reference_profile_package_dir_path(package_name);
2561 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2562 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2563 return false;
2564 }
2565
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002566 // Return false for empty class path since it may otherwise return true below if profiles is
2567 // empty.
2568 if (classpath.empty()) {
2569 PLOG(ERROR) << "Class path is empty";
2570 return false;
2571 }
2572
Calin Juravle0d0a4922018-01-23 19:54:11 -08002573 // Open and create the snapshot profile.
2574 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2575
2576 // Collect all non empty profiles.
2577 // The collection will traverse all applications profiles and find the non empty files.
2578 // This has the potential of inspecting a large number of files and directories (depending
2579 // on the number of applications and users). So there is a slight increase in the chance
2580 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2581 // fail the snapshot and aggregate whatever profile we could open.
2582 //
2583 // The profile snapshot is a best effort based on available data it's ok if some data
2584 // from some apps is missing. It will be counter productive for the snapshot to fail
2585 // because we could not open or read some of the files.
2586 std::vector<std::string> profiles;
2587 if (!collect_profiles(&profiles)) {
2588 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2589 }
2590
2591 // If we have no profiles return early.
2592 if (profiles.empty()) {
2593 return true;
2594 }
2595
2596 // Open the classpath elements. These will be used to filter out profile data that does
2597 // not belong to the classpath during merge.
2598 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002599 std::vector<std::string> dex_locations;
2600 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002601 return false;
2602 }
2603
2604 // If we could not open any files from the classpath return an error.
2605 if (apk_fds.empty()) {
2606 LOG(ERROR) << "Could not open any of the classpath elements.";
2607 return false;
2608 }
2609
2610 // Aggregate the profiles in batches of kAggregationBatchSize.
2611 // We do this to avoid opening a huge a amount of files.
2612 static constexpr size_t kAggregationBatchSize = 10;
2613
2614 std::vector<unique_fd> profiles_fd;
2615 for (size_t i = 0; i < profiles.size(); ) {
2616 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2617 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2618 if (fd.get() >= 0) {
2619 profiles_fd.push_back(std::move(fd));
2620 }
2621 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002622 RunProfman args;
2623 args.SetupMerge(profiles_fd, snapshot_fd, apk_fds, dex_locations);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002624 pid_t pid = fork();
2625 if (pid == 0) {
2626 /* child -- drop privileges before continuing */
2627 drop_capabilities(AID_SYSTEM);
2628
Calin Juravle59f7ab82018-04-27 17:50:23 -07002629 // The introduction of new access flags into boot jars causes them to
2630 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002631 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002632 }
2633
2634 /* parent */
2635 int return_code = wait_child(pid);
2636 if (!WIFEXITED(return_code)) {
2637 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2638 return false;
2639 }
2640 return true;
2641 }
2642 return true;
2643}
2644
2645bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2646 const std::string& profile_name, const std::string& classpath) {
2647 if (app_id == -1) {
2648 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2649 } else {
2650 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2651 }
2652}
2653
Calin Juravlec3b049e2018-01-18 22:32:58 -08002654bool prepare_app_profile(const std::string& package_name,
2655 userid_t user_id,
2656 appid_t app_id,
2657 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002658 const std::string& code_path,
Calin Juravlec3b049e2018-01-18 22:32:58 -08002659 const std::unique_ptr<std::string>& dex_metadata) {
2660 // Prepare the current profile.
2661 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2662 /*is_secondary_dex*/ false);
2663 uid_t uid = multiuser_get_uid(user_id, app_id);
2664 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2665 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2666 return false;
2667 }
2668
2669 // Check if we need to install the profile from the dex metadata.
2670 if (dex_metadata == nullptr) {
2671 return true;
2672 }
2673
2674 // We have a dex metdata. Merge the profile into the reference profile.
2675 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2676 /*read_write*/ true, /*is_secondary_dex*/ false);
2677 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2678 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002679 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2680 if (apk_fd < 0) {
2681 PLOG(ERROR) << "Could not open code path " << code_path;
2682 return false;
2683 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002684
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002685 RunProfman args;
2686 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2687 std::move(ref_profile_fd),
2688 std::move(apk_fd),
2689 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002690 pid_t pid = fork();
2691 if (pid == 0) {
2692 /* child -- drop privileges before continuing */
2693 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2694 drop_capabilities(app_shared_gid);
2695
Calin Juravlef63d4792018-01-30 17:43:34 +00002696 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002697 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002698 }
2699
2700 /* parent */
2701 int return_code = wait_child(pid);
2702 if (!WIFEXITED(return_code)) {
2703 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2704 return false;
2705 }
2706 return true;
2707}
2708
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002709} // namespace installd
2710} // namespace android