blob: 37f51e0d9a65a8410bc1cf02a9057188988d7aec [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 Stokes753dc712017-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 Stokes753dc712017-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 Stokes753dc712017-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 Stokes753dc712017-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 Juravlecfcd6aa2018-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 Juravlecfcd6aa2018-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 Juravlecfcd6aa2018-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 Juravlecfcd6aa2018-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 Juravlecfcd6aa2018-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 Juravlecfcd6aa2018-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 Brazdil570d3982018-01-16 20:15:43 +0000226 const char* class_loader_context, int target_sdk_version) {
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)
452 + (target_sdk_version != 0 ? 2 : 0)];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700453 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700454 argv[i++] = dex2oat_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700455 argv[i++] = zip_fd_arg;
456 argv[i++] = zip_location_arg;
457 argv[i++] = input_vdex_fd_arg;
458 argv[i++] = output_vdex_fd_arg;
459 argv[i++] = oat_fd_arg;
460 argv[i++] = oat_location_arg;
461 argv[i++] = instruction_set_arg;
462 if (have_dex2oat_isa_variant) {
463 argv[i++] = instruction_set_variant_arg;
464 }
465 if (have_dex2oat_isa_features) {
466 argv[i++] = instruction_set_features_arg;
467 }
468 if (have_dex2oat_Xms_flag) {
469 argv[i++] = RUNTIME_ARG;
470 argv[i++] = dex2oat_Xms_arg;
471 }
472 if (have_dex2oat_Xmx_flag) {
473 argv[i++] = RUNTIME_ARG;
474 argv[i++] = dex2oat_Xmx_arg;
475 }
476 if (have_dex2oat_compiler_filter_flag) {
477 argv[i++] = dex2oat_compiler_filter_arg;
478 }
479 if (have_dex2oat_threads_flag) {
480 argv[i++] = dex2oat_threads_arg;
481 }
482 if (have_dex2oat_swap_fd) {
483 argv[i++] = dex2oat_swap_fd;
484 }
485 if (have_dex2oat_image_fd) {
486 argv[i++] = dex2oat_image_fd;
487 }
488 if (generate_debug_info) {
489 argv[i++] = "--generate-debug-info";
490 }
491 if (debuggable) {
492 argv[i++] = "--debuggable";
493 }
494 if (have_app_image_format) {
495 argv[i++] = image_format_arg;
496 }
497 if (have_dex2oat_large_app_threshold) {
498 argv[i++] = dex2oat_large_app_threshold_arg;
499 }
500 if (dex2oat_flags_count) {
501 i += split(dex2oat_flags, argv + i);
502 }
503 if (have_dex2oat_relocation_skip_flag) {
504 argv[i++] = RUNTIME_ARG;
505 argv[i++] = dex2oat_norelocation;
506 }
507 if (profile_fd != -1) {
508 argv[i++] = profile_arg;
509 }
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700510 if (has_base_dir) {
511 argv[i++] = base_dir;
512 }
Calin Juravle52c45822017-07-13 22:50:21 -0700513 if (class_loader_context != nullptr) {
514 argv[i++] = class_loader_context_arg;
515 }
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700516 if (generate_minidebug_info) {
517 argv[i++] = kMinidebugDex2oatFlag;
518 }
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800519 if (disable_cdex) {
520 argv[i++] = kDisableCompactDexFlag;
521 }
David Brazdil570d3982018-01-16 20:15:43 +0000522 if (target_sdk_version != 0) {
523 argv[i++] = RUNTIME_ARG;
524 argv[i++] = target_sdk_version_arg;
525 }
Calin Juravle52c45822017-07-13 22:50:21 -0700526
Jeff Sharkey90aff262016-12-12 14:28:24 -0700527 // Do not add after dex2oat_flags, they should override others for debugging.
528 argv[i] = NULL;
529
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700530 execv(dex2oat_bin, (char * const *)argv);
531 ALOGE("execv(%s) failed: %s\n", dex2oat_bin, strerror(errno));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700532}
533
534/*
535 * Whether dexopt should use a swap file when compiling an APK.
536 *
537 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
538 * itself, anyways).
539 *
540 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
541 *
542 * Otherwise, return true if this is a low-mem device.
543 *
544 * Otherwise, return default value.
545 */
546static bool kAlwaysProvideSwapFile = false;
547static bool kDefaultProvideSwapFile = true;
548
549static bool ShouldUseSwapFileForDexopt() {
550 if (kAlwaysProvideSwapFile) {
551 return true;
552 }
553
554 // Check the "override" property. If it exists, return value == "true".
555 char dex2oat_prop_buf[kPropertyValueMax];
556 if (get_property("dalvik.vm.dex2oat-swap", dex2oat_prop_buf, "") > 0) {
557 if (strcmp(dex2oat_prop_buf, "true") == 0) {
558 return true;
559 } else {
560 return false;
561 }
562 }
563
564 // Shortcut for default value. This is an implementation optimization for the process sketched
565 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
566 // as low-mem is never returning false. The compiler will optimize this away if it can.
567 if (kDefaultProvideSwapFile) {
568 return true;
569 }
570
571 bool is_low_mem = property_get_bool("ro.config.low_ram", false);
572 if (is_low_mem) {
573 return true;
574 }
575
576 // Default value must be false here.
577 return kDefaultProvideSwapFile;
578}
579
Richard Uhler76cc0272016-12-08 10:46:35 +0000580static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700581 if (set_to_bg) {
582 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
583 ALOGE("set_sched_policy failed: %s\n", strerror(errno));
584 exit(70);
585 }
586 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
587 ALOGE("setpriority failed: %s\n", strerror(errno));
588 exit(71);
589 }
590 }
591}
592
Calin Juravle29591732017-11-20 17:46:19 -0800593static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
594 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800595 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800596 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800597 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800598 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800599 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700600 }
Calin Juravle114f0812017-03-08 19:05:07 -0800601 // Profiles should belong to the app; make sure of that by giving ownership to
602 // the app uid. If we cannot do that, there's no point in returning the fd
603 // since dex2oat/profman will fail with SElinux denials.
604 if (fchown(fd.get(), uid, uid) < 0) {
605 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800606 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800607 }
Calin Juravle29591732017-11-20 17:46:19 -0800608 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800609}
610
Calin Juravle29591732017-11-20 17:46:19 -0800611static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800612 // Do not follow symlinks when opening a profile:
613 // - primary profiles should not contain symlinks in their paths
614 // - secondary dex paths should have been already resolved and validated
615 flags |= O_NOFOLLOW;
616
Calin Juravle29591732017-11-20 17:46:19 -0800617 // Check if we need to create the profile
618 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
619 unique_fd fd;
620 if ((flags & O_CREAT) != 0) {
621 fd = create_profile(uid, profile, flags);
622 } else {
623 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
624 }
625
Calin Juravle114f0812017-03-08 19:05:07 -0800626 if (fd.get() < 0) {
627 if (errno != ENOENT) {
628 // Profiles might be missing for various reasons. For example, in a
629 // multi-user environment, the profile directory for one user can be created
630 // after we start a merge. In this case the current profile for that user
631 // will not be found.
632 // Also, the secondary dex profiles might be deleted by the app at any time,
633 // so we can't we need to prepare if they are missing.
634 PLOG(ERROR) << "Failed to open profile " << profile;
635 }
636 return invalid_unique_fd();
637 }
638
Jeff Sharkey90aff262016-12-12 14:28:24 -0700639 return fd;
640}
641
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800642static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
643 const std::string& location, bool is_secondary_dex) {
644 std::string profile = create_current_profile_path(user, package_name, location,
645 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800646 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800647}
648
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800649static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
650 const std::string& location, bool read_write, bool is_secondary_dex) {
651 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800652 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
653}
654
655static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800656 const std::string& location) {
657 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800658 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800659}
660
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800661static void open_profile_files(uid_t uid, const std::string& package_name,
662 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800663 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700664 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800665 *reference_profile_fd = open_reference_profile(uid, package_name, location,
666 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700667
Calin Juravle114f0812017-03-08 19:05:07 -0800668 // For secondary dex files, we don't really need the user but we use it for sanity checks.
669 // Note: the user owning the dex file should be the current user.
670 std::vector<userid_t> users;
671 if (is_secondary_dex){
672 users.push_back(multiuser_get_user_id(uid));
673 } else {
674 users = get_known_users(/*volume_uuid*/ nullptr);
675 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700676 for (auto user : users) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800677 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
678 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700679 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800680 if (profile_fd.get() >= 0) {
681 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700682 }
683 }
684}
685
686static void drop_capabilities(uid_t uid) {
687 if (setgid(uid) != 0) {
688 ALOGE("setgid(%d) failed in installd during dexopt\n", uid);
689 exit(64);
690 }
691 if (setuid(uid) != 0) {
692 ALOGE("setuid(%d) failed in installd during dexopt\n", uid);
693 exit(65);
694 }
695 // drop capabilities
696 struct __user_cap_header_struct capheader;
697 struct __user_cap_data_struct capdata[2];
698 memset(&capheader, 0, sizeof(capheader));
699 memset(&capdata, 0, sizeof(capdata));
700 capheader.version = _LINUX_CAPABILITY_VERSION_3;
701 if (capset(&capheader, &capdata[0]) < 0) {
702 ALOGE("capset failed: %s\n", strerror(errno));
703 exit(66);
704 }
705}
706
707static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
708static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
709static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
710static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
711static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
712
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800713static void run_profman_merge(const std::vector<unique_fd>& profiles_fd,
714 const unique_fd& reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700715 static const size_t MAX_INT_LEN = 32;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700716 const char* profman_bin = is_debug_runtime() ? "/system/bin/profmand" : "/system/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700717
718 std::vector<std::string> profile_args(profiles_fd.size());
719 char profile_buf[strlen("--profile-file-fd=") + MAX_INT_LEN];
720 for (size_t k = 0; k < profiles_fd.size(); k++) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800721 sprintf(profile_buf, "--profile-file-fd=%d", profiles_fd[k].get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700722 profile_args[k].assign(profile_buf);
723 }
724 char reference_profile_arg[strlen("--reference-profile-file-fd=") + MAX_INT_LEN];
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800725 sprintf(reference_profile_arg, "--reference-profile-file-fd=%d", reference_profile_fd.get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700726
727 // program name, reference profile fd, the final NULL and the profile fds
728 const char* argv[3 + profiles_fd.size()];
729 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700730 argv[i++] = profman_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700731 argv[i++] = reference_profile_arg;
732 for (size_t k = 0; k < profile_args.size(); k++) {
733 argv[i++] = profile_args[k].c_str();
734 }
735 // Do not add after dex2oat_flags, they should override others for debugging.
736 argv[i] = NULL;
737
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700738 execv(profman_bin, (char * const *)argv);
739 ALOGE("execv(%s) failed: %s\n", profman_bin, strerror(errno));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700740 exit(68); /* only get here on exec failure */
741}
742
743// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800744// The location is the package name for primary apks or the dex path for secondary dex files.
745// Returns true if there is enough information in the current profiles that makes it
746// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700747// If the return value is true all the current profiles would have been merged into
748// the reference profiles accessible with open_reference_profile().
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800749static bool analyze_profiles(uid_t uid, const std::string& package_name,
750 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800751 std::vector<unique_fd> profiles_fd;
752 unique_fd reference_profile_fd;
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800753 open_profile_files(uid, package_name, location, is_secondary_dex,
754 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800755 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700756 // Skip profile guided compilation because no profiles were found.
757 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700758 return false;
759 }
760
Jeff Sharkey90aff262016-12-12 14:28:24 -0700761 pid_t pid = fork();
762 if (pid == 0) {
763 /* child -- drop privileges before continuing */
764 drop_capabilities(uid);
765 run_profman_merge(profiles_fd, reference_profile_fd);
766 exit(68); /* only get here on exec failure */
767 }
768 /* parent */
769 int return_code = wait_child(pid);
770 bool need_to_compile = false;
771 bool should_clear_current_profiles = false;
772 bool should_clear_reference_profile = false;
773 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800774 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700775 } else {
776 return_code = WEXITSTATUS(return_code);
777 switch (return_code) {
778 case PROFMAN_BIN_RETURN_CODE_COMPILE:
779 need_to_compile = true;
780 should_clear_current_profiles = true;
781 should_clear_reference_profile = false;
782 break;
783 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
784 need_to_compile = false;
785 should_clear_current_profiles = false;
786 should_clear_reference_profile = false;
787 break;
788 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800789 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700790 need_to_compile = false;
791 should_clear_current_profiles = true;
792 should_clear_reference_profile = true;
793 break;
794 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
795 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
796 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800797 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700798 need_to_compile = false;
799 should_clear_current_profiles = false;
800 should_clear_reference_profile = false;
801 break;
802 default:
803 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800804 LOG(WARNING) << "Unknown error code while processing profiles for location "
805 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700806 need_to_compile = false;
807 should_clear_current_profiles = true;
808 should_clear_reference_profile = true;
809 break;
810 }
811 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800812
Jeff Sharkey90aff262016-12-12 14:28:24 -0700813 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800814 if (is_secondary_dex) {
815 // For secondary dex files, the owning user is the current user.
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800816 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
817 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800818 } else {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800819 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800820 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700821 }
822 if (should_clear_reference_profile) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800823 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700824 }
825 return need_to_compile;
826}
827
Calin Juravle114f0812017-03-08 19:05:07 -0800828// Decides if profile guided compilation is needed or not based on existing profiles.
829// The analysis is done for the primary apks of the given package.
830// Returns true if there is enough information in the current profiles that makes it
831// worth to recompile the package.
832// If the return value is true all the current profiles would have been merged into
833// the reference profiles accessible with open_reference_profile().
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800834bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
835 const std::string& profile_name) {
836 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800837}
838
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800839static void run_profman_dump(const std::vector<unique_fd>& profile_fds,
840 const unique_fd& reference_profile_fd,
Jeff Sharkey90aff262016-12-12 14:28:24 -0700841 const std::vector<std::string>& dex_locations,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800842 const std::vector<unique_fd>& apk_fds,
843 const unique_fd& output_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700844 std::vector<std::string> profman_args;
845 static const char* PROFMAN_BIN = "/system/bin/profman";
846 profman_args.push_back(PROFMAN_BIN);
847 profman_args.push_back("--dump-only");
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800848 profman_args.push_back(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700849 if (reference_profile_fd != -1) {
850 profman_args.push_back(StringPrintf("--reference-profile-file-fd=%d",
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800851 reference_profile_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700852 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800853 for (size_t i = 0; i < profile_fds.size(); i++) {
854 profman_args.push_back(StringPrintf("--profile-file-fd=%d", profile_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700855 }
856 for (const std::string& dex_location : dex_locations) {
857 profman_args.push_back(StringPrintf("--dex-location=%s", dex_location.c_str()));
858 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800859 for (size_t i = 0; i < apk_fds.size(); i++) {
860 profman_args.push_back(StringPrintf("--apk-fd=%d", apk_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700861 }
862 const char **argv = new const char*[profman_args.size() + 1];
863 size_t i = 0;
864 for (const std::string& profman_arg : profman_args) {
865 argv[i++] = profman_arg.c_str();
866 }
867 argv[i] = NULL;
868
869 execv(PROFMAN_BIN, (char * const *)argv);
870 ALOGE("execv(%s) failed: %s\n", PROFMAN_BIN, strerror(errno));
871 exit(68); /* only get here on exec failure */
872}
873
Calin Juravle76268c52017-03-09 13:19:42 -0800874bool dump_profiles(int32_t uid, const std::string& pkgname, const char* code_paths) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800875 std::vector<unique_fd> profile_fds;
876 unique_fd reference_profile_fd;
Calin Juravle76268c52017-03-09 13:19:42 -0800877 std::string out_file_name = StringPrintf("/data/misc/profman/%s.txt", pkgname.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700878
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800879 // TODO(calin): get the profile name as a parameter.
880 open_profile_files(uid, pkgname, "primary.prof", /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800881 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700882
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800883 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700884 const bool has_profiles = !profile_fds.empty();
885
886 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800887 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700888 return false;
889 }
890
Calin Juravle114f0812017-03-08 19:05:07 -0800891 unique_fd output_fd(open(out_file_name.c_str(),
892 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700893 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
894 ALOGE("installd cannot chmod '%s' dump_profile\n", out_file_name.c_str());
895 return false;
896 }
897 std::vector<std::string> code_full_paths = base::Split(code_paths, ";");
898 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800899 std::vector<unique_fd> apk_fds;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700900 for (const std::string& code_full_path : code_full_paths) {
901 const char* full_path = code_full_path.c_str();
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800902 unique_fd apk_fd(open(full_path, O_RDONLY | O_NOFOLLOW));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700903 if (apk_fd == -1) {
904 ALOGE("installd cannot open '%s'\n", full_path);
905 return false;
906 }
907 dex_locations.push_back(get_location_from_path(full_path));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800908 apk_fds.push_back(std::move(apk_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700909 }
910
911 pid_t pid = fork();
912 if (pid == 0) {
913 /* child -- drop privileges before continuing */
914 drop_capabilities(uid);
915 run_profman_dump(profile_fds, reference_profile_fd, dex_locations,
916 apk_fds, output_fd);
917 exit(68); /* only get here on exec failure */
918 }
919 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700920 int return_code = wait_child(pid);
921 if (!WIFEXITED(return_code)) {
922 LOG(WARNING) << "profman failed for package " << pkgname << ": "
923 << return_code;
924 return false;
925 }
926 return true;
927}
928
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700929bool copy_system_profile(const std::string& system_profile,
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800930 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700931 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
932 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800933 package_name,
934 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700935 /*read_write*/ true,
936 /*secondary*/ false));
937 if (in_fd.get() < 0) {
938 PLOG(WARNING) << "Could not open profile " << system_profile;
939 return false;
940 }
941 if (out_fd.get() < 0) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800942 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700943 return false;
944 }
945
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700946 // As a security measure we want to write the profile information with the reduced capabilities
947 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700948 pid_t pid = fork();
949 if (pid == 0) {
950 /* child -- drop privileges before continuing */
951 drop_capabilities(packageUid);
952
953 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
954 if (errno != EWOULDBLOCK) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800955 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700956 }
957 // This implies that the app owning this profile is running
958 // (and has acquired the lock).
959 //
960 // The app never acquires the lock for the reference profiles of primary apks.
961 // Only dex2oat from installd will do that. Since installd is single threaded
962 // we should not see this case. Nevertheless be prepared for it.
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800963 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700964 return false;
965 }
966
967 bool truncated = ftruncate(out_fd.get(), 0) == 0;
968 if (!truncated) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800969 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700970 }
971
972 // Copy over data.
973 static constexpr size_t kBufferSize = 4 * 1024;
974 char buffer[kBufferSize];
975 while (true) {
976 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
977 if (bytes == 0) {
978 break;
979 }
980 write(out_fd.get(), buffer, bytes);
981 }
982 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -0800983 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700984 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700985 // Use _exit since we don't want to run the global destructors in the child.
986 // b/62597429
987 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700988 }
989 /* parent */
990 int return_code = wait_child(pid);
991 return return_code == 0;
992}
993
Jeff Sharkey90aff262016-12-12 14:28:24 -0700994static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
995 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
996 if (EndsWith(oat_path, ".dex")) {
997 std::string new_path = oat_path;
998 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800999 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -07001000 return new_path;
1001 }
1002
1003 // An odex entry. Not that this may not be an extension, e.g., in the OTA
1004 // case (where the base name will have an extension for the B artifact).
1005 size_t odex_pos = oat_path.rfind(".odex");
1006 if (odex_pos != std::string::npos) {
1007 std::string new_path = oat_path;
1008 new_path.replace(odex_pos, strlen(".odex"), new_ext);
1009 CHECK_NE(new_path.find(new_ext), std::string::npos);
1010 return new_path;
1011 }
1012
1013 // Don't know how to handle this.
1014 return "";
1015}
1016
1017// Translate the given oat path to an art (app image) path. An empty string
1018// denotes an error.
1019static std::string create_image_filename(const std::string& oat_path) {
1020 return replace_file_extension(oat_path, ".art");
1021}
1022
1023// Translate the given oat path to a vdex path. An empty string denotes an error.
1024static std::string create_vdex_filename(const std::string& oat_path) {
1025 return replace_file_extension(oat_path, ".vdex");
1026}
1027
Jeff Sharkey90aff262016-12-12 14:28:24 -07001028static int open_output_file(const char* file_name, bool recreate, int permissions) {
1029 int flags = O_RDWR | O_CREAT;
1030 if (recreate) {
1031 if (unlink(file_name) < 0) {
1032 if (errno != ENOENT) {
1033 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1034 }
1035 }
1036 flags |= O_EXCL;
1037 }
1038 return open(file_name, flags, permissions);
1039}
1040
Calin Juravle2289c0a2017-02-15 12:44:14 -08001041static bool set_permissions_and_ownership(
1042 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1043 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1044 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001045 if (fchmod(fd,
1046 S_IRUSR|S_IWUSR|S_IRGRP |
1047 (is_public ? S_IROTH : 0)) < 0) {
1048 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1049 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001050 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001051 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1052 return false;
1053 }
1054 return true;
1055}
1056
1057static bool IsOutputDalvikCache(const char* oat_dir) {
1058 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1059 // into '!'. Play it safe by handling it both.
1060 // TODO: ensure we never get null.
1061 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1062 return oat_dir == nullptr || oat_dir[0] == '!';
1063}
1064
Calin Juravled23dee72017-07-06 16:29:11 -07001065// Best-effort check whether we can fit the the path into our buffers.
1066// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1067// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1068// extension to the cache path (5 bytes).
1069// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1070static bool validate_dex_path_size(const std::string& dex_path) {
1071 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1072 LOG(ERROR) << "dex_path too long: " << dex_path;
1073 return false;
1074 }
1075 return true;
1076}
1077
Jeff Sharkey90aff262016-12-12 14:28:24 -07001078static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001079 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001080 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001081 return false;
1082 }
1083
1084 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001085 // Oat dirs for secondary dex files are already validated.
1086 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001087 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1088 return false;
1089 }
1090 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1091 return false;
1092 }
1093 } else {
1094 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1095 return false;
1096 }
1097 }
1098 return true;
1099}
1100
1101// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1102// on destruction. It will also run the given cleanup (unless told not to) after closing.
1103//
1104// Usage example:
1105//
Calin Juravle7a570e82017-01-14 16:23:30 -08001106// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001107// [name]() {
1108// unlink(name.c_str());
1109// });
1110// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1111// wrapper if captured as a reference.
1112//
1113// if (file.get() == -1) {
1114// // Error opening...
1115// }
1116//
1117// ...
1118// if (error) {
1119// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1120// // and delete the file (after the fd is closed).
1121// return -1;
1122// }
1123//
1124// (Success case)
1125// file.SetCleanup(false);
1126// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1127// // (leaving the file around; after the fd is closed).
1128//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001129class Dex2oatFileWrapper {
1130 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001131 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001132 }
1133
Calin Juravle7a570e82017-01-14 16:23:30 -08001134 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1135 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1136
1137 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1138 value_ = other.value_;
1139 cleanup_ = other.cleanup_;
1140 do_cleanup_ = other.do_cleanup_;
1141 auto_close_ = other.auto_close_;
1142 other.release();
1143 }
1144
1145 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1146 value_ = other.value_;
1147 cleanup_ = other.cleanup_;
1148 do_cleanup_ = other.do_cleanup_;
1149 auto_close_ = other.auto_close_;
1150 other.release();
1151 return *this;
1152 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001153
1154 ~Dex2oatFileWrapper() {
1155 reset(-1);
1156 }
1157
1158 int get() {
1159 return value_;
1160 }
1161
1162 void SetCleanup(bool cleanup) {
1163 do_cleanup_ = cleanup;
1164 }
1165
1166 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001167 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001168 close(value_);
1169 }
1170 if (do_cleanup_ && cleanup_ != nullptr) {
1171 cleanup_();
1172 }
1173
1174 value_ = new_value;
1175 }
1176
Calin Juravle7a570e82017-01-14 16:23:30 -08001177 void reset(int new_value, std::function<void ()> new_cleanup) {
1178 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001179 close(value_);
1180 }
1181 if (do_cleanup_ && cleanup_ != nullptr) {
1182 cleanup_();
1183 }
1184
1185 value_ = new_value;
1186 cleanup_ = new_cleanup;
1187 }
1188
Calin Juravle7a570e82017-01-14 16:23:30 -08001189 void DisableAutoClose() {
1190 auto_close_ = false;
1191 }
1192
Jeff Sharkey90aff262016-12-12 14:28:24 -07001193 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001194 void release() {
1195 value_ = -1;
1196 do_cleanup_ = false;
1197 cleanup_ = nullptr;
1198 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001199 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001200 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001201 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001202 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001203};
1204
Calin Juravle7a570e82017-01-14 16:23:30 -08001205// (re)Creates the app image if needed.
1206Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path, bool profile_guided,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001207 bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001208
1209 // We don't create an image for secondary dex files.
1210 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001211 return Dex2oatFileWrapper();
1212 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001213
Calin Juravle7a570e82017-01-14 16:23:30 -08001214 const std::string image_path = create_image_filename(out_oat_path);
1215 if (image_path.empty()) {
1216 // Happens when the out_oat_path has an unknown extension.
1217 return Dex2oatFileWrapper();
1218 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001219
1220 // Use app images only if it is enabled (by a set image format) and we are compiling
1221 // profile-guided (so the app image doesn't conservatively contain all classes).
1222 if (!profile_guided) {
1223 // In case there is a stale image, remove it now. Ignore any error.
1224 unlink(image_path.c_str());
1225 return Dex2oatFileWrapper();
1226 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001227 char app_image_format[kPropertyValueMax];
1228 bool have_app_image_format =
1229 get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
1230 if (!have_app_image_format) {
1231 return Dex2oatFileWrapper();
1232 }
1233 // Recreate is true since we do not want to modify a mapped image. If the app is
1234 // already running and we modify the image file, it can cause crashes (b/27493510).
1235 Dex2oatFileWrapper wrapper_fd(
1236 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1237 [image_path]() { unlink(image_path.c_str()); });
1238 if (wrapper_fd.get() < 0) {
1239 // Could not create application image file. Go on since we can compile without it.
1240 LOG(ERROR) << "installd could not create '" << image_path
1241 << "' for image file during dexopt";
1242 // If we have a valid image file path but no image fd, explicitly erase the image file.
1243 if (unlink(image_path.c_str()) < 0) {
1244 if (errno != ENOENT) {
1245 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1246 }
1247 }
1248 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001249 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001250 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1251 wrapper_fd.reset(-1);
1252 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001253
Calin Juravle7a570e82017-01-14 16:23:30 -08001254 return wrapper_fd;
1255}
1256
1257// Creates the dexopt swap file if necessary and return its fd.
1258// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001259unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001260 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001261 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001262 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001263 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001264 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001265 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001266 if (swap_fd.get() < 0) {
1267 // Could not create swap file. Optimistically go on and hope that we can compile
1268 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001269 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001270 } else {
1271 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001272 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001273 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1274 }
1275 }
1276 return swap_fd;
1277}
1278
1279// Opens the reference profiles if needed.
1280// 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 -08001281Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08001282 const std::string& dex_path, const std::string& profile_name, bool profile_guided,
1283 bool is_public, int uid, bool is_secondary_dex) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001284 // Public apps should not be compiled with profile information ever. Same goes for the special
1285 // package '*' used for the system server.
Calin Juravle114f0812017-03-08 19:05:07 -08001286 if (!profile_guided || is_public || (pkgname[0] == '*')) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001287 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001288 }
Calin Juravle114f0812017-03-08 19:05:07 -08001289
1290 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08001291 const std::string location = is_secondary_dex ? dex_path : profile_name;
1292 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1293 is_secondary_dex);
1294 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1295 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001296 };
1297 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001298}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001299
Calin Juravle7a570e82017-01-14 16:23:30 -08001300// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1301// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001302bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001303 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001304 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001305 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1306 CHECK(in_vdex_wrapper_fd != nullptr);
1307 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001308 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1309 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001310 char in_odex_path[PKG_PATH_MAX];
1311 int dexopt_action = abs(dexopt_needed);
1312 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001313 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001314
1315 // Infer the name of the output VDEX.
1316 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1317 if (out_vdex_path_str.empty()) {
1318 return false;
1319 }
1320
1321 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001322 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001323 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1324 const char* path = nullptr;
1325 if (is_odex_location) {
1326 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1327 path = in_odex_path;
1328 } else {
1329 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001330 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001331 }
1332 } else {
1333 path = out_oat_path;
1334 }
1335 in_vdex_path_str = create_vdex_filename(path);
1336 if (in_vdex_path_str.empty()) {
1337 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001338 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001339 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001340 // We can update in place when all these conditions are met:
1341 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1342 // on /system typically cannot be updated in place).
1343 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1344 // cannot be currently used by a running process.
1345 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1346 // different vdex files to operate.
1347 update_vdex_in_place =
1348 (in_vdex_path_str == out_vdex_path_str) &&
1349 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1350 !profile_guided;
1351 if (update_vdex_in_place) {
1352 // Open the file read-write to be able to update it.
1353 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1354 if (in_vdex_wrapper_fd->get() == -1) {
1355 // If we failed to open the file, we cannot update it in place.
1356 update_vdex_in_place = false;
1357 }
1358 } else {
1359 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1360 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001361 }
1362
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001363 // If we are updating the vdex in place, we do not need to recreate a vdex,
1364 // and can use the same existing one.
1365 if (update_vdex_in_place) {
1366 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1367 // have bogus stale vdex files.
1368 out_vdex_wrapper_fd->reset(
1369 in_vdex_wrapper_fd->get(),
1370 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1371 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1372 // wrapper).
1373 in_vdex_wrapper_fd->DisableAutoClose();
1374 } else {
1375 out_vdex_wrapper_fd->reset(
1376 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1377 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1378 if (out_vdex_wrapper_fd->get() < 0) {
1379 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1380 return false;
1381 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001382 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001383 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001384 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001385 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1386 return false;
1387 }
1388
1389 // If we got here we successfully opened the vdex files.
1390 return true;
1391}
1392
1393// Opens the output oat file for the given apk.
1394// If successful it stores the output path into out_oat_path and returns true.
1395Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001396 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1397 char* out_oat_path) {
1398 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001399 return Dex2oatFileWrapper();
1400 }
1401 const std::string out_oat_path_str(out_oat_path);
1402 Dex2oatFileWrapper wrapper_fd(
1403 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1404 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1405 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001406 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001407 } else if (!set_permissions_and_ownership(
1408 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001409 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1410 wrapper_fd.reset(-1);
1411 }
1412 return wrapper_fd;
1413}
1414
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001415// Creates RDONLY fds for oat and vdex files, if exist.
1416// Returns false if it fails to create oat out path for the given apk path.
1417// Note that the method returns true even if the files could not be opened.
1418bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1419 const std::string& oat_dir,
1420 const std::string& instruction_set,
1421 bool is_secondary_dex,
1422 unique_fd* oat_file_fd,
1423 unique_fd* vdex_file_fd) {
1424 char oat_path[PKG_PATH_MAX];
1425 if (!create_oat_out_path(apk_path.c_str(),
1426 instruction_set.c_str(),
1427 oat_dir.c_str(),
1428 is_secondary_dex,
1429 oat_path)) {
Calin Juravle46e27bc2017-09-04 15:57:10 -07001430 LOG(ERROR) << "Could not create oat out path for "
1431 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001432 return false;
1433 }
1434 oat_file_fd->reset(open(oat_path, O_RDONLY));
1435 if (oat_file_fd->get() < 0) {
1436 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1437 }
1438
1439 std::string vdex_filename = create_vdex_filename(oat_path);
1440 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1441 if (vdex_file_fd->get() < 0) {
1442 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1443 }
1444
1445 return true;
1446}
1447
Calin Juravle7a570e82017-01-14 16:23:30 -08001448// Updates the access times of out_oat_path based on those from apk_path.
1449void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1450 struct stat input_stat;
1451 memset(&input_stat, 0, sizeof(input_stat));
1452 if (stat(apk_path, &input_stat) != 0) {
1453 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1454 return;
1455 }
1456
1457 struct utimbuf ut;
1458 ut.actime = input_stat.st_atime;
1459 ut.modtime = input_stat.st_mtime;
1460 if (utime(out_oat_path, &ut) != 0) {
1461 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1462 }
1463}
1464
Calin Juravle80a21252017-01-17 14:43:25 -08001465// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001466// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1467// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1468// the profile has changed.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001469static void exec_dexoptanalyzer(const std::string& dex_file, int vdex_fd, int oat_fd,
1470 int zip_fd, const std::string& instruction_set, const std::string& compiler_filter,
1471 bool profile_was_updated, bool downgrade,
Calin Juravle58cab072017-09-12 01:02:26 -07001472 const char* class_loader_context) {
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001473 CHECK_GE(zip_fd, 0);
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001474 const char* dexoptanalyzer_bin =
1475 is_debug_runtime()
1476 ? "/system/bin/dexoptanalyzerd"
1477 : "/system/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001478 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
1479
Calin Juravled23dee72017-07-06 16:29:11 -07001480 if (instruction_set.size() >= MAX_INSTRUCTION_SET_LEN) {
1481 LOG(ERROR) << "Instruction set " << instruction_set
1482 << " longer than max length of " << MAX_INSTRUCTION_SET_LEN;
Calin Juravle80a21252017-01-17 14:43:25 -08001483 return;
1484 }
1485
Calin Juravled23dee72017-07-06 16:29:11 -07001486 std::string dex_file_arg = "--dex-file=" + dex_file;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001487 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1488 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1489 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
Calin Juravled23dee72017-07-06 16:29:11 -07001490 std::string isa_arg = "--isa=" + instruction_set;
1491 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
Calin Juravle114f0812017-03-08 19:05:07 -08001492 const char* assume_profile_changed = "--assume-profile-changed";
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001493 const char* downgrade_flag = "--downgrade";
Calin Juravle58cab072017-09-12 01:02:26 -07001494 std::string class_loader_context_arg = "--class-loader-context=";
1495 if (class_loader_context != nullptr) {
1496 class_loader_context_arg += class_loader_context;
1497 }
Calin Juravle80a21252017-01-17 14:43:25 -08001498
Calin Juravle80a21252017-01-17 14:43:25 -08001499 // program name, dex file, isa, filter, the final NULL
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001500 const int argc = 6 +
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001501 (profile_was_updated ? 1 : 0) +
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001502 (vdex_fd >= 0 ? 1 : 0) +
1503 (oat_fd >= 0 ? 1 : 0) +
Calin Juravle58cab072017-09-12 01:02:26 -07001504 (downgrade ? 1 : 0) +
1505 (class_loader_context != nullptr ? 1 : 0);
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001506 const char* argv[argc];
Calin Juravle80a21252017-01-17 14:43:25 -08001507 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001508 argv[i++] = dexoptanalyzer_bin;
Calin Juravled23dee72017-07-06 16:29:11 -07001509 argv[i++] = dex_file_arg.c_str();
1510 argv[i++] = isa_arg.c_str();
1511 argv[i++] = compiler_filter_arg.c_str();
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001512 if (oat_fd >= 0) {
1513 argv[i++] = oat_fd_arg.c_str();
1514 }
1515 if (vdex_fd >= 0) {
1516 argv[i++] = vdex_fd_arg.c_str();
1517 }
1518 argv[i++] = zip_fd_arg.c_str();
Calin Juravle114f0812017-03-08 19:05:07 -08001519 if (profile_was_updated) {
1520 argv[i++] = assume_profile_changed;
1521 }
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001522 if (downgrade) {
1523 argv[i++] = downgrade_flag;
1524 }
Calin Juravle58cab072017-09-12 01:02:26 -07001525 if (class_loader_context != nullptr) {
Calin Juravle91501072017-10-26 15:44:53 -07001526 argv[i++] = class_loader_context_arg.c_str();
Calin Juravle58cab072017-09-12 01:02:26 -07001527 }
Calin Juravle80a21252017-01-17 14:43:25 -08001528 argv[i] = NULL;
1529
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001530 execv(dexoptanalyzer_bin, (char * const *)argv);
1531 ALOGE("execv(%s) failed: %s\n", dexoptanalyzer_bin, strerror(errno));
Calin Juravle80a21252017-01-17 14:43:25 -08001532}
1533
1534// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001535static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle46e27bc2017-09-04 15:57:10 -07001536 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001537 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001538 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001539 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001540 return false;
1541 }
Calin Juravle114f0812017-03-08 19:05:07 -08001542 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001543
Calin Juravle80a21252017-01-17 14:43:25 -08001544 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001545 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1546 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001547 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001548 return false;
1549 }
1550
1551 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001552 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001553
Calin Juravle46e27bc2017-09-04 15:57:10 -07001554 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001555 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001556 return false;
1557 }
1558
1559 return true;
1560}
1561
Calin Juravle46e27bc2017-09-04 15:57:10 -07001562// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1563// secondary dex files. This return codes are returned by the child process created for
1564// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001565
Calin Juravle46e27bc2017-09-04 15:57:10 -07001566// The dexoptanalyzer was not invoked because of validation or IO errors.
1567static int constexpr SECONDARY_DEX_DEXOPTANALYZER_SKIPPED = 200;
1568// The dexoptanalyzer was not invoked because the dex file does not exist anymore.
1569static int constexpr SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE = 201;
1570
1571// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001572// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1573// Returns false for errors or unexpected result values.
Calin Juravle46e27bc2017-09-04 15:57:10 -07001574// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1575// of dexoptanalyzer.
1576static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Calin Juravle80a21252017-01-17 14:43:25 -08001577 int* dexopt_needed_out) {
1578 // The result values are defined in dexoptanalyzer.
1579 switch (result) {
Calin Juravle46e27bc2017-09-04 15:57:10 -07001580 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001581 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001582 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001583 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001584 case 5: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001585 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001586 case 6: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001587 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001588 case 7: // dexoptanalyzer: dex2oat_for_relocation_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001589 *dexopt_needed_out = -DEX2OAT_FOR_RELOCATION; return true;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001590 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1591 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
1592 case 4: // dexoptanalyzer: dex2oat_for_relocation_oat
Calin Juravlec9eab382017-01-25 01:17:17 -08001593 LOG(ERROR) << "Dexoptnalyzer return the status of an oat file."
1594 << " Expected odex file status for secondary dex " << dex_path
Calin Juravle80a21252017-01-17 14:43:25 -08001595 << " : dexoptanalyzer result=" << result;
1596 return false;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001597 case SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE:
1598 // If the file does not exist there's no need for dexopt.
1599 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1600 return true;
1601 case SECONDARY_DEX_DEXOPTANALYZER_SKIPPED:
1602 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001603 default:
Calin Juravle46e27bc2017-09-04 15:57:10 -07001604 LOG(ERROR) << "Unexpected result from analyzing secondary dex " << dex_path
1605 << " result=" << result;
Calin Juravle80a21252017-01-17 14:43:25 -08001606 return false;
1607 }
1608}
1609
Calin Juravle46e27bc2017-09-04 15:57:10 -07001610enum SecondaryDexAccess {
1611 kSecondaryDexAccessReadOk = 0,
1612 kSecondaryDexAccessDoesNotExist = 1,
1613 kSecondaryDexAccessPermissionError = 2,
1614 kSecondaryDexAccessIOError = 3
1615};
1616
1617static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1618 // Check if the path exists and can be read. If not, there's nothing to do.
1619 if (access(dex_path.c_str(), R_OK) == 0) {
1620 return kSecondaryDexAccessReadOk;
1621 } else {
1622 if (errno == ENOENT) {
1623 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1624 return kSecondaryDexAccessDoesNotExist;
1625 } else {
1626 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1627 return errno == EACCES
1628 ? kSecondaryDexAccessPermissionError
1629 : kSecondaryDexAccessIOError;
1630 }
1631 }
1632}
1633
1634static bool is_file_public(const std::string& filename) {
1635 struct stat file_stat;
1636 if (stat(filename.c_str(), &file_stat) == 0) {
1637 return (file_stat.st_mode & S_IROTH) != 0;
1638 }
1639 return false;
1640}
1641
1642// Create the oat file structure for the secondary dex 'dex_path' and assign
1643// the individual path component to the 'out_' parameters.
1644static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
1645 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path) {
1646 size_t dirIndex = dex_path.rfind('/');
1647 if (dirIndex == std::string::npos) {
1648 LOG(ERROR) << "Unexpected dir structure for dex file " << dex_path;
1649 return false;
1650 }
1651 // TODO(calin): we have similar computations in at lest 3 other places
1652 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1653 // using string append.
1654 std::string apk_dir = dex_path.substr(0, dirIndex);
1655 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1656 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1657
1658 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1659 /*is_secondary_dex*/true, out_oat_path)) {
1660 LOG(ERROR) << "Could not create oat path for secondary dex " << dex_path;
1661 return false;
1662 }
1663 return true;
1664}
1665
1666// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1667// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
1668static bool validate_dexopt_storage_flags(int dexopt_flags, int* out_storage_flag) {
1669 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1670 *out_storage_flag = FLAG_STORAGE_CE;
1671 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1672 LOG(ERROR) << "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
1673 return false;
1674 }
1675 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1676 *out_storage_flag = FLAG_STORAGE_DE;
1677 } else {
1678 LOG(ERROR) << "Secondary dex storage flag must be set";
1679 return false;
1680 }
1681 return true;
1682}
1683
Calin Juravlec9eab382017-01-25 01:17:17 -08001684// 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 -08001685// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1686// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001687// When returning true, the output parameters will be:
1688// - is_public_out: whether or not the oat file should not be made public
1689// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1690// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle46e27bc2017-09-04 15:57:10 -07001691static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001692 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001693 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Calin Juravle46e27bc2017-09-04 15:57:10 -07001694 std::string* oat_dir_out, bool downgrade, const char* class_loader_context) {
1695 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001696 int storage_flag;
Calin Juravle46e27bc2017-09-04 15:57:10 -07001697 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001698 return false;
1699 }
Calin Juravle46e27bc2017-09-04 15:57:10 -07001700 // Compute the oat dir as it's not easy to extract it from the child computation.
1701 char oat_path[PKG_PATH_MAX];
1702 char oat_dir[PKG_PATH_MAX];
1703 char oat_isa_dir[PKG_PATH_MAX];
1704 if (!create_secondary_dex_oat_layout(
1705 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path)) {
1706 LOG(ERROR) << "Could not create secondary odex layout: " << dex_path;
Calin Juravled23dee72017-07-06 16:29:11 -07001707 return false;
1708 }
Calin Juravle46e27bc2017-09-04 15:57:10 -07001709 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001710
Calin Juravle80a21252017-01-17 14:43:25 -08001711 pid_t pid = fork();
1712 if (pid == 0) {
1713 // child -- drop privileges before continuing.
1714 drop_capabilities(uid);
Calin Juravle46e27bc2017-09-04 15:57:10 -07001715
1716 // Validate the path structure.
1717 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1718 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
1719 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1720 }
1721
1722 // Open the dex file.
1723 unique_fd zip_fd;
1724 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1725 if (zip_fd.get() < 0) {
1726 if (errno == ENOENT) {
1727 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE);
1728 } else {
1729 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1730 }
1731 }
1732
1733 // Prepare the oat directories.
1734 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
1735 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1736 }
1737
1738 // Open the vdex/oat files if any.
1739 unique_fd oat_file_fd;
1740 unique_fd vdex_file_fd;
1741 if (!maybe_open_oat_and_vdex_file(dex_path,
1742 *oat_dir_out,
1743 instruction_set,
1744 true /* is_secondary_dex */,
1745 &oat_file_fd,
1746 &vdex_file_fd)) {
1747 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
1748 }
1749
1750 // Analyze profiles.
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08001751 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1752 /*is_secondary_dex*/true);
Calin Juravle46e27bc2017-09-04 15:57:10 -07001753
1754 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001755 exec_dexoptanalyzer(dex_path,
1756 vdex_file_fd.get(),
1757 oat_file_fd.get(),
1758 zip_fd.get(),
1759 instruction_set,
Calin Juravle46e27bc2017-09-04 15:57:10 -07001760 compiler_filter, profile_was_updated,
1761 downgrade,
1762 class_loader_context);
1763 PLOG(ERROR) << "Failed to exec dexoptanalyzer";
1764 _exit(SECONDARY_DEX_DEXOPTANALYZER_SKIPPED);
Calin Juravle80a21252017-01-17 14:43:25 -08001765 }
1766
1767 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001768 int result = wait_child(pid);
1769 if (!WIFEXITED(result)) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001770 LOG(ERROR) << "dexoptanalyzer failed for path " << dex_path << ": " << result;
Calin Juravle80a21252017-01-17 14:43:25 -08001771 return false;
1772 }
1773 result = WEXITSTATUS(result);
Calin Juravle46e27bc2017-09-04 15:57:10 -07001774 // Check that we successfully executed dexoptanalyzer.
1775 bool success = process_secondary_dexoptanalyzer_result(dex_path, result, dexopt_needed_out);
1776
1777 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1778
Calin Juravle80a21252017-01-17 14:43:25 -08001779 // Run dexopt only if needed or forced.
Calin Juravle46e27bc2017-09-04 15:57:10 -07001780 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1781 // makes the code simpler; force compilation is only needed during tests).
1782 if (success &&
1783 (result != SECONDARY_DEX_DEXOPTANALYZER_SKIPPED_NO_FILE) &&
1784 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001785 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1786 }
1787
Calin Juravle46e27bc2017-09-04 15:57:10 -07001788 // Check if we should make the oat file public.
1789 // Note that if the dex file is not public the compiled code cannot be made public.
1790 // It is ok to check this flag outside in the parent process.
1791 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1792
Calin Juravle80a21252017-01-17 14:43:25 -08001793 return success;
1794}
1795
Calin Juravlec9eab382017-01-25 01:17:17 -08001796int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001797 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001798 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08001799 bool downgrade, int target_sdk_version, const char* profile_name) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001800 CHECK(pkgname != nullptr);
1801 CHECK(pkgname[0] != 0);
1802 if ((dexopt_flags & ~DEXOPT_MASK) != 0) {
1803 LOG_FATAL("dexopt flags contains unknown fields\n");
1804 }
1805
Calin Juravled23dee72017-07-06 16:29:11 -07001806 if (!validate_dex_path_size(dex_path)) {
Calin Juravle52c45822017-07-13 22:50:21 -07001807 return -1;
1808 }
1809
1810 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
1811 LOG(ERROR) << "Class loader context exceeds the allowed size: " << class_loader_context;
1812 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001813 }
1814
Calin Juravleebc8a792017-04-04 20:21:05 -07001815 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001816 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1817 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1818 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001819 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001820 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001821
1822 // Check if we're dealing with a secondary dex file and if we need to compile it.
1823 std::string oat_dir_str;
1824 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001825 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001826 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Calin Juravle46e27bc2017-09-04 15:57:10 -07001827 downgrade, class_loader_context)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001828 oat_dir = oat_dir_str.c_str();
1829 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1830 return 0; // Nothing to do, report success.
1831 }
1832 } else {
1833 return -1; // We had an error, logged in the process method.
1834 }
1835 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001836 // Currently these flags are only use for secondary dex files.
1837 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001838 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1839 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1840 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001841
1842 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001843 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001844 if (input_fd.get() < 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001845 ALOGE("installd cannot open '%s' for input during dexopt\n", dex_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001846 return -1;
1847 }
1848
1849 // Create the output OAT file.
1850 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001851 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001852 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001853 if (out_oat_fd.get() < 0) {
1854 return -1;
1855 }
1856
1857 // Open vdex files.
1858 Dex2oatFileWrapper in_vdex_fd;
1859 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001860 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1861 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001862 return -1;
1863 }
1864
Calin Juravlecb556e32017-04-04 20:22:50 -07001865 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1866 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1867 // fully inherit their parent context).
1868 // Note that for primary apk the oat files are created before, in a separate installd
1869 // call which also does the restorecon. TODO(calin): unify the paths.
1870 if (is_secondary_dex) {
1871 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1872 SELINUX_ANDROID_RESTORECON_RECURSE)) {
1873 LOG(ERROR) << "Failed to restorecon " << oat_dir;
1874 return -1;
1875 }
1876 }
1877
Jeff Sharkey90aff262016-12-12 14:28:24 -07001878 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001879 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001880
Calin Juravle7a570e82017-01-14 16:23:30 -08001881 // Create the app image file if needed.
1882 Dex2oatFileWrapper image_fd =
Calin Juravle2289c0a2017-02-15 12:44:14 -08001883 maybe_open_app_image(out_oat_path, profile_guided, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001884
Calin Juravle7a570e82017-01-14 16:23:30 -08001885 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001886 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08001887 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001888
Calin Juravlec9eab382017-01-25 01:17:17 -08001889 ALOGV("DexInv: --- BEGIN '%s' ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001890
1891 pid_t pid = fork();
1892 if (pid == 0) {
1893 /* child -- drop privileges before continuing */
1894 drop_capabilities(uid);
1895
Richard Uhler76cc0272016-12-08 10:46:35 +00001896 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001897 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
1898 ALOGE("flock(%s) failed: %s\n", out_oat_path, strerror(errno));
1899 _exit(67);
1900 }
1901
Richard Uhler76cc0272016-12-08 10:46:35 +00001902 run_dex2oat(input_fd.get(),
1903 out_oat_fd.get(),
1904 in_vdex_fd.get(),
Calin Juravle7a570e82017-01-14 16:23:30 -08001905 out_vdex_fd.get(),
Richard Uhler76cc0272016-12-08 10:46:35 +00001906 image_fd.get(),
Jeff Hao10b8a6e2017-04-05 17:11:39 -07001907 dex_path,
Richard Uhler76cc0272016-12-08 10:46:35 +00001908 out_oat_path,
1909 swap_fd.get(),
1910 instruction_set,
1911 compiler_filter,
Richard Uhler76cc0272016-12-08 10:46:35 +00001912 debuggable,
1913 boot_complete,
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001914 background_job_compile,
Richard Uhler76cc0272016-12-08 10:46:35 +00001915 reference_profile_fd.get(),
David Brazdil570d3982018-01-16 20:15:43 +00001916 class_loader_context,
1917 target_sdk_version);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001918 _exit(68); /* only get here on exec failure */
1919 } else {
1920 int res = wait_child(pid);
1921 if (res == 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001922 ALOGV("DexInv: --- END '%s' (success) ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001923 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001924 ALOGE("DexInv: --- END '%s' --- status=0x%04x, process failed\n", dex_path, res);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001925 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001926 }
1927 }
1928
Calin Juravlec9eab382017-01-25 01:17:17 -08001929 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001930
1931 // We've been successful, don't delete output.
1932 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001933 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001934 image_fd.SetCleanup(false);
1935 reference_profile_fd.SetCleanup(false);
1936
1937 return 0;
1938}
1939
Calin Juravlec9eab382017-01-25 01:17:17 -08001940// Try to remove the given directory. Log an error if the directory exists
1941// and is empty but could not be removed.
1942static bool rmdir_if_empty(const char* dir) {
1943 if (rmdir(dir) == 0) {
1944 return true;
1945 }
1946 if (errno == ENOENT || errno == ENOTEMPTY) {
1947 return true;
1948 }
1949 PLOG(ERROR) << "Failed to remove dir: " << dir;
1950 return false;
1951}
1952
1953// Try to unlink the given file. Log an error if the file exists and could not
1954// be unlinked.
1955static bool unlink_if_exists(const std::string& file) {
1956 if (unlink(file.c_str()) == 0) {
1957 return true;
1958 }
1959 if (errno == ENOENT) {
1960 return true;
1961
1962 }
1963 PLOG(ERROR) << "Could not unlink: " << file;
1964 return false;
1965}
1966
Calin Juravle46e27bc2017-09-04 15:57:10 -07001967enum ReconcileSecondaryDexResult {
1968 kReconcileSecondaryDexExists = 0,
1969 kReconcileSecondaryDexCleanedUp = 1,
1970 kReconcileSecondaryDexValidationError = 2,
1971 kReconcileSecondaryDexCleanUpError = 3,
1972 kReconcileSecondaryDexAccessIOError = 4,
1973};
Calin Juravlec9eab382017-01-25 01:17:17 -08001974
1975// Reconcile the secondary dex 'dex_path' and its generated oat files.
1976// Return true if all the parameters are valid and the secondary dex file was
1977// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1978// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1979// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1980// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1981// Return false if there were errors during processing. In this case
1982// out_secondary_dex_exists will be set to false.
1983bool reconcile_secondary_dex_file(const std::string& dex_path,
1984 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
1985 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
1986 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle46e27bc2017-09-04 15:57:10 -07001987 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08001988 if (isas.size() == 0) {
1989 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1990 return false;
1991 }
1992
Calin Juravle46e27bc2017-09-04 15:57:10 -07001993 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
1994 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
1995 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08001996 return false;
1997 }
1998
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07001999 // As a security measure we want to unlink art artifacts with the reduced capabilities
2000 // of the package user id. So we fork and drop capabilities in the child.
2001 pid_t pid = fork();
2002 if (pid == 0) {
Calin Juravle46e27bc2017-09-04 15:57:10 -07002003 /* child -- drop privileges before continuing */
2004 drop_capabilities(uid);
2005
2006 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2007 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2008 uid, storage_flag)) {
2009 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2010 _exit(kReconcileSecondaryDexValidationError);
2011 }
2012
2013 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2014 switch (access_check) {
2015 case kSecondaryDexAccessDoesNotExist:
2016 // File does not exist. Proceed with cleaning.
2017 break;
2018 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2019 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2020 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2021 default:
2022 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2023 _exit(kReconcileSecondaryDexValidationError);
2024 }
2025
2026 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002027 char oat_path[PKG_PATH_MAX];
2028 char oat_dir[PKG_PATH_MAX];
2029 char oat_isa_dir[PKG_PATH_MAX];
2030 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002031 for (size_t i = 0; i < isas.size(); i++) {
Calin Juravle46e27bc2017-09-04 15:57:10 -07002032 if (!create_secondary_dex_oat_layout(
2033 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path)) {
2034 LOG(ERROR) << "Could not create secondary odex layout: " << dex_path;
2035 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002036 }
Calin Juravle51314092017-05-18 15:33:05 -07002037
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002038 // Delete oat/vdex/art files.
2039 result = unlink_if_exists(oat_path) && result;
2040 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2041 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002042
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002043 // Delete profiles.
2044 std::string current_profile = create_current_profile_path(
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08002045 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002046 std::string reference_profile = create_reference_profile_path(
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08002047 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002048 result = unlink_if_exists(current_profile) && result;
2049 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002050
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002051 // We upgraded once the location of current profile for secondary dex files.
2052 // Check for any previous left-overs and remove them as well.
2053 std::string old_current_profile = dex_path + ".prof";
2054 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002055
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002056 // Try removing the directories as well, they might be empty.
2057 result = rmdir_if_empty(oat_isa_dir) && result;
2058 result = rmdir_if_empty(oat_dir) && result;
2059 }
Calin Juravle46e27bc2017-09-04 15:57:10 -07002060 if (!result) {
2061 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2062 }
2063 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002064 }
2065
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002066 int return_code = wait_child(pid);
Calin Juravle46e27bc2017-09-04 15:57:10 -07002067 if (!WIFEXITED(return_code)) {
2068 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2069 } else {
2070 return_code = WEXITSTATUS(return_code);
2071 }
2072
2073 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2074
2075 switch (return_code) {
2076 case kReconcileSecondaryDexCleanedUp:
2077 case kReconcileSecondaryDexValidationError:
2078 // If we couldn't validate assume the dex file does not exist.
2079 // This will purge the entry from the PM records.
2080 *out_secondary_dex_exists = false;
2081 return true;
2082 case kReconcileSecondaryDexExists:
2083 *out_secondary_dex_exists = true;
2084 return true;
2085 case kReconcileSecondaryDexAccessIOError:
2086 // We had an access IO error.
2087 // Return false so that we can try again.
2088 // The value of out_secondary_dex_exists does not matter in this case and by convention
2089 // is set to false.
2090 *out_secondary_dex_exists = false;
2091 return false;
2092 default:
2093 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2094 *out_secondary_dex_exists = false;
2095 return false;
2096 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002097}
2098
Alan Stokes753dc712017-10-16 10:56:00 +01002099// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2100// Returns true if all parameters are valid and the hash successfully computed and stored in
2101// out_secondary_dex_hash.
2102// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2103// the app.
2104// For any other errors (e.g. if any of the parameters are invalid) returns false.
2105bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2106 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2107 std::vector<uint8_t>* out_secondary_dex_hash) {
2108 out_secondary_dex_hash->clear();
2109
2110 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2111
2112 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2113 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2114 << storage_flag;
2115 return false;
2116 }
2117
2118 // Pipe to get the hash result back from our child process.
2119 unique_fd pipe_read, pipe_write;
2120 if (!Pipe(&pipe_read, &pipe_write)) {
2121 PLOG(ERROR) << "Failed to create pipe";
2122 return false;
2123 }
2124
2125 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2126 // access data the app itself can access.
2127 pid_t pid = fork();
2128 if (pid == 0) {
2129 // child -- drop privileges before continuing
2130 drop_capabilities(uid);
2131 pipe_read.reset();
2132
2133 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2134 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2135 _exit(1);
2136 }
2137
2138 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2139 if (fd == -1) {
2140 if (errno == EACCES || errno == ENOENT) {
2141 // Not treated as an error.
2142 _exit(0);
2143 }
2144 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
2145 _exit(1);
2146 }
2147
2148 SHA256_CTX ctx;
2149 SHA256_Init(&ctx);
2150
2151 std::vector<uint8_t> buffer(65536);
2152 while (true) {
2153 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2154 if (bytes_read == 0) {
2155 break;
2156 } else if (bytes_read == -1) {
2157 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
2158 _exit(1);
2159 }
2160
2161 SHA256_Update(&ctx, buffer.data(), bytes_read);
2162 }
2163
2164 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2165 SHA256_Final(hash.data(), &ctx);
2166 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
2167 _exit(1);
2168 }
2169
2170 _exit(0);
2171 }
2172
2173 // parent
2174 pipe_write.reset();
2175
2176 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2177 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2178 out_secondary_dex_hash->clear();
2179 }
2180 return wait_child(pid) == 0;
2181}
2182
Jeff Sharkey90aff262016-12-12 14:28:24 -07002183// Helper for move_ab, so that we can have common failure-case cleanup.
2184static bool unlink_and_rename(const char* from, const char* to) {
2185 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2186 // return a failure.
2187 struct stat s;
2188 if (stat(to, &s) == 0) {
2189 if (!S_ISREG(s.st_mode)) {
2190 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2191 return false;
2192 }
2193 if (unlink(to) != 0) {
2194 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2195 return false;
2196 }
2197 } else {
2198 // This may be a permission problem. We could investigate the error code, but we'll just
2199 // let the rename failure do the work for us.
2200 }
2201
2202 // Try to rename "to" to "from."
2203 if (rename(from, to) != 0) {
2204 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2205 return false;
2206 }
2207 return true;
2208}
2209
2210// Move/rename a B artifact (from) to an A artifact (to).
2211static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2212 // Check whether B exists.
2213 {
2214 struct stat s;
2215 if (stat(b_path.c_str(), &s) != 0) {
2216 // Silently ignore for now. The service calling this isn't smart enough to understand
2217 // lack of artifacts at the moment.
2218 return false;
2219 }
2220 if (!S_ISREG(s.st_mode)) {
2221 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2222 // Try to unlink, but swallow errors.
2223 unlink(b_path.c_str());
2224 return false;
2225 }
2226 }
2227
2228 // Rename B to A.
2229 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2230 // Delete the b_path so we don't try again (or fail earlier).
2231 if (unlink(b_path.c_str()) != 0) {
2232 PLOG(ERROR) << "Could not unlink " << b_path;
2233 }
2234
2235 return false;
2236 }
2237
2238 return true;
2239}
2240
2241bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2242 // Get the current slot suffix. No suffix, no A/B.
2243 std::string slot_suffix;
2244 {
2245 char buf[kPropertyValueMax];
2246 if (get_property("ro.boot.slot_suffix", buf, nullptr) <= 0) {
2247 return false;
2248 }
2249 slot_suffix = buf;
2250
2251 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2252 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2253 return false;
2254 }
2255 }
2256
2257 // Validate other inputs.
2258 if (validate_apk_path(apk_path) != 0) {
2259 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2260 return false;
2261 }
2262 if (validate_apk_path(oat_dir) != 0) {
2263 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2264 return false;
2265 }
2266
2267 char a_path[PKG_PATH_MAX];
2268 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2269 return false;
2270 }
2271 const std::string a_vdex_path = create_vdex_filename(a_path);
2272 const std::string a_image_path = create_image_filename(a_path);
2273
2274 // B path = A path + slot suffix.
2275 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2276 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2277 const std::string b_image_path = StringPrintf("%s.%s",
2278 a_image_path.c_str(),
2279 slot_suffix.c_str());
2280
2281 bool success = true;
2282 if (move_ab_path(b_path, a_path)) {
2283 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2284 // Note: we can live without an app image. As such, ignore failure to move the image file.
2285 // If we decide to require the app image, or the app image being moved correctly,
2286 // then change accordingly.
2287 constexpr bool kIgnoreAppImageFailure = true;
2288
2289 if (!a_image_path.empty()) {
2290 if (!move_ab_path(b_image_path, a_image_path)) {
2291 unlink(a_image_path.c_str());
2292 if (!kIgnoreAppImageFailure) {
2293 success = false;
2294 }
2295 }
2296 }
2297 } else {
2298 // Cleanup: delete B image, ignore errors.
2299 unlink(b_image_path.c_str());
2300 success = false;
2301 }
2302 } else {
2303 // Cleanup: delete B image, ignore errors.
2304 unlink(b_vdex_path.c_str());
2305 unlink(b_image_path.c_str());
2306 success = false;
2307 }
2308 return success;
2309}
2310
2311bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2312 // Delete the oat/odex file.
2313 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002314 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002315 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002316 return false;
2317 }
2318
2319 // In case of a permission failure report the issue. Otherwise just print a warning.
2320 auto unlink_and_check = [](const char* path) -> bool {
2321 int result = unlink(path);
2322 if (result != 0) {
2323 if (errno == EACCES || errno == EPERM) {
2324 PLOG(ERROR) << "Could not unlink " << path;
2325 return false;
2326 }
2327 PLOG(WARNING) << "Could not unlink " << path;
2328 }
2329 return true;
2330 };
2331
2332 // Delete the oat/odex file.
2333 bool return_value_oat = unlink_and_check(out_path);
2334
2335 // Derive and delete the app image.
2336 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2337
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002338 // Derive and delete the vdex file.
2339 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2340
Jeff Sharkey90aff262016-12-12 14:28:24 -07002341 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002342 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002343}
2344
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002345static bool is_absolute_path(const std::string& path) {
2346 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2347 LOG(ERROR) << "Invalid absolute path " << path;
2348 return false;
2349 } else {
2350 return true;
2351 }
2352}
2353
2354static bool is_valid_instruction_set(const std::string& instruction_set) {
2355 // TODO: add explicit whitelisting of instruction sets
2356 if (instruction_set.find('/') != std::string::npos) {
2357 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2358 return false;
2359 } else {
2360 return true;
2361 }
2362}
2363
2364bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2365 const char *apk_path, const char *instruction_set) {
2366 std::string oat_dir_ = oat_dir;
2367 std::string apk_path_ = apk_path;
2368 std::string instruction_set_ = instruction_set;
2369
2370 if (!is_absolute_path(oat_dir_)) return false;
2371 if (!is_absolute_path(apk_path_)) return false;
2372 if (!is_valid_instruction_set(instruction_set_)) return false;
2373
2374 std::string::size_type end = apk_path_.rfind('.');
2375 std::string::size_type start = apk_path_.rfind('/', end);
2376 if (end == std::string::npos || start == std::string::npos) {
2377 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2378 return false;
2379 }
2380
2381 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2382 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2383 const char* res = res_.c_str();
2384 if (strlen(res) >= PKG_PATH_MAX) {
2385 LOG(ERROR) << "Result too large";
2386 return false;
2387 } else {
2388 strlcpy(path, res, PKG_PATH_MAX);
2389 return true;
2390 }
2391}
2392
2393bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2394 const char *instruction_set) {
2395 std::string apk_path_ = apk_path;
2396 std::string instruction_set_ = instruction_set;
2397
2398 if (!is_absolute_path(apk_path_)) return false;
2399 if (!is_valid_instruction_set(instruction_set_)) return false;
2400
2401 std::string::size_type end = apk_path_.rfind('.');
2402 std::string::size_type start = apk_path_.rfind('/', end);
2403 if (end == std::string::npos || start == std::string::npos) {
2404 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2405 return false;
2406 }
2407
2408 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2409 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2410}
2411
2412bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2413 const char *instruction_set) {
2414 std::string src_ = src;
2415 std::string instruction_set_ = instruction_set;
2416
2417 if (!is_absolute_path(src_)) return false;
2418 if (!is_valid_instruction_set(instruction_set_)) return false;
2419
2420 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2421 if (*it == '/') {
2422 *it = '@';
2423 }
2424 }
2425
2426 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2427 + DALVIK_CACHE_POSTFIX;
2428 const char* res = res_.c_str();
2429 if (strlen(res) >= PKG_PATH_MAX) {
2430 LOG(ERROR) << "Result too large";
2431 return false;
2432 } else {
2433 strlcpy(path, res, PKG_PATH_MAX);
2434 return true;
2435 }
2436}
2437
Calin Juravlec41dac22017-12-05 12:29:15 -08002438bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08002439 const std::string& profile_name) {
Calin Juravle29591732017-11-20 17:46:19 -08002440 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2441
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08002442 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002443 if (snapshot_fd < 0) {
2444 return false;
2445 }
2446
2447 std::vector<unique_fd> profiles_fd;
2448 unique_fd reference_profile_fd;
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08002449 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2450 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002451 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2452 return false;
2453 }
2454
2455 profiles_fd.push_back(std::move(reference_profile_fd));
2456
2457 pid_t pid = fork();
2458 if (pid == 0) {
2459 /* child -- drop privileges before continuing */
2460 drop_capabilities(app_shared_gid);
2461 run_profman_merge(profiles_fd, snapshot_fd);
2462 exit(42); /* only get here on exec failure */
2463 }
2464
2465 /* parent */
2466 int return_code = wait_child(pid);
2467 if (!WIFEXITED(return_code)) {
Calin Juravlecfcd6aa2018-01-18 20:23:17 -08002468 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002469 return false;
2470 }
2471
2472 return true;
2473}
2474
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002475} // namespace installd
2476} // namespace android