blob: df74d50b31fca82d1c7960327b83817832616acd [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 */
Mark Salyzyna5e161b2016-09-29 08:08:05 -070016#define LOG_TAG "installed"
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
Alan Stokesa25d90c2017-10-16 10:56:00 +010031#include <android-base/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070032#include <android-base/logging.h>
Andreas Gampe6a9cf722017-07-24 16:49:10 -070033#include <android-base/properties.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070034#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070035#include <android-base/strings.h>
36#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080037#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070038#include <cutils/properties.h>
39#include <cutils/sched_policy.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070040#include <log/log.h> // TODO: Move everything to base/logging.
Alan Stokesa25d90c2017-10-16 10:56:00 +010041#include <openssl/sha.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070042#include <private/android_filesystem_config.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070043#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070044#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070045
46#include "dexopt.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060047#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070048#include "installd_deps.h"
49#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070050#include "utils.h"
51
Jeff Sharkey90aff262016-12-12 14:28:24 -070052using android::base::EndsWith;
Alan Stokesa25d90c2017-10-16 10:56:00 +010053using android::base::ReadFully;
54using android::base::StringPrintf;
55using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080056using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070057
58namespace android {
59namespace installd {
60
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070061// Should minidebug info be included in compiled artifacts? Even if this value is
62// "true," usage might still be conditional to other constraints, e.g., system
63// property overrides.
64static constexpr bool kEnableMinidebugInfo = true;
65
66static constexpr const char* kMinidebugInfoSystemProperty = "dalvik.vm.dex2oat-minidebuginfo";
67static constexpr bool kMinidebugInfoSystemPropertyDefault = false;
68static constexpr const char* kMinidebugDex2oatFlag = "--generate-mini-debug-info";
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -080069static constexpr const char* kDisableCompactDexFlag = "--compact-dex-level=none";
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070070
Calin Juravle114f0812017-03-08 19:05:07 -080071// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
72struct FreeDelete {
73 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
74 void operator()(const void* ptr) const {
75 free(const_cast<void*>(ptr));
76 }
77};
78
79// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
80template <typename T>
81using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
82
Calin Juravle1a0af3b2017-03-09 14:33:33 -080083static unique_fd invalid_unique_fd() {
84 return unique_fd(-1);
85}
86
Andreas Gampe6a9cf722017-07-24 16:49:10 -070087static bool is_debug_runtime() {
88 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
89}
90
David Sehra3b5ab62017-10-25 14:27:29 -070091static bool is_debuggable_build() {
92 return android::base::GetBoolProperty("ro.debuggable", false);
93}
94
Jeff Sharkey90aff262016-12-12 14:28:24 -070095static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -080096 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -070097 if (ufd.get() < 0) {
98 if (errno != ENOENT) {
99 PLOG(WARNING) << "Could not open profile " << profile;
100 return false;
101 } else {
102 // Nothing to clear. That's ok.
103 return true;
104 }
105 }
106
107 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
108 if (errno != EWOULDBLOCK) {
109 PLOG(WARNING) << "Error locking profile " << profile;
110 }
111 // This implies that the app owning this profile is running
112 // (and has acquired the lock).
113 //
114 // If we can't acquire the lock bail out since clearing is useless anyway
115 // (the app will write again to the profile).
116 //
117 // Note:
118 // This does not impact the this is not an issue for the profiling correctness.
119 // In case this is needed because of an app upgrade, profiles will still be
120 // eventually cleared by the app itself due to checksum mismatch.
121 // If this is needed because profman advised, then keeping the data around
122 // until the next run is again not an issue.
123 //
124 // If the app attempts to acquire a lock while we've held one here,
125 // it will simply skip the current write cycle.
126 return false;
127 }
128
129 bool truncated = ftruncate(ufd.get(), 0) == 0;
130 if (!truncated) {
131 PLOG(WARNING) << "Could not truncate " << profile;
132 }
133 if (flock(ufd.get(), LOCK_UN) != 0) {
134 PLOG(WARNING) << "Error unlocking profile " << profile;
135 }
136 return truncated;
137}
138
Calin Juravle114f0812017-03-08 19:05:07 -0800139// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800140// The location is the profile name for primary apks or the dex path for secondary dex files.
141static bool clear_reference_profile(const std::string& package_name, const std::string& location,
142 bool is_secondary_dex) {
143 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700144}
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_current_profile(const std::string& package_name, const std::string& location,
149 userid_t user, bool is_secondary_dex) {
150 return clear_profile(create_current_profile_path(user, package_name, location,
151 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700152}
153
Calin Juravle114f0812017-03-08 19:05:07 -0800154// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800155// The location is the profile name for primary apks or the dex path for secondary dex files.
156bool clear_primary_reference_profile(const std::string& package_name,
157 const std::string& location) {
158 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800159}
160
161// Clear all current 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_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700164 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800165 // 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 -0700166 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
167 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800168 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700169 }
170 return success;
171}
172
Calin Juravle114f0812017-03-08 19:05:07 -0800173// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800174bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
175 userid_t user) {
176 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800177}
178
Jeff Sharkey90aff262016-12-12 14:28:24 -0700179static int split_count(const char *str)
180{
181 char *ctx;
182 int count = 0;
183 char buf[kPropertyValueMax];
184
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600185 strlcpy(buf, str, sizeof(buf));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700186 char *pBuf = buf;
187
188 while(strtok_r(pBuf, " ", &ctx) != NULL) {
189 count++;
190 pBuf = NULL;
191 }
192
193 return count;
194}
195
196static int split(char *buf, const char **argv)
197{
198 char *ctx;
199 int count = 0;
200 char *tok;
201 char *pBuf = buf;
202
203 while((tok = strtok_r(pBuf, " ", &ctx)) != NULL) {
204 argv[count++] = tok;
205 pBuf = NULL;
206 }
207
208 return count;
209}
210
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700211static const char* get_location_from_path(const char* path) {
212 static constexpr char kLocationSeparator = '/';
213 const char *location = strrchr(path, kLocationSeparator);
214 if (location == NULL) {
215 return path;
216 } else {
217 // Skip the separator character.
218 return location + 1;
219 }
220}
221
Jeff Sharkey90aff262016-12-12 14:28:24 -0700222static void run_dex2oat(int zip_fd, int oat_fd, int input_vdex_fd, int output_vdex_fd, int image_fd,
223 const char* input_file_name, const char* output_file_name, int swap_fd,
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100224 const char* instruction_set, const char* compiler_filter,
Andreas Gampea73a0cb2017-11-02 18:14:42 -0700225 bool debuggable, bool post_bootcomplete, bool background_job_compile, int profile_fd,
David Brazdil52249162018-02-12 18:04:59 -0800226 const char* class_loader_context, int target_sdk_version, bool enable_hidden_api_checks) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700227 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
228
229 if (strlen(instruction_set) >= MAX_INSTRUCTION_SET_LEN) {
230 ALOGE("Instruction set %s longer than max length of %d",
231 instruction_set, MAX_INSTRUCTION_SET_LEN);
232 return;
233 }
234
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700235 // Get the relative path to the input file.
236 const char* relative_input_file_name = get_location_from_path(input_file_name);
237
Jeff Sharkey90aff262016-12-12 14:28:24 -0700238 char dex2oat_Xms_flag[kPropertyValueMax];
239 bool have_dex2oat_Xms_flag = get_property("dalvik.vm.dex2oat-Xms", dex2oat_Xms_flag, NULL) > 0;
240
241 char dex2oat_Xmx_flag[kPropertyValueMax];
242 bool have_dex2oat_Xmx_flag = get_property("dalvik.vm.dex2oat-Xmx", dex2oat_Xmx_flag, NULL) > 0;
243
244 char dex2oat_threads_buf[kPropertyValueMax];
245 bool have_dex2oat_threads_flag = get_property(post_bootcomplete
246 ? "dalvik.vm.dex2oat-threads"
247 : "dalvik.vm.boot-dex2oat-threads",
248 dex2oat_threads_buf,
249 NULL) > 0;
250 char dex2oat_threads_arg[kPropertyValueMax + 2];
251 if (have_dex2oat_threads_flag) {
252 sprintf(dex2oat_threads_arg, "-j%s", dex2oat_threads_buf);
253 }
254
255 char dex2oat_isa_features_key[kPropertyKeyMax];
256 sprintf(dex2oat_isa_features_key, "dalvik.vm.isa.%s.features", instruction_set);
257 char dex2oat_isa_features[kPropertyValueMax];
258 bool have_dex2oat_isa_features = get_property(dex2oat_isa_features_key,
259 dex2oat_isa_features, NULL) > 0;
260
261 char dex2oat_isa_variant_key[kPropertyKeyMax];
262 sprintf(dex2oat_isa_variant_key, "dalvik.vm.isa.%s.variant", instruction_set);
263 char dex2oat_isa_variant[kPropertyValueMax];
264 bool have_dex2oat_isa_variant = get_property(dex2oat_isa_variant_key,
265 dex2oat_isa_variant, NULL) > 0;
266
267 const char *dex2oat_norelocation = "-Xnorelocate";
268 bool have_dex2oat_relocation_skip_flag = false;
269
270 char dex2oat_flags[kPropertyValueMax];
271 int dex2oat_flags_count = get_property("dalvik.vm.dex2oat-flags",
272 dex2oat_flags, NULL) <= 0 ? 0 : split_count(dex2oat_flags);
273 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags);
274
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100275 // If we are booting without the real /data, don't spend time compiling.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700276 char vold_decrypt[kPropertyValueMax];
277 bool have_vold_decrypt = get_property("vold.decrypt", vold_decrypt, "") > 0;
278 bool skip_compilation = (have_vold_decrypt &&
279 (strcmp(vold_decrypt, "trigger_restart_min_framework") == 0 ||
280 (strcmp(vold_decrypt, "1") == 0)));
281
282 bool generate_debug_info = property_get_bool("debug.generate-debug-info", false);
283
284 char app_image_format[kPropertyValueMax];
285 char image_format_arg[strlen("--image-format=") + kPropertyValueMax];
286 bool have_app_image_format =
287 image_fd >= 0 && get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
288 if (have_app_image_format) {
289 sprintf(image_format_arg, "--image-format=%s", app_image_format);
290 }
291
292 char dex2oat_large_app_threshold[kPropertyValueMax];
293 bool have_dex2oat_large_app_threshold =
294 get_property("dalvik.vm.dex2oat-very-large", dex2oat_large_app_threshold, NULL) > 0;
295 char dex2oat_large_app_threshold_arg[strlen("--very-large-app-threshold=") + kPropertyValueMax];
296 if (have_dex2oat_large_app_threshold) {
297 sprintf(dex2oat_large_app_threshold_arg,
298 "--very-large-app-threshold=%s",
299 dex2oat_large_app_threshold);
300 }
301
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700302 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
David Sehra3b5ab62017-10-25 14:27:29 -0700303 const char* dex2oat_bin = "/system/bin/dex2oat";
304 static const char* kDex2oatDebugPath = "/system/bin/dex2oatd";
Andreas Gampea73a0cb2017-11-02 18:14:42 -0700305 if (is_debug_runtime() || (background_job_compile && is_debuggable_build())) {
David Sehra3b5ab62017-10-25 14:27:29 -0700306 DCHECK(access(kDex2oatDebugPath, X_OK) == 0);
307 dex2oat_bin = kDex2oatDebugPath;
308 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700309
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700310 bool generate_minidebug_info = kEnableMinidebugInfo &&
311 android::base::GetBoolProperty(kMinidebugInfoSystemProperty,
312 kMinidebugInfoSystemPropertyDefault);
313
Jeff Sharkey90aff262016-12-12 14:28:24 -0700314 static const char* RUNTIME_ARG = "--runtime-arg";
315
316 static const int MAX_INT_LEN = 12; // '-'+10dig+'\0' -OR- 0x+8dig
317
George Burgess IV36cebe772017-01-25 11:52:01 -0800318 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
319 // use arraysize instead.
320 char zip_fd_arg[arraysize("--zip-fd=") + MAX_INT_LEN];
321 char zip_location_arg[arraysize("--zip-location=") + PKG_PATH_MAX];
322 char input_vdex_fd_arg[arraysize("--input-vdex-fd=") + MAX_INT_LEN];
323 char output_vdex_fd_arg[arraysize("--output-vdex-fd=") + MAX_INT_LEN];
324 char oat_fd_arg[arraysize("--oat-fd=") + MAX_INT_LEN];
325 char oat_location_arg[arraysize("--oat-location=") + PKG_PATH_MAX];
326 char instruction_set_arg[arraysize("--instruction-set=") + MAX_INSTRUCTION_SET_LEN];
327 char instruction_set_variant_arg[arraysize("--instruction-set-variant=") + kPropertyValueMax];
328 char instruction_set_features_arg[arraysize("--instruction-set-features=") + kPropertyValueMax];
329 char dex2oat_Xms_arg[arraysize("-Xms") + kPropertyValueMax];
330 char dex2oat_Xmx_arg[arraysize("-Xmx") + kPropertyValueMax];
331 char dex2oat_compiler_filter_arg[arraysize("--compiler-filter=") + kPropertyValueMax];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700332 bool have_dex2oat_swap_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800333 char dex2oat_swap_fd[arraysize("--swap-fd=") + MAX_INT_LEN];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700334 bool have_dex2oat_image_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800335 char dex2oat_image_fd[arraysize("--app-image-fd=") + MAX_INT_LEN];
Calin Juravle52c45822017-07-13 22:50:21 -0700336 size_t class_loader_context_size = arraysize("--class-loader-context=") + PKG_PATH_MAX;
David Brazdil570d3982018-01-16 20:15:43 +0000337 char target_sdk_version_arg[arraysize("-Xtarget-sdk-version:") + MAX_INT_LEN];
Calin Juravle52c45822017-07-13 22:50:21 -0700338 char class_loader_context_arg[class_loader_context_size];
339 if (class_loader_context != nullptr) {
340 snprintf(class_loader_context_arg, class_loader_context_size, "--class-loader-context=%s",
341 class_loader_context);
342 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700343
344 sprintf(zip_fd_arg, "--zip-fd=%d", zip_fd);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700345 sprintf(zip_location_arg, "--zip-location=%s", relative_input_file_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700346 sprintf(input_vdex_fd_arg, "--input-vdex-fd=%d", input_vdex_fd);
347 sprintf(output_vdex_fd_arg, "--output-vdex-fd=%d", output_vdex_fd);
348 sprintf(oat_fd_arg, "--oat-fd=%d", oat_fd);
349 sprintf(oat_location_arg, "--oat-location=%s", output_file_name);
350 sprintf(instruction_set_arg, "--instruction-set=%s", instruction_set);
351 sprintf(instruction_set_variant_arg, "--instruction-set-variant=%s", dex2oat_isa_variant);
352 sprintf(instruction_set_features_arg, "--instruction-set-features=%s", dex2oat_isa_features);
353 if (swap_fd >= 0) {
354 have_dex2oat_swap_fd = true;
355 sprintf(dex2oat_swap_fd, "--swap-fd=%d", swap_fd);
356 }
357 if (image_fd >= 0) {
358 have_dex2oat_image_fd = true;
359 sprintf(dex2oat_image_fd, "--app-image-fd=%d", image_fd);
360 }
361
362 if (have_dex2oat_Xms_flag) {
363 sprintf(dex2oat_Xms_arg, "-Xms%s", dex2oat_Xms_flag);
364 }
365 if (have_dex2oat_Xmx_flag) {
366 sprintf(dex2oat_Xmx_arg, "-Xmx%s", dex2oat_Xmx_flag);
367 }
David Brazdil570d3982018-01-16 20:15:43 +0000368 sprintf(target_sdk_version_arg, "-Xtarget-sdk-version:%d", target_sdk_version);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700369
370 // Compute compiler filter.
371
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100372 bool have_dex2oat_compiler_filter_flag = false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700373 if (skip_compilation) {
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600374 strlcpy(dex2oat_compiler_filter_arg, "--compiler-filter=extract",
375 sizeof(dex2oat_compiler_filter_arg));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700376 have_dex2oat_compiler_filter_flag = true;
377 have_dex2oat_relocation_skip_flag = true;
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100378 } else if (compiler_filter != nullptr) {
379 if (strlen(compiler_filter) + strlen("--compiler-filter=") <
Jeff Sharkey90aff262016-12-12 14:28:24 -0700380 arraysize(dex2oat_compiler_filter_arg)) {
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100381 sprintf(dex2oat_compiler_filter_arg, "--compiler-filter=%s", compiler_filter);
382 have_dex2oat_compiler_filter_flag = true;
383 } else {
384 ALOGW("Compiler filter name '%s' is too large (max characters is %zu)",
385 compiler_filter,
386 kPropertyValueMax);
387 }
388 }
389
390 if (!have_dex2oat_compiler_filter_flag) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700391 char dex2oat_compiler_filter_flag[kPropertyValueMax];
392 have_dex2oat_compiler_filter_flag = get_property("dalvik.vm.dex2oat-filter",
393 dex2oat_compiler_filter_flag, NULL) > 0;
394 if (have_dex2oat_compiler_filter_flag) {
395 sprintf(dex2oat_compiler_filter_arg,
396 "--compiler-filter=%s",
397 dex2oat_compiler_filter_flag);
398 }
399 }
400
401 // Check whether all apps should be compiled debuggable.
402 if (!debuggable) {
403 char prop_buf[kPropertyValueMax];
404 debuggable =
405 (get_property("dalvik.vm.always_debuggable", prop_buf, "0") > 0) &&
406 (prop_buf[0] == '1');
407 }
408 char profile_arg[strlen("--profile-file-fd=") + MAX_INT_LEN];
409 if (profile_fd != -1) {
410 sprintf(profile_arg, "--profile-file-fd=%d", profile_fd);
411 }
412
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700413 // Get the directory of the apk to pass as a base classpath directory.
414 char base_dir[arraysize("--classpath-dir=") + PKG_PATH_MAX];
415 std::string apk_dir(input_file_name);
416 unsigned long dir_index = apk_dir.rfind('/');
417 bool has_base_dir = dir_index != std::string::npos;
418 if (has_base_dir) {
419 apk_dir = apk_dir.substr(0, dir_index);
420 sprintf(base_dir, "--classpath-dir=%s", apk_dir.c_str());
421 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700422
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700423
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700424 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700425
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800426 // Disable cdex if update input vdex is true since this combination of options is not
427 // supported.
Mathieu Chartier1fb463e2018-01-09 15:16:10 -0800428 // Disable cdex for non-background compiles since we don't want to regress app install until
429 // there are enough benefits to justify the tradeoff.
430 const bool disable_cdex = !background_job_compile || (input_vdex_fd == output_vdex_fd);
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800431
Jeff Sharkey90aff262016-12-12 14:28:24 -0700432 const char* argv[9 // program name, mandatory arguments and the final NULL
433 + (have_dex2oat_isa_variant ? 1 : 0)
434 + (have_dex2oat_isa_features ? 1 : 0)
435 + (have_dex2oat_Xms_flag ? 2 : 0)
436 + (have_dex2oat_Xmx_flag ? 2 : 0)
437 + (have_dex2oat_compiler_filter_flag ? 1 : 0)
438 + (have_dex2oat_threads_flag ? 1 : 0)
439 + (have_dex2oat_swap_fd ? 1 : 0)
440 + (have_dex2oat_image_fd ? 1 : 0)
441 + (have_dex2oat_relocation_skip_flag ? 2 : 0)
442 + (generate_debug_info ? 1 : 0)
443 + (debuggable ? 1 : 0)
444 + (have_app_image_format ? 1 : 0)
445 + dex2oat_flags_count
446 + (profile_fd == -1 ? 0 : 1)
Calin Juravle52c45822017-07-13 22:50:21 -0700447 + (class_loader_context != nullptr ? 1 : 0)
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700448 + (has_base_dir ? 1 : 0)
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700449 + (have_dex2oat_large_app_threshold ? 1 : 0)
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800450 + (disable_cdex ? 1 : 0)
David Brazdil570d3982018-01-16 20:15:43 +0000451 + (generate_minidebug_info ? 1 : 0)
David Brazdil7fcbb812018-01-17 17:05:40 +0000452 + (target_sdk_version != 0 ? 2 : 0)
David Brazdil52249162018-02-12 18:04:59 -0800453 + (enable_hidden_api_checks ? 2 : 0)];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700454 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700455 argv[i++] = dex2oat_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700456 argv[i++] = zip_fd_arg;
457 argv[i++] = zip_location_arg;
458 argv[i++] = input_vdex_fd_arg;
459 argv[i++] = output_vdex_fd_arg;
460 argv[i++] = oat_fd_arg;
461 argv[i++] = oat_location_arg;
462 argv[i++] = instruction_set_arg;
463 if (have_dex2oat_isa_variant) {
464 argv[i++] = instruction_set_variant_arg;
465 }
466 if (have_dex2oat_isa_features) {
467 argv[i++] = instruction_set_features_arg;
468 }
469 if (have_dex2oat_Xms_flag) {
470 argv[i++] = RUNTIME_ARG;
471 argv[i++] = dex2oat_Xms_arg;
472 }
473 if (have_dex2oat_Xmx_flag) {
474 argv[i++] = RUNTIME_ARG;
475 argv[i++] = dex2oat_Xmx_arg;
476 }
477 if (have_dex2oat_compiler_filter_flag) {
478 argv[i++] = dex2oat_compiler_filter_arg;
479 }
480 if (have_dex2oat_threads_flag) {
481 argv[i++] = dex2oat_threads_arg;
482 }
483 if (have_dex2oat_swap_fd) {
484 argv[i++] = dex2oat_swap_fd;
485 }
486 if (have_dex2oat_image_fd) {
487 argv[i++] = dex2oat_image_fd;
488 }
489 if (generate_debug_info) {
490 argv[i++] = "--generate-debug-info";
491 }
492 if (debuggable) {
493 argv[i++] = "--debuggable";
494 }
495 if (have_app_image_format) {
496 argv[i++] = image_format_arg;
497 }
498 if (have_dex2oat_large_app_threshold) {
499 argv[i++] = dex2oat_large_app_threshold_arg;
500 }
501 if (dex2oat_flags_count) {
502 i += split(dex2oat_flags, argv + i);
503 }
504 if (have_dex2oat_relocation_skip_flag) {
505 argv[i++] = RUNTIME_ARG;
506 argv[i++] = dex2oat_norelocation;
507 }
508 if (profile_fd != -1) {
509 argv[i++] = profile_arg;
510 }
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700511 if (has_base_dir) {
512 argv[i++] = base_dir;
513 }
Calin Juravle52c45822017-07-13 22:50:21 -0700514 if (class_loader_context != nullptr) {
515 argv[i++] = class_loader_context_arg;
516 }
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700517 if (generate_minidebug_info) {
518 argv[i++] = kMinidebugDex2oatFlag;
519 }
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800520 if (disable_cdex) {
521 argv[i++] = kDisableCompactDexFlag;
522 }
David Brazdil570d3982018-01-16 20:15:43 +0000523 if (target_sdk_version != 0) {
524 argv[i++] = RUNTIME_ARG;
525 argv[i++] = target_sdk_version_arg;
526 }
David Brazdil52249162018-02-12 18:04:59 -0800527 if (enable_hidden_api_checks) {
David Brazdil7fcbb812018-01-17 17:05:40 +0000528 argv[i++] = RUNTIME_ARG;
David Brazdil52249162018-02-12 18:04:59 -0800529 argv[i++] = "-Xhidden-api-checks";
David Brazdil7fcbb812018-01-17 17:05:40 +0000530 }
Calin Juravle52c45822017-07-13 22:50:21 -0700531
Jeff Sharkey90aff262016-12-12 14:28:24 -0700532 // Do not add after dex2oat_flags, they should override others for debugging.
533 argv[i] = NULL;
534
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700535 execv(dex2oat_bin, (char * const *)argv);
536 ALOGE("execv(%s) failed: %s\n", dex2oat_bin, strerror(errno));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700537}
538
539/*
540 * Whether dexopt should use a swap file when compiling an APK.
541 *
542 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
543 * itself, anyways).
544 *
545 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
546 *
547 * Otherwise, return true if this is a low-mem device.
548 *
549 * Otherwise, return default value.
550 */
551static bool kAlwaysProvideSwapFile = false;
552static bool kDefaultProvideSwapFile = true;
553
554static bool ShouldUseSwapFileForDexopt() {
555 if (kAlwaysProvideSwapFile) {
556 return true;
557 }
558
559 // Check the "override" property. If it exists, return value == "true".
560 char dex2oat_prop_buf[kPropertyValueMax];
561 if (get_property("dalvik.vm.dex2oat-swap", dex2oat_prop_buf, "") > 0) {
562 if (strcmp(dex2oat_prop_buf, "true") == 0) {
563 return true;
564 } else {
565 return false;
566 }
567 }
568
569 // Shortcut for default value. This is an implementation optimization for the process sketched
570 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
571 // as low-mem is never returning false. The compiler will optimize this away if it can.
572 if (kDefaultProvideSwapFile) {
573 return true;
574 }
575
576 bool is_low_mem = property_get_bool("ro.config.low_ram", false);
577 if (is_low_mem) {
578 return true;
579 }
580
581 // Default value must be false here.
582 return kDefaultProvideSwapFile;
583}
584
Richard Uhler76cc0272016-12-08 10:46:35 +0000585static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700586 if (set_to_bg) {
587 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
588 ALOGE("set_sched_policy failed: %s\n", strerror(errno));
589 exit(70);
590 }
591 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
592 ALOGE("setpriority failed: %s\n", strerror(errno));
593 exit(71);
594 }
595 }
596}
597
Calin Juravle29591732017-11-20 17:46:19 -0800598static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
599 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800600 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800601 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800602 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800603 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800604 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700605 }
Calin Juravle114f0812017-03-08 19:05:07 -0800606 // Profiles should belong to the app; make sure of that by giving ownership to
607 // the app uid. If we cannot do that, there's no point in returning the fd
608 // since dex2oat/profman will fail with SElinux denials.
609 if (fchown(fd.get(), uid, uid) < 0) {
610 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800611 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800612 }
Calin Juravle29591732017-11-20 17:46:19 -0800613 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800614}
615
Calin Juravle29591732017-11-20 17:46:19 -0800616static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800617 // Do not follow symlinks when opening a profile:
618 // - primary profiles should not contain symlinks in their paths
619 // - secondary dex paths should have been already resolved and validated
620 flags |= O_NOFOLLOW;
621
Calin Juravle29591732017-11-20 17:46:19 -0800622 // Check if we need to create the profile
623 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
624 unique_fd fd;
625 if ((flags & O_CREAT) != 0) {
626 fd = create_profile(uid, profile, flags);
627 } else {
628 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
629 }
630
Calin Juravle114f0812017-03-08 19:05:07 -0800631 if (fd.get() < 0) {
632 if (errno != ENOENT) {
633 // Profiles might be missing for various reasons. For example, in a
634 // multi-user environment, the profile directory for one user can be created
635 // after we start a merge. In this case the current profile for that user
636 // will not be found.
637 // Also, the secondary dex profiles might be deleted by the app at any time,
638 // so we can't we need to prepare if they are missing.
639 PLOG(ERROR) << "Failed to open profile " << profile;
640 }
641 return invalid_unique_fd();
642 }
643
Jeff Sharkey90aff262016-12-12 14:28:24 -0700644 return fd;
645}
646
Calin Juravle824a64d2018-01-18 20:23:17 -0800647static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
648 const std::string& location, bool is_secondary_dex) {
649 std::string profile = create_current_profile_path(user, package_name, location,
650 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800651 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800652}
653
Calin Juravle824a64d2018-01-18 20:23:17 -0800654static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
655 const std::string& location, bool read_write, bool is_secondary_dex) {
656 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800657 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
658}
659
660static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800661 const std::string& location) {
662 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800663 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800664}
665
Calin Juravle824a64d2018-01-18 20:23:17 -0800666static void open_profile_files(uid_t uid, const std::string& package_name,
667 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800668 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700669 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800670 *reference_profile_fd = open_reference_profile(uid, package_name, location,
671 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700672
Calin Juravle114f0812017-03-08 19:05:07 -0800673 // For secondary dex files, we don't really need the user but we use it for sanity checks.
674 // Note: the user owning the dex file should be the current user.
675 std::vector<userid_t> users;
676 if (is_secondary_dex){
677 users.push_back(multiuser_get_user_id(uid));
678 } else {
679 users = get_known_users(/*volume_uuid*/ nullptr);
680 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700681 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800682 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
683 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700684 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800685 if (profile_fd.get() >= 0) {
686 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700687 }
688 }
689}
690
691static void drop_capabilities(uid_t uid) {
692 if (setgid(uid) != 0) {
693 ALOGE("setgid(%d) failed in installd during dexopt\n", uid);
694 exit(64);
695 }
696 if (setuid(uid) != 0) {
697 ALOGE("setuid(%d) failed in installd during dexopt\n", uid);
698 exit(65);
699 }
700 // drop capabilities
701 struct __user_cap_header_struct capheader;
702 struct __user_cap_data_struct capdata[2];
703 memset(&capheader, 0, sizeof(capheader));
704 memset(&capdata, 0, sizeof(capdata));
705 capheader.version = _LINUX_CAPABILITY_VERSION_3;
706 if (capset(&capheader, &capdata[0]) < 0) {
707 ALOGE("capset failed: %s\n", strerror(errno));
708 exit(66);
709 }
710}
711
712static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
713static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
714static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
715static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
716static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
717
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800718static void run_profman_merge(const std::vector<unique_fd>& profiles_fd,
719 const unique_fd& reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700720 static const size_t MAX_INT_LEN = 32;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700721 const char* profman_bin = is_debug_runtime() ? "/system/bin/profmand" : "/system/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700722
723 std::vector<std::string> profile_args(profiles_fd.size());
724 char profile_buf[strlen("--profile-file-fd=") + MAX_INT_LEN];
725 for (size_t k = 0; k < profiles_fd.size(); k++) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800726 sprintf(profile_buf, "--profile-file-fd=%d", profiles_fd[k].get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700727 profile_args[k].assign(profile_buf);
728 }
729 char reference_profile_arg[strlen("--reference-profile-file-fd=") + MAX_INT_LEN];
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800730 sprintf(reference_profile_arg, "--reference-profile-file-fd=%d", reference_profile_fd.get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700731
732 // program name, reference profile fd, the final NULL and the profile fds
733 const char* argv[3 + profiles_fd.size()];
734 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700735 argv[i++] = profman_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700736 argv[i++] = reference_profile_arg;
737 for (size_t k = 0; k < profile_args.size(); k++) {
738 argv[i++] = profile_args[k].c_str();
739 }
740 // Do not add after dex2oat_flags, they should override others for debugging.
741 argv[i] = NULL;
742
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700743 execv(profman_bin, (char * const *)argv);
744 ALOGE("execv(%s) failed: %s\n", profman_bin, strerror(errno));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700745 exit(68); /* only get here on exec failure */
746}
747
748// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800749// The location is the package name for primary apks or the dex path for secondary dex files.
750// Returns true if there is enough information in the current profiles that makes it
751// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700752// If the return value is true all the current profiles would have been merged into
753// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800754static bool analyze_profiles(uid_t uid, const std::string& package_name,
755 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800756 std::vector<unique_fd> profiles_fd;
757 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800758 open_profile_files(uid, package_name, location, is_secondary_dex,
759 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800760 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700761 // Skip profile guided compilation because no profiles were found.
762 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700763 return false;
764 }
765
Jeff Sharkey90aff262016-12-12 14:28:24 -0700766 pid_t pid = fork();
767 if (pid == 0) {
768 /* child -- drop privileges before continuing */
769 drop_capabilities(uid);
770 run_profman_merge(profiles_fd, reference_profile_fd);
771 exit(68); /* only get here on exec failure */
772 }
773 /* parent */
774 int return_code = wait_child(pid);
775 bool need_to_compile = false;
776 bool should_clear_current_profiles = false;
777 bool should_clear_reference_profile = false;
778 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800779 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700780 } else {
781 return_code = WEXITSTATUS(return_code);
782 switch (return_code) {
783 case PROFMAN_BIN_RETURN_CODE_COMPILE:
784 need_to_compile = true;
785 should_clear_current_profiles = true;
786 should_clear_reference_profile = false;
787 break;
788 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
789 need_to_compile = false;
790 should_clear_current_profiles = false;
791 should_clear_reference_profile = false;
792 break;
793 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800794 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700795 need_to_compile = false;
796 should_clear_current_profiles = true;
797 should_clear_reference_profile = true;
798 break;
799 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
800 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
801 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800802 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700803 need_to_compile = false;
804 should_clear_current_profiles = false;
805 should_clear_reference_profile = false;
806 break;
807 default:
808 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800809 LOG(WARNING) << "Unknown error code while processing profiles for location "
810 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700811 need_to_compile = false;
812 should_clear_current_profiles = true;
813 should_clear_reference_profile = true;
814 break;
815 }
816 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800817
Jeff Sharkey90aff262016-12-12 14:28:24 -0700818 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800819 if (is_secondary_dex) {
820 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800821 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
822 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800823 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800824 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800825 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700826 }
827 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800828 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700829 }
830 return need_to_compile;
831}
832
Calin Juravle114f0812017-03-08 19:05:07 -0800833// Decides if profile guided compilation is needed or not based on existing profiles.
834// The analysis is done for the primary apks of the given package.
835// Returns true if there is enough information in the current profiles that makes it
836// worth to recompile the package.
837// If the return value is true all the current profiles would have been merged into
838// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800839bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
840 const std::string& profile_name) {
841 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800842}
843
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800844static void run_profman_dump(const std::vector<unique_fd>& profile_fds,
845 const unique_fd& reference_profile_fd,
Jeff Sharkey90aff262016-12-12 14:28:24 -0700846 const std::vector<std::string>& dex_locations,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800847 const std::vector<unique_fd>& apk_fds,
848 const unique_fd& output_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700849 std::vector<std::string> profman_args;
850 static const char* PROFMAN_BIN = "/system/bin/profman";
851 profman_args.push_back(PROFMAN_BIN);
852 profman_args.push_back("--dump-only");
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800853 profman_args.push_back(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700854 if (reference_profile_fd != -1) {
855 profman_args.push_back(StringPrintf("--reference-profile-file-fd=%d",
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800856 reference_profile_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700857 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800858 for (size_t i = 0; i < profile_fds.size(); i++) {
859 profman_args.push_back(StringPrintf("--profile-file-fd=%d", profile_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700860 }
861 for (const std::string& dex_location : dex_locations) {
862 profman_args.push_back(StringPrintf("--dex-location=%s", dex_location.c_str()));
863 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800864 for (size_t i = 0; i < apk_fds.size(); i++) {
865 profman_args.push_back(StringPrintf("--apk-fd=%d", apk_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700866 }
867 const char **argv = new const char*[profman_args.size() + 1];
868 size_t i = 0;
869 for (const std::string& profman_arg : profman_args) {
870 argv[i++] = profman_arg.c_str();
871 }
872 argv[i] = NULL;
873
874 execv(PROFMAN_BIN, (char * const *)argv);
875 ALOGE("execv(%s) failed: %s\n", PROFMAN_BIN, strerror(errno));
876 exit(68); /* only get here on exec failure */
877}
878
Calin Juravle76268c52017-03-09 13:19:42 -0800879bool dump_profiles(int32_t uid, const std::string& pkgname, const char* code_paths) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800880 std::vector<unique_fd> profile_fds;
881 unique_fd reference_profile_fd;
Calin Juravle76268c52017-03-09 13:19:42 -0800882 std::string out_file_name = StringPrintf("/data/misc/profman/%s.txt", pkgname.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700883
Calin Juravle824a64d2018-01-18 20:23:17 -0800884 // TODO(calin): get the profile name as a parameter.
885 open_profile_files(uid, pkgname, "primary.prof", /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800886 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700887
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800888 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700889 const bool has_profiles = !profile_fds.empty();
890
891 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800892 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700893 return false;
894 }
895
Calin Juravle114f0812017-03-08 19:05:07 -0800896 unique_fd output_fd(open(out_file_name.c_str(),
897 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700898 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
899 ALOGE("installd cannot chmod '%s' dump_profile\n", out_file_name.c_str());
900 return false;
901 }
902 std::vector<std::string> code_full_paths = base::Split(code_paths, ";");
903 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800904 std::vector<unique_fd> apk_fds;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700905 for (const std::string& code_full_path : code_full_paths) {
906 const char* full_path = code_full_path.c_str();
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800907 unique_fd apk_fd(open(full_path, O_RDONLY | O_NOFOLLOW));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700908 if (apk_fd == -1) {
909 ALOGE("installd cannot open '%s'\n", full_path);
910 return false;
911 }
912 dex_locations.push_back(get_location_from_path(full_path));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800913 apk_fds.push_back(std::move(apk_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700914 }
915
916 pid_t pid = fork();
917 if (pid == 0) {
918 /* child -- drop privileges before continuing */
919 drop_capabilities(uid);
920 run_profman_dump(profile_fds, reference_profile_fd, dex_locations,
921 apk_fds, output_fd);
922 exit(68); /* only get here on exec failure */
923 }
924 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700925 int return_code = wait_child(pid);
926 if (!WIFEXITED(return_code)) {
927 LOG(WARNING) << "profman failed for package " << pkgname << ": "
928 << return_code;
929 return false;
930 }
931 return true;
932}
933
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700934bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800935 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700936 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
937 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800938 package_name,
939 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700940 /*read_write*/ true,
941 /*secondary*/ false));
942 if (in_fd.get() < 0) {
943 PLOG(WARNING) << "Could not open profile " << system_profile;
944 return false;
945 }
946 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800947 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700948 return false;
949 }
950
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700951 // As a security measure we want to write the profile information with the reduced capabilities
952 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700953 pid_t pid = fork();
954 if (pid == 0) {
955 /* child -- drop privileges before continuing */
956 drop_capabilities(packageUid);
957
958 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
959 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800960 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700961 }
962 // This implies that the app owning this profile is running
963 // (and has acquired the lock).
964 //
965 // The app never acquires the lock for the reference profiles of primary apks.
966 // Only dex2oat from installd will do that. Since installd is single threaded
967 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800968 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700969 return false;
970 }
971
972 bool truncated = ftruncate(out_fd.get(), 0) == 0;
973 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800974 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700975 }
976
977 // Copy over data.
978 static constexpr size_t kBufferSize = 4 * 1024;
979 char buffer[kBufferSize];
980 while (true) {
981 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
982 if (bytes == 0) {
983 break;
984 }
985 write(out_fd.get(), buffer, bytes);
986 }
987 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800988 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700989 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700990 // Use _exit since we don't want to run the global destructors in the child.
991 // b/62597429
992 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700993 }
994 /* parent */
995 int return_code = wait_child(pid);
996 return return_code == 0;
997}
998
Jeff Sharkey90aff262016-12-12 14:28:24 -0700999static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
1000 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
1001 if (EndsWith(oat_path, ".dex")) {
1002 std::string new_path = oat_path;
1003 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -08001004 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -07001005 return new_path;
1006 }
1007
1008 // An odex entry. Not that this may not be an extension, e.g., in the OTA
1009 // case (where the base name will have an extension for the B artifact).
1010 size_t odex_pos = oat_path.rfind(".odex");
1011 if (odex_pos != std::string::npos) {
1012 std::string new_path = oat_path;
1013 new_path.replace(odex_pos, strlen(".odex"), new_ext);
1014 CHECK_NE(new_path.find(new_ext), std::string::npos);
1015 return new_path;
1016 }
1017
1018 // Don't know how to handle this.
1019 return "";
1020}
1021
1022// Translate the given oat path to an art (app image) path. An empty string
1023// denotes an error.
1024static std::string create_image_filename(const std::string& oat_path) {
1025 return replace_file_extension(oat_path, ".art");
1026}
1027
1028// Translate the given oat path to a vdex path. An empty string denotes an error.
1029static std::string create_vdex_filename(const std::string& oat_path) {
1030 return replace_file_extension(oat_path, ".vdex");
1031}
1032
Jeff Sharkey90aff262016-12-12 14:28:24 -07001033static int open_output_file(const char* file_name, bool recreate, int permissions) {
1034 int flags = O_RDWR | O_CREAT;
1035 if (recreate) {
1036 if (unlink(file_name) < 0) {
1037 if (errno != ENOENT) {
1038 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1039 }
1040 }
1041 flags |= O_EXCL;
1042 }
1043 return open(file_name, flags, permissions);
1044}
1045
Calin Juravle2289c0a2017-02-15 12:44:14 -08001046static bool set_permissions_and_ownership(
1047 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1048 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1049 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001050 if (fchmod(fd,
1051 S_IRUSR|S_IWUSR|S_IRGRP |
1052 (is_public ? S_IROTH : 0)) < 0) {
1053 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1054 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001055 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001056 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1057 return false;
1058 }
1059 return true;
1060}
1061
1062static bool IsOutputDalvikCache(const char* oat_dir) {
1063 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1064 // into '!'. Play it safe by handling it both.
1065 // TODO: ensure we never get null.
1066 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1067 return oat_dir == nullptr || oat_dir[0] == '!';
1068}
1069
Calin Juravled23dee72017-07-06 16:29:11 -07001070// Best-effort check whether we can fit the the path into our buffers.
1071// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1072// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1073// extension to the cache path (5 bytes).
1074// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1075static bool validate_dex_path_size(const std::string& dex_path) {
1076 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1077 LOG(ERROR) << "dex_path too long: " << dex_path;
1078 return false;
1079 }
1080 return true;
1081}
1082
Jeff Sharkey90aff262016-12-12 14:28:24 -07001083static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001084 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001085 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001086 return false;
1087 }
1088
1089 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001090 // Oat dirs for secondary dex files are already validated.
1091 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001092 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1093 return false;
1094 }
1095 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1096 return false;
1097 }
1098 } else {
1099 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1100 return false;
1101 }
1102 }
1103 return true;
1104}
1105
1106// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1107// on destruction. It will also run the given cleanup (unless told not to) after closing.
1108//
1109// Usage example:
1110//
Calin Juravle7a570e82017-01-14 16:23:30 -08001111// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001112// [name]() {
1113// unlink(name.c_str());
1114// });
1115// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1116// wrapper if captured as a reference.
1117//
1118// if (file.get() == -1) {
1119// // Error opening...
1120// }
1121//
1122// ...
1123// if (error) {
1124// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1125// // and delete the file (after the fd is closed).
1126// return -1;
1127// }
1128//
1129// (Success case)
1130// file.SetCleanup(false);
1131// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1132// // (leaving the file around; after the fd is closed).
1133//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001134class Dex2oatFileWrapper {
1135 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001136 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001137 }
1138
Calin Juravle7a570e82017-01-14 16:23:30 -08001139 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1140 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1141
1142 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1143 value_ = other.value_;
1144 cleanup_ = other.cleanup_;
1145 do_cleanup_ = other.do_cleanup_;
1146 auto_close_ = other.auto_close_;
1147 other.release();
1148 }
1149
1150 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1151 value_ = other.value_;
1152 cleanup_ = other.cleanup_;
1153 do_cleanup_ = other.do_cleanup_;
1154 auto_close_ = other.auto_close_;
1155 other.release();
1156 return *this;
1157 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001158
1159 ~Dex2oatFileWrapper() {
1160 reset(-1);
1161 }
1162
1163 int get() {
1164 return value_;
1165 }
1166
1167 void SetCleanup(bool cleanup) {
1168 do_cleanup_ = cleanup;
1169 }
1170
1171 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001172 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001173 close(value_);
1174 }
1175 if (do_cleanup_ && cleanup_ != nullptr) {
1176 cleanup_();
1177 }
1178
1179 value_ = new_value;
1180 }
1181
Calin Juravle7a570e82017-01-14 16:23:30 -08001182 void reset(int new_value, std::function<void ()> new_cleanup) {
1183 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001184 close(value_);
1185 }
1186 if (do_cleanup_ && cleanup_ != nullptr) {
1187 cleanup_();
1188 }
1189
1190 value_ = new_value;
1191 cleanup_ = new_cleanup;
1192 }
1193
Calin Juravle7a570e82017-01-14 16:23:30 -08001194 void DisableAutoClose() {
1195 auto_close_ = false;
1196 }
1197
Jeff Sharkey90aff262016-12-12 14:28:24 -07001198 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001199 void release() {
1200 value_ = -1;
1201 do_cleanup_ = false;
1202 cleanup_ = nullptr;
1203 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001204 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001205 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001206 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001207 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001208};
1209
Calin Juravle7a570e82017-01-14 16:23:30 -08001210// (re)Creates the app image if needed.
1211Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path, bool profile_guided,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001212 bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001213
1214 // We don't create an image for secondary dex files.
1215 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001216 return Dex2oatFileWrapper();
1217 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001218
Calin Juravle7a570e82017-01-14 16:23:30 -08001219 const std::string image_path = create_image_filename(out_oat_path);
1220 if (image_path.empty()) {
1221 // Happens when the out_oat_path has an unknown extension.
1222 return Dex2oatFileWrapper();
1223 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001224
1225 // Use app images only if it is enabled (by a set image format) and we are compiling
1226 // profile-guided (so the app image doesn't conservatively contain all classes).
1227 if (!profile_guided) {
1228 // In case there is a stale image, remove it now. Ignore any error.
1229 unlink(image_path.c_str());
1230 return Dex2oatFileWrapper();
1231 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001232 char app_image_format[kPropertyValueMax];
1233 bool have_app_image_format =
1234 get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
1235 if (!have_app_image_format) {
1236 return Dex2oatFileWrapper();
1237 }
1238 // Recreate is true since we do not want to modify a mapped image. If the app is
1239 // already running and we modify the image file, it can cause crashes (b/27493510).
1240 Dex2oatFileWrapper wrapper_fd(
1241 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1242 [image_path]() { unlink(image_path.c_str()); });
1243 if (wrapper_fd.get() < 0) {
1244 // Could not create application image file. Go on since we can compile without it.
1245 LOG(ERROR) << "installd could not create '" << image_path
1246 << "' for image file during dexopt";
1247 // If we have a valid image file path but no image fd, explicitly erase the image file.
1248 if (unlink(image_path.c_str()) < 0) {
1249 if (errno != ENOENT) {
1250 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1251 }
1252 }
1253 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001254 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001255 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1256 wrapper_fd.reset(-1);
1257 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001258
Calin Juravle7a570e82017-01-14 16:23:30 -08001259 return wrapper_fd;
1260}
1261
1262// Creates the dexopt swap file if necessary and return its fd.
1263// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001264unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001265 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001266 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001267 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001268 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001269 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001270 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001271 if (swap_fd.get() < 0) {
1272 // Could not create swap file. Optimistically go on and hope that we can compile
1273 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001274 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001275 } else {
1276 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001277 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001278 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1279 }
1280 }
1281 return swap_fd;
1282}
1283
1284// Opens the reference profiles if needed.
1285// 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 -08001286Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravle824a64d2018-01-18 20:23:17 -08001287 const std::string& dex_path, const std::string& profile_name, bool profile_guided,
1288 bool is_public, int uid, bool is_secondary_dex) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001289 // Public apps should not be compiled with profile information ever. Same goes for the special
1290 // package '*' used for the system server.
Calin Juravle114f0812017-03-08 19:05:07 -08001291 if (!profile_guided || is_public || (pkgname[0] == '*')) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001292 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001293 }
Calin Juravle114f0812017-03-08 19:05:07 -08001294
1295 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravle824a64d2018-01-18 20:23:17 -08001296 const std::string location = is_secondary_dex ? dex_path : profile_name;
1297 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1298 is_secondary_dex);
1299 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1300 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001301 };
1302 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001303}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001304
Calin Juravle7a570e82017-01-14 16:23:30 -08001305// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1306// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001307bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001308 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001309 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001310 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1311 CHECK(in_vdex_wrapper_fd != nullptr);
1312 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001313 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1314 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001315 char in_odex_path[PKG_PATH_MAX];
1316 int dexopt_action = abs(dexopt_needed);
1317 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001318 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001319
1320 // Infer the name of the output VDEX.
1321 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1322 if (out_vdex_path_str.empty()) {
1323 return false;
1324 }
1325
1326 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001327 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001328 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1329 const char* path = nullptr;
1330 if (is_odex_location) {
1331 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1332 path = in_odex_path;
1333 } else {
1334 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001335 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001336 }
1337 } else {
1338 path = out_oat_path;
1339 }
1340 in_vdex_path_str = create_vdex_filename(path);
1341 if (in_vdex_path_str.empty()) {
1342 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001343 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001344 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001345 // We can update in place when all these conditions are met:
1346 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1347 // on /system typically cannot be updated in place).
1348 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1349 // cannot be currently used by a running process.
1350 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1351 // different vdex files to operate.
1352 update_vdex_in_place =
1353 (in_vdex_path_str == out_vdex_path_str) &&
1354 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1355 !profile_guided;
1356 if (update_vdex_in_place) {
1357 // Open the file read-write to be able to update it.
1358 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1359 if (in_vdex_wrapper_fd->get() == -1) {
1360 // If we failed to open the file, we cannot update it in place.
1361 update_vdex_in_place = false;
1362 }
1363 } else {
1364 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1365 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001366 }
1367
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001368 // If we are updating the vdex in place, we do not need to recreate a vdex,
1369 // and can use the same existing one.
1370 if (update_vdex_in_place) {
1371 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1372 // have bogus stale vdex files.
1373 out_vdex_wrapper_fd->reset(
1374 in_vdex_wrapper_fd->get(),
1375 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1376 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1377 // wrapper).
1378 in_vdex_wrapper_fd->DisableAutoClose();
1379 } else {
1380 out_vdex_wrapper_fd->reset(
1381 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1382 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1383 if (out_vdex_wrapper_fd->get() < 0) {
1384 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1385 return false;
1386 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001387 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001388 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001389 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001390 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1391 return false;
1392 }
1393
1394 // If we got here we successfully opened the vdex files.
1395 return true;
1396}
1397
1398// Opens the output oat file for the given apk.
1399// If successful it stores the output path into out_oat_path and returns true.
1400Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001401 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1402 char* out_oat_path) {
1403 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001404 return Dex2oatFileWrapper();
1405 }
1406 const std::string out_oat_path_str(out_oat_path);
1407 Dex2oatFileWrapper wrapper_fd(
1408 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1409 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1410 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001411 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001412 } else if (!set_permissions_and_ownership(
1413 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001414 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1415 wrapper_fd.reset(-1);
1416 }
1417 return wrapper_fd;
1418}
1419
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001420// Creates RDONLY fds for oat and vdex files, if exist.
1421// Returns false if it fails to create oat out path for the given apk path.
1422// Note that the method returns true even if the files could not be opened.
1423bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1424 const std::string& oat_dir,
1425 const std::string& instruction_set,
1426 bool is_secondary_dex,
1427 unique_fd* oat_file_fd,
1428 unique_fd* vdex_file_fd) {
1429 char oat_path[PKG_PATH_MAX];
1430 if (!create_oat_out_path(apk_path.c_str(),
1431 instruction_set.c_str(),
1432 oat_dir.c_str(),
1433 is_secondary_dex,
1434 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001435 LOG(ERROR) << "Could not create oat out path for "
1436 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001437 return false;
1438 }
1439 oat_file_fd->reset(open(oat_path, O_RDONLY));
1440 if (oat_file_fd->get() < 0) {
1441 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1442 }
1443
1444 std::string vdex_filename = create_vdex_filename(oat_path);
1445 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1446 if (vdex_file_fd->get() < 0) {
1447 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1448 }
1449
1450 return true;
1451}
1452
Calin Juravle7a570e82017-01-14 16:23:30 -08001453// Updates the access times of out_oat_path based on those from apk_path.
1454void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1455 struct stat input_stat;
1456 memset(&input_stat, 0, sizeof(input_stat));
1457 if (stat(apk_path, &input_stat) != 0) {
1458 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1459 return;
1460 }
1461
1462 struct utimbuf ut;
1463 ut.actime = input_stat.st_atime;
1464 ut.modtime = input_stat.st_mtime;
1465 if (utime(out_oat_path, &ut) != 0) {
1466 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1467 }
1468}
1469
Calin Juravle80a21252017-01-17 14:43:25 -08001470// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001471// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1472// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1473// the profile has changed.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001474static void exec_dexoptanalyzer(const std::string& dex_file, int vdex_fd, int oat_fd,
1475 int zip_fd, const std::string& instruction_set, const std::string& compiler_filter,
1476 bool profile_was_updated, bool downgrade,
Calin Juravle58cab072017-09-12 01:02:26 -07001477 const char* class_loader_context) {
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001478 CHECK_GE(zip_fd, 0);
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001479 const char* dexoptanalyzer_bin =
1480 is_debug_runtime()
1481 ? "/system/bin/dexoptanalyzerd"
1482 : "/system/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001483 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
1484
Calin Juravled23dee72017-07-06 16:29:11 -07001485 if (instruction_set.size() >= MAX_INSTRUCTION_SET_LEN) {
1486 LOG(ERROR) << "Instruction set " << instruction_set
1487 << " longer than max length of " << MAX_INSTRUCTION_SET_LEN;
Calin Juravle80a21252017-01-17 14:43:25 -08001488 return;
1489 }
1490
Calin Juravled23dee72017-07-06 16:29:11 -07001491 std::string dex_file_arg = "--dex-file=" + dex_file;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001492 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1493 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1494 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
Calin Juravled23dee72017-07-06 16:29:11 -07001495 std::string isa_arg = "--isa=" + instruction_set;
1496 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
Calin Juravle114f0812017-03-08 19:05:07 -08001497 const char* assume_profile_changed = "--assume-profile-changed";
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001498 const char* downgrade_flag = "--downgrade";
Calin Juravle58cab072017-09-12 01:02:26 -07001499 std::string class_loader_context_arg = "--class-loader-context=";
1500 if (class_loader_context != nullptr) {
1501 class_loader_context_arg += class_loader_context;
1502 }
Calin Juravle80a21252017-01-17 14:43:25 -08001503
Calin Juravle80a21252017-01-17 14:43:25 -08001504 // program name, dex file, isa, filter, the final NULL
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001505 const int argc = 6 +
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001506 (profile_was_updated ? 1 : 0) +
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001507 (vdex_fd >= 0 ? 1 : 0) +
1508 (oat_fd >= 0 ? 1 : 0) +
Calin Juravle58cab072017-09-12 01:02:26 -07001509 (downgrade ? 1 : 0) +
1510 (class_loader_context != nullptr ? 1 : 0);
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001511 const char* argv[argc];
Calin Juravle80a21252017-01-17 14:43:25 -08001512 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001513 argv[i++] = dexoptanalyzer_bin;
Calin Juravled23dee72017-07-06 16:29:11 -07001514 argv[i++] = dex_file_arg.c_str();
1515 argv[i++] = isa_arg.c_str();
1516 argv[i++] = compiler_filter_arg.c_str();
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001517 if (oat_fd >= 0) {
1518 argv[i++] = oat_fd_arg.c_str();
1519 }
1520 if (vdex_fd >= 0) {
1521 argv[i++] = vdex_fd_arg.c_str();
1522 }
1523 argv[i++] = zip_fd_arg.c_str();
Calin Juravle114f0812017-03-08 19:05:07 -08001524 if (profile_was_updated) {
1525 argv[i++] = assume_profile_changed;
1526 }
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001527 if (downgrade) {
1528 argv[i++] = downgrade_flag;
1529 }
Calin Juravle58cab072017-09-12 01:02:26 -07001530 if (class_loader_context != nullptr) {
Calin Juravle91501072017-10-26 15:44:53 -07001531 argv[i++] = class_loader_context_arg.c_str();
Calin Juravle58cab072017-09-12 01:02:26 -07001532 }
Calin Juravle80a21252017-01-17 14:43:25 -08001533 argv[i] = NULL;
1534
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001535 execv(dexoptanalyzer_bin, (char * const *)argv);
1536 ALOGE("execv(%s) failed: %s\n", dexoptanalyzer_bin, strerror(errno));
Calin Juravle80a21252017-01-17 14:43:25 -08001537}
1538
1539// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001540static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001541 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001542 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001543 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001544 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001545 return false;
1546 }
Calin Juravle114f0812017-03-08 19:05:07 -08001547 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001548
Calin Juravle80a21252017-01-17 14:43:25 -08001549 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001550 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1551 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001552 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001553 return false;
1554 }
1555
1556 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001557 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001558
Calin Juravle7d765462017-09-04 15:57:10 -07001559 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001560 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001561 return false;
1562 }
1563
1564 return true;
1565}
1566
Calin Juravle7d765462017-09-04 15:57:10 -07001567// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1568// secondary dex files. This return codes are returned by the child process created for
1569// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001570
Calin Juravle7d765462017-09-04 15:57:10 -07001571// The dexoptanalyzer was not invoked because of validation or IO errors.
1572static int constexpr SECONDARY_DEX_DEXOPTANALYZER_SKIPPED = 200;
1573// The dexoptanalyzer was not invoked because the dex file does not exist anymore.
1574static int constexpr SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE = 201;
1575
1576// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001577// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1578// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001579// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1580// of dexoptanalyzer.
1581static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Calin Juravle80a21252017-01-17 14:43:25 -08001582 int* dexopt_needed_out) {
1583 // The result values are defined in dexoptanalyzer.
1584 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001585 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001586 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001587 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001588 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001589 case 5: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001590 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001591 case 6: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001592 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001593 case 7: // dexoptanalyzer: dex2oat_for_relocation_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001594 *dexopt_needed_out = -DEX2OAT_FOR_RELOCATION; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001595 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1596 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
1597 case 4: // dexoptanalyzer: dex2oat_for_relocation_oat
Calin Juravlec9eab382017-01-25 01:17:17 -08001598 LOG(ERROR) << "Dexoptnalyzer return the status of an oat file."
1599 << " Expected odex file status for secondary dex " << dex_path
Calin Juravle80a21252017-01-17 14:43:25 -08001600 << " : dexoptanalyzer result=" << result;
1601 return false;
Calin Juravle7d765462017-09-04 15:57:10 -07001602 case SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE:
1603 // If the file does not exist there's no need for dexopt.
1604 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1605 return true;
1606 case SECONDARY_DEX_DEXOPTANALYZER_SKIPPED:
1607 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001608 default:
Calin Juravle7d765462017-09-04 15:57:10 -07001609 LOG(ERROR) << "Unexpected result from analyzing secondary dex " << dex_path
1610 << " result=" << result;
Calin Juravle80a21252017-01-17 14:43:25 -08001611 return false;
1612 }
1613}
1614
Calin Juravle7d765462017-09-04 15:57:10 -07001615enum SecondaryDexAccess {
1616 kSecondaryDexAccessReadOk = 0,
1617 kSecondaryDexAccessDoesNotExist = 1,
1618 kSecondaryDexAccessPermissionError = 2,
1619 kSecondaryDexAccessIOError = 3
1620};
1621
1622static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1623 // Check if the path exists and can be read. If not, there's nothing to do.
1624 if (access(dex_path.c_str(), R_OK) == 0) {
1625 return kSecondaryDexAccessReadOk;
1626 } else {
1627 if (errno == ENOENT) {
1628 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1629 return kSecondaryDexAccessDoesNotExist;
1630 } else {
1631 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1632 return errno == EACCES
1633 ? kSecondaryDexAccessPermissionError
1634 : kSecondaryDexAccessIOError;
1635 }
1636 }
1637}
1638
1639static bool is_file_public(const std::string& filename) {
1640 struct stat file_stat;
1641 if (stat(filename.c_str(), &file_stat) == 0) {
1642 return (file_stat.st_mode & S_IROTH) != 0;
1643 }
1644 return false;
1645}
1646
1647// Create the oat file structure for the secondary dex 'dex_path' and assign
1648// the individual path component to the 'out_' parameters.
1649static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
1650 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path) {
1651 size_t dirIndex = dex_path.rfind('/');
1652 if (dirIndex == std::string::npos) {
1653 LOG(ERROR) << "Unexpected dir structure for dex file " << dex_path;
1654 return false;
1655 }
1656 // TODO(calin): we have similar computations in at lest 3 other places
1657 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1658 // using string append.
1659 std::string apk_dir = dex_path.substr(0, dirIndex);
1660 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1661 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1662
1663 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1664 /*is_secondary_dex*/true, out_oat_path)) {
1665 LOG(ERROR) << "Could not create oat path for secondary dex " << dex_path;
1666 return false;
1667 }
1668 return true;
1669}
1670
1671// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1672// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
1673static bool validate_dexopt_storage_flags(int dexopt_flags, int* out_storage_flag) {
1674 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1675 *out_storage_flag = FLAG_STORAGE_CE;
1676 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1677 LOG(ERROR) << "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
1678 return false;
1679 }
1680 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1681 *out_storage_flag = FLAG_STORAGE_DE;
1682 } else {
1683 LOG(ERROR) << "Secondary dex storage flag must be set";
1684 return false;
1685 }
1686 return true;
1687}
1688
Calin Juravlec9eab382017-01-25 01:17:17 -08001689// 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 -08001690// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1691// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001692// When returning true, the output parameters will be:
1693// - is_public_out: whether or not the oat file should not be made public
1694// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1695// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001696static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001697 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001698 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Calin Juravle7d765462017-09-04 15:57:10 -07001699 std::string* oat_dir_out, bool downgrade, const char* class_loader_context) {
1700 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001701 int storage_flag;
Calin Juravle7d765462017-09-04 15:57:10 -07001702 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001703 return false;
1704 }
Calin Juravle7d765462017-09-04 15:57:10 -07001705 // Compute the oat dir as it's not easy to extract it from the child computation.
1706 char oat_path[PKG_PATH_MAX];
1707 char oat_dir[PKG_PATH_MAX];
1708 char oat_isa_dir[PKG_PATH_MAX];
1709 if (!create_secondary_dex_oat_layout(
1710 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path)) {
1711 LOG(ERROR) << "Could not create secondary odex layout: " << dex_path;
Calin Juravled23dee72017-07-06 16:29:11 -07001712 return false;
1713 }
Calin Juravle7d765462017-09-04 15:57:10 -07001714 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001715
Calin Juravle80a21252017-01-17 14:43:25 -08001716 pid_t pid = fork();
1717 if (pid == 0) {
1718 // child -- drop privileges before continuing.
1719 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001720
1721 // Validate the path structure.
1722 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1723 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
1724 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1725 }
1726
1727 // Open the dex file.
1728 unique_fd zip_fd;
1729 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1730 if (zip_fd.get() < 0) {
1731 if (errno == ENOENT) {
1732 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE);
1733 } else {
1734 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1735 }
1736 }
1737
1738 // Prepare the oat directories.
1739 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
1740 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1741 }
1742
1743 // Open the vdex/oat files if any.
1744 unique_fd oat_file_fd;
1745 unique_fd vdex_file_fd;
1746 if (!maybe_open_oat_and_vdex_file(dex_path,
1747 *oat_dir_out,
1748 instruction_set,
1749 true /* is_secondary_dex */,
1750 &oat_file_fd,
1751 &vdex_file_fd)) {
1752 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1753 }
1754
1755 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001756 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1757 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001758
1759 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001760 exec_dexoptanalyzer(dex_path,
1761 vdex_file_fd.get(),
1762 oat_file_fd.get(),
1763 zip_fd.get(),
1764 instruction_set,
Calin Juravle7d765462017-09-04 15:57:10 -07001765 compiler_filter, profile_was_updated,
1766 downgrade,
1767 class_loader_context);
1768 PLOG(ERROR) << "Failed to exec dexoptanalyzer";
1769 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
Calin Juravle80a21252017-01-17 14:43:25 -08001770 }
1771
1772 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001773 int result = wait_child(pid);
1774 if (!WIFEXITED(result)) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001775 LOG(ERROR) << "dexoptanalyzer failed for path " << dex_path << ": " << result;
Calin Juravle80a21252017-01-17 14:43:25 -08001776 return false;
1777 }
1778 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001779 // Check that we successfully executed dexoptanalyzer.
1780 bool success = process_secondary_dexoptanalyzer_result(dex_path, result, dexopt_needed_out);
1781
1782 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1783
Calin Juravle80a21252017-01-17 14:43:25 -08001784 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001785 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1786 // makes the code simpler; force compilation is only needed during tests).
1787 if (success &&
1788 (result != SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE) &&
1789 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001790 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1791 }
1792
Calin Juravle7d765462017-09-04 15:57:10 -07001793 // Check if we should make the oat file public.
1794 // Note that if the dex file is not public the compiled code cannot be made public.
1795 // It is ok to check this flag outside in the parent process.
1796 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1797
Calin Juravle80a21252017-01-17 14:43:25 -08001798 return success;
1799}
1800
Calin Juravlec9eab382017-01-25 01:17:17 -08001801int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001802 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001803 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle824a64d2018-01-18 20:23:17 -08001804 bool downgrade, int target_sdk_version, const char* profile_name) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001805 CHECK(pkgname != nullptr);
1806 CHECK(pkgname[0] != 0);
1807 if ((dexopt_flags & ~DEXOPT_MASK) != 0) {
1808 LOG_FATAL("dexopt flags contains unknown fields\n");
1809 }
1810
Calin Juravled23dee72017-07-06 16:29:11 -07001811 if (!validate_dex_path_size(dex_path)) {
Calin Juravle52c45822017-07-13 22:50:21 -07001812 return -1;
1813 }
1814
1815 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
1816 LOG(ERROR) << "Class loader context exceeds the allowed size: " << class_loader_context;
1817 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001818 }
1819
Calin Juravleebc8a792017-04-04 20:21:05 -07001820 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001821 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1822 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1823 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001824 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001825 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001826 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001827
1828 // Check if we're dealing with a secondary dex file and if we need to compile it.
1829 std::string oat_dir_str;
1830 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001831 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001832 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Calin Juravle7d765462017-09-04 15:57:10 -07001833 downgrade, class_loader_context)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001834 oat_dir = oat_dir_str.c_str();
1835 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1836 return 0; // Nothing to do, report success.
1837 }
1838 } else {
1839 return -1; // We had an error, logged in the process method.
1840 }
1841 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001842 // Currently these flags are only use for secondary dex files.
1843 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001844 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1845 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1846 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001847
1848 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001849 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001850 if (input_fd.get() < 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001851 ALOGE("installd cannot open '%s' for input during dexopt\n", dex_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001852 return -1;
1853 }
1854
1855 // Create the output OAT file.
1856 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001857 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001858 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001859 if (out_oat_fd.get() < 0) {
1860 return -1;
1861 }
1862
1863 // Open vdex files.
1864 Dex2oatFileWrapper in_vdex_fd;
1865 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001866 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1867 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001868 return -1;
1869 }
1870
Calin Juravlecb556e32017-04-04 20:22:50 -07001871 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1872 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1873 // fully inherit their parent context).
1874 // Note that for primary apk the oat files are created before, in a separate installd
1875 // call which also does the restorecon. TODO(calin): unify the paths.
1876 if (is_secondary_dex) {
1877 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1878 SELINUX_ANDROID_RESTORECON_RECURSE)) {
1879 LOG(ERROR) << "Failed to restorecon " << oat_dir;
1880 return -1;
1881 }
1882 }
1883
Jeff Sharkey90aff262016-12-12 14:28:24 -07001884 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001885 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001886
Calin Juravle7a570e82017-01-14 16:23:30 -08001887 // Create the app image file if needed.
1888 Dex2oatFileWrapper image_fd =
Calin Juravle2289c0a2017-02-15 12:44:14 -08001889 maybe_open_app_image(out_oat_path, profile_guided, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001890
Calin Juravle7a570e82017-01-14 16:23:30 -08001891 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001892 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001893 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001894
Calin Juravlec9eab382017-01-25 01:17:17 -08001895 ALOGV("DexInv: --- BEGIN '%s' ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001896
1897 pid_t pid = fork();
1898 if (pid == 0) {
1899 /* child -- drop privileges before continuing */
1900 drop_capabilities(uid);
1901
Richard Uhler76cc0272016-12-08 10:46:35 +00001902 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001903 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
1904 ALOGE("flock(%s) failed: %s\n", out_oat_path, strerror(errno));
1905 _exit(67);
1906 }
1907
Richard Uhler76cc0272016-12-08 10:46:35 +00001908 run_dex2oat(input_fd.get(),
1909 out_oat_fd.get(),
1910 in_vdex_fd.get(),
Calin Juravle7a570e82017-01-14 16:23:30 -08001911 out_vdex_fd.get(),
Richard Uhler76cc0272016-12-08 10:46:35 +00001912 image_fd.get(),
Jeff Hao10b8a6e2017-04-05 17:11:39 -07001913 dex_path,
Richard Uhler76cc0272016-12-08 10:46:35 +00001914 out_oat_path,
1915 swap_fd.get(),
1916 instruction_set,
1917 compiler_filter,
Richard Uhler76cc0272016-12-08 10:46:35 +00001918 debuggable,
1919 boot_complete,
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001920 background_job_compile,
Richard Uhler76cc0272016-12-08 10:46:35 +00001921 reference_profile_fd.get(),
David Brazdil570d3982018-01-16 20:15:43 +00001922 class_loader_context,
David Brazdil7fcbb812018-01-17 17:05:40 +00001923 target_sdk_version,
David Brazdil52249162018-02-12 18:04:59 -08001924 enable_hidden_api_checks);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001925 _exit(68); /* only get here on exec failure */
1926 } else {
1927 int res = wait_child(pid);
1928 if (res == 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001929 ALOGV("DexInv: --- END '%s' (success) ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001930 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001931 ALOGE("DexInv: --- END '%s' --- status=0x%04x, process failed\n", dex_path, res);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001932 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001933 }
1934 }
1935
Calin Juravlec9eab382017-01-25 01:17:17 -08001936 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001937
1938 // We've been successful, don't delete output.
1939 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001940 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001941 image_fd.SetCleanup(false);
1942 reference_profile_fd.SetCleanup(false);
1943
1944 return 0;
1945}
1946
Calin Juravlec9eab382017-01-25 01:17:17 -08001947// Try to remove the given directory. Log an error if the directory exists
1948// and is empty but could not be removed.
1949static bool rmdir_if_empty(const char* dir) {
1950 if (rmdir(dir) == 0) {
1951 return true;
1952 }
1953 if (errno == ENOENT || errno == ENOTEMPTY) {
1954 return true;
1955 }
1956 PLOG(ERROR) << "Failed to remove dir: " << dir;
1957 return false;
1958}
1959
1960// Try to unlink the given file. Log an error if the file exists and could not
1961// be unlinked.
1962static bool unlink_if_exists(const std::string& file) {
1963 if (unlink(file.c_str()) == 0) {
1964 return true;
1965 }
1966 if (errno == ENOENT) {
1967 return true;
1968
1969 }
1970 PLOG(ERROR) << "Could not unlink: " << file;
1971 return false;
1972}
1973
Calin Juravle7d765462017-09-04 15:57:10 -07001974enum ReconcileSecondaryDexResult {
1975 kReconcileSecondaryDexExists = 0,
1976 kReconcileSecondaryDexCleanedUp = 1,
1977 kReconcileSecondaryDexValidationError = 2,
1978 kReconcileSecondaryDexCleanUpError = 3,
1979 kReconcileSecondaryDexAccessIOError = 4,
1980};
Calin Juravlec9eab382017-01-25 01:17:17 -08001981
1982// Reconcile the secondary dex 'dex_path' and its generated oat files.
1983// Return true if all the parameters are valid and the secondary dex file was
1984// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1985// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1986// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1987// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1988// Return false if there were errors during processing. In this case
1989// out_secondary_dex_exists will be set to false.
1990bool reconcile_secondary_dex_file(const std::string& dex_path,
1991 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
1992 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
1993 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07001994 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08001995 if (isas.size() == 0) {
1996 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1997 return false;
1998 }
1999
Calin Juravle7d765462017-09-04 15:57:10 -07002000 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2001 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2002 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002003 return false;
2004 }
2005
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002006 // As a security measure we want to unlink art artifacts with the reduced capabilities
2007 // of the package user id. So we fork and drop capabilities in the child.
2008 pid_t pid = fork();
2009 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002010 /* child -- drop privileges before continuing */
2011 drop_capabilities(uid);
2012
2013 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2014 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2015 uid, storage_flag)) {
2016 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2017 _exit(kReconcileSecondaryDexValidationError);
2018 }
2019
2020 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2021 switch (access_check) {
2022 case kSecondaryDexAccessDoesNotExist:
2023 // File does not exist. Proceed with cleaning.
2024 break;
2025 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2026 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2027 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2028 default:
2029 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2030 _exit(kReconcileSecondaryDexValidationError);
2031 }
2032
2033 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002034 char oat_path[PKG_PATH_MAX];
2035 char oat_dir[PKG_PATH_MAX];
2036 char oat_isa_dir[PKG_PATH_MAX];
2037 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002038 for (size_t i = 0; i < isas.size(); i++) {
Calin Juravle7d765462017-09-04 15:57:10 -07002039 if (!create_secondary_dex_oat_layout(
2040 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path)) {
2041 LOG(ERROR) << "Could not create secondary odex layout: " << dex_path;
2042 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002043 }
Calin Juravle51314092017-05-18 15:33:05 -07002044
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002045 // Delete oat/vdex/art files.
2046 result = unlink_if_exists(oat_path) && result;
2047 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2048 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002049
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002050 // Delete profiles.
2051 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002052 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002053 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002054 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002055 result = unlink_if_exists(current_profile) && result;
2056 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002057
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002058 // We upgraded once the location of current profile for secondary dex files.
2059 // Check for any previous left-overs and remove them as well.
2060 std::string old_current_profile = dex_path + ".prof";
2061 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002062
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002063 // Try removing the directories as well, they might be empty.
2064 result = rmdir_if_empty(oat_isa_dir) && result;
2065 result = rmdir_if_empty(oat_dir) && result;
2066 }
Calin Juravle7d765462017-09-04 15:57:10 -07002067 if (!result) {
2068 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2069 }
2070 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002071 }
2072
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002073 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002074 if (!WIFEXITED(return_code)) {
2075 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2076 } else {
2077 return_code = WEXITSTATUS(return_code);
2078 }
2079
2080 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2081
2082 switch (return_code) {
2083 case kReconcileSecondaryDexCleanedUp:
2084 case kReconcileSecondaryDexValidationError:
2085 // If we couldn't validate assume the dex file does not exist.
2086 // This will purge the entry from the PM records.
2087 *out_secondary_dex_exists = false;
2088 return true;
2089 case kReconcileSecondaryDexExists:
2090 *out_secondary_dex_exists = true;
2091 return true;
2092 case kReconcileSecondaryDexAccessIOError:
2093 // We had an access IO error.
2094 // Return false so that we can try again.
2095 // The value of out_secondary_dex_exists does not matter in this case and by convention
2096 // is set to false.
2097 *out_secondary_dex_exists = false;
2098 return false;
2099 default:
2100 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2101 *out_secondary_dex_exists = false;
2102 return false;
2103 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002104}
2105
Alan Stokesa25d90c2017-10-16 10:56:00 +01002106// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2107// Returns true if all parameters are valid and the hash successfully computed and stored in
2108// out_secondary_dex_hash.
2109// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2110// the app.
2111// For any other errors (e.g. if any of the parameters are invalid) returns false.
2112bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2113 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2114 std::vector<uint8_t>* out_secondary_dex_hash) {
2115 out_secondary_dex_hash->clear();
2116
2117 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2118
2119 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2120 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2121 << storage_flag;
2122 return false;
2123 }
2124
2125 // Pipe to get the hash result back from our child process.
2126 unique_fd pipe_read, pipe_write;
2127 if (!Pipe(&pipe_read, &pipe_write)) {
2128 PLOG(ERROR) << "Failed to create pipe";
2129 return false;
2130 }
2131
2132 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2133 // access data the app itself can access.
2134 pid_t pid = fork();
2135 if (pid == 0) {
2136 // child -- drop privileges before continuing
2137 drop_capabilities(uid);
2138 pipe_read.reset();
2139
2140 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2141 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2142 _exit(1);
2143 }
2144
2145 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2146 if (fd == -1) {
2147 if (errno == EACCES || errno == ENOENT) {
2148 // Not treated as an error.
2149 _exit(0);
2150 }
2151 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
2152 _exit(1);
2153 }
2154
2155 SHA256_CTX ctx;
2156 SHA256_Init(&ctx);
2157
2158 std::vector<uint8_t> buffer(65536);
2159 while (true) {
2160 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2161 if (bytes_read == 0) {
2162 break;
2163 } else if (bytes_read == -1) {
2164 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
2165 _exit(1);
2166 }
2167
2168 SHA256_Update(&ctx, buffer.data(), bytes_read);
2169 }
2170
2171 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2172 SHA256_Final(hash.data(), &ctx);
2173 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
2174 _exit(1);
2175 }
2176
2177 _exit(0);
2178 }
2179
2180 // parent
2181 pipe_write.reset();
2182
2183 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2184 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2185 out_secondary_dex_hash->clear();
2186 }
2187 return wait_child(pid) == 0;
2188}
2189
Jeff Sharkey90aff262016-12-12 14:28:24 -07002190// Helper for move_ab, so that we can have common failure-case cleanup.
2191static bool unlink_and_rename(const char* from, const char* to) {
2192 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2193 // return a failure.
2194 struct stat s;
2195 if (stat(to, &s) == 0) {
2196 if (!S_ISREG(s.st_mode)) {
2197 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2198 return false;
2199 }
2200 if (unlink(to) != 0) {
2201 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2202 return false;
2203 }
2204 } else {
2205 // This may be a permission problem. We could investigate the error code, but we'll just
2206 // let the rename failure do the work for us.
2207 }
2208
2209 // Try to rename "to" to "from."
2210 if (rename(from, to) != 0) {
2211 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2212 return false;
2213 }
2214 return true;
2215}
2216
2217// Move/rename a B artifact (from) to an A artifact (to).
2218static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2219 // Check whether B exists.
2220 {
2221 struct stat s;
2222 if (stat(b_path.c_str(), &s) != 0) {
2223 // Silently ignore for now. The service calling this isn't smart enough to understand
2224 // lack of artifacts at the moment.
2225 return false;
2226 }
2227 if (!S_ISREG(s.st_mode)) {
2228 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2229 // Try to unlink, but swallow errors.
2230 unlink(b_path.c_str());
2231 return false;
2232 }
2233 }
2234
2235 // Rename B to A.
2236 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2237 // Delete the b_path so we don't try again (or fail earlier).
2238 if (unlink(b_path.c_str()) != 0) {
2239 PLOG(ERROR) << "Could not unlink " << b_path;
2240 }
2241
2242 return false;
2243 }
2244
2245 return true;
2246}
2247
2248bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2249 // Get the current slot suffix. No suffix, no A/B.
2250 std::string slot_suffix;
2251 {
2252 char buf[kPropertyValueMax];
2253 if (get_property("ro.boot.slot_suffix", buf, nullptr) <= 0) {
2254 return false;
2255 }
2256 slot_suffix = buf;
2257
2258 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2259 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2260 return false;
2261 }
2262 }
2263
2264 // Validate other inputs.
2265 if (validate_apk_path(apk_path) != 0) {
2266 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2267 return false;
2268 }
2269 if (validate_apk_path(oat_dir) != 0) {
2270 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2271 return false;
2272 }
2273
2274 char a_path[PKG_PATH_MAX];
2275 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2276 return false;
2277 }
2278 const std::string a_vdex_path = create_vdex_filename(a_path);
2279 const std::string a_image_path = create_image_filename(a_path);
2280
2281 // B path = A path + slot suffix.
2282 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2283 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2284 const std::string b_image_path = StringPrintf("%s.%s",
2285 a_image_path.c_str(),
2286 slot_suffix.c_str());
2287
2288 bool success = true;
2289 if (move_ab_path(b_path, a_path)) {
2290 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2291 // Note: we can live without an app image. As such, ignore failure to move the image file.
2292 // If we decide to require the app image, or the app image being moved correctly,
2293 // then change accordingly.
2294 constexpr bool kIgnoreAppImageFailure = true;
2295
2296 if (!a_image_path.empty()) {
2297 if (!move_ab_path(b_image_path, a_image_path)) {
2298 unlink(a_image_path.c_str());
2299 if (!kIgnoreAppImageFailure) {
2300 success = false;
2301 }
2302 }
2303 }
2304 } else {
2305 // Cleanup: delete B image, ignore errors.
2306 unlink(b_image_path.c_str());
2307 success = false;
2308 }
2309 } else {
2310 // Cleanup: delete B image, ignore errors.
2311 unlink(b_vdex_path.c_str());
2312 unlink(b_image_path.c_str());
2313 success = false;
2314 }
2315 return success;
2316}
2317
2318bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2319 // Delete the oat/odex file.
2320 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002321 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002322 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002323 return false;
2324 }
2325
2326 // In case of a permission failure report the issue. Otherwise just print a warning.
2327 auto unlink_and_check = [](const char* path) -> bool {
2328 int result = unlink(path);
2329 if (result != 0) {
2330 if (errno == EACCES || errno == EPERM) {
2331 PLOG(ERROR) << "Could not unlink " << path;
2332 return false;
2333 }
2334 PLOG(WARNING) << "Could not unlink " << path;
2335 }
2336 return true;
2337 };
2338
2339 // Delete the oat/odex file.
2340 bool return_value_oat = unlink_and_check(out_path);
2341
2342 // Derive and delete the app image.
2343 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2344
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002345 // Derive and delete the vdex file.
2346 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2347
Jeff Sharkey90aff262016-12-12 14:28:24 -07002348 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002349 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002350}
2351
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002352static bool is_absolute_path(const std::string& path) {
2353 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2354 LOG(ERROR) << "Invalid absolute path " << path;
2355 return false;
2356 } else {
2357 return true;
2358 }
2359}
2360
2361static bool is_valid_instruction_set(const std::string& instruction_set) {
2362 // TODO: add explicit whitelisting of instruction sets
2363 if (instruction_set.find('/') != std::string::npos) {
2364 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2365 return false;
2366 } else {
2367 return true;
2368 }
2369}
2370
2371bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2372 const char *apk_path, const char *instruction_set) {
2373 std::string oat_dir_ = oat_dir;
2374 std::string apk_path_ = apk_path;
2375 std::string instruction_set_ = instruction_set;
2376
2377 if (!is_absolute_path(oat_dir_)) return false;
2378 if (!is_absolute_path(apk_path_)) return false;
2379 if (!is_valid_instruction_set(instruction_set_)) return false;
2380
2381 std::string::size_type end = apk_path_.rfind('.');
2382 std::string::size_type start = apk_path_.rfind('/', end);
2383 if (end == std::string::npos || start == std::string::npos) {
2384 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2385 return false;
2386 }
2387
2388 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2389 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2390 const char* res = res_.c_str();
2391 if (strlen(res) >= PKG_PATH_MAX) {
2392 LOG(ERROR) << "Result too large";
2393 return false;
2394 } else {
2395 strlcpy(path, res, PKG_PATH_MAX);
2396 return true;
2397 }
2398}
2399
2400bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2401 const char *instruction_set) {
2402 std::string apk_path_ = apk_path;
2403 std::string instruction_set_ = instruction_set;
2404
2405 if (!is_absolute_path(apk_path_)) return false;
2406 if (!is_valid_instruction_set(instruction_set_)) return false;
2407
2408 std::string::size_type end = apk_path_.rfind('.');
2409 std::string::size_type start = apk_path_.rfind('/', end);
2410 if (end == std::string::npos || start == std::string::npos) {
2411 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2412 return false;
2413 }
2414
2415 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2416 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2417}
2418
2419bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2420 const char *instruction_set) {
2421 std::string src_ = src;
2422 std::string instruction_set_ = instruction_set;
2423
2424 if (!is_absolute_path(src_)) return false;
2425 if (!is_valid_instruction_set(instruction_set_)) return false;
2426
2427 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2428 if (*it == '/') {
2429 *it = '@';
2430 }
2431 }
2432
2433 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2434 + DALVIK_CACHE_POSTFIX;
2435 const char* res = res_.c_str();
2436 if (strlen(res) >= PKG_PATH_MAX) {
2437 LOG(ERROR) << "Result too large";
2438 return false;
2439 } else {
2440 strlcpy(path, res, PKG_PATH_MAX);
2441 return true;
2442 }
2443}
2444
Calin Juravlec3596c32017-12-05 12:29:15 -08002445bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -08002446 const std::string& profile_name) {
Calin Juravle29591732017-11-20 17:46:19 -08002447 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2448
Calin Juravle824a64d2018-01-18 20:23:17 -08002449 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002450 if (snapshot_fd < 0) {
2451 return false;
2452 }
2453
2454 std::vector<unique_fd> profiles_fd;
2455 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002456 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2457 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002458 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2459 return false;
2460 }
2461
2462 profiles_fd.push_back(std::move(reference_profile_fd));
2463
2464 pid_t pid = fork();
2465 if (pid == 0) {
2466 /* child -- drop privileges before continuing */
2467 drop_capabilities(app_shared_gid);
2468 run_profman_merge(profiles_fd, snapshot_fd);
2469 exit(42); /* only get here on exec failure */
2470 }
2471
2472 /* parent */
2473 int return_code = wait_child(pid);
2474 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002475 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002476 return false;
2477 }
2478
2479 return true;
2480}
2481
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002482} // namespace installd
2483} // namespace android