blob: d78431542cd429f332eb688f7df16d51c4648f62 [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
Jeff Sharkey90aff262016-12-12 14:28:24 -070018#include <fcntl.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070019#include <stdlib.h>
20#include <string.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070021#include <sys/capability.h>
22#include <sys/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070023#include <sys/stat.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070024#include <sys/time.h>
25#include <sys/types.h>
26#include <sys/resource.h>
27#include <sys/wait.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070028#include <unistd.h>
29
30#include <android-base/logging.h>
Andreas Gampef2d5d512017-07-24 16:49:10 -070031#include <android-base/properties.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070032#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070033#include <android-base/strings.h>
34#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080035#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070036#include <cutils/properties.h>
37#include <cutils/sched_policy.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070038#include <log/log.h> // TODO: Move everything to base/logging.
Jeff Sharkey90aff262016-12-12 14:28:24 -070039#include <private/android_filesystem_config.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070040#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070041#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070042
43#include "dexopt.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070044#include "installd_deps.h"
45#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070046#include "utils.h"
47
48using android::base::StringPrintf;
Jeff Sharkey90aff262016-12-12 14:28:24 -070049using android::base::EndsWith;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080050using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070051
52namespace android {
53namespace installd {
54
Calin Juravle114f0812017-03-08 19:05:07 -080055// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
56struct FreeDelete {
57 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
58 void operator()(const void* ptr) const {
59 free(const_cast<void*>(ptr));
60 }
61};
62
63// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
64template <typename T>
65using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
66
Calin Juravle1a0af3b2017-03-09 14:33:33 -080067static unique_fd invalid_unique_fd() {
68 return unique_fd(-1);
69}
70
Andreas Gampef2d5d512017-07-24 16:49:10 -070071static bool is_debug_runtime() {
72 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
73}
74
Jeff Sharkey90aff262016-12-12 14:28:24 -070075static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -080076 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -070077 if (ufd.get() < 0) {
78 if (errno != ENOENT) {
79 PLOG(WARNING) << "Could not open profile " << profile;
80 return false;
81 } else {
82 // Nothing to clear. That's ok.
83 return true;
84 }
85 }
86
87 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
88 if (errno != EWOULDBLOCK) {
89 PLOG(WARNING) << "Error locking profile " << profile;
90 }
91 // This implies that the app owning this profile is running
92 // (and has acquired the lock).
93 //
94 // If we can't acquire the lock bail out since clearing is useless anyway
95 // (the app will write again to the profile).
96 //
97 // Note:
98 // This does not impact the this is not an issue for the profiling correctness.
99 // In case this is needed because of an app upgrade, profiles will still be
100 // eventually cleared by the app itself due to checksum mismatch.
101 // If this is needed because profman advised, then keeping the data around
102 // until the next run is again not an issue.
103 //
104 // If the app attempts to acquire a lock while we've held one here,
105 // it will simply skip the current write cycle.
106 return false;
107 }
108
109 bool truncated = ftruncate(ufd.get(), 0) == 0;
110 if (!truncated) {
111 PLOG(WARNING) << "Could not truncate " << profile;
112 }
113 if (flock(ufd.get(), LOCK_UN) != 0) {
114 PLOG(WARNING) << "Error unlocking profile " << profile;
115 }
116 return truncated;
117}
118
Calin Juravle114f0812017-03-08 19:05:07 -0800119// Clear the reference profile for the given location.
120// The location is the package name for primary apks or the dex path for secondary dex files.
121static bool clear_reference_profile(const std::string& location, bool is_secondary_dex) {
122 return clear_profile(create_reference_profile_path(location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700123}
124
Calin Juravle114f0812017-03-08 19:05:07 -0800125// Clear the reference profile for the given location.
126// The location is the package name for primary apks or the dex path for secondary dex files.
127static bool clear_current_profile(const std::string& pkgname, userid_t user,
128 bool is_secondary_dex) {
129 return clear_profile(create_current_profile_path(user, pkgname, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700130}
131
Calin Juravle114f0812017-03-08 19:05:07 -0800132// Clear the reference profile for the primary apk of the given package.
133bool clear_primary_reference_profile(const std::string& pkgname) {
134 return clear_reference_profile(pkgname, /*is_secondary_dex*/false);
135}
136
137// Clear all current profile for the primary apk of the given package.
138bool clear_primary_current_profiles(const std::string& pkgname) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700139 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800140 // 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 -0700141 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
142 for (auto user : users) {
Calin Juravle114f0812017-03-08 19:05:07 -0800143 success &= clear_current_profile(pkgname, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700144 }
145 return success;
146}
147
Calin Juravle114f0812017-03-08 19:05:07 -0800148// Clear the current profile for the primary apk of the given package and user.
149bool clear_primary_current_profile(const std::string& pkgname, userid_t user) {
150 return clear_current_profile(pkgname, user, /*is_secondary_dex*/false);
151}
152
Jeff Sharkey90aff262016-12-12 14:28:24 -0700153static int split_count(const char *str)
154{
155 char *ctx;
156 int count = 0;
157 char buf[kPropertyValueMax];
158
159 strncpy(buf, str, sizeof(buf));
160 char *pBuf = buf;
161
162 while(strtok_r(pBuf, " ", &ctx) != NULL) {
163 count++;
164 pBuf = NULL;
165 }
166
167 return count;
168}
169
170static int split(char *buf, const char **argv)
171{
172 char *ctx;
173 int count = 0;
174 char *tok;
175 char *pBuf = buf;
176
177 while((tok = strtok_r(pBuf, " ", &ctx)) != NULL) {
178 argv[count++] = tok;
179 pBuf = NULL;
180 }
181
182 return count;
183}
184
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700185static const char* get_location_from_path(const char* path) {
186 static constexpr char kLocationSeparator = '/';
187 const char *location = strrchr(path, kLocationSeparator);
188 if (location == NULL) {
189 return path;
190 } else {
191 // Skip the separator character.
192 return location + 1;
193 }
194}
195
Jeff Sharkey90aff262016-12-12 14:28:24 -0700196static void run_dex2oat(int zip_fd, int oat_fd, int input_vdex_fd, int output_vdex_fd, int image_fd,
197 const char* input_file_name, const char* output_file_name, int swap_fd,
Nicolas Geoffraya0af34d2017-05-03 13:21:37 +0100198 const char* instruction_set, const char* compiler_filter,
Jeff Sharkey90aff262016-12-12 14:28:24 -0700199 bool debuggable, bool post_bootcomplete, int profile_fd, const char* shared_libraries) {
200 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
201
202 if (strlen(instruction_set) >= MAX_INSTRUCTION_SET_LEN) {
203 ALOGE("Instruction set %s longer than max length of %d",
204 instruction_set, MAX_INSTRUCTION_SET_LEN);
205 return;
206 }
207
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700208 // Get the relative path to the input file.
209 const char* relative_input_file_name = get_location_from_path(input_file_name);
210
Jeff Sharkey90aff262016-12-12 14:28:24 -0700211 char dex2oat_Xms_flag[kPropertyValueMax];
212 bool have_dex2oat_Xms_flag = get_property("dalvik.vm.dex2oat-Xms", dex2oat_Xms_flag, NULL) > 0;
213
214 char dex2oat_Xmx_flag[kPropertyValueMax];
215 bool have_dex2oat_Xmx_flag = get_property("dalvik.vm.dex2oat-Xmx", dex2oat_Xmx_flag, NULL) > 0;
216
217 char dex2oat_threads_buf[kPropertyValueMax];
218 bool have_dex2oat_threads_flag = get_property(post_bootcomplete
219 ? "dalvik.vm.dex2oat-threads"
220 : "dalvik.vm.boot-dex2oat-threads",
221 dex2oat_threads_buf,
222 NULL) > 0;
223 char dex2oat_threads_arg[kPropertyValueMax + 2];
224 if (have_dex2oat_threads_flag) {
225 sprintf(dex2oat_threads_arg, "-j%s", dex2oat_threads_buf);
226 }
227
228 char dex2oat_isa_features_key[kPropertyKeyMax];
229 sprintf(dex2oat_isa_features_key, "dalvik.vm.isa.%s.features", instruction_set);
230 char dex2oat_isa_features[kPropertyValueMax];
231 bool have_dex2oat_isa_features = get_property(dex2oat_isa_features_key,
232 dex2oat_isa_features, NULL) > 0;
233
234 char dex2oat_isa_variant_key[kPropertyKeyMax];
235 sprintf(dex2oat_isa_variant_key, "dalvik.vm.isa.%s.variant", instruction_set);
236 char dex2oat_isa_variant[kPropertyValueMax];
237 bool have_dex2oat_isa_variant = get_property(dex2oat_isa_variant_key,
238 dex2oat_isa_variant, NULL) > 0;
239
240 const char *dex2oat_norelocation = "-Xnorelocate";
241 bool have_dex2oat_relocation_skip_flag = false;
242
243 char dex2oat_flags[kPropertyValueMax];
244 int dex2oat_flags_count = get_property("dalvik.vm.dex2oat-flags",
245 dex2oat_flags, NULL) <= 0 ? 0 : split_count(dex2oat_flags);
246 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags);
247
Nicolas Geoffraya0af34d2017-05-03 13:21:37 +0100248 // If we are booting without the real /data, don't spend time compiling.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700249 char vold_decrypt[kPropertyValueMax];
250 bool have_vold_decrypt = get_property("vold.decrypt", vold_decrypt, "") > 0;
251 bool skip_compilation = (have_vold_decrypt &&
252 (strcmp(vold_decrypt, "trigger_restart_min_framework") == 0 ||
253 (strcmp(vold_decrypt, "1") == 0)));
254
255 bool generate_debug_info = property_get_bool("debug.generate-debug-info", false);
256
257 char app_image_format[kPropertyValueMax];
258 char image_format_arg[strlen("--image-format=") + kPropertyValueMax];
259 bool have_app_image_format =
260 image_fd >= 0 && get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
261 if (have_app_image_format) {
262 sprintf(image_format_arg, "--image-format=%s", app_image_format);
263 }
264
265 char dex2oat_large_app_threshold[kPropertyValueMax];
266 bool have_dex2oat_large_app_threshold =
267 get_property("dalvik.vm.dex2oat-very-large", dex2oat_large_app_threshold, NULL) > 0;
268 char dex2oat_large_app_threshold_arg[strlen("--very-large-app-threshold=") + kPropertyValueMax];
269 if (have_dex2oat_large_app_threshold) {
270 sprintf(dex2oat_large_app_threshold_arg,
271 "--very-large-app-threshold=%s",
272 dex2oat_large_app_threshold);
273 }
274
Andreas Gampef2d5d512017-07-24 16:49:10 -0700275 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
276 const char* dex2oat_bin = is_debug_runtime() ? "/system/bin/dex2oatd" : "/system/bin/dex2oat";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700277
278 static const char* RUNTIME_ARG = "--runtime-arg";
279
280 static const int MAX_INT_LEN = 12; // '-'+10dig+'\0' -OR- 0x+8dig
281
George Burgess IV36cebe772017-01-25 11:52:01 -0800282 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
283 // use arraysize instead.
284 char zip_fd_arg[arraysize("--zip-fd=") + MAX_INT_LEN];
285 char zip_location_arg[arraysize("--zip-location=") + PKG_PATH_MAX];
286 char input_vdex_fd_arg[arraysize("--input-vdex-fd=") + MAX_INT_LEN];
287 char output_vdex_fd_arg[arraysize("--output-vdex-fd=") + MAX_INT_LEN];
288 char oat_fd_arg[arraysize("--oat-fd=") + MAX_INT_LEN];
289 char oat_location_arg[arraysize("--oat-location=") + PKG_PATH_MAX];
290 char instruction_set_arg[arraysize("--instruction-set=") + MAX_INSTRUCTION_SET_LEN];
291 char instruction_set_variant_arg[arraysize("--instruction-set-variant=") + kPropertyValueMax];
292 char instruction_set_features_arg[arraysize("--instruction-set-features=") + kPropertyValueMax];
293 char dex2oat_Xms_arg[arraysize("-Xms") + kPropertyValueMax];
294 char dex2oat_Xmx_arg[arraysize("-Xmx") + kPropertyValueMax];
295 char dex2oat_compiler_filter_arg[arraysize("--compiler-filter=") + kPropertyValueMax];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700296 bool have_dex2oat_swap_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800297 char dex2oat_swap_fd[arraysize("--swap-fd=") + MAX_INT_LEN];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700298 bool have_dex2oat_image_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800299 char dex2oat_image_fd[arraysize("--app-image-fd=") + MAX_INT_LEN];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700300
301 sprintf(zip_fd_arg, "--zip-fd=%d", zip_fd);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700302 sprintf(zip_location_arg, "--zip-location=%s", relative_input_file_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700303 sprintf(input_vdex_fd_arg, "--input-vdex-fd=%d", input_vdex_fd);
304 sprintf(output_vdex_fd_arg, "--output-vdex-fd=%d", output_vdex_fd);
305 sprintf(oat_fd_arg, "--oat-fd=%d", oat_fd);
306 sprintf(oat_location_arg, "--oat-location=%s", output_file_name);
307 sprintf(instruction_set_arg, "--instruction-set=%s", instruction_set);
308 sprintf(instruction_set_variant_arg, "--instruction-set-variant=%s", dex2oat_isa_variant);
309 sprintf(instruction_set_features_arg, "--instruction-set-features=%s", dex2oat_isa_features);
310 if (swap_fd >= 0) {
311 have_dex2oat_swap_fd = true;
312 sprintf(dex2oat_swap_fd, "--swap-fd=%d", swap_fd);
313 }
314 if (image_fd >= 0) {
315 have_dex2oat_image_fd = true;
316 sprintf(dex2oat_image_fd, "--app-image-fd=%d", image_fd);
317 }
318
319 if (have_dex2oat_Xms_flag) {
320 sprintf(dex2oat_Xms_arg, "-Xms%s", dex2oat_Xms_flag);
321 }
322 if (have_dex2oat_Xmx_flag) {
323 sprintf(dex2oat_Xmx_arg, "-Xmx%s", dex2oat_Xmx_flag);
324 }
325
326 // Compute compiler filter.
327
Nicolas Geoffraya0af34d2017-05-03 13:21:37 +0100328 bool have_dex2oat_compiler_filter_flag = false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700329 if (skip_compilation) {
Nicolas Geoffray63d8e562017-04-25 12:28:28 +0100330 strcpy(dex2oat_compiler_filter_arg, "--compiler-filter=extract");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700331 have_dex2oat_compiler_filter_flag = true;
332 have_dex2oat_relocation_skip_flag = true;
Nicolas Geoffraya0af34d2017-05-03 13:21:37 +0100333 } else if (compiler_filter != nullptr) {
334 if (strlen(compiler_filter) + strlen("--compiler-filter=") <
Jeff Sharkey90aff262016-12-12 14:28:24 -0700335 arraysize(dex2oat_compiler_filter_arg)) {
Nicolas Geoffraya0af34d2017-05-03 13:21:37 +0100336 sprintf(dex2oat_compiler_filter_arg, "--compiler-filter=%s", compiler_filter);
337 have_dex2oat_compiler_filter_flag = true;
338 } else {
339 ALOGW("Compiler filter name '%s' is too large (max characters is %zu)",
340 compiler_filter,
341 kPropertyValueMax);
342 }
343 }
344
345 if (!have_dex2oat_compiler_filter_flag) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700346 char dex2oat_compiler_filter_flag[kPropertyValueMax];
347 have_dex2oat_compiler_filter_flag = get_property("dalvik.vm.dex2oat-filter",
348 dex2oat_compiler_filter_flag, NULL) > 0;
349 if (have_dex2oat_compiler_filter_flag) {
350 sprintf(dex2oat_compiler_filter_arg,
351 "--compiler-filter=%s",
352 dex2oat_compiler_filter_flag);
353 }
354 }
355
356 // Check whether all apps should be compiled debuggable.
357 if (!debuggable) {
358 char prop_buf[kPropertyValueMax];
359 debuggable =
360 (get_property("dalvik.vm.always_debuggable", prop_buf, "0") > 0) &&
361 (prop_buf[0] == '1');
362 }
363 char profile_arg[strlen("--profile-file-fd=") + MAX_INT_LEN];
364 if (profile_fd != -1) {
365 sprintf(profile_arg, "--profile-file-fd=%d", profile_fd);
366 }
367
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700368 // Get the directory of the apk to pass as a base classpath directory.
369 char base_dir[arraysize("--classpath-dir=") + PKG_PATH_MAX];
370 std::string apk_dir(input_file_name);
371 unsigned long dir_index = apk_dir.rfind('/');
372 bool has_base_dir = dir_index != std::string::npos;
373 if (has_base_dir) {
374 apk_dir = apk_dir.substr(0, dir_index);
375 sprintf(base_dir, "--classpath-dir=%s", apk_dir.c_str());
376 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700377
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700378
Andreas Gampef2d5d512017-07-24 16:49:10 -0700379 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700380
381 const char* argv[9 // program name, mandatory arguments and the final NULL
382 + (have_dex2oat_isa_variant ? 1 : 0)
383 + (have_dex2oat_isa_features ? 1 : 0)
384 + (have_dex2oat_Xms_flag ? 2 : 0)
385 + (have_dex2oat_Xmx_flag ? 2 : 0)
386 + (have_dex2oat_compiler_filter_flag ? 1 : 0)
387 + (have_dex2oat_threads_flag ? 1 : 0)
388 + (have_dex2oat_swap_fd ? 1 : 0)
389 + (have_dex2oat_image_fd ? 1 : 0)
390 + (have_dex2oat_relocation_skip_flag ? 2 : 0)
391 + (generate_debug_info ? 1 : 0)
392 + (debuggable ? 1 : 0)
393 + (have_app_image_format ? 1 : 0)
394 + dex2oat_flags_count
395 + (profile_fd == -1 ? 0 : 1)
396 + (shared_libraries != nullptr ? 4 : 0)
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700397 + (has_base_dir ? 1 : 0)
Jeff Sharkey90aff262016-12-12 14:28:24 -0700398 + (have_dex2oat_large_app_threshold ? 1 : 0)];
399 int i = 0;
Andreas Gampef2d5d512017-07-24 16:49:10 -0700400 argv[i++] = dex2oat_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700401 argv[i++] = zip_fd_arg;
402 argv[i++] = zip_location_arg;
403 argv[i++] = input_vdex_fd_arg;
404 argv[i++] = output_vdex_fd_arg;
405 argv[i++] = oat_fd_arg;
406 argv[i++] = oat_location_arg;
407 argv[i++] = instruction_set_arg;
408 if (have_dex2oat_isa_variant) {
409 argv[i++] = instruction_set_variant_arg;
410 }
411 if (have_dex2oat_isa_features) {
412 argv[i++] = instruction_set_features_arg;
413 }
414 if (have_dex2oat_Xms_flag) {
415 argv[i++] = RUNTIME_ARG;
416 argv[i++] = dex2oat_Xms_arg;
417 }
418 if (have_dex2oat_Xmx_flag) {
419 argv[i++] = RUNTIME_ARG;
420 argv[i++] = dex2oat_Xmx_arg;
421 }
422 if (have_dex2oat_compiler_filter_flag) {
423 argv[i++] = dex2oat_compiler_filter_arg;
424 }
425 if (have_dex2oat_threads_flag) {
426 argv[i++] = dex2oat_threads_arg;
427 }
428 if (have_dex2oat_swap_fd) {
429 argv[i++] = dex2oat_swap_fd;
430 }
431 if (have_dex2oat_image_fd) {
432 argv[i++] = dex2oat_image_fd;
433 }
434 if (generate_debug_info) {
435 argv[i++] = "--generate-debug-info";
436 }
437 if (debuggable) {
438 argv[i++] = "--debuggable";
439 }
440 if (have_app_image_format) {
441 argv[i++] = image_format_arg;
442 }
443 if (have_dex2oat_large_app_threshold) {
444 argv[i++] = dex2oat_large_app_threshold_arg;
445 }
446 if (dex2oat_flags_count) {
447 i += split(dex2oat_flags, argv + i);
448 }
449 if (have_dex2oat_relocation_skip_flag) {
450 argv[i++] = RUNTIME_ARG;
451 argv[i++] = dex2oat_norelocation;
452 }
453 if (profile_fd != -1) {
454 argv[i++] = profile_arg;
455 }
456 if (shared_libraries != nullptr) {
457 argv[i++] = RUNTIME_ARG;
458 argv[i++] = "-classpath";
459 argv[i++] = RUNTIME_ARG;
460 argv[i++] = shared_libraries;
461 }
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700462 if (has_base_dir) {
463 argv[i++] = base_dir;
464 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700465 // Do not add after dex2oat_flags, they should override others for debugging.
466 argv[i] = NULL;
467
Andreas Gampef2d5d512017-07-24 16:49:10 -0700468 execv(dex2oat_bin, (char * const *)argv);
469 ALOGE("execv(%s) failed: %s\n", dex2oat_bin, strerror(errno));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700470}
471
472/*
473 * Whether dexopt should use a swap file when compiling an APK.
474 *
475 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
476 * itself, anyways).
477 *
478 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
479 *
480 * Otherwise, return true if this is a low-mem device.
481 *
482 * Otherwise, return default value.
483 */
484static bool kAlwaysProvideSwapFile = false;
485static bool kDefaultProvideSwapFile = true;
486
487static bool ShouldUseSwapFileForDexopt() {
488 if (kAlwaysProvideSwapFile) {
489 return true;
490 }
491
492 // Check the "override" property. If it exists, return value == "true".
493 char dex2oat_prop_buf[kPropertyValueMax];
494 if (get_property("dalvik.vm.dex2oat-swap", dex2oat_prop_buf, "") > 0) {
495 if (strcmp(dex2oat_prop_buf, "true") == 0) {
496 return true;
497 } else {
498 return false;
499 }
500 }
501
502 // Shortcut for default value. This is an implementation optimization for the process sketched
503 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
504 // as low-mem is never returning false. The compiler will optimize this away if it can.
505 if (kDefaultProvideSwapFile) {
506 return true;
507 }
508
509 bool is_low_mem = property_get_bool("ro.config.low_ram", false);
510 if (is_low_mem) {
511 return true;
512 }
513
514 // Default value must be false here.
515 return kDefaultProvideSwapFile;
516}
517
Richard Uhler76cc0272016-12-08 10:46:35 +0000518static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700519 if (set_to_bg) {
520 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
521 ALOGE("set_sched_policy failed: %s\n", strerror(errno));
522 exit(70);
523 }
524 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
525 ALOGE("setpriority failed: %s\n", strerror(errno));
526 exit(71);
527 }
528 }
529}
530
Calin Juravle114f0812017-03-08 19:05:07 -0800531static bool create_profile(int uid, const std::string& profile) {
532 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), O_CREAT | O_NOFOLLOW, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800533 if (fd.get() < 0) {
Calin Juravle114f0812017-03-08 19:05:07 -0800534 if (errno == EEXIST) {
535 return true;
536 } else {
537 PLOG(ERROR) << "Failed to create profile " << profile;
538 return false;
539 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700540 }
Calin Juravle114f0812017-03-08 19:05:07 -0800541 // Profiles should belong to the app; make sure of that by giving ownership to
542 // the app uid. If we cannot do that, there's no point in returning the fd
543 // since dex2oat/profman will fail with SElinux denials.
544 if (fchown(fd.get(), uid, uid) < 0) {
545 PLOG(ERROR) << "Could not chwon profile " << profile;
546 return false;
547 }
548 return true;
549}
550
551static unique_fd open_profile(int uid, const std::string& profile, bool read_write) {
552 // Check if we need to open the profile for a read-write operation. If so, we
553 // might need to create the profile since the file might not be there. Reference
554 // profiles are created on the fly so they might not exist beforehand.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700555 if (read_write) {
Calin Juravle114f0812017-03-08 19:05:07 -0800556 if (!create_profile(uid, profile)) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800557 return invalid_unique_fd();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700558 }
559 }
Calin Juravle114f0812017-03-08 19:05:07 -0800560 int flags = read_write ? O_RDWR : O_RDONLY;
561 // Do not follow symlinks when opening a profile:
562 // - primary profiles should not contain symlinks in their paths
563 // - secondary dex paths should have been already resolved and validated
564 flags |= O_NOFOLLOW;
565
566 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
567 if (fd.get() < 0) {
568 if (errno != ENOENT) {
569 // Profiles might be missing for various reasons. For example, in a
570 // multi-user environment, the profile directory for one user can be created
571 // after we start a merge. In this case the current profile for that user
572 // will not be found.
573 // Also, the secondary dex profiles might be deleted by the app at any time,
574 // so we can't we need to prepare if they are missing.
575 PLOG(ERROR) << "Failed to open profile " << profile;
576 }
577 return invalid_unique_fd();
578 }
579
Jeff Sharkey90aff262016-12-12 14:28:24 -0700580 return fd;
581}
582
Calin Juravle114f0812017-03-08 19:05:07 -0800583static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& location,
584 bool is_secondary_dex) {
585 std::string profile = create_current_profile_path(user, location, is_secondary_dex);
586 return open_profile(uid, profile, /*read_write*/false);
587}
588
589static unique_fd open_reference_profile(uid_t uid, const std::string& location, bool read_write,
590 bool is_secondary_dex) {
591 std::string profile = create_reference_profile_path(location, is_secondary_dex);
592 return open_profile(uid, profile, read_write);
593}
594
595static void open_profile_files(uid_t uid, const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800596 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700597 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle114f0812017-03-08 19:05:07 -0800598 *reference_profile_fd = open_reference_profile(uid, location, /*read_write*/ true,
599 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700600
Calin Juravle114f0812017-03-08 19:05:07 -0800601 // For secondary dex files, we don't really need the user but we use it for sanity checks.
602 // Note: the user owning the dex file should be the current user.
603 std::vector<userid_t> users;
604 if (is_secondary_dex){
605 users.push_back(multiuser_get_user_id(uid));
606 } else {
607 users = get_known_users(/*volume_uuid*/ nullptr);
608 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700609 for (auto user : users) {
Calin Juravle114f0812017-03-08 19:05:07 -0800610 unique_fd profile_fd = open_current_profile(uid, user, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700611 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800612 if (profile_fd.get() >= 0) {
613 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700614 }
615 }
616}
617
618static void drop_capabilities(uid_t uid) {
619 if (setgid(uid) != 0) {
620 ALOGE("setgid(%d) failed in installd during dexopt\n", uid);
621 exit(64);
622 }
623 if (setuid(uid) != 0) {
624 ALOGE("setuid(%d) failed in installd during dexopt\n", uid);
625 exit(65);
626 }
627 // drop capabilities
628 struct __user_cap_header_struct capheader;
629 struct __user_cap_data_struct capdata[2];
630 memset(&capheader, 0, sizeof(capheader));
631 memset(&capdata, 0, sizeof(capdata));
632 capheader.version = _LINUX_CAPABILITY_VERSION_3;
633 if (capset(&capheader, &capdata[0]) < 0) {
634 ALOGE("capset failed: %s\n", strerror(errno));
635 exit(66);
636 }
637}
638
639static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
640static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
641static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
642static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
643static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
644
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800645static void run_profman_merge(const std::vector<unique_fd>& profiles_fd,
646 const unique_fd& reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700647 static const size_t MAX_INT_LEN = 32;
Andreas Gampef2d5d512017-07-24 16:49:10 -0700648 const char* profman_bin = is_debug_runtime() ? "/system/bin/profmand" : "/system/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700649
650 std::vector<std::string> profile_args(profiles_fd.size());
651 char profile_buf[strlen("--profile-file-fd=") + MAX_INT_LEN];
652 for (size_t k = 0; k < profiles_fd.size(); k++) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800653 sprintf(profile_buf, "--profile-file-fd=%d", profiles_fd[k].get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700654 profile_args[k].assign(profile_buf);
655 }
656 char reference_profile_arg[strlen("--reference-profile-file-fd=") + MAX_INT_LEN];
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800657 sprintf(reference_profile_arg, "--reference-profile-file-fd=%d", reference_profile_fd.get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700658
659 // program name, reference profile fd, the final NULL and the profile fds
660 const char* argv[3 + profiles_fd.size()];
661 int i = 0;
Andreas Gampef2d5d512017-07-24 16:49:10 -0700662 argv[i++] = profman_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700663 argv[i++] = reference_profile_arg;
664 for (size_t k = 0; k < profile_args.size(); k++) {
665 argv[i++] = profile_args[k].c_str();
666 }
667 // Do not add after dex2oat_flags, they should override others for debugging.
668 argv[i] = NULL;
669
Andreas Gampef2d5d512017-07-24 16:49:10 -0700670 execv(profman_bin, (char * const *)argv);
671 ALOGE("execv(%s) failed: %s\n", profman_bin, strerror(errno));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700672 exit(68); /* only get here on exec failure */
673}
674
675// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800676// The location is the package name for primary apks or the dex path for secondary dex files.
677// Returns true if there is enough information in the current profiles that makes it
678// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700679// If the return value is true all the current profiles would have been merged into
680// the reference profiles accessible with open_reference_profile().
Calin Juravle114f0812017-03-08 19:05:07 -0800681static bool analyze_profiles(uid_t uid, const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800682 std::vector<unique_fd> profiles_fd;
683 unique_fd reference_profile_fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800684 open_profile_files(uid, location, is_secondary_dex, &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800685 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700686 // Skip profile guided compilation because no profiles were found.
687 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700688 return false;
689 }
690
Jeff Sharkey90aff262016-12-12 14:28:24 -0700691 pid_t pid = fork();
692 if (pid == 0) {
693 /* child -- drop privileges before continuing */
694 drop_capabilities(uid);
695 run_profman_merge(profiles_fd, reference_profile_fd);
696 exit(68); /* only get here on exec failure */
697 }
698 /* parent */
699 int return_code = wait_child(pid);
700 bool need_to_compile = false;
701 bool should_clear_current_profiles = false;
702 bool should_clear_reference_profile = false;
703 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800704 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700705 } else {
706 return_code = WEXITSTATUS(return_code);
707 switch (return_code) {
708 case PROFMAN_BIN_RETURN_CODE_COMPILE:
709 need_to_compile = true;
710 should_clear_current_profiles = true;
711 should_clear_reference_profile = false;
712 break;
713 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
714 need_to_compile = false;
715 should_clear_current_profiles = false;
716 should_clear_reference_profile = false;
717 break;
718 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800719 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700720 need_to_compile = false;
721 should_clear_current_profiles = true;
722 should_clear_reference_profile = true;
723 break;
724 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
725 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
726 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800727 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700728 need_to_compile = false;
729 should_clear_current_profiles = false;
730 should_clear_reference_profile = false;
731 break;
732 default:
733 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800734 LOG(WARNING) << "Unknown error code while processing profiles for location "
735 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700736 need_to_compile = false;
737 should_clear_current_profiles = true;
738 should_clear_reference_profile = true;
739 break;
740 }
741 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800742
Jeff Sharkey90aff262016-12-12 14:28:24 -0700743 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800744 if (is_secondary_dex) {
745 // For secondary dex files, the owning user is the current user.
746 clear_current_profile(location, multiuser_get_user_id(uid), is_secondary_dex);
747 } else {
748 clear_primary_current_profiles(location);
749 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700750 }
751 if (should_clear_reference_profile) {
Calin Juravle114f0812017-03-08 19:05:07 -0800752 clear_reference_profile(location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700753 }
754 return need_to_compile;
755}
756
Calin Juravle114f0812017-03-08 19:05:07 -0800757// Decides if profile guided compilation is needed or not based on existing profiles.
758// The analysis is done for the primary apks of the given package.
759// Returns true if there is enough information in the current profiles that makes it
760// worth to recompile the package.
761// If the return value is true all the current profiles would have been merged into
762// the reference profiles accessible with open_reference_profile().
763bool analyze_primary_profiles(uid_t uid, const std::string& pkgname) {
764 return analyze_profiles(uid, pkgname, /*is_secondary_dex*/false);
765}
766
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800767static void run_profman_dump(const std::vector<unique_fd>& profile_fds,
768 const unique_fd& reference_profile_fd,
Jeff Sharkey90aff262016-12-12 14:28:24 -0700769 const std::vector<std::string>& dex_locations,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800770 const std::vector<unique_fd>& apk_fds,
771 const unique_fd& output_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700772 std::vector<std::string> profman_args;
773 static const char* PROFMAN_BIN = "/system/bin/profman";
774 profman_args.push_back(PROFMAN_BIN);
775 profman_args.push_back("--dump-only");
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800776 profman_args.push_back(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700777 if (reference_profile_fd != -1) {
778 profman_args.push_back(StringPrintf("--reference-profile-file-fd=%d",
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800779 reference_profile_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700780 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800781 for (size_t i = 0; i < profile_fds.size(); i++) {
782 profman_args.push_back(StringPrintf("--profile-file-fd=%d", profile_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700783 }
784 for (const std::string& dex_location : dex_locations) {
785 profman_args.push_back(StringPrintf("--dex-location=%s", dex_location.c_str()));
786 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800787 for (size_t i = 0; i < apk_fds.size(); i++) {
788 profman_args.push_back(StringPrintf("--apk-fd=%d", apk_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700789 }
790 const char **argv = new const char*[profman_args.size() + 1];
791 size_t i = 0;
792 for (const std::string& profman_arg : profman_args) {
793 argv[i++] = profman_arg.c_str();
794 }
795 argv[i] = NULL;
796
797 execv(PROFMAN_BIN, (char * const *)argv);
798 ALOGE("execv(%s) failed: %s\n", PROFMAN_BIN, strerror(errno));
799 exit(68); /* only get here on exec failure */
800}
801
Calin Juravle76268c52017-03-09 13:19:42 -0800802bool dump_profiles(int32_t uid, const std::string& pkgname, const char* code_paths) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800803 std::vector<unique_fd> profile_fds;
804 unique_fd reference_profile_fd;
Calin Juravle76268c52017-03-09 13:19:42 -0800805 std::string out_file_name = StringPrintf("/data/misc/profman/%s.txt", pkgname.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700806
Calin Juravle114f0812017-03-08 19:05:07 -0800807 open_profile_files(uid, pkgname, /*is_secondary_dex*/false,
808 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700809
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800810 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700811 const bool has_profiles = !profile_fds.empty();
812
813 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800814 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700815 return false;
816 }
817
Calin Juravle114f0812017-03-08 19:05:07 -0800818 unique_fd output_fd(open(out_file_name.c_str(),
819 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700820 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
821 ALOGE("installd cannot chmod '%s' dump_profile\n", out_file_name.c_str());
822 return false;
823 }
824 std::vector<std::string> code_full_paths = base::Split(code_paths, ";");
825 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800826 std::vector<unique_fd> apk_fds;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700827 for (const std::string& code_full_path : code_full_paths) {
828 const char* full_path = code_full_path.c_str();
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800829 unique_fd apk_fd(open(full_path, O_RDONLY | O_NOFOLLOW));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700830 if (apk_fd == -1) {
831 ALOGE("installd cannot open '%s'\n", full_path);
832 return false;
833 }
834 dex_locations.push_back(get_location_from_path(full_path));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800835 apk_fds.push_back(std::move(apk_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700836 }
837
838 pid_t pid = fork();
839 if (pid == 0) {
840 /* child -- drop privileges before continuing */
841 drop_capabilities(uid);
842 run_profman_dump(profile_fds, reference_profile_fd, dex_locations,
843 apk_fds, output_fd);
844 exit(68); /* only get here on exec failure */
845 }
846 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700847 int return_code = wait_child(pid);
848 if (!WIFEXITED(return_code)) {
849 LOG(WARNING) << "profman failed for package " << pkgname << ": "
850 << return_code;
851 return false;
852 }
853 return true;
854}
855
856static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
857 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
858 if (EndsWith(oat_path, ".dex")) {
859 std::string new_path = oat_path;
860 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
861 CHECK(EndsWith(new_path, new_ext.c_str()));
862 return new_path;
863 }
864
865 // An odex entry. Not that this may not be an extension, e.g., in the OTA
866 // case (where the base name will have an extension for the B artifact).
867 size_t odex_pos = oat_path.rfind(".odex");
868 if (odex_pos != std::string::npos) {
869 std::string new_path = oat_path;
870 new_path.replace(odex_pos, strlen(".odex"), new_ext);
871 CHECK_NE(new_path.find(new_ext), std::string::npos);
872 return new_path;
873 }
874
875 // Don't know how to handle this.
876 return "";
877}
878
879// Translate the given oat path to an art (app image) path. An empty string
880// denotes an error.
881static std::string create_image_filename(const std::string& oat_path) {
882 return replace_file_extension(oat_path, ".art");
883}
884
885// Translate the given oat path to a vdex path. An empty string denotes an error.
886static std::string create_vdex_filename(const std::string& oat_path) {
887 return replace_file_extension(oat_path, ".vdex");
888}
889
890static bool add_extension_to_file_name(char* file_name, const char* extension) {
891 if (strlen(file_name) + strlen(extension) + 1 > PKG_PATH_MAX) {
892 return false;
893 }
894 strcat(file_name, extension);
895 return true;
896}
897
898static int open_output_file(const char* file_name, bool recreate, int permissions) {
899 int flags = O_RDWR | O_CREAT;
900 if (recreate) {
901 if (unlink(file_name) < 0) {
902 if (errno != ENOENT) {
903 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
904 }
905 }
906 flags |= O_EXCL;
907 }
908 return open(file_name, flags, permissions);
909}
910
Calin Juravle2289c0a2017-02-15 12:44:14 -0800911static bool set_permissions_and_ownership(
912 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
913 // Primary apks are owned by the system. Secondary dex files are owned by the app.
914 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700915 if (fchmod(fd,
916 S_IRUSR|S_IWUSR|S_IRGRP |
917 (is_public ? S_IROTH : 0)) < 0) {
918 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
919 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -0800920 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700921 ALOGE("installd cannot chown '%s' during dexopt\n", path);
922 return false;
923 }
924 return true;
925}
926
927static bool IsOutputDalvikCache(const char* oat_dir) {
928 // InstallerConnection.java (which invokes installd) transforms Java null arguments
929 // into '!'. Play it safe by handling it both.
930 // TODO: ensure we never get null.
931 // TODO: pass a flag instead of inferring if the output is dalvik cache.
932 return oat_dir == nullptr || oat_dir[0] == '!';
933}
934
935static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -0800936 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700937 // Early best-effort check whether we can fit the the path into our buffers.
938 // Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
939 // without a swap file, if necessary. Reference profiles file also add an extra ".prof"
940 // extension to the cache path (5 bytes).
941 if (strlen(apk_path) >= (PKG_PATH_MAX - 8)) {
942 ALOGE("apk_path too long '%s'\n", apk_path);
943 return false;
944 }
945
946 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -0800947 // Oat dirs for secondary dex files are already validated.
948 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700949 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
950 return false;
951 }
952 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
953 return false;
954 }
955 } else {
956 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
957 return false;
958 }
959 }
960 return true;
961}
962
963// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
964// on destruction. It will also run the given cleanup (unless told not to) after closing.
965//
966// Usage example:
967//
Calin Juravle7a570e82017-01-14 16:23:30 -0800968// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -0700969// [name]() {
970// unlink(name.c_str());
971// });
972// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
973// wrapper if captured as a reference.
974//
975// if (file.get() == -1) {
976// // Error opening...
977// }
978//
979// ...
980// if (error) {
981// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
982// // and delete the file (after the fd is closed).
983// return -1;
984// }
985//
986// (Success case)
987// file.SetCleanup(false);
988// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
989// // (leaving the file around; after the fd is closed).
990//
Jeff Sharkey90aff262016-12-12 14:28:24 -0700991class Dex2oatFileWrapper {
992 public:
Calin Juravle7a570e82017-01-14 16:23:30 -0800993 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700994 }
995
Calin Juravle7a570e82017-01-14 16:23:30 -0800996 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
997 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
998
999 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1000 value_ = other.value_;
1001 cleanup_ = other.cleanup_;
1002 do_cleanup_ = other.do_cleanup_;
1003 auto_close_ = other.auto_close_;
1004 other.release();
1005 }
1006
1007 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1008 value_ = other.value_;
1009 cleanup_ = other.cleanup_;
1010 do_cleanup_ = other.do_cleanup_;
1011 auto_close_ = other.auto_close_;
1012 other.release();
1013 return *this;
1014 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001015
1016 ~Dex2oatFileWrapper() {
1017 reset(-1);
1018 }
1019
1020 int get() {
1021 return value_;
1022 }
1023
1024 void SetCleanup(bool cleanup) {
1025 do_cleanup_ = cleanup;
1026 }
1027
1028 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001029 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001030 close(value_);
1031 }
1032 if (do_cleanup_ && cleanup_ != nullptr) {
1033 cleanup_();
1034 }
1035
1036 value_ = new_value;
1037 }
1038
Calin Juravle7a570e82017-01-14 16:23:30 -08001039 void reset(int new_value, std::function<void ()> new_cleanup) {
1040 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001041 close(value_);
1042 }
1043 if (do_cleanup_ && cleanup_ != nullptr) {
1044 cleanup_();
1045 }
1046
1047 value_ = new_value;
1048 cleanup_ = new_cleanup;
1049 }
1050
Calin Juravle7a570e82017-01-14 16:23:30 -08001051 void DisableAutoClose() {
1052 auto_close_ = false;
1053 }
1054
Jeff Sharkey90aff262016-12-12 14:28:24 -07001055 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001056 void release() {
1057 value_ = -1;
1058 do_cleanup_ = false;
1059 cleanup_ = nullptr;
1060 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001061 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001062 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001063 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001064 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001065};
1066
Calin Juravle7a570e82017-01-14 16:23:30 -08001067// (re)Creates the app image if needed.
1068Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path, bool profile_guided,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001069 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001070 // Use app images only if it is enabled (by a set image format) and we are compiling
1071 // profile-guided (so the app image doesn't conservatively contain all classes).
Calin Juravle2289c0a2017-02-15 12:44:14 -08001072 // Note that we don't create an image for secondary dex files.
1073 if (is_secondary_dex || !profile_guided) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001074 return Dex2oatFileWrapper();
1075 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001076
Calin Juravle7a570e82017-01-14 16:23:30 -08001077 const std::string image_path = create_image_filename(out_oat_path);
1078 if (image_path.empty()) {
1079 // Happens when the out_oat_path has an unknown extension.
1080 return Dex2oatFileWrapper();
1081 }
1082 char app_image_format[kPropertyValueMax];
1083 bool have_app_image_format =
1084 get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
1085 if (!have_app_image_format) {
1086 return Dex2oatFileWrapper();
1087 }
1088 // Recreate is true since we do not want to modify a mapped image. If the app is
1089 // already running and we modify the image file, it can cause crashes (b/27493510).
1090 Dex2oatFileWrapper wrapper_fd(
1091 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1092 [image_path]() { unlink(image_path.c_str()); });
1093 if (wrapper_fd.get() < 0) {
1094 // Could not create application image file. Go on since we can compile without it.
1095 LOG(ERROR) << "installd could not create '" << image_path
1096 << "' for image file during dexopt";
1097 // If we have a valid image file path but no image fd, explicitly erase the image file.
1098 if (unlink(image_path.c_str()) < 0) {
1099 if (errno != ENOENT) {
1100 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1101 }
1102 }
1103 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001104 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001105 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1106 wrapper_fd.reset(-1);
1107 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001108
Calin Juravle7a570e82017-01-14 16:23:30 -08001109 return wrapper_fd;
1110}
1111
1112// Creates the dexopt swap file if necessary and return its fd.
1113// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001114unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001115 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001116 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001117 }
1118 // Make sure there really is enough space.
1119 char swap_file_name[PKG_PATH_MAX];
1120 strcpy(swap_file_name, out_oat_path);
1121 if (!add_extension_to_file_name(swap_file_name, ".swap")) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001122 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001123 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001124 unique_fd swap_fd(open_output_file(
Calin Juravle7a570e82017-01-14 16:23:30 -08001125 swap_file_name, /*recreate*/true, /*permissions*/0600));
1126 if (swap_fd.get() < 0) {
1127 // Could not create swap file. Optimistically go on and hope that we can compile
1128 // without it.
1129 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name);
1130 } else {
1131 // Immediately unlink. We don't really want to hit flash.
1132 if (unlink(swap_file_name) < 0) {
1133 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1134 }
1135 }
1136 return swap_fd;
1137}
1138
1139// Opens the reference profiles if needed.
1140// 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 -08001141Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
1142 const std::string& dex_path, bool profile_guided, bool is_public, int uid,
1143 bool is_secondary_dex) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001144 // Public apps should not be compiled with profile information ever. Same goes for the special
1145 // package '*' used for the system server.
Calin Juravle114f0812017-03-08 19:05:07 -08001146 if (!profile_guided || is_public || (pkgname[0] == '*')) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001147 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001148 }
Calin Juravle114f0812017-03-08 19:05:07 -08001149
1150 // Open reference profile in read only mode as dex2oat does not get write permissions.
1151 const std::string location = is_secondary_dex ? dex_path : pkgname;
1152 unique_fd ufd = open_reference_profile(uid, location, /*read_write*/false, is_secondary_dex);
1153 const auto& cleanup = [location, is_secondary_dex]() {
1154 clear_reference_profile(location.c_str(), is_secondary_dex);
1155 };
1156 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001157}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001158
Calin Juravle7a570e82017-01-14 16:23:30 -08001159// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1160// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
1161bool open_vdex_files(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray575fc2c2017-04-24 13:34:59 +00001162 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001163 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001164 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1165 CHECK(in_vdex_wrapper_fd != nullptr);
1166 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001167 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1168 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001169 char in_odex_path[PKG_PATH_MAX];
1170 int dexopt_action = abs(dexopt_needed);
1171 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001172 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001173
1174 // Infer the name of the output VDEX.
1175 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1176 if (out_vdex_path_str.empty()) {
1177 return false;
1178 }
1179
1180 bool update_vdex_in_place = false;
Nicolas Geoffray575fc2c2017-04-24 13:34:59 +00001181 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001182 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1183 const char* path = nullptr;
1184 if (is_odex_location) {
1185 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1186 path = in_odex_path;
1187 } else {
1188 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001189 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001190 }
1191 } else {
1192 path = out_oat_path;
1193 }
1194 in_vdex_path_str = create_vdex_filename(path);
1195 if (in_vdex_path_str.empty()) {
1196 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001197 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001198 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001199 // We can update in place when all these conditions are met:
1200 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1201 // on /system typically cannot be updated in place).
1202 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1203 // cannot be currently used by a running process.
1204 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1205 // different vdex files to operate.
1206 update_vdex_in_place =
1207 (in_vdex_path_str == out_vdex_path_str) &&
1208 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1209 !profile_guided;
1210 if (update_vdex_in_place) {
1211 // Open the file read-write to be able to update it.
1212 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1213 if (in_vdex_wrapper_fd->get() == -1) {
1214 // If we failed to open the file, we cannot update it in place.
1215 update_vdex_in_place = false;
1216 }
1217 } else {
1218 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1219 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001220 }
1221
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001222 // If we are updating the vdex in place, we do not need to recreate a vdex,
1223 // and can use the same existing one.
1224 if (update_vdex_in_place) {
1225 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1226 // have bogus stale vdex files.
1227 out_vdex_wrapper_fd->reset(
1228 in_vdex_wrapper_fd->get(),
1229 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1230 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1231 // wrapper).
1232 in_vdex_wrapper_fd->DisableAutoClose();
1233 } else {
1234 out_vdex_wrapper_fd->reset(
1235 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1236 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1237 if (out_vdex_wrapper_fd->get() < 0) {
1238 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1239 return false;
1240 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001241 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001242 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001243 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001244 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1245 return false;
1246 }
1247
1248 // If we got here we successfully opened the vdex files.
1249 return true;
1250}
1251
1252// Opens the output oat file for the given apk.
1253// If successful it stores the output path into out_oat_path and returns true.
1254Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001255 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1256 char* out_oat_path) {
1257 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001258 return Dex2oatFileWrapper();
1259 }
1260 const std::string out_oat_path_str(out_oat_path);
1261 Dex2oatFileWrapper wrapper_fd(
1262 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1263 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1264 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001265 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001266 } else if (!set_permissions_and_ownership(
1267 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001268 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1269 wrapper_fd.reset(-1);
1270 }
1271 return wrapper_fd;
1272}
1273
1274// Updates the access times of out_oat_path based on those from apk_path.
1275void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1276 struct stat input_stat;
1277 memset(&input_stat, 0, sizeof(input_stat));
1278 if (stat(apk_path, &input_stat) != 0) {
1279 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1280 return;
1281 }
1282
1283 struct utimbuf ut;
1284 ut.actime = input_stat.st_atime;
1285 ut.modtime = input_stat.st_mtime;
1286 if (utime(out_oat_path, &ut) != 0) {
1287 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1288 }
1289}
1290
Calin Juravle80a21252017-01-17 14:43:25 -08001291// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001292// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1293// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1294// the profile has changed.
1295static void exec_dexoptanalyzer(const std::string& dex_file, const char* instruction_set,
1296 const char* compiler_filter, bool profile_was_updated) {
Andreas Gampef2d5d512017-07-24 16:49:10 -07001297 const char* dexoptanalyzer_bin =
1298 is_debug_runtime()
1299 ? "/system/bin/dexoptanalyzerd"
1300 : "/system/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001301 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
1302
1303 if (strlen(instruction_set) >= MAX_INSTRUCTION_SET_LEN) {
1304 ALOGE("Instruction set %s longer than max length of %d",
1305 instruction_set, MAX_INSTRUCTION_SET_LEN);
1306 return;
1307 }
1308
1309 char dex_file_arg[strlen("--dex-file=") + PKG_PATH_MAX];
1310 char isa_arg[strlen("--isa=") + MAX_INSTRUCTION_SET_LEN];
1311 char compiler_filter_arg[strlen("--compiler-filter=") + kPropertyValueMax];
Calin Juravle114f0812017-03-08 19:05:07 -08001312 const char* assume_profile_changed = "--assume-profile-changed";
Calin Juravle80a21252017-01-17 14:43:25 -08001313
Calin Juravle114f0812017-03-08 19:05:07 -08001314 sprintf(dex_file_arg, "--dex-file=%s", dex_file.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001315 sprintf(isa_arg, "--isa=%s", instruction_set);
1316 sprintf(compiler_filter_arg, "--compiler-filter=%s", compiler_filter);
1317
1318 // program name, dex file, isa, filter, the final NULL
Calin Juravle114f0812017-03-08 19:05:07 -08001319 const char* argv[5 + (profile_was_updated ? 1 : 0)];
Calin Juravle80a21252017-01-17 14:43:25 -08001320 int i = 0;
Andreas Gampef2d5d512017-07-24 16:49:10 -07001321 argv[i++] = dexoptanalyzer_bin;
Calin Juravle80a21252017-01-17 14:43:25 -08001322 argv[i++] = dex_file_arg;
1323 argv[i++] = isa_arg;
1324 argv[i++] = compiler_filter_arg;
Calin Juravle114f0812017-03-08 19:05:07 -08001325 if (profile_was_updated) {
1326 argv[i++] = assume_profile_changed;
1327 }
Calin Juravle80a21252017-01-17 14:43:25 -08001328 argv[i] = NULL;
1329
Andreas Gampef2d5d512017-07-24 16:49:10 -07001330 execv(dexoptanalyzer_bin, (char * const *)argv);
1331 ALOGE("execv(%s) failed: %s\n", dexoptanalyzer_bin, strerror(errno));
Calin Juravle80a21252017-01-17 14:43:25 -08001332}
1333
1334// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001335static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
1336 const char* instruction_set, std::string* oat_dir_out) {
1337 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001338 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001339 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001340 return false;
1341 }
Calin Juravle114f0812017-03-08 19:05:07 -08001342 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001343
Calin Juravle80a21252017-01-17 14:43:25 -08001344 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001345 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1346 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001347 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001348 return false;
1349 }
1350
1351 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001352 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001353 oat_dir_out->assign(oat_dir);
1354
1355 // Create oat/isa output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001356 if (prepare_app_cache_dir(*oat_dir_out, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001357 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001358 return false;
1359 }
1360
1361 return true;
1362}
1363
1364static int constexpr DEXOPTANALYZER_BIN_EXEC_ERROR = 200;
1365
1366// Verifies the result of dexoptanalyzer executed for the apk_path.
1367// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1368// Returns false for errors or unexpected result values.
Calin Juravle114f0812017-03-08 19:05:07 -08001369static bool process_dexoptanalyzer_result(const std::string& dex_path, int result,
Calin Juravle80a21252017-01-17 14:43:25 -08001370 int* dexopt_needed_out) {
1371 // The result values are defined in dexoptanalyzer.
1372 switch (result) {
1373 case 0: // no_dexopt_needed
1374 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
1375 case 1: // dex2oat_from_scratch
1376 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
1377 case 5: // dex2oat_for_bootimage_odex
1378 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
1379 case 6: // dex2oat_for_filter_odex
1380 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
1381 case 7: // dex2oat_for_relocation_odex
1382 *dexopt_needed_out = -DEX2OAT_FOR_RELOCATION; return true;
1383 case 2: // dex2oat_for_bootimage_oat
1384 case 3: // dex2oat_for_filter_oat
1385 case 4: // dex2oat_for_relocation_oat
Calin Juravlec9eab382017-01-25 01:17:17 -08001386 LOG(ERROR) << "Dexoptnalyzer return the status of an oat file."
1387 << " Expected odex file status for secondary dex " << dex_path
Calin Juravle80a21252017-01-17 14:43:25 -08001388 << " : dexoptanalyzer result=" << result;
1389 return false;
1390 default:
Calin Juravlec9eab382017-01-25 01:17:17 -08001391 LOG(ERROR) << "Unexpected result for dexoptanalyzer " << dex_path
Calin Juravle80a21252017-01-17 14:43:25 -08001392 << " exec_dexoptanalyzer result=" << result;
1393 return false;
1394 }
1395}
1396
Calin Juravlec9eab382017-01-25 01:17:17 -08001397// 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 -08001398// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1399// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001400// When returning true, the output parameters will be:
1401// - is_public_out: whether or not the oat file should not be made public
1402// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1403// - oat_dir_out: the oat dir path where the oat file should be stored
1404// - dex_path_out: the real path of the dex file
Calin Juravle114f0812017-03-08 19:05:07 -08001405static bool process_secondary_dex_dexopt(const char* original_dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001406 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001407 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
1408 std::string* oat_dir_out, std::string* dex_path_out) {
Calin Juravle80a21252017-01-17 14:43:25 -08001409 int storage_flag;
1410
1411 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1412 storage_flag = FLAG_STORAGE_CE;
1413 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1414 LOG(ERROR) << "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
1415 return false;
1416 }
1417 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1418 storage_flag = FLAG_STORAGE_DE;
1419 } else {
1420 LOG(ERROR) << "Secondary dex storage flag must be set";
1421 return false;
1422 }
1423
Calin Juravle114f0812017-03-08 19:05:07 -08001424 {
1425 // As opposed to the primary apk, secondary dex files might contain symlinks.
1426 // Resolve the path before passing it to the validate method to
1427 // make sure the verification is done on the real location.
1428 UniqueCPtr<char> dex_real_path_cstr(realpath(original_dex_path, nullptr));
1429 if (dex_real_path_cstr == nullptr) {
1430 PLOG(ERROR) << "Could not get the real path of the secondary dex file "
1431 << original_dex_path;
1432 return false;
1433 } else {
1434 dex_path_out->assign(dex_real_path_cstr.get());
1435 }
1436 }
1437 const std::string& dex_path = *dex_path_out;
Calin Juravlec9eab382017-01-25 01:17:17 -08001438 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1439 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001440 return false;
1441 }
1442
1443 // Check if the path exist. If not, there's nothing to do.
Calin Juravleebc8a792017-04-04 20:21:05 -07001444 struct stat dex_path_stat;
1445 if (stat(dex_path.c_str(), &dex_path_stat) != 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001446 if (errno == ENOENT) {
1447 // Secondary dex files might be deleted any time by the app.
1448 // Nothing to do if that's the case
Calin Juravle114f0812017-03-08 19:05:07 -08001449 ALOGV("Secondary dex does not exist %s", dex_path.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001450 return NO_DEXOPT_NEEDED;
1451 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001452 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001453 }
1454 }
1455
Calin Juravleebc8a792017-04-04 20:21:05 -07001456 // Check if we should make the oat file public.
1457 // Note that if the dex file is not public the compiled code cannot be made public.
1458 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) &&
1459 ((dex_path_stat.st_mode & S_IROTH) != 0);
1460
Calin Juravle80a21252017-01-17 14:43:25 -08001461 // Prepare the oat directories.
Calin Juravle114f0812017-03-08 19:05:07 -08001462 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set, oat_dir_out)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001463 return false;
1464 }
1465
Calin Juravle114f0812017-03-08 19:05:07 -08001466 // Analyze profiles.
1467 bool profile_was_updated = analyze_profiles(uid, dex_path, /*is_secondary_dex*/true);
1468
Calin Juravle80a21252017-01-17 14:43:25 -08001469 pid_t pid = fork();
1470 if (pid == 0) {
1471 // child -- drop privileges before continuing.
1472 drop_capabilities(uid);
1473 // Run dexoptanalyzer to get dexopt_needed code.
Calin Juravle114f0812017-03-08 19:05:07 -08001474 exec_dexoptanalyzer(dex_path, instruction_set, compiler_filter, profile_was_updated);
Calin Juravle80a21252017-01-17 14:43:25 -08001475 exit(DEXOPTANALYZER_BIN_EXEC_ERROR);
1476 }
1477
1478 /* parent */
1479
1480 int result = wait_child(pid);
1481 if (!WIFEXITED(result)) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001482 LOG(ERROR) << "dexoptanalyzer failed for path " << dex_path << ": " << result;
Calin Juravle80a21252017-01-17 14:43:25 -08001483 return false;
1484 }
1485 result = WEXITSTATUS(result);
Calin Juravlec9eab382017-01-25 01:17:17 -08001486 bool success = process_dexoptanalyzer_result(dex_path, result, dexopt_needed_out);
Calin Juravle80a21252017-01-17 14:43:25 -08001487 // Run dexopt only if needed or forced.
1488 // Note that dexoptanalyzer is executed even if force compilation is enabled.
1489 // We ignore its valid dexopNeeded result, but still check (in process_dexoptanalyzer_result)
1490 // that we only get results for odex files (apk_dir/oat/isa/code.odex) and not
1491 // for oat files from dalvik-cache.
1492 if (success && ((dexopt_flags & DEXOPT_FORCE) != 0)) {
1493 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1494 }
1495
1496 return success;
1497}
1498
Calin Juravlec9eab382017-01-25 01:17:17 -08001499int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001500 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravlecb556e32017-04-04 20:22:50 -07001501 const char* volume_uuid, const char* shared_libraries, const char* se_info) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001502 CHECK(pkgname != nullptr);
1503 CHECK(pkgname[0] != 0);
1504 if ((dexopt_flags & ~DEXOPT_MASK) != 0) {
1505 LOG_FATAL("dexopt flags contains unknown fields\n");
1506 }
1507
Calin Juravleebc8a792017-04-04 20:21:05 -07001508 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001509 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1510 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1511 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001512 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
1513
1514 // Check if we're dealing with a secondary dex file and if we need to compile it.
1515 std::string oat_dir_str;
Calin Juravle114f0812017-03-08 19:05:07 -08001516 std::string dex_real_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001517 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001518 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001519 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
1520 &dex_real_path)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001521 oat_dir = oat_dir_str.c_str();
Calin Juravle114f0812017-03-08 19:05:07 -08001522 dex_path = dex_real_path.c_str();
Calin Juravle80a21252017-01-17 14:43:25 -08001523 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1524 return 0; // Nothing to do, report success.
1525 }
1526 } else {
1527 return -1; // We had an error, logged in the process method.
1528 }
1529 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001530 // Currently these flags are only use for secondary dex files.
1531 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001532 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1533 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1534 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001535
1536 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001537 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001538 if (input_fd.get() < 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001539 ALOGE("installd cannot open '%s' for input during dexopt\n", dex_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001540 return -1;
1541 }
1542
1543 // Create the output OAT file.
1544 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001545 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001546 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001547 if (out_oat_fd.get() < 0) {
1548 return -1;
1549 }
1550
1551 // Open vdex files.
1552 Dex2oatFileWrapper in_vdex_fd;
1553 Dex2oatFileWrapper out_vdex_fd;
Nicolas Geoffray575fc2c2017-04-24 13:34:59 +00001554 if (!open_vdex_files(dex_path, out_oat_path, dexopt_needed, instruction_set, is_public, uid,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001555 is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001556 return -1;
1557 }
1558
Calin Juravlecb556e32017-04-04 20:22:50 -07001559 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1560 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1561 // fully inherit their parent context).
1562 // Note that for primary apk the oat files are created before, in a separate installd
1563 // call which also does the restorecon. TODO(calin): unify the paths.
1564 if (is_secondary_dex) {
1565 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1566 SELINUX_ANDROID_RESTORECON_RECURSE)) {
1567 LOG(ERROR) << "Failed to restorecon " << oat_dir;
1568 return -1;
1569 }
1570 }
1571
Jeff Sharkey90aff262016-12-12 14:28:24 -07001572 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001573 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001574
Calin Juravle7a570e82017-01-14 16:23:30 -08001575 // Create the app image file if needed.
1576 Dex2oatFileWrapper image_fd =
Calin Juravle2289c0a2017-02-15 12:44:14 -08001577 maybe_open_app_image(out_oat_path, profile_guided, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001578
Calin Juravle7a570e82017-01-14 16:23:30 -08001579 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001580 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
1581 pkgname, dex_path, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001582
Calin Juravlec9eab382017-01-25 01:17:17 -08001583 ALOGV("DexInv: --- BEGIN '%s' ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001584
1585 pid_t pid = fork();
1586 if (pid == 0) {
1587 /* child -- drop privileges before continuing */
1588 drop_capabilities(uid);
1589
Richard Uhler76cc0272016-12-08 10:46:35 +00001590 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001591 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
1592 ALOGE("flock(%s) failed: %s\n", out_oat_path, strerror(errno));
1593 _exit(67);
1594 }
1595
Richard Uhler76cc0272016-12-08 10:46:35 +00001596 run_dex2oat(input_fd.get(),
1597 out_oat_fd.get(),
1598 in_vdex_fd.get(),
Calin Juravle7a570e82017-01-14 16:23:30 -08001599 out_vdex_fd.get(),
Richard Uhler76cc0272016-12-08 10:46:35 +00001600 image_fd.get(),
Jeff Hao10b8a6e2017-04-05 17:11:39 -07001601 dex_path,
Richard Uhler76cc0272016-12-08 10:46:35 +00001602 out_oat_path,
1603 swap_fd.get(),
1604 instruction_set,
1605 compiler_filter,
Richard Uhler76cc0272016-12-08 10:46:35 +00001606 debuggable,
1607 boot_complete,
1608 reference_profile_fd.get(),
1609 shared_libraries);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001610 _exit(68); /* only get here on exec failure */
1611 } else {
1612 int res = wait_child(pid);
1613 if (res == 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001614 ALOGV("DexInv: --- END '%s' (success) ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001615 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001616 ALOGE("DexInv: --- END '%s' --- status=0x%04x, process failed\n", dex_path, res);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001617 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001618 }
1619 }
1620
Calin Juravlec9eab382017-01-25 01:17:17 -08001621 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001622
1623 // We've been successful, don't delete output.
1624 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001625 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001626 image_fd.SetCleanup(false);
1627 reference_profile_fd.SetCleanup(false);
1628
1629 return 0;
1630}
1631
Calin Juravlec9eab382017-01-25 01:17:17 -08001632// Try to remove the given directory. Log an error if the directory exists
1633// and is empty but could not be removed.
1634static bool rmdir_if_empty(const char* dir) {
1635 if (rmdir(dir) == 0) {
1636 return true;
1637 }
1638 if (errno == ENOENT || errno == ENOTEMPTY) {
1639 return true;
1640 }
1641 PLOG(ERROR) << "Failed to remove dir: " << dir;
1642 return false;
1643}
1644
1645// Try to unlink the given file. Log an error if the file exists and could not
1646// be unlinked.
1647static bool unlink_if_exists(const std::string& file) {
1648 if (unlink(file.c_str()) == 0) {
1649 return true;
1650 }
1651 if (errno == ENOENT) {
1652 return true;
1653
1654 }
1655 PLOG(ERROR) << "Could not unlink: " << file;
1656 return false;
1657}
1658
1659// Create the oat file structure for the secondary dex 'dex_path' and assign
1660// the individual path component to the 'out_' parameters.
1661static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
1662 /*out*/char* out_oat_dir, /*out*/char* out_oat_isa_dir, /*out*/char* out_oat_path) {
1663 size_t dirIndex = dex_path.rfind('/');
1664 if (dirIndex == std::string::npos) {
1665 LOG(ERROR) << "Unexpected dir structure for dex file " << dex_path;
1666 return false;
1667 }
1668 // TODO(calin): we have similar computations in at lest 3 other places
1669 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1670 // use string append.
1671 std::string apk_dir = dex_path.substr(0, dirIndex);
1672 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1673 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1674
1675 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08001676 /*is_secondary_dex*/true, out_oat_path)) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001677 LOG(ERROR) << "Could not create oat path for secondary dex " << dex_path;
1678 return false;
1679 }
1680 return true;
1681}
1682
1683// Reconcile the secondary dex 'dex_path' and its generated oat files.
1684// Return true if all the parameters are valid and the secondary dex file was
1685// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1686// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1687// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1688// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1689// Return false if there were errors during processing. In this case
1690// out_secondary_dex_exists will be set to false.
1691bool reconcile_secondary_dex_file(const std::string& dex_path,
1692 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
1693 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
1694 /*out*/bool* out_secondary_dex_exists) {
1695 // Set out to false to start with, just in case we have validation errors.
1696 *out_secondary_dex_exists = false;
1697 if (isas.size() == 0) {
1698 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1699 return false;
1700 }
1701
1702 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
1703 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
1704 uid, storage_flag)) {
1705 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
1706 return false;
1707 }
1708
1709 if (access(dex_path.c_str(), F_OK) == 0) {
1710 // The path exists, nothing to do. The odex files (if any) will be left untouched.
1711 *out_secondary_dex_exists = true;
1712 return true;
1713 } else if (errno != ENOENT) {
1714 PLOG(ERROR) << "Failed to check access to secondary dex " << dex_path;
1715 return false;
1716 }
1717
1718 // The secondary dex does not exist anymore. Clear any generated files.
1719 char oat_path[PKG_PATH_MAX];
1720 char oat_dir[PKG_PATH_MAX];
1721 char oat_isa_dir[PKG_PATH_MAX];
1722 bool result = true;
1723 for (size_t i = 0; i < isas.size(); i++) {
1724 if (!create_secondary_dex_oat_layout(dex_path, isas[i], oat_dir, oat_isa_dir, oat_path)) {
1725 LOG(ERROR) << "Could not create secondary odex layout: " << dex_path;
1726 result = false;
1727 continue;
1728 }
Calin Juravle51314092017-05-18 15:33:05 -07001729
1730 // Delete oat/vdex/art files.
Calin Juravlec9eab382017-01-25 01:17:17 -08001731 result = unlink_if_exists(oat_path) && result;
1732 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
1733 result = unlink_if_exists(create_image_filename(oat_path)) && result;
1734
Calin Juravle51314092017-05-18 15:33:05 -07001735 // Delete profiles.
1736 std::string current_profile = create_current_profile_path(
1737 multiuser_get_user_id(uid), dex_path, /*is_secondary*/true);
1738 std::string reference_profile = create_reference_profile_path(
1739 dex_path, /*is_secondary*/true);
1740 result = unlink_if_exists(current_profile) && result;
1741 result = unlink_if_exists(reference_profile) && result;
1742
Calin Juravlec9eab382017-01-25 01:17:17 -08001743 // Try removing the directories as well, they might be empty.
1744 result = rmdir_if_empty(oat_isa_dir) && result;
1745 result = rmdir_if_empty(oat_dir) && result;
1746 }
1747
1748 return result;
1749}
1750
Jeff Sharkey90aff262016-12-12 14:28:24 -07001751// Helper for move_ab, so that we can have common failure-case cleanup.
1752static bool unlink_and_rename(const char* from, const char* to) {
1753 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
1754 // return a failure.
1755 struct stat s;
1756 if (stat(to, &s) == 0) {
1757 if (!S_ISREG(s.st_mode)) {
1758 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
1759 return false;
1760 }
1761 if (unlink(to) != 0) {
1762 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
1763 return false;
1764 }
1765 } else {
1766 // This may be a permission problem. We could investigate the error code, but we'll just
1767 // let the rename failure do the work for us.
1768 }
1769
1770 // Try to rename "to" to "from."
1771 if (rename(from, to) != 0) {
1772 PLOG(ERROR) << "Could not rename " << from << " to " << to;
1773 return false;
1774 }
1775 return true;
1776}
1777
1778// Move/rename a B artifact (from) to an A artifact (to).
1779static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
1780 // Check whether B exists.
1781 {
1782 struct stat s;
1783 if (stat(b_path.c_str(), &s) != 0) {
1784 // Silently ignore for now. The service calling this isn't smart enough to understand
1785 // lack of artifacts at the moment.
1786 return false;
1787 }
1788 if (!S_ISREG(s.st_mode)) {
1789 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
1790 // Try to unlink, but swallow errors.
1791 unlink(b_path.c_str());
1792 return false;
1793 }
1794 }
1795
1796 // Rename B to A.
1797 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
1798 // Delete the b_path so we don't try again (or fail earlier).
1799 if (unlink(b_path.c_str()) != 0) {
1800 PLOG(ERROR) << "Could not unlink " << b_path;
1801 }
1802
1803 return false;
1804 }
1805
1806 return true;
1807}
1808
1809bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
1810 // Get the current slot suffix. No suffix, no A/B.
1811 std::string slot_suffix;
1812 {
1813 char buf[kPropertyValueMax];
1814 if (get_property("ro.boot.slot_suffix", buf, nullptr) <= 0) {
1815 return false;
1816 }
1817 slot_suffix = buf;
1818
1819 if (!ValidateTargetSlotSuffix(slot_suffix)) {
1820 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
1821 return false;
1822 }
1823 }
1824
1825 // Validate other inputs.
1826 if (validate_apk_path(apk_path) != 0) {
1827 LOG(ERROR) << "Invalid apk_path: " << apk_path;
1828 return false;
1829 }
1830 if (validate_apk_path(oat_dir) != 0) {
1831 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
1832 return false;
1833 }
1834
1835 char a_path[PKG_PATH_MAX];
1836 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
1837 return false;
1838 }
1839 const std::string a_vdex_path = create_vdex_filename(a_path);
1840 const std::string a_image_path = create_image_filename(a_path);
1841
1842 // B path = A path + slot suffix.
1843 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
1844 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
1845 const std::string b_image_path = StringPrintf("%s.%s",
1846 a_image_path.c_str(),
1847 slot_suffix.c_str());
1848
1849 bool success = true;
1850 if (move_ab_path(b_path, a_path)) {
1851 if (move_ab_path(b_vdex_path, a_vdex_path)) {
1852 // Note: we can live without an app image. As such, ignore failure to move the image file.
1853 // If we decide to require the app image, or the app image being moved correctly,
1854 // then change accordingly.
1855 constexpr bool kIgnoreAppImageFailure = true;
1856
1857 if (!a_image_path.empty()) {
1858 if (!move_ab_path(b_image_path, a_image_path)) {
1859 unlink(a_image_path.c_str());
1860 if (!kIgnoreAppImageFailure) {
1861 success = false;
1862 }
1863 }
1864 }
1865 } else {
1866 // Cleanup: delete B image, ignore errors.
1867 unlink(b_image_path.c_str());
1868 success = false;
1869 }
1870 } else {
1871 // Cleanup: delete B image, ignore errors.
1872 unlink(b_vdex_path.c_str());
1873 unlink(b_image_path.c_str());
1874 success = false;
1875 }
1876 return success;
1877}
1878
1879bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
1880 // Delete the oat/odex file.
1881 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08001882 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08001883 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001884 return false;
1885 }
1886
1887 // In case of a permission failure report the issue. Otherwise just print a warning.
1888 auto unlink_and_check = [](const char* path) -> bool {
1889 int result = unlink(path);
1890 if (result != 0) {
1891 if (errno == EACCES || errno == EPERM) {
1892 PLOG(ERROR) << "Could not unlink " << path;
1893 return false;
1894 }
1895 PLOG(WARNING) << "Could not unlink " << path;
1896 }
1897 return true;
1898 };
1899
1900 // Delete the oat/odex file.
1901 bool return_value_oat = unlink_and_check(out_path);
1902
1903 // Derive and delete the app image.
1904 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
1905
Nicolas Geoffray192fb962017-05-25 13:58:06 +01001906 // Derive and delete the vdex file.
1907 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
1908
Jeff Sharkey90aff262016-12-12 14:28:24 -07001909 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01001910 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001911}
1912
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07001913} // namespace installd
1914} // namespace android