blob: d534830c0837a23fdd9c38a305367eb3cb6d0023 [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>
31#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070032#include <android-base/strings.h>
33#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080034#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070035#include <cutils/properties.h>
36#include <cutils/sched_policy.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070037#include <log/log.h> // TODO: Move everything to base/logging.
Jeff Sharkey90aff262016-12-12 14:28:24 -070038#include <private/android_filesystem_config.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070039#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070040#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070041
42#include "dexopt.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070043#include "installd_deps.h"
44#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070045#include "utils.h"
46
47using android::base::StringPrintf;
Jeff Sharkey90aff262016-12-12 14:28:24 -070048using android::base::EndsWith;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080049using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070050
51namespace android {
52namespace installd {
53
Calin Juravle114f0812017-03-08 19:05:07 -080054// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
55struct FreeDelete {
56 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
57 void operator()(const void* ptr) const {
58 free(const_cast<void*>(ptr));
59 }
60};
61
62// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
63template <typename T>
64using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
65
Calin Juravle1a0af3b2017-03-09 14:33:33 -080066static unique_fd invalid_unique_fd() {
67 return unique_fd(-1);
68}
69
Jeff Sharkey90aff262016-12-12 14:28:24 -070070static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -080071 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -070072 if (ufd.get() < 0) {
73 if (errno != ENOENT) {
74 PLOG(WARNING) << "Could not open profile " << profile;
75 return false;
76 } else {
77 // Nothing to clear. That's ok.
78 return true;
79 }
80 }
81
82 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
83 if (errno != EWOULDBLOCK) {
84 PLOG(WARNING) << "Error locking profile " << profile;
85 }
86 // This implies that the app owning this profile is running
87 // (and has acquired the lock).
88 //
89 // If we can't acquire the lock bail out since clearing is useless anyway
90 // (the app will write again to the profile).
91 //
92 // Note:
93 // This does not impact the this is not an issue for the profiling correctness.
94 // In case this is needed because of an app upgrade, profiles will still be
95 // eventually cleared by the app itself due to checksum mismatch.
96 // If this is needed because profman advised, then keeping the data around
97 // until the next run is again not an issue.
98 //
99 // If the app attempts to acquire a lock while we've held one here,
100 // it will simply skip the current write cycle.
101 return false;
102 }
103
104 bool truncated = ftruncate(ufd.get(), 0) == 0;
105 if (!truncated) {
106 PLOG(WARNING) << "Could not truncate " << profile;
107 }
108 if (flock(ufd.get(), LOCK_UN) != 0) {
109 PLOG(WARNING) << "Error unlocking profile " << profile;
110 }
111 return truncated;
112}
113
Calin Juravle114f0812017-03-08 19:05:07 -0800114// Clear the reference profile for the given location.
115// The location is the package name for primary apks or the dex path for secondary dex files.
116static bool clear_reference_profile(const std::string& location, bool is_secondary_dex) {
117 return clear_profile(create_reference_profile_path(location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700118}
119
Calin Juravle114f0812017-03-08 19:05:07 -0800120// Clear the reference profile for the given location.
121// The location is the package name for primary apks or the dex path for secondary dex files.
122static bool clear_current_profile(const std::string& pkgname, userid_t user,
123 bool is_secondary_dex) {
124 return clear_profile(create_current_profile_path(user, pkgname, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700125}
126
Calin Juravle114f0812017-03-08 19:05:07 -0800127// Clear the reference profile for the primary apk of the given package.
128bool clear_primary_reference_profile(const std::string& pkgname) {
129 return clear_reference_profile(pkgname, /*is_secondary_dex*/false);
130}
131
132// Clear all current profile for the primary apk of the given package.
133bool clear_primary_current_profiles(const std::string& pkgname) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700134 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800135 // 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 -0700136 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
137 for (auto user : users) {
Calin Juravle114f0812017-03-08 19:05:07 -0800138 success &= clear_current_profile(pkgname, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700139 }
140 return success;
141}
142
Calin Juravle114f0812017-03-08 19:05:07 -0800143// Clear the current profile for the primary apk of the given package and user.
144bool clear_primary_current_profile(const std::string& pkgname, userid_t user) {
145 return clear_current_profile(pkgname, user, /*is_secondary_dex*/false);
146}
147
Jeff Sharkey90aff262016-12-12 14:28:24 -0700148static int split_count(const char *str)
149{
150 char *ctx;
151 int count = 0;
152 char buf[kPropertyValueMax];
153
154 strncpy(buf, str, sizeof(buf));
155 char *pBuf = buf;
156
157 while(strtok_r(pBuf, " ", &ctx) != NULL) {
158 count++;
159 pBuf = NULL;
160 }
161
162 return count;
163}
164
165static int split(char *buf, const char **argv)
166{
167 char *ctx;
168 int count = 0;
169 char *tok;
170 char *pBuf = buf;
171
172 while((tok = strtok_r(pBuf, " ", &ctx)) != NULL) {
173 argv[count++] = tok;
174 pBuf = NULL;
175 }
176
177 return count;
178}
179
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700180static const char* get_location_from_path(const char* path) {
181 static constexpr char kLocationSeparator = '/';
182 const char *location = strrchr(path, kLocationSeparator);
183 if (location == NULL) {
184 return path;
185 } else {
186 // Skip the separator character.
187 return location + 1;
188 }
189}
190
Jeff Sharkey90aff262016-12-12 14:28:24 -0700191static void run_dex2oat(int zip_fd, int oat_fd, int input_vdex_fd, int output_vdex_fd, int image_fd,
192 const char* input_file_name, const char* output_file_name, int swap_fd,
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100193 const char* instruction_set, const char* compiler_filter,
Calin Juravle1d667612017-07-13 22:50:21 -0700194 bool debuggable, bool post_bootcomplete, int profile_fd, const char* class_loader_context) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700195 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
196
197 if (strlen(instruction_set) >= MAX_INSTRUCTION_SET_LEN) {
198 ALOGE("Instruction set %s longer than max length of %d",
199 instruction_set, MAX_INSTRUCTION_SET_LEN);
200 return;
201 }
202
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700203 // Get the relative path to the input file.
204 const char* relative_input_file_name = get_location_from_path(input_file_name);
205
Jeff Sharkey90aff262016-12-12 14:28:24 -0700206 char dex2oat_Xms_flag[kPropertyValueMax];
207 bool have_dex2oat_Xms_flag = get_property("dalvik.vm.dex2oat-Xms", dex2oat_Xms_flag, NULL) > 0;
208
209 char dex2oat_Xmx_flag[kPropertyValueMax];
210 bool have_dex2oat_Xmx_flag = get_property("dalvik.vm.dex2oat-Xmx", dex2oat_Xmx_flag, NULL) > 0;
211
212 char dex2oat_threads_buf[kPropertyValueMax];
213 bool have_dex2oat_threads_flag = get_property(post_bootcomplete
214 ? "dalvik.vm.dex2oat-threads"
215 : "dalvik.vm.boot-dex2oat-threads",
216 dex2oat_threads_buf,
217 NULL) > 0;
218 char dex2oat_threads_arg[kPropertyValueMax + 2];
219 if (have_dex2oat_threads_flag) {
220 sprintf(dex2oat_threads_arg, "-j%s", dex2oat_threads_buf);
221 }
222
223 char dex2oat_isa_features_key[kPropertyKeyMax];
224 sprintf(dex2oat_isa_features_key, "dalvik.vm.isa.%s.features", instruction_set);
225 char dex2oat_isa_features[kPropertyValueMax];
226 bool have_dex2oat_isa_features = get_property(dex2oat_isa_features_key,
227 dex2oat_isa_features, NULL) > 0;
228
229 char dex2oat_isa_variant_key[kPropertyKeyMax];
230 sprintf(dex2oat_isa_variant_key, "dalvik.vm.isa.%s.variant", instruction_set);
231 char dex2oat_isa_variant[kPropertyValueMax];
232 bool have_dex2oat_isa_variant = get_property(dex2oat_isa_variant_key,
233 dex2oat_isa_variant, NULL) > 0;
234
235 const char *dex2oat_norelocation = "-Xnorelocate";
236 bool have_dex2oat_relocation_skip_flag = false;
237
238 char dex2oat_flags[kPropertyValueMax];
239 int dex2oat_flags_count = get_property("dalvik.vm.dex2oat-flags",
240 dex2oat_flags, NULL) <= 0 ? 0 : split_count(dex2oat_flags);
241 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags);
242
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100243 // If we are booting without the real /data, don't spend time compiling.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700244 char vold_decrypt[kPropertyValueMax];
245 bool have_vold_decrypt = get_property("vold.decrypt", vold_decrypt, "") > 0;
246 bool skip_compilation = (have_vold_decrypt &&
247 (strcmp(vold_decrypt, "trigger_restart_min_framework") == 0 ||
248 (strcmp(vold_decrypt, "1") == 0)));
249
250 bool generate_debug_info = property_get_bool("debug.generate-debug-info", false);
251
252 char app_image_format[kPropertyValueMax];
253 char image_format_arg[strlen("--image-format=") + kPropertyValueMax];
254 bool have_app_image_format =
255 image_fd >= 0 && get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
256 if (have_app_image_format) {
257 sprintf(image_format_arg, "--image-format=%s", app_image_format);
258 }
259
260 char dex2oat_large_app_threshold[kPropertyValueMax];
261 bool have_dex2oat_large_app_threshold =
262 get_property("dalvik.vm.dex2oat-very-large", dex2oat_large_app_threshold, NULL) > 0;
263 char dex2oat_large_app_threshold_arg[strlen("--very-large-app-threshold=") + kPropertyValueMax];
264 if (have_dex2oat_large_app_threshold) {
265 sprintf(dex2oat_large_app_threshold_arg,
266 "--very-large-app-threshold=%s",
267 dex2oat_large_app_threshold);
268 }
269
270 static const char* DEX2OAT_BIN = "/system/bin/dex2oat";
271
272 static const char* RUNTIME_ARG = "--runtime-arg";
273
274 static const int MAX_INT_LEN = 12; // '-'+10dig+'\0' -OR- 0x+8dig
275
George Burgess IV36cebe772017-01-25 11:52:01 -0800276 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
277 // use arraysize instead.
278 char zip_fd_arg[arraysize("--zip-fd=") + MAX_INT_LEN];
279 char zip_location_arg[arraysize("--zip-location=") + PKG_PATH_MAX];
280 char input_vdex_fd_arg[arraysize("--input-vdex-fd=") + MAX_INT_LEN];
281 char output_vdex_fd_arg[arraysize("--output-vdex-fd=") + MAX_INT_LEN];
282 char oat_fd_arg[arraysize("--oat-fd=") + MAX_INT_LEN];
283 char oat_location_arg[arraysize("--oat-location=") + PKG_PATH_MAX];
284 char instruction_set_arg[arraysize("--instruction-set=") + MAX_INSTRUCTION_SET_LEN];
285 char instruction_set_variant_arg[arraysize("--instruction-set-variant=") + kPropertyValueMax];
286 char instruction_set_features_arg[arraysize("--instruction-set-features=") + kPropertyValueMax];
287 char dex2oat_Xms_arg[arraysize("-Xms") + kPropertyValueMax];
288 char dex2oat_Xmx_arg[arraysize("-Xmx") + kPropertyValueMax];
289 char dex2oat_compiler_filter_arg[arraysize("--compiler-filter=") + kPropertyValueMax];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700290 bool have_dex2oat_swap_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800291 char dex2oat_swap_fd[arraysize("--swap-fd=") + MAX_INT_LEN];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700292 bool have_dex2oat_image_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800293 char dex2oat_image_fd[arraysize("--app-image-fd=") + MAX_INT_LEN];
Calin Juravle1d667612017-07-13 22:50:21 -0700294 size_t class_loader_context_size = arraysize("--class-loader-context=") + PKG_PATH_MAX;
295 char class_loader_context_arg[class_loader_context_size];
296 if (class_loader_context != nullptr) {
297 snprintf(class_loader_context_arg, class_loader_context_size, "--class-loader-context=%s",
298 class_loader_context);
299 }
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 Geoffraybe6ecd62017-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 Geoffray4b64ed92017-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 Geoffraybe6ecd62017-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 Geoffraybe6ecd62017-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
379 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)
Calin Juravle1d667612017-07-13 22:50:21 -0700396 + (class_loader_context != nullptr ? 1 : 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;
400 argv[i++] = DEX2OAT_BIN;
401 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 }
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700456 if (has_base_dir) {
457 argv[i++] = base_dir;
458 }
Calin Juravle1d667612017-07-13 22:50:21 -0700459 if (class_loader_context != nullptr) {
460 argv[i++] = class_loader_context_arg;
461 }
462
Jeff Sharkey90aff262016-12-12 14:28:24 -0700463 // Do not add after dex2oat_flags, they should override others for debugging.
464 argv[i] = NULL;
465
466 execv(DEX2OAT_BIN, (char * const *)argv);
467 ALOGE("execv(%s) failed: %s\n", DEX2OAT_BIN, strerror(errno));
468}
469
470/*
471 * Whether dexopt should use a swap file when compiling an APK.
472 *
473 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
474 * itself, anyways).
475 *
476 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
477 *
478 * Otherwise, return true if this is a low-mem device.
479 *
480 * Otherwise, return default value.
481 */
482static bool kAlwaysProvideSwapFile = false;
483static bool kDefaultProvideSwapFile = true;
484
485static bool ShouldUseSwapFileForDexopt() {
486 if (kAlwaysProvideSwapFile) {
487 return true;
488 }
489
490 // Check the "override" property. If it exists, return value == "true".
491 char dex2oat_prop_buf[kPropertyValueMax];
492 if (get_property("dalvik.vm.dex2oat-swap", dex2oat_prop_buf, "") > 0) {
493 if (strcmp(dex2oat_prop_buf, "true") == 0) {
494 return true;
495 } else {
496 return false;
497 }
498 }
499
500 // Shortcut for default value. This is an implementation optimization for the process sketched
501 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
502 // as low-mem is never returning false. The compiler will optimize this away if it can.
503 if (kDefaultProvideSwapFile) {
504 return true;
505 }
506
507 bool is_low_mem = property_get_bool("ro.config.low_ram", false);
508 if (is_low_mem) {
509 return true;
510 }
511
512 // Default value must be false here.
513 return kDefaultProvideSwapFile;
514}
515
Richard Uhler76cc0272016-12-08 10:46:35 +0000516static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700517 if (set_to_bg) {
518 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
519 ALOGE("set_sched_policy failed: %s\n", strerror(errno));
520 exit(70);
521 }
522 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
523 ALOGE("setpriority failed: %s\n", strerror(errno));
524 exit(71);
525 }
526 }
527}
528
Calin Juravle114f0812017-03-08 19:05:07 -0800529static bool create_profile(int uid, const std::string& profile) {
530 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), O_CREAT | O_NOFOLLOW, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800531 if (fd.get() < 0) {
Calin Juravle114f0812017-03-08 19:05:07 -0800532 if (errno == EEXIST) {
533 return true;
534 } else {
535 PLOG(ERROR) << "Failed to create profile " << profile;
536 return false;
537 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700538 }
Calin Juravle114f0812017-03-08 19:05:07 -0800539 // Profiles should belong to the app; make sure of that by giving ownership to
540 // the app uid. If we cannot do that, there's no point in returning the fd
541 // since dex2oat/profman will fail with SElinux denials.
542 if (fchown(fd.get(), uid, uid) < 0) {
543 PLOG(ERROR) << "Could not chwon profile " << profile;
544 return false;
545 }
546 return true;
547}
548
549static unique_fd open_profile(int uid, const std::string& profile, bool read_write) {
550 // Check if we need to open the profile for a read-write operation. If so, we
551 // might need to create the profile since the file might not be there. Reference
552 // profiles are created on the fly so they might not exist beforehand.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700553 if (read_write) {
Calin Juravle114f0812017-03-08 19:05:07 -0800554 if (!create_profile(uid, profile)) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800555 return invalid_unique_fd();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700556 }
557 }
Calin Juravle114f0812017-03-08 19:05:07 -0800558 int flags = read_write ? O_RDWR : O_RDONLY;
559 // Do not follow symlinks when opening a profile:
560 // - primary profiles should not contain symlinks in their paths
561 // - secondary dex paths should have been already resolved and validated
562 flags |= O_NOFOLLOW;
563
564 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
565 if (fd.get() < 0) {
566 if (errno != ENOENT) {
567 // Profiles might be missing for various reasons. For example, in a
568 // multi-user environment, the profile directory for one user can be created
569 // after we start a merge. In this case the current profile for that user
570 // will not be found.
571 // Also, the secondary dex profiles might be deleted by the app at any time,
572 // so we can't we need to prepare if they are missing.
573 PLOG(ERROR) << "Failed to open profile " << profile;
574 }
575 return invalid_unique_fd();
576 }
577
Jeff Sharkey90aff262016-12-12 14:28:24 -0700578 return fd;
579}
580
Calin Juravle114f0812017-03-08 19:05:07 -0800581static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& location,
582 bool is_secondary_dex) {
583 std::string profile = create_current_profile_path(user, location, is_secondary_dex);
584 return open_profile(uid, profile, /*read_write*/false);
585}
586
587static unique_fd open_reference_profile(uid_t uid, const std::string& location, bool read_write,
588 bool is_secondary_dex) {
589 std::string profile = create_reference_profile_path(location, is_secondary_dex);
590 return open_profile(uid, profile, read_write);
591}
592
593static void open_profile_files(uid_t uid, const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800594 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700595 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle114f0812017-03-08 19:05:07 -0800596 *reference_profile_fd = open_reference_profile(uid, location, /*read_write*/ true,
597 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700598
Calin Juravle114f0812017-03-08 19:05:07 -0800599 // For secondary dex files, we don't really need the user but we use it for sanity checks.
600 // Note: the user owning the dex file should be the current user.
601 std::vector<userid_t> users;
602 if (is_secondary_dex){
603 users.push_back(multiuser_get_user_id(uid));
604 } else {
605 users = get_known_users(/*volume_uuid*/ nullptr);
606 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700607 for (auto user : users) {
Calin Juravle114f0812017-03-08 19:05:07 -0800608 unique_fd profile_fd = open_current_profile(uid, user, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700609 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800610 if (profile_fd.get() >= 0) {
611 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700612 }
613 }
614}
615
616static void drop_capabilities(uid_t uid) {
617 if (setgid(uid) != 0) {
618 ALOGE("setgid(%d) failed in installd during dexopt\n", uid);
619 exit(64);
620 }
621 if (setuid(uid) != 0) {
622 ALOGE("setuid(%d) failed in installd during dexopt\n", uid);
623 exit(65);
624 }
625 // drop capabilities
626 struct __user_cap_header_struct capheader;
627 struct __user_cap_data_struct capdata[2];
628 memset(&capheader, 0, sizeof(capheader));
629 memset(&capdata, 0, sizeof(capdata));
630 capheader.version = _LINUX_CAPABILITY_VERSION_3;
631 if (capset(&capheader, &capdata[0]) < 0) {
632 ALOGE("capset failed: %s\n", strerror(errno));
633 exit(66);
634 }
635}
636
637static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
638static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
639static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
640static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
641static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
642
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800643static void run_profman_merge(const std::vector<unique_fd>& profiles_fd,
644 const unique_fd& reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700645 static const size_t MAX_INT_LEN = 32;
646 static const char* PROFMAN_BIN = "/system/bin/profman";
647
648 std::vector<std::string> profile_args(profiles_fd.size());
649 char profile_buf[strlen("--profile-file-fd=") + MAX_INT_LEN];
650 for (size_t k = 0; k < profiles_fd.size(); k++) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800651 sprintf(profile_buf, "--profile-file-fd=%d", profiles_fd[k].get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700652 profile_args[k].assign(profile_buf);
653 }
654 char reference_profile_arg[strlen("--reference-profile-file-fd=") + MAX_INT_LEN];
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800655 sprintf(reference_profile_arg, "--reference-profile-file-fd=%d", reference_profile_fd.get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700656
657 // program name, reference profile fd, the final NULL and the profile fds
658 const char* argv[3 + profiles_fd.size()];
659 int i = 0;
660 argv[i++] = PROFMAN_BIN;
661 argv[i++] = reference_profile_arg;
662 for (size_t k = 0; k < profile_args.size(); k++) {
663 argv[i++] = profile_args[k].c_str();
664 }
665 // Do not add after dex2oat_flags, they should override others for debugging.
666 argv[i] = NULL;
667
668 execv(PROFMAN_BIN, (char * const *)argv);
669 ALOGE("execv(%s) failed: %s\n", PROFMAN_BIN, strerror(errno));
670 exit(68); /* only get here on exec failure */
671}
672
673// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800674// The location is the package name for primary apks or the dex path for secondary dex files.
675// Returns true if there is enough information in the current profiles that makes it
676// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700677// If the return value is true all the current profiles would have been merged into
678// the reference profiles accessible with open_reference_profile().
Calin Juravle114f0812017-03-08 19:05:07 -0800679static bool analyze_profiles(uid_t uid, const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800680 std::vector<unique_fd> profiles_fd;
681 unique_fd reference_profile_fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800682 open_profile_files(uid, location, is_secondary_dex, &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800683 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700684 // Skip profile guided compilation because no profiles were found.
685 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700686 return false;
687 }
688
Jeff Sharkey90aff262016-12-12 14:28:24 -0700689 pid_t pid = fork();
690 if (pid == 0) {
691 /* child -- drop privileges before continuing */
692 drop_capabilities(uid);
693 run_profman_merge(profiles_fd, reference_profile_fd);
694 exit(68); /* only get here on exec failure */
695 }
696 /* parent */
697 int return_code = wait_child(pid);
698 bool need_to_compile = false;
699 bool should_clear_current_profiles = false;
700 bool should_clear_reference_profile = false;
701 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800702 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700703 } else {
704 return_code = WEXITSTATUS(return_code);
705 switch (return_code) {
706 case PROFMAN_BIN_RETURN_CODE_COMPILE:
707 need_to_compile = true;
708 should_clear_current_profiles = true;
709 should_clear_reference_profile = false;
710 break;
711 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
712 need_to_compile = false;
713 should_clear_current_profiles = false;
714 should_clear_reference_profile = false;
715 break;
716 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800717 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700718 need_to_compile = false;
719 should_clear_current_profiles = true;
720 should_clear_reference_profile = true;
721 break;
722 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
723 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
724 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800725 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700726 need_to_compile = false;
727 should_clear_current_profiles = false;
728 should_clear_reference_profile = false;
729 break;
730 default:
731 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800732 LOG(WARNING) << "Unknown error code while processing profiles for location "
733 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700734 need_to_compile = false;
735 should_clear_current_profiles = true;
736 should_clear_reference_profile = true;
737 break;
738 }
739 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800740
Jeff Sharkey90aff262016-12-12 14:28:24 -0700741 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800742 if (is_secondary_dex) {
743 // For secondary dex files, the owning user is the current user.
744 clear_current_profile(location, multiuser_get_user_id(uid), is_secondary_dex);
745 } else {
746 clear_primary_current_profiles(location);
747 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700748 }
749 if (should_clear_reference_profile) {
Calin Juravle114f0812017-03-08 19:05:07 -0800750 clear_reference_profile(location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700751 }
752 return need_to_compile;
753}
754
Calin Juravle114f0812017-03-08 19:05:07 -0800755// Decides if profile guided compilation is needed or not based on existing profiles.
756// The analysis is done for the primary apks of the given package.
757// Returns true if there is enough information in the current profiles that makes it
758// worth to recompile the package.
759// If the return value is true all the current profiles would have been merged into
760// the reference profiles accessible with open_reference_profile().
761bool analyze_primary_profiles(uid_t uid, const std::string& pkgname) {
762 return analyze_profiles(uid, pkgname, /*is_secondary_dex*/false);
763}
764
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800765static void run_profman_dump(const std::vector<unique_fd>& profile_fds,
766 const unique_fd& reference_profile_fd,
Jeff Sharkey90aff262016-12-12 14:28:24 -0700767 const std::vector<std::string>& dex_locations,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800768 const std::vector<unique_fd>& apk_fds,
769 const unique_fd& output_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700770 std::vector<std::string> profman_args;
771 static const char* PROFMAN_BIN = "/system/bin/profman";
772 profman_args.push_back(PROFMAN_BIN);
773 profman_args.push_back("--dump-only");
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800774 profman_args.push_back(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700775 if (reference_profile_fd != -1) {
776 profman_args.push_back(StringPrintf("--reference-profile-file-fd=%d",
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800777 reference_profile_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700778 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800779 for (size_t i = 0; i < profile_fds.size(); i++) {
780 profman_args.push_back(StringPrintf("--profile-file-fd=%d", profile_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700781 }
782 for (const std::string& dex_location : dex_locations) {
783 profman_args.push_back(StringPrintf("--dex-location=%s", dex_location.c_str()));
784 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800785 for (size_t i = 0; i < apk_fds.size(); i++) {
786 profman_args.push_back(StringPrintf("--apk-fd=%d", apk_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700787 }
788 const char **argv = new const char*[profman_args.size() + 1];
789 size_t i = 0;
790 for (const std::string& profman_arg : profman_args) {
791 argv[i++] = profman_arg.c_str();
792 }
793 argv[i] = NULL;
794
795 execv(PROFMAN_BIN, (char * const *)argv);
796 ALOGE("execv(%s) failed: %s\n", PROFMAN_BIN, strerror(errno));
797 exit(68); /* only get here on exec failure */
798}
799
Calin Juravle76268c52017-03-09 13:19:42 -0800800bool dump_profiles(int32_t uid, const std::string& pkgname, const char* code_paths) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800801 std::vector<unique_fd> profile_fds;
802 unique_fd reference_profile_fd;
Calin Juravle76268c52017-03-09 13:19:42 -0800803 std::string out_file_name = StringPrintf("/data/misc/profman/%s.txt", pkgname.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700804
Calin Juravle114f0812017-03-08 19:05:07 -0800805 open_profile_files(uid, pkgname, /*is_secondary_dex*/false,
806 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700807
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800808 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700809 const bool has_profiles = !profile_fds.empty();
810
811 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800812 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700813 return false;
814 }
815
Calin Juravle114f0812017-03-08 19:05:07 -0800816 unique_fd output_fd(open(out_file_name.c_str(),
817 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700818 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
819 ALOGE("installd cannot chmod '%s' dump_profile\n", out_file_name.c_str());
820 return false;
821 }
822 std::vector<std::string> code_full_paths = base::Split(code_paths, ";");
823 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800824 std::vector<unique_fd> apk_fds;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700825 for (const std::string& code_full_path : code_full_paths) {
826 const char* full_path = code_full_path.c_str();
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800827 unique_fd apk_fd(open(full_path, O_RDONLY | O_NOFOLLOW));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700828 if (apk_fd == -1) {
829 ALOGE("installd cannot open '%s'\n", full_path);
830 return false;
831 }
832 dex_locations.push_back(get_location_from_path(full_path));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800833 apk_fds.push_back(std::move(apk_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700834 }
835
836 pid_t pid = fork();
837 if (pid == 0) {
838 /* child -- drop privileges before continuing */
839 drop_capabilities(uid);
840 run_profman_dump(profile_fds, reference_profile_fd, dex_locations,
841 apk_fds, output_fd);
842 exit(68); /* only get here on exec failure */
843 }
844 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700845 int return_code = wait_child(pid);
846 if (!WIFEXITED(return_code)) {
847 LOG(WARNING) << "profman failed for package " << pkgname << ": "
848 << return_code;
849 return false;
850 }
851 return true;
852}
853
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700854bool copy_system_profile(const std::string& system_profile,
855 uid_t packageUid, const std::string& data_profile_location) {
856 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
857 unique_fd out_fd(open_reference_profile(packageUid,
858 data_profile_location,
859 /*read_write*/ true,
860 /*secondary*/ false));
861 if (in_fd.get() < 0) {
862 PLOG(WARNING) << "Could not open profile " << system_profile;
863 return false;
864 }
865 if (out_fd.get() < 0) {
866 PLOG(WARNING) << "Could not open profile " << data_profile_location;
867 return false;
868 }
869
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700870 // As a security measure we want to write the profile information with the reduced capabilities
871 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700872 pid_t pid = fork();
873 if (pid == 0) {
874 /* child -- drop privileges before continuing */
875 drop_capabilities(packageUid);
876
877 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
878 if (errno != EWOULDBLOCK) {
879 PLOG(WARNING) << "Error locking profile " << data_profile_location;
880 }
881 // This implies that the app owning this profile is running
882 // (and has acquired the lock).
883 //
884 // The app never acquires the lock for the reference profiles of primary apks.
885 // Only dex2oat from installd will do that. Since installd is single threaded
886 // we should not see this case. Nevertheless be prepared for it.
887 PLOG(WARNING) << "Failed to flock " << data_profile_location;
888 return false;
889 }
890
891 bool truncated = ftruncate(out_fd.get(), 0) == 0;
892 if (!truncated) {
893 PLOG(WARNING) << "Could not truncate " << data_profile_location;
894 }
895
896 // Copy over data.
897 static constexpr size_t kBufferSize = 4 * 1024;
898 char buffer[kBufferSize];
899 while (true) {
900 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
901 if (bytes == 0) {
902 break;
903 }
904 write(out_fd.get(), buffer, bytes);
905 }
906 if (flock(out_fd.get(), LOCK_UN) != 0) {
907 PLOG(WARNING) << "Error unlocking profile " << data_profile_location;
908 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700909 // Use _exit since we don't want to run the global destructors in the child.
910 // b/62597429
911 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700912 }
913 /* parent */
914 int return_code = wait_child(pid);
915 return return_code == 0;
916}
917
Jeff Sharkey90aff262016-12-12 14:28:24 -0700918static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
919 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
920 if (EndsWith(oat_path, ".dex")) {
921 std::string new_path = oat_path;
922 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
923 CHECK(EndsWith(new_path, new_ext.c_str()));
924 return new_path;
925 }
926
927 // An odex entry. Not that this may not be an extension, e.g., in the OTA
928 // case (where the base name will have an extension for the B artifact).
929 size_t odex_pos = oat_path.rfind(".odex");
930 if (odex_pos != std::string::npos) {
931 std::string new_path = oat_path;
932 new_path.replace(odex_pos, strlen(".odex"), new_ext);
933 CHECK_NE(new_path.find(new_ext), std::string::npos);
934 return new_path;
935 }
936
937 // Don't know how to handle this.
938 return "";
939}
940
941// Translate the given oat path to an art (app image) path. An empty string
942// denotes an error.
943static std::string create_image_filename(const std::string& oat_path) {
944 return replace_file_extension(oat_path, ".art");
945}
946
947// Translate the given oat path to a vdex path. An empty string denotes an error.
948static std::string create_vdex_filename(const std::string& oat_path) {
949 return replace_file_extension(oat_path, ".vdex");
950}
951
952static bool add_extension_to_file_name(char* file_name, const char* extension) {
953 if (strlen(file_name) + strlen(extension) + 1 > PKG_PATH_MAX) {
954 return false;
955 }
956 strcat(file_name, extension);
957 return true;
958}
959
960static int open_output_file(const char* file_name, bool recreate, int permissions) {
961 int flags = O_RDWR | O_CREAT;
962 if (recreate) {
963 if (unlink(file_name) < 0) {
964 if (errno != ENOENT) {
965 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
966 }
967 }
968 flags |= O_EXCL;
969 }
970 return open(file_name, flags, permissions);
971}
972
Calin Juravle2289c0a2017-02-15 12:44:14 -0800973static bool set_permissions_and_ownership(
974 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
975 // Primary apks are owned by the system. Secondary dex files are owned by the app.
976 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700977 if (fchmod(fd,
978 S_IRUSR|S_IWUSR|S_IRGRP |
979 (is_public ? S_IROTH : 0)) < 0) {
980 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
981 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -0800982 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700983 ALOGE("installd cannot chown '%s' during dexopt\n", path);
984 return false;
985 }
986 return true;
987}
988
989static bool IsOutputDalvikCache(const char* oat_dir) {
990 // InstallerConnection.java (which invokes installd) transforms Java null arguments
991 // into '!'. Play it safe by handling it both.
992 // TODO: ensure we never get null.
993 // TODO: pass a flag instead of inferring if the output is dalvik cache.
994 return oat_dir == nullptr || oat_dir[0] == '!';
995}
996
Calin Juravled23dee72017-07-06 16:29:11 -0700997// Best-effort check whether we can fit the the path into our buffers.
998// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
999// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1000// extension to the cache path (5 bytes).
1001// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1002static bool validate_dex_path_size(const std::string& dex_path) {
1003 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1004 LOG(ERROR) << "dex_path too long: " << dex_path;
1005 return false;
1006 }
1007 return true;
1008}
1009
Jeff Sharkey90aff262016-12-12 14:28:24 -07001010static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001011 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001012 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001013 return false;
1014 }
1015
1016 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001017 // Oat dirs for secondary dex files are already validated.
1018 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001019 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1020 return false;
1021 }
1022 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1023 return false;
1024 }
1025 } else {
1026 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1027 return false;
1028 }
1029 }
1030 return true;
1031}
1032
1033// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1034// on destruction. It will also run the given cleanup (unless told not to) after closing.
1035//
1036// Usage example:
1037//
Calin Juravle7a570e82017-01-14 16:23:30 -08001038// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001039// [name]() {
1040// unlink(name.c_str());
1041// });
1042// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1043// wrapper if captured as a reference.
1044//
1045// if (file.get() == -1) {
1046// // Error opening...
1047// }
1048//
1049// ...
1050// if (error) {
1051// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1052// // and delete the file (after the fd is closed).
1053// return -1;
1054// }
1055//
1056// (Success case)
1057// file.SetCleanup(false);
1058// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1059// // (leaving the file around; after the fd is closed).
1060//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001061class Dex2oatFileWrapper {
1062 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001063 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001064 }
1065
Calin Juravle7a570e82017-01-14 16:23:30 -08001066 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1067 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1068
1069 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1070 value_ = other.value_;
1071 cleanup_ = other.cleanup_;
1072 do_cleanup_ = other.do_cleanup_;
1073 auto_close_ = other.auto_close_;
1074 other.release();
1075 }
1076
1077 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1078 value_ = other.value_;
1079 cleanup_ = other.cleanup_;
1080 do_cleanup_ = other.do_cleanup_;
1081 auto_close_ = other.auto_close_;
1082 other.release();
1083 return *this;
1084 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001085
1086 ~Dex2oatFileWrapper() {
1087 reset(-1);
1088 }
1089
1090 int get() {
1091 return value_;
1092 }
1093
1094 void SetCleanup(bool cleanup) {
1095 do_cleanup_ = cleanup;
1096 }
1097
1098 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001099 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001100 close(value_);
1101 }
1102 if (do_cleanup_ && cleanup_ != nullptr) {
1103 cleanup_();
1104 }
1105
1106 value_ = new_value;
1107 }
1108
Calin Juravle7a570e82017-01-14 16:23:30 -08001109 void reset(int new_value, std::function<void ()> new_cleanup) {
1110 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001111 close(value_);
1112 }
1113 if (do_cleanup_ && cleanup_ != nullptr) {
1114 cleanup_();
1115 }
1116
1117 value_ = new_value;
1118 cleanup_ = new_cleanup;
1119 }
1120
Calin Juravle7a570e82017-01-14 16:23:30 -08001121 void DisableAutoClose() {
1122 auto_close_ = false;
1123 }
1124
Jeff Sharkey90aff262016-12-12 14:28:24 -07001125 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001126 void release() {
1127 value_ = -1;
1128 do_cleanup_ = false;
1129 cleanup_ = nullptr;
1130 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001131 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001132 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001133 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001134 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001135};
1136
Calin Juravle7a570e82017-01-14 16:23:30 -08001137// (re)Creates the app image if needed.
1138Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path, bool profile_guided,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001139 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001140 // Use app images only if it is enabled (by a set image format) and we are compiling
1141 // profile-guided (so the app image doesn't conservatively contain all classes).
Calin Juravle2289c0a2017-02-15 12:44:14 -08001142 // Note that we don't create an image for secondary dex files.
1143 if (is_secondary_dex || !profile_guided) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001144 return Dex2oatFileWrapper();
1145 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001146
Calin Juravle7a570e82017-01-14 16:23:30 -08001147 const std::string image_path = create_image_filename(out_oat_path);
1148 if (image_path.empty()) {
1149 // Happens when the out_oat_path has an unknown extension.
1150 return Dex2oatFileWrapper();
1151 }
1152 char app_image_format[kPropertyValueMax];
1153 bool have_app_image_format =
1154 get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
1155 if (!have_app_image_format) {
1156 return Dex2oatFileWrapper();
1157 }
1158 // Recreate is true since we do not want to modify a mapped image. If the app is
1159 // already running and we modify the image file, it can cause crashes (b/27493510).
1160 Dex2oatFileWrapper wrapper_fd(
1161 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1162 [image_path]() { unlink(image_path.c_str()); });
1163 if (wrapper_fd.get() < 0) {
1164 // Could not create application image file. Go on since we can compile without it.
1165 LOG(ERROR) << "installd could not create '" << image_path
1166 << "' for image file during dexopt";
1167 // If we have a valid image file path but no image fd, explicitly erase the image file.
1168 if (unlink(image_path.c_str()) < 0) {
1169 if (errno != ENOENT) {
1170 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1171 }
1172 }
1173 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001174 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001175 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1176 wrapper_fd.reset(-1);
1177 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001178
Calin Juravle7a570e82017-01-14 16:23:30 -08001179 return wrapper_fd;
1180}
1181
1182// Creates the dexopt swap file if necessary and return its fd.
1183// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001184unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001185 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001186 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001187 }
1188 // Make sure there really is enough space.
1189 char swap_file_name[PKG_PATH_MAX];
1190 strcpy(swap_file_name, out_oat_path);
1191 if (!add_extension_to_file_name(swap_file_name, ".swap")) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001192 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001193 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001194 unique_fd swap_fd(open_output_file(
Calin Juravle7a570e82017-01-14 16:23:30 -08001195 swap_file_name, /*recreate*/true, /*permissions*/0600));
1196 if (swap_fd.get() < 0) {
1197 // Could not create swap file. Optimistically go on and hope that we can compile
1198 // without it.
1199 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name);
1200 } else {
1201 // Immediately unlink. We don't really want to hit flash.
1202 if (unlink(swap_file_name) < 0) {
1203 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1204 }
1205 }
1206 return swap_fd;
1207}
1208
1209// Opens the reference profiles if needed.
1210// 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 -08001211Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
1212 const std::string& dex_path, bool profile_guided, bool is_public, int uid,
1213 bool is_secondary_dex) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001214 // Public apps should not be compiled with profile information ever. Same goes for the special
1215 // package '*' used for the system server.
Calin Juravle114f0812017-03-08 19:05:07 -08001216 if (!profile_guided || is_public || (pkgname[0] == '*')) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001217 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001218 }
Calin Juravle114f0812017-03-08 19:05:07 -08001219
1220 // Open reference profile in read only mode as dex2oat does not get write permissions.
1221 const std::string location = is_secondary_dex ? dex_path : pkgname;
1222 unique_fd ufd = open_reference_profile(uid, location, /*read_write*/false, is_secondary_dex);
1223 const auto& cleanup = [location, is_secondary_dex]() {
1224 clear_reference_profile(location.c_str(), is_secondary_dex);
1225 };
1226 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001227}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001228
Calin Juravle7a570e82017-01-14 16:23:30 -08001229// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1230// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
1231bool open_vdex_files(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001232 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001233 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001234 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1235 CHECK(in_vdex_wrapper_fd != nullptr);
1236 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001237 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1238 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001239 char in_odex_path[PKG_PATH_MAX];
1240 int dexopt_action = abs(dexopt_needed);
1241 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001242 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001243
1244 // Infer the name of the output VDEX.
1245 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1246 if (out_vdex_path_str.empty()) {
1247 return false;
1248 }
1249
1250 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001251 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001252 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1253 const char* path = nullptr;
1254 if (is_odex_location) {
1255 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1256 path = in_odex_path;
1257 } else {
1258 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001259 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001260 }
1261 } else {
1262 path = out_oat_path;
1263 }
1264 in_vdex_path_str = create_vdex_filename(path);
1265 if (in_vdex_path_str.empty()) {
1266 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001267 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001268 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001269 // We can update in place when all these conditions are met:
1270 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1271 // on /system typically cannot be updated in place).
1272 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1273 // cannot be currently used by a running process.
1274 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1275 // different vdex files to operate.
1276 update_vdex_in_place =
1277 (in_vdex_path_str == out_vdex_path_str) &&
1278 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1279 !profile_guided;
1280 if (update_vdex_in_place) {
1281 // Open the file read-write to be able to update it.
1282 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1283 if (in_vdex_wrapper_fd->get() == -1) {
1284 // If we failed to open the file, we cannot update it in place.
1285 update_vdex_in_place = false;
1286 }
1287 } else {
1288 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1289 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001290 }
1291
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001292 // If we are updating the vdex in place, we do not need to recreate a vdex,
1293 // and can use the same existing one.
1294 if (update_vdex_in_place) {
1295 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1296 // have bogus stale vdex files.
1297 out_vdex_wrapper_fd->reset(
1298 in_vdex_wrapper_fd->get(),
1299 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1300 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1301 // wrapper).
1302 in_vdex_wrapper_fd->DisableAutoClose();
1303 } else {
1304 out_vdex_wrapper_fd->reset(
1305 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1306 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1307 if (out_vdex_wrapper_fd->get() < 0) {
1308 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1309 return false;
1310 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001311 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001312 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001313 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001314 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1315 return false;
1316 }
1317
1318 // If we got here we successfully opened the vdex files.
1319 return true;
1320}
1321
1322// Opens the output oat file for the given apk.
1323// If successful it stores the output path into out_oat_path and returns true.
1324Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001325 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1326 char* out_oat_path) {
1327 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001328 return Dex2oatFileWrapper();
1329 }
1330 const std::string out_oat_path_str(out_oat_path);
1331 Dex2oatFileWrapper wrapper_fd(
1332 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1333 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1334 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001335 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001336 } else if (!set_permissions_and_ownership(
1337 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001338 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1339 wrapper_fd.reset(-1);
1340 }
1341 return wrapper_fd;
1342}
1343
1344// Updates the access times of out_oat_path based on those from apk_path.
1345void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1346 struct stat input_stat;
1347 memset(&input_stat, 0, sizeof(input_stat));
1348 if (stat(apk_path, &input_stat) != 0) {
1349 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1350 return;
1351 }
1352
1353 struct utimbuf ut;
1354 ut.actime = input_stat.st_atime;
1355 ut.modtime = input_stat.st_mtime;
1356 if (utime(out_oat_path, &ut) != 0) {
1357 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1358 }
1359}
1360
Calin Juravle80a21252017-01-17 14:43:25 -08001361// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001362// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1363// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1364// the profile has changed.
Calin Juravled23dee72017-07-06 16:29:11 -07001365static void exec_dexoptanalyzer(const std::string& dex_file, const std::string& instruction_set,
Shubham Ajmera45c87432017-06-22 11:10:27 -07001366 const std::string& compiler_filter, bool profile_was_updated, bool downgrade) {
Calin Juravle80a21252017-01-17 14:43:25 -08001367 static const char* DEXOPTANALYZER_BIN = "/system/bin/dexoptanalyzer";
1368 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
1369
Calin Juravled23dee72017-07-06 16:29:11 -07001370 if (instruction_set.size() >= MAX_INSTRUCTION_SET_LEN) {
1371 LOG(ERROR) << "Instruction set " << instruction_set
1372 << " longer than max length of " << MAX_INSTRUCTION_SET_LEN;
Calin Juravle80a21252017-01-17 14:43:25 -08001373 return;
1374 }
1375
Calin Juravled23dee72017-07-06 16:29:11 -07001376 std::string dex_file_arg = "--dex-file=" + dex_file;
1377 std::string isa_arg = "--isa=" + instruction_set;
1378 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
Calin Juravle114f0812017-03-08 19:05:07 -08001379 const char* assume_profile_changed = "--assume-profile-changed";
Shubham Ajmera45c87432017-06-22 11:10:27 -07001380 const char* downgrade_flag = "--downgrade";
Calin Juravle80a21252017-01-17 14:43:25 -08001381
Calin Juravle80a21252017-01-17 14:43:25 -08001382 // program name, dex file, isa, filter, the final NULL
Shubham Ajmera45c87432017-06-22 11:10:27 -07001383 const int argc = 5 +
1384 (profile_was_updated ? 1 : 0) +
1385 (downgrade ? 1 : 0);
1386 const char* argv[argc];
Calin Juravle80a21252017-01-17 14:43:25 -08001387 int i = 0;
1388 argv[i++] = DEXOPTANALYZER_BIN;
Calin Juravled23dee72017-07-06 16:29:11 -07001389 argv[i++] = dex_file_arg.c_str();
1390 argv[i++] = isa_arg.c_str();
1391 argv[i++] = compiler_filter_arg.c_str();
Calin Juravle114f0812017-03-08 19:05:07 -08001392 if (profile_was_updated) {
1393 argv[i++] = assume_profile_changed;
1394 }
Shubham Ajmera45c87432017-06-22 11:10:27 -07001395 if (downgrade) {
1396 argv[i++] = downgrade_flag;
1397 }
Calin Juravle80a21252017-01-17 14:43:25 -08001398 argv[i] = NULL;
1399
1400 execv(DEXOPTANALYZER_BIN, (char * const *)argv);
1401 ALOGE("execv(%s) failed: %s\n", DEXOPTANALYZER_BIN, strerror(errno));
1402}
1403
1404// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001405static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
1406 const char* instruction_set, std::string* oat_dir_out) {
1407 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001408 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001409 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001410 return false;
1411 }
Calin Juravle114f0812017-03-08 19:05:07 -08001412 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001413
Calin Juravle80a21252017-01-17 14:43:25 -08001414 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001415 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1416 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001417 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001418 return false;
1419 }
1420
1421 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001422 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001423 oat_dir_out->assign(oat_dir);
1424
1425 // Create oat/isa output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001426 if (prepare_app_cache_dir(*oat_dir_out, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001427 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001428 return false;
1429 }
1430
1431 return true;
1432}
1433
1434static int constexpr DEXOPTANALYZER_BIN_EXEC_ERROR = 200;
1435
1436// Verifies the result of dexoptanalyzer executed for the apk_path.
1437// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1438// Returns false for errors or unexpected result values.
Calin Juravle114f0812017-03-08 19:05:07 -08001439static bool process_dexoptanalyzer_result(const std::string& dex_path, int result,
Calin Juravle80a21252017-01-17 14:43:25 -08001440 int* dexopt_needed_out) {
1441 // The result values are defined in dexoptanalyzer.
1442 switch (result) {
1443 case 0: // no_dexopt_needed
1444 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
1445 case 1: // dex2oat_from_scratch
1446 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
1447 case 5: // dex2oat_for_bootimage_odex
1448 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
1449 case 6: // dex2oat_for_filter_odex
1450 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
1451 case 7: // dex2oat_for_relocation_odex
1452 *dexopt_needed_out = -DEX2OAT_FOR_RELOCATION; return true;
1453 case 2: // dex2oat_for_bootimage_oat
1454 case 3: // dex2oat_for_filter_oat
1455 case 4: // dex2oat_for_relocation_oat
Calin Juravlec9eab382017-01-25 01:17:17 -08001456 LOG(ERROR) << "Dexoptnalyzer return the status of an oat file."
1457 << " Expected odex file status for secondary dex " << dex_path
Calin Juravle80a21252017-01-17 14:43:25 -08001458 << " : dexoptanalyzer result=" << result;
1459 return false;
1460 default:
Calin Juravlec9eab382017-01-25 01:17:17 -08001461 LOG(ERROR) << "Unexpected result for dexoptanalyzer " << dex_path
Calin Juravle80a21252017-01-17 14:43:25 -08001462 << " exec_dexoptanalyzer result=" << result;
1463 return false;
1464 }
1465}
1466
Calin Juravlec9eab382017-01-25 01:17:17 -08001467// 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 -08001468// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1469// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001470// When returning true, the output parameters will be:
1471// - is_public_out: whether or not the oat file should not be made public
1472// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1473// - oat_dir_out: the oat dir path where the oat file should be stored
1474// - dex_path_out: the real path of the dex file
Calin Juravle114f0812017-03-08 19:05:07 -08001475static bool process_secondary_dex_dexopt(const char* original_dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001476 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001477 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Shubham Ajmera45c87432017-06-22 11:10:27 -07001478 std::string* oat_dir_out, std::string* dex_path_out, bool downgrade) {
Calin Juravle80a21252017-01-17 14:43:25 -08001479 int storage_flag;
1480
1481 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1482 storage_flag = FLAG_STORAGE_CE;
1483 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1484 LOG(ERROR) << "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
1485 return false;
1486 }
1487 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1488 storage_flag = FLAG_STORAGE_DE;
1489 } else {
1490 LOG(ERROR) << "Secondary dex storage flag must be set";
1491 return false;
1492 }
1493
Calin Juravle114f0812017-03-08 19:05:07 -08001494 {
1495 // As opposed to the primary apk, secondary dex files might contain symlinks.
1496 // Resolve the path before passing it to the validate method to
1497 // make sure the verification is done on the real location.
1498 UniqueCPtr<char> dex_real_path_cstr(realpath(original_dex_path, nullptr));
1499 if (dex_real_path_cstr == nullptr) {
1500 PLOG(ERROR) << "Could not get the real path of the secondary dex file "
1501 << original_dex_path;
1502 return false;
1503 } else {
1504 dex_path_out->assign(dex_real_path_cstr.get());
1505 }
1506 }
1507 const std::string& dex_path = *dex_path_out;
Calin Juravled23dee72017-07-06 16:29:11 -07001508 if (!validate_dex_path_size(dex_path)) {
1509 return false;
1510 }
Calin Juravlec9eab382017-01-25 01:17:17 -08001511 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1512 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001513 return false;
1514 }
1515
1516 // Check if the path exist. If not, there's nothing to do.
Calin Juravleebc8a792017-04-04 20:21:05 -07001517 struct stat dex_path_stat;
1518 if (stat(dex_path.c_str(), &dex_path_stat) != 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001519 if (errno == ENOENT) {
1520 // Secondary dex files might be deleted any time by the app.
1521 // Nothing to do if that's the case
Calin Juravle114f0812017-03-08 19:05:07 -08001522 ALOGV("Secondary dex does not exist %s", dex_path.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001523 return NO_DEXOPT_NEEDED;
1524 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001525 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001526 }
1527 }
1528
Calin Juravleebc8a792017-04-04 20:21:05 -07001529 // Check if we should make the oat file public.
1530 // Note that if the dex file is not public the compiled code cannot be made public.
1531 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) &&
1532 ((dex_path_stat.st_mode & S_IROTH) != 0);
1533
Calin Juravle80a21252017-01-17 14:43:25 -08001534 // Prepare the oat directories.
Calin Juravle114f0812017-03-08 19:05:07 -08001535 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set, oat_dir_out)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001536 return false;
1537 }
1538
Calin Juravle114f0812017-03-08 19:05:07 -08001539 // Analyze profiles.
1540 bool profile_was_updated = analyze_profiles(uid, dex_path, /*is_secondary_dex*/true);
1541
Calin Juravle80a21252017-01-17 14:43:25 -08001542 pid_t pid = fork();
1543 if (pid == 0) {
1544 // child -- drop privileges before continuing.
1545 drop_capabilities(uid);
1546 // Run dexoptanalyzer to get dexopt_needed code.
Shubham Ajmera45c87432017-06-22 11:10:27 -07001547 exec_dexoptanalyzer(dex_path, instruction_set, compiler_filter, profile_was_updated,
1548 downgrade);
Calin Juravle80a21252017-01-17 14:43:25 -08001549 exit(DEXOPTANALYZER_BIN_EXEC_ERROR);
1550 }
1551
1552 /* parent */
1553
1554 int result = wait_child(pid);
1555 if (!WIFEXITED(result)) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001556 LOG(ERROR) << "dexoptanalyzer failed for path " << dex_path << ": " << result;
Calin Juravle80a21252017-01-17 14:43:25 -08001557 return false;
1558 }
1559 result = WEXITSTATUS(result);
Calin Juravlec9eab382017-01-25 01:17:17 -08001560 bool success = process_dexoptanalyzer_result(dex_path, result, dexopt_needed_out);
Calin Juravle80a21252017-01-17 14:43:25 -08001561 // Run dexopt only if needed or forced.
1562 // Note that dexoptanalyzer is executed even if force compilation is enabled.
1563 // We ignore its valid dexopNeeded result, but still check (in process_dexoptanalyzer_result)
1564 // that we only get results for odex files (apk_dir/oat/isa/code.odex) and not
1565 // for oat files from dalvik-cache.
1566 if (success && ((dexopt_flags & DEXOPT_FORCE) != 0)) {
1567 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1568 }
1569
1570 return success;
1571}
1572
Calin Juravlec9eab382017-01-25 01:17:17 -08001573int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001574 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle1d667612017-07-13 22:50:21 -07001575 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Shubham Ajmera45c87432017-06-22 11:10:27 -07001576 bool downgrade) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001577 CHECK(pkgname != nullptr);
1578 CHECK(pkgname[0] != 0);
1579 if ((dexopt_flags & ~DEXOPT_MASK) != 0) {
1580 LOG_FATAL("dexopt flags contains unknown fields\n");
1581 }
1582
Calin Juravled23dee72017-07-06 16:29:11 -07001583 if (!validate_dex_path_size(dex_path)) {
Calin Juravle1d667612017-07-13 22:50:21 -07001584 return -1;
1585 }
1586
1587 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
1588 LOG(ERROR) << "Class loader context exceeds the allowed size: " << class_loader_context;
1589 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001590 }
1591
Calin Juravleebc8a792017-04-04 20:21:05 -07001592 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001593 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1594 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1595 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001596 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
1597
1598 // Check if we're dealing with a secondary dex file and if we need to compile it.
1599 std::string oat_dir_str;
Calin Juravle114f0812017-03-08 19:05:07 -08001600 std::string dex_real_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001601 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001602 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001603 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Shubham Ajmera45c87432017-06-22 11:10:27 -07001604 &dex_real_path,
1605 downgrade)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001606 oat_dir = oat_dir_str.c_str();
Calin Juravle114f0812017-03-08 19:05:07 -08001607 dex_path = dex_real_path.c_str();
Calin Juravle80a21252017-01-17 14:43:25 -08001608 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1609 return 0; // Nothing to do, report success.
1610 }
1611 } else {
1612 return -1; // We had an error, logged in the process method.
1613 }
1614 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001615 // Currently these flags are only use for secondary dex files.
1616 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001617 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1618 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1619 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001620
1621 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001622 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001623 if (input_fd.get() < 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001624 ALOGE("installd cannot open '%s' for input during dexopt\n", dex_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001625 return -1;
1626 }
1627
1628 // Create the output OAT file.
1629 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001630 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001631 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001632 if (out_oat_fd.get() < 0) {
1633 return -1;
1634 }
1635
1636 // Open vdex files.
1637 Dex2oatFileWrapper in_vdex_fd;
1638 Dex2oatFileWrapper out_vdex_fd;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001639 if (!open_vdex_files(dex_path, out_oat_path, dexopt_needed, instruction_set, is_public, uid,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001640 is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001641 return -1;
1642 }
1643
Calin Juravlecb556e32017-04-04 20:22:50 -07001644 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1645 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1646 // fully inherit their parent context).
1647 // Note that for primary apk the oat files are created before, in a separate installd
1648 // call which also does the restorecon. TODO(calin): unify the paths.
1649 if (is_secondary_dex) {
1650 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1651 SELINUX_ANDROID_RESTORECON_RECURSE)) {
1652 LOG(ERROR) << "Failed to restorecon " << oat_dir;
1653 return -1;
1654 }
1655 }
1656
Jeff Sharkey90aff262016-12-12 14:28:24 -07001657 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001658 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001659
Calin Juravle7a570e82017-01-14 16:23:30 -08001660 // Create the app image file if needed.
1661 Dex2oatFileWrapper image_fd =
Calin Juravle2289c0a2017-02-15 12:44:14 -08001662 maybe_open_app_image(out_oat_path, profile_guided, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001663
Calin Juravle7a570e82017-01-14 16:23:30 -08001664 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001665 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
1666 pkgname, dex_path, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001667
Calin Juravlec9eab382017-01-25 01:17:17 -08001668 ALOGV("DexInv: --- BEGIN '%s' ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001669
1670 pid_t pid = fork();
1671 if (pid == 0) {
1672 /* child -- drop privileges before continuing */
1673 drop_capabilities(uid);
1674
Richard Uhler76cc0272016-12-08 10:46:35 +00001675 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001676 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
1677 ALOGE("flock(%s) failed: %s\n", out_oat_path, strerror(errno));
1678 _exit(67);
1679 }
1680
Richard Uhler76cc0272016-12-08 10:46:35 +00001681 run_dex2oat(input_fd.get(),
1682 out_oat_fd.get(),
1683 in_vdex_fd.get(),
Calin Juravle7a570e82017-01-14 16:23:30 -08001684 out_vdex_fd.get(),
Richard Uhler76cc0272016-12-08 10:46:35 +00001685 image_fd.get(),
Jeff Hao10b8a6e2017-04-05 17:11:39 -07001686 dex_path,
Richard Uhler76cc0272016-12-08 10:46:35 +00001687 out_oat_path,
1688 swap_fd.get(),
1689 instruction_set,
1690 compiler_filter,
Richard Uhler76cc0272016-12-08 10:46:35 +00001691 debuggable,
1692 boot_complete,
1693 reference_profile_fd.get(),
Calin Juravle1d667612017-07-13 22:50:21 -07001694 class_loader_context);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001695 _exit(68); /* only get here on exec failure */
1696 } else {
1697 int res = wait_child(pid);
1698 if (res == 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001699 ALOGV("DexInv: --- END '%s' (success) ---\n", dex_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001700 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001701 ALOGE("DexInv: --- END '%s' --- status=0x%04x, process failed\n", dex_path, res);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001702 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001703 }
1704 }
1705
Calin Juravlec9eab382017-01-25 01:17:17 -08001706 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001707
1708 // We've been successful, don't delete output.
1709 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001710 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001711 image_fd.SetCleanup(false);
1712 reference_profile_fd.SetCleanup(false);
1713
1714 return 0;
1715}
1716
Calin Juravlec9eab382017-01-25 01:17:17 -08001717// Try to remove the given directory. Log an error if the directory exists
1718// and is empty but could not be removed.
1719static bool rmdir_if_empty(const char* dir) {
1720 if (rmdir(dir) == 0) {
1721 return true;
1722 }
1723 if (errno == ENOENT || errno == ENOTEMPTY) {
1724 return true;
1725 }
1726 PLOG(ERROR) << "Failed to remove dir: " << dir;
1727 return false;
1728}
1729
1730// Try to unlink the given file. Log an error if the file exists and could not
1731// be unlinked.
1732static bool unlink_if_exists(const std::string& file) {
1733 if (unlink(file.c_str()) == 0) {
1734 return true;
1735 }
1736 if (errno == ENOENT) {
1737 return true;
1738
1739 }
1740 PLOG(ERROR) << "Could not unlink: " << file;
1741 return false;
1742}
1743
1744// Create the oat file structure for the secondary dex 'dex_path' and assign
1745// the individual path component to the 'out_' parameters.
1746static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
1747 /*out*/char* out_oat_dir, /*out*/char* out_oat_isa_dir, /*out*/char* out_oat_path) {
1748 size_t dirIndex = dex_path.rfind('/');
1749 if (dirIndex == std::string::npos) {
1750 LOG(ERROR) << "Unexpected dir structure for dex file " << dex_path;
1751 return false;
1752 }
1753 // TODO(calin): we have similar computations in at lest 3 other places
1754 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1755 // use string append.
1756 std::string apk_dir = dex_path.substr(0, dirIndex);
1757 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1758 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1759
1760 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08001761 /*is_secondary_dex*/true, out_oat_path)) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001762 LOG(ERROR) << "Could not create oat path for secondary dex " << dex_path;
1763 return false;
1764 }
1765 return true;
1766}
1767
1768// Reconcile the secondary dex 'dex_path' and its generated oat files.
1769// Return true if all the parameters are valid and the secondary dex file was
1770// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
1771// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
1772// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
1773// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
1774// Return false if there were errors during processing. In this case
1775// out_secondary_dex_exists will be set to false.
1776bool reconcile_secondary_dex_file(const std::string& dex_path,
1777 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
1778 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
1779 /*out*/bool* out_secondary_dex_exists) {
1780 // Set out to false to start with, just in case we have validation errors.
1781 *out_secondary_dex_exists = false;
Calin Juravled23dee72017-07-06 16:29:11 -07001782 if (!validate_dex_path_size(dex_path)) {
1783 return false;
1784 }
1785
Calin Juravlec9eab382017-01-25 01:17:17 -08001786 if (isas.size() == 0) {
1787 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
1788 return false;
1789 }
1790
1791 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
1792 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
1793 uid, storage_flag)) {
1794 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
1795 return false;
1796 }
1797
1798 if (access(dex_path.c_str(), F_OK) == 0) {
1799 // The path exists, nothing to do. The odex files (if any) will be left untouched.
1800 *out_secondary_dex_exists = true;
1801 return true;
1802 } else if (errno != ENOENT) {
1803 PLOG(ERROR) << "Failed to check access to secondary dex " << dex_path;
1804 return false;
1805 }
1806
1807 // The secondary dex does not exist anymore. Clear any generated files.
1808 char oat_path[PKG_PATH_MAX];
1809 char oat_dir[PKG_PATH_MAX];
1810 char oat_isa_dir[PKG_PATH_MAX];
1811 bool result = true;
1812 for (size_t i = 0; i < isas.size(); i++) {
1813 if (!create_secondary_dex_oat_layout(dex_path, isas[i], oat_dir, oat_isa_dir, oat_path)) {
1814 LOG(ERROR) << "Could not create secondary odex layout: " << dex_path;
1815 result = false;
1816 continue;
1817 }
Calin Juravle51314092017-05-18 15:33:05 -07001818
1819 // Delete oat/vdex/art files.
Calin Juravlec9eab382017-01-25 01:17:17 -08001820 result = unlink_if_exists(oat_path) && result;
1821 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
1822 result = unlink_if_exists(create_image_filename(oat_path)) && result;
1823
Calin Juravle51314092017-05-18 15:33:05 -07001824 // Delete profiles.
1825 std::string current_profile = create_current_profile_path(
1826 multiuser_get_user_id(uid), dex_path, /*is_secondary*/true);
1827 std::string reference_profile = create_reference_profile_path(
1828 dex_path, /*is_secondary*/true);
1829 result = unlink_if_exists(current_profile) && result;
1830 result = unlink_if_exists(reference_profile) && result;
1831
Calin Juravlec9eab382017-01-25 01:17:17 -08001832 // Try removing the directories as well, they might be empty.
1833 result = rmdir_if_empty(oat_isa_dir) && result;
1834 result = rmdir_if_empty(oat_dir) && result;
1835 }
1836
1837 return result;
1838}
1839
Jeff Sharkey90aff262016-12-12 14:28:24 -07001840// Helper for move_ab, so that we can have common failure-case cleanup.
1841static bool unlink_and_rename(const char* from, const char* to) {
1842 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
1843 // return a failure.
1844 struct stat s;
1845 if (stat(to, &s) == 0) {
1846 if (!S_ISREG(s.st_mode)) {
1847 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
1848 return false;
1849 }
1850 if (unlink(to) != 0) {
1851 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
1852 return false;
1853 }
1854 } else {
1855 // This may be a permission problem. We could investigate the error code, but we'll just
1856 // let the rename failure do the work for us.
1857 }
1858
1859 // Try to rename "to" to "from."
1860 if (rename(from, to) != 0) {
1861 PLOG(ERROR) << "Could not rename " << from << " to " << to;
1862 return false;
1863 }
1864 return true;
1865}
1866
1867// Move/rename a B artifact (from) to an A artifact (to).
1868static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
1869 // Check whether B exists.
1870 {
1871 struct stat s;
1872 if (stat(b_path.c_str(), &s) != 0) {
1873 // Silently ignore for now. The service calling this isn't smart enough to understand
1874 // lack of artifacts at the moment.
1875 return false;
1876 }
1877 if (!S_ISREG(s.st_mode)) {
1878 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
1879 // Try to unlink, but swallow errors.
1880 unlink(b_path.c_str());
1881 return false;
1882 }
1883 }
1884
1885 // Rename B to A.
1886 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
1887 // Delete the b_path so we don't try again (or fail earlier).
1888 if (unlink(b_path.c_str()) != 0) {
1889 PLOG(ERROR) << "Could not unlink " << b_path;
1890 }
1891
1892 return false;
1893 }
1894
1895 return true;
1896}
1897
1898bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
1899 // Get the current slot suffix. No suffix, no A/B.
1900 std::string slot_suffix;
1901 {
1902 char buf[kPropertyValueMax];
1903 if (get_property("ro.boot.slot_suffix", buf, nullptr) <= 0) {
1904 return false;
1905 }
1906 slot_suffix = buf;
1907
1908 if (!ValidateTargetSlotSuffix(slot_suffix)) {
1909 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
1910 return false;
1911 }
1912 }
1913
1914 // Validate other inputs.
1915 if (validate_apk_path(apk_path) != 0) {
1916 LOG(ERROR) << "Invalid apk_path: " << apk_path;
1917 return false;
1918 }
1919 if (validate_apk_path(oat_dir) != 0) {
1920 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
1921 return false;
1922 }
1923
1924 char a_path[PKG_PATH_MAX];
1925 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
1926 return false;
1927 }
1928 const std::string a_vdex_path = create_vdex_filename(a_path);
1929 const std::string a_image_path = create_image_filename(a_path);
1930
1931 // B path = A path + slot suffix.
1932 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
1933 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
1934 const std::string b_image_path = StringPrintf("%s.%s",
1935 a_image_path.c_str(),
1936 slot_suffix.c_str());
1937
1938 bool success = true;
1939 if (move_ab_path(b_path, a_path)) {
1940 if (move_ab_path(b_vdex_path, a_vdex_path)) {
1941 // Note: we can live without an app image. As such, ignore failure to move the image file.
1942 // If we decide to require the app image, or the app image being moved correctly,
1943 // then change accordingly.
1944 constexpr bool kIgnoreAppImageFailure = true;
1945
1946 if (!a_image_path.empty()) {
1947 if (!move_ab_path(b_image_path, a_image_path)) {
1948 unlink(a_image_path.c_str());
1949 if (!kIgnoreAppImageFailure) {
1950 success = false;
1951 }
1952 }
1953 }
1954 } else {
1955 // Cleanup: delete B image, ignore errors.
1956 unlink(b_image_path.c_str());
1957 success = false;
1958 }
1959 } else {
1960 // Cleanup: delete B image, ignore errors.
1961 unlink(b_vdex_path.c_str());
1962 unlink(b_image_path.c_str());
1963 success = false;
1964 }
1965 return success;
1966}
1967
1968bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
1969 // Delete the oat/odex file.
1970 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08001971 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08001972 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001973 return false;
1974 }
1975
1976 // In case of a permission failure report the issue. Otherwise just print a warning.
1977 auto unlink_and_check = [](const char* path) -> bool {
1978 int result = unlink(path);
1979 if (result != 0) {
1980 if (errno == EACCES || errno == EPERM) {
1981 PLOG(ERROR) << "Could not unlink " << path;
1982 return false;
1983 }
1984 PLOG(WARNING) << "Could not unlink " << path;
1985 }
1986 return true;
1987 };
1988
1989 // Delete the oat/odex file.
1990 bool return_value_oat = unlink_and_check(out_path);
1991
1992 // Derive and delete the app image.
1993 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
1994
Nicolas Geoffray192fb962017-05-25 13:58:06 +01001995 // Derive and delete the vdex file.
1996 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
1997
Jeff Sharkey90aff262016-12-12 14:28:24 -07001998 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01001999 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002000}
2001
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002002} // namespace installd
2003} // namespace android