blob: 230853d0dceb0dd8724a0f5b1b84decc3898c691 [file] [log] [blame]
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Mark Salyzyna5e161b2016-09-29 08:08:05 -070016#define LOG_TAG "installed"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070017
Alan Stokesa25d90c2017-10-16 10:56:00 +010018#include <array>
Jeff Sharkey90aff262016-12-12 14:28:24 -070019#include <fcntl.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070020#include <stdlib.h>
21#include <string.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070022#include <sys/capability.h>
23#include <sys/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070024#include <sys/stat.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070025#include <sys/time.h>
26#include <sys/types.h>
27#include <sys/resource.h>
28#include <sys/wait.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070029#include <unistd.h>
30
Andreas Gampe023b2242018-02-28 16:03:25 -080031#include <iomanip>
32
Alan Stokesa25d90c2017-10-16 10:56:00 +010033#include <android-base/file.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070034#include <android-base/logging.h>
Andreas Gampe6a9cf722017-07-24 16:49:10 -070035#include <android-base/properties.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070036#include <android-base/stringprintf.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070037#include <android-base/strings.h>
38#include <android-base/unique_fd.h>
Calin Juravle80a21252017-01-17 14:43:25 -080039#include <cutils/fs.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070040#include <cutils/properties.h>
41#include <cutils/sched_policy.h>
Andreas Gampefa2dadd2018-02-28 19:52:47 -080042#include <dex2oat_return_codes.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070043#include <log/log.h> // TODO: Move everything to base/logging.
Alan Stokesa25d90c2017-10-16 10:56:00 +010044#include <openssl/sha.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070045#include <private/android_filesystem_config.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070046#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070047#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070048
49#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080050#include "dexopt_return_codes.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060051#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070052#include "installd_deps.h"
53#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070054#include "utils.h"
55
Jeff Sharkey90aff262016-12-12 14:28:24 -070056using android::base::EndsWith;
Alan Stokesa25d90c2017-10-16 10:56:00 +010057using android::base::ReadFully;
58using android::base::StringPrintf;
59using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080060using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070061
62namespace android {
63namespace installd {
64
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070065// Should minidebug info be included in compiled artifacts? Even if this value is
66// "true," usage might still be conditional to other constraints, e.g., system
67// property overrides.
68static constexpr bool kEnableMinidebugInfo = true;
69
70static constexpr const char* kMinidebugInfoSystemProperty = "dalvik.vm.dex2oat-minidebuginfo";
71static constexpr bool kMinidebugInfoSystemPropertyDefault = false;
72static constexpr const char* kMinidebugDex2oatFlag = "--generate-mini-debug-info";
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -080073static constexpr const char* kDisableCompactDexFlag = "--compact-dex-level=none";
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070074
Andreas Gampefa2dadd2018-02-28 19:52:47 -080075
Calin Juravle114f0812017-03-08 19:05:07 -080076// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
77struct FreeDelete {
78 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
79 void operator()(const void* ptr) const {
80 free(const_cast<void*>(ptr));
81 }
82};
83
84// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
85template <typename T>
86using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
87
Calin Juravle1a0af3b2017-03-09 14:33:33 -080088static unique_fd invalid_unique_fd() {
89 return unique_fd(-1);
90}
91
Andreas Gampe6a9cf722017-07-24 16:49:10 -070092static bool is_debug_runtime() {
93 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
94}
95
David Sehra3b5ab62017-10-25 14:27:29 -070096static bool is_debuggable_build() {
97 return android::base::GetBoolProperty("ro.debuggable", false);
98}
99
Jeff Sharkey90aff262016-12-12 14:28:24 -0700100static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800101 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700102 if (ufd.get() < 0) {
103 if (errno != ENOENT) {
104 PLOG(WARNING) << "Could not open profile " << profile;
105 return false;
106 } else {
107 // Nothing to clear. That's ok.
108 return true;
109 }
110 }
111
112 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
113 if (errno != EWOULDBLOCK) {
114 PLOG(WARNING) << "Error locking profile " << profile;
115 }
116 // This implies that the app owning this profile is running
117 // (and has acquired the lock).
118 //
119 // If we can't acquire the lock bail out since clearing is useless anyway
120 // (the app will write again to the profile).
121 //
122 // Note:
123 // This does not impact the this is not an issue for the profiling correctness.
124 // In case this is needed because of an app upgrade, profiles will still be
125 // eventually cleared by the app itself due to checksum mismatch.
126 // If this is needed because profman advised, then keeping the data around
127 // until the next run is again not an issue.
128 //
129 // If the app attempts to acquire a lock while we've held one here,
130 // it will simply skip the current write cycle.
131 return false;
132 }
133
134 bool truncated = ftruncate(ufd.get(), 0) == 0;
135 if (!truncated) {
136 PLOG(WARNING) << "Could not truncate " << profile;
137 }
138 if (flock(ufd.get(), LOCK_UN) != 0) {
139 PLOG(WARNING) << "Error unlocking profile " << profile;
140 }
141 return truncated;
142}
143
Calin Juravle114f0812017-03-08 19:05:07 -0800144// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800145// The location is the profile name for primary apks or the dex path for secondary dex files.
146static bool clear_reference_profile(const std::string& package_name, const std::string& location,
147 bool is_secondary_dex) {
148 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700149}
150
Calin Juravle114f0812017-03-08 19:05:07 -0800151// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800152// The location is the profile name for primary apks or the dex path for secondary dex files.
153static bool clear_current_profile(const std::string& package_name, const std::string& location,
154 userid_t user, bool is_secondary_dex) {
155 return clear_profile(create_current_profile_path(user, package_name, location,
156 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700157}
158
Calin Juravle114f0812017-03-08 19:05:07 -0800159// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800160// The location is the profile name for primary apks or the dex path for secondary dex files.
161bool clear_primary_reference_profile(const std::string& package_name,
162 const std::string& location) {
163 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800164}
165
166// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800167// The location is the profile name for primary apks or the dex path for secondary dex files.
168bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700169 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800170 // 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 -0700171 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
172 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800173 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700174 }
175 return success;
176}
177
Calin Juravle114f0812017-03-08 19:05:07 -0800178// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800179bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
180 userid_t user) {
181 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800182}
183
Jeff Sharkey90aff262016-12-12 14:28:24 -0700184static int split_count(const char *str)
185{
186 char *ctx;
187 int count = 0;
188 char buf[kPropertyValueMax];
189
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600190 strlcpy(buf, str, sizeof(buf));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700191 char *pBuf = buf;
192
193 while(strtok_r(pBuf, " ", &ctx) != NULL) {
194 count++;
195 pBuf = NULL;
196 }
197
198 return count;
199}
200
201static int split(char *buf, const char **argv)
202{
203 char *ctx;
204 int count = 0;
205 char *tok;
206 char *pBuf = buf;
207
208 while((tok = strtok_r(pBuf, " ", &ctx)) != NULL) {
209 argv[count++] = tok;
210 pBuf = NULL;
211 }
212
213 return count;
214}
215
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700216static const char* get_location_from_path(const char* path) {
217 static constexpr char kLocationSeparator = '/';
218 const char *location = strrchr(path, kLocationSeparator);
219 if (location == NULL) {
220 return path;
221 } else {
222 // Skip the separator character.
223 return location + 1;
224 }
225}
226
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800227[[ noreturn ]]
Jeff Sharkey90aff262016-12-12 14:28:24 -0700228static void run_dex2oat(int zip_fd, int oat_fd, int input_vdex_fd, int output_vdex_fd, int image_fd,
229 const char* input_file_name, const char* output_file_name, int swap_fd,
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100230 const char* instruction_set, const char* compiler_filter,
Andreas Gampea73a0cb2017-11-02 18:14:42 -0700231 bool debuggable, bool post_bootcomplete, bool background_job_compile, int profile_fd,
Calin Juravle62c5a372018-02-01 17:03:23 +0000232 const char* class_loader_context, int target_sdk_version, bool enable_hidden_api_checks,
Calin Juravle2efc4022018-02-13 18:31:32 -0800233 int dex_metadata_fd, const char* compilation_reason) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700234 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
235
236 if (strlen(instruction_set) >= MAX_INSTRUCTION_SET_LEN) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800237 LOG(ERROR) << "Instruction set '" << instruction_set << "' longer than max length of "
238 << MAX_INSTRUCTION_SET_LEN;
239 exit(DexoptReturnCodes::kInstructionSetLength);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700240 }
241
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700242 // Get the relative path to the input file.
243 const char* relative_input_file_name = get_location_from_path(input_file_name);
244
Jeff Sharkey90aff262016-12-12 14:28:24 -0700245 char dex2oat_Xms_flag[kPropertyValueMax];
246 bool have_dex2oat_Xms_flag = get_property("dalvik.vm.dex2oat-Xms", dex2oat_Xms_flag, NULL) > 0;
247
248 char dex2oat_Xmx_flag[kPropertyValueMax];
249 bool have_dex2oat_Xmx_flag = get_property("dalvik.vm.dex2oat-Xmx", dex2oat_Xmx_flag, NULL) > 0;
250
251 char dex2oat_threads_buf[kPropertyValueMax];
252 bool have_dex2oat_threads_flag = get_property(post_bootcomplete
253 ? "dalvik.vm.dex2oat-threads"
254 : "dalvik.vm.boot-dex2oat-threads",
255 dex2oat_threads_buf,
256 NULL) > 0;
257 char dex2oat_threads_arg[kPropertyValueMax + 2];
258 if (have_dex2oat_threads_flag) {
259 sprintf(dex2oat_threads_arg, "-j%s", dex2oat_threads_buf);
260 }
261
262 char dex2oat_isa_features_key[kPropertyKeyMax];
263 sprintf(dex2oat_isa_features_key, "dalvik.vm.isa.%s.features", instruction_set);
264 char dex2oat_isa_features[kPropertyValueMax];
265 bool have_dex2oat_isa_features = get_property(dex2oat_isa_features_key,
266 dex2oat_isa_features, NULL) > 0;
267
268 char dex2oat_isa_variant_key[kPropertyKeyMax];
269 sprintf(dex2oat_isa_variant_key, "dalvik.vm.isa.%s.variant", instruction_set);
270 char dex2oat_isa_variant[kPropertyValueMax];
271 bool have_dex2oat_isa_variant = get_property(dex2oat_isa_variant_key,
272 dex2oat_isa_variant, NULL) > 0;
273
274 const char *dex2oat_norelocation = "-Xnorelocate";
275 bool have_dex2oat_relocation_skip_flag = false;
276
277 char dex2oat_flags[kPropertyValueMax];
278 int dex2oat_flags_count = get_property("dalvik.vm.dex2oat-flags",
279 dex2oat_flags, NULL) <= 0 ? 0 : split_count(dex2oat_flags);
280 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags);
281
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100282 // If we are booting without the real /data, don't spend time compiling.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700283 char vold_decrypt[kPropertyValueMax];
284 bool have_vold_decrypt = get_property("vold.decrypt", vold_decrypt, "") > 0;
285 bool skip_compilation = (have_vold_decrypt &&
286 (strcmp(vold_decrypt, "trigger_restart_min_framework") == 0 ||
287 (strcmp(vold_decrypt, "1") == 0)));
288
289 bool generate_debug_info = property_get_bool("debug.generate-debug-info", false);
290
291 char app_image_format[kPropertyValueMax];
292 char image_format_arg[strlen("--image-format=") + kPropertyValueMax];
293 bool have_app_image_format =
294 image_fd >= 0 && get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
295 if (have_app_image_format) {
296 sprintf(image_format_arg, "--image-format=%s", app_image_format);
297 }
298
299 char dex2oat_large_app_threshold[kPropertyValueMax];
300 bool have_dex2oat_large_app_threshold =
301 get_property("dalvik.vm.dex2oat-very-large", dex2oat_large_app_threshold, NULL) > 0;
302 char dex2oat_large_app_threshold_arg[strlen("--very-large-app-threshold=") + kPropertyValueMax];
303 if (have_dex2oat_large_app_threshold) {
304 sprintf(dex2oat_large_app_threshold_arg,
305 "--very-large-app-threshold=%s",
306 dex2oat_large_app_threshold);
307 }
308
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700309 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
David Sehra3b5ab62017-10-25 14:27:29 -0700310 const char* dex2oat_bin = "/system/bin/dex2oat";
Andreas Gampee87fe0a2018-03-01 23:55:53 -0800311 constexpr const char* kDex2oatDebugPath = "/system/bin/dex2oatd";
Andreas Gampea73a0cb2017-11-02 18:14:42 -0700312 if (is_debug_runtime() || (background_job_compile && is_debuggable_build())) {
Andreas Gampee87fe0a2018-03-01 23:55:53 -0800313 if (access(kDex2oatDebugPath, X_OK) == 0) {
314 dex2oat_bin = kDex2oatDebugPath;
315 }
David Sehra3b5ab62017-10-25 14:27:29 -0700316 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700317
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700318 bool generate_minidebug_info = kEnableMinidebugInfo &&
319 android::base::GetBoolProperty(kMinidebugInfoSystemProperty,
320 kMinidebugInfoSystemPropertyDefault);
321
Jeff Sharkey90aff262016-12-12 14:28:24 -0700322 static const char* RUNTIME_ARG = "--runtime-arg";
323
324 static const int MAX_INT_LEN = 12; // '-'+10dig+'\0' -OR- 0x+8dig
325
George Burgess IV36cebe772017-01-25 11:52:01 -0800326 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
327 // use arraysize instead.
328 char zip_fd_arg[arraysize("--zip-fd=") + MAX_INT_LEN];
329 char zip_location_arg[arraysize("--zip-location=") + PKG_PATH_MAX];
330 char input_vdex_fd_arg[arraysize("--input-vdex-fd=") + MAX_INT_LEN];
331 char output_vdex_fd_arg[arraysize("--output-vdex-fd=") + MAX_INT_LEN];
332 char oat_fd_arg[arraysize("--oat-fd=") + MAX_INT_LEN];
333 char oat_location_arg[arraysize("--oat-location=") + PKG_PATH_MAX];
334 char instruction_set_arg[arraysize("--instruction-set=") + MAX_INSTRUCTION_SET_LEN];
335 char instruction_set_variant_arg[arraysize("--instruction-set-variant=") + kPropertyValueMax];
336 char instruction_set_features_arg[arraysize("--instruction-set-features=") + kPropertyValueMax];
337 char dex2oat_Xms_arg[arraysize("-Xms") + kPropertyValueMax];
338 char dex2oat_Xmx_arg[arraysize("-Xmx") + kPropertyValueMax];
339 char dex2oat_compiler_filter_arg[arraysize("--compiler-filter=") + kPropertyValueMax];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700340 bool have_dex2oat_swap_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800341 char dex2oat_swap_fd[arraysize("--swap-fd=") + MAX_INT_LEN];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700342 bool have_dex2oat_image_fd = false;
George Burgess IV36cebe772017-01-25 11:52:01 -0800343 char dex2oat_image_fd[arraysize("--app-image-fd=") + MAX_INT_LEN];
Calin Juravle52c45822017-07-13 22:50:21 -0700344 size_t class_loader_context_size = arraysize("--class-loader-context=") + PKG_PATH_MAX;
David Brazdil570d3982018-01-16 20:15:43 +0000345 char target_sdk_version_arg[arraysize("-Xtarget-sdk-version:") + MAX_INT_LEN];
Calin Juravle52c45822017-07-13 22:50:21 -0700346 char class_loader_context_arg[class_loader_context_size];
347 if (class_loader_context != nullptr) {
348 snprintf(class_loader_context_arg, class_loader_context_size, "--class-loader-context=%s",
349 class_loader_context);
350 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700351
352 sprintf(zip_fd_arg, "--zip-fd=%d", zip_fd);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700353 sprintf(zip_location_arg, "--zip-location=%s", relative_input_file_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700354 sprintf(input_vdex_fd_arg, "--input-vdex-fd=%d", input_vdex_fd);
355 sprintf(output_vdex_fd_arg, "--output-vdex-fd=%d", output_vdex_fd);
356 sprintf(oat_fd_arg, "--oat-fd=%d", oat_fd);
357 sprintf(oat_location_arg, "--oat-location=%s", output_file_name);
358 sprintf(instruction_set_arg, "--instruction-set=%s", instruction_set);
359 sprintf(instruction_set_variant_arg, "--instruction-set-variant=%s", dex2oat_isa_variant);
360 sprintf(instruction_set_features_arg, "--instruction-set-features=%s", dex2oat_isa_features);
361 if (swap_fd >= 0) {
362 have_dex2oat_swap_fd = true;
363 sprintf(dex2oat_swap_fd, "--swap-fd=%d", swap_fd);
364 }
365 if (image_fd >= 0) {
366 have_dex2oat_image_fd = true;
367 sprintf(dex2oat_image_fd, "--app-image-fd=%d", image_fd);
368 }
369
370 if (have_dex2oat_Xms_flag) {
371 sprintf(dex2oat_Xms_arg, "-Xms%s", dex2oat_Xms_flag);
372 }
373 if (have_dex2oat_Xmx_flag) {
374 sprintf(dex2oat_Xmx_arg, "-Xmx%s", dex2oat_Xmx_flag);
375 }
David Brazdil570d3982018-01-16 20:15:43 +0000376 sprintf(target_sdk_version_arg, "-Xtarget-sdk-version:%d", target_sdk_version);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700377
378 // Compute compiler filter.
379
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100380 bool have_dex2oat_compiler_filter_flag = false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700381 if (skip_compilation) {
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600382 strlcpy(dex2oat_compiler_filter_arg, "--compiler-filter=extract",
383 sizeof(dex2oat_compiler_filter_arg));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700384 have_dex2oat_compiler_filter_flag = true;
385 have_dex2oat_relocation_skip_flag = true;
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100386 } else if (compiler_filter != nullptr) {
387 if (strlen(compiler_filter) + strlen("--compiler-filter=") <
Jeff Sharkey90aff262016-12-12 14:28:24 -0700388 arraysize(dex2oat_compiler_filter_arg)) {
Nicolas Geoffraybe6ecd62017-05-03 13:21:37 +0100389 sprintf(dex2oat_compiler_filter_arg, "--compiler-filter=%s", compiler_filter);
390 have_dex2oat_compiler_filter_flag = true;
391 } else {
392 ALOGW("Compiler filter name '%s' is too large (max characters is %zu)",
393 compiler_filter,
394 kPropertyValueMax);
395 }
396 }
397
398 if (!have_dex2oat_compiler_filter_flag) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700399 char dex2oat_compiler_filter_flag[kPropertyValueMax];
400 have_dex2oat_compiler_filter_flag = get_property("dalvik.vm.dex2oat-filter",
401 dex2oat_compiler_filter_flag, NULL) > 0;
402 if (have_dex2oat_compiler_filter_flag) {
403 sprintf(dex2oat_compiler_filter_arg,
404 "--compiler-filter=%s",
405 dex2oat_compiler_filter_flag);
406 }
407 }
408
409 // Check whether all apps should be compiled debuggable.
410 if (!debuggable) {
411 char prop_buf[kPropertyValueMax];
412 debuggable =
413 (get_property("dalvik.vm.always_debuggable", prop_buf, "0") > 0) &&
414 (prop_buf[0] == '1');
415 }
416 char profile_arg[strlen("--profile-file-fd=") + MAX_INT_LEN];
417 if (profile_fd != -1) {
418 sprintf(profile_arg, "--profile-file-fd=%d", profile_fd);
419 }
420
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700421 // Get the directory of the apk to pass as a base classpath directory.
422 char base_dir[arraysize("--classpath-dir=") + PKG_PATH_MAX];
423 std::string apk_dir(input_file_name);
424 unsigned long dir_index = apk_dir.rfind('/');
425 bool has_base_dir = dir_index != std::string::npos;
426 if (has_base_dir) {
427 apk_dir = apk_dir.substr(0, dir_index);
428 sprintf(base_dir, "--classpath-dir=%s", apk_dir.c_str());
429 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700430
Calin Juravle62c5a372018-02-01 17:03:23 +0000431 std::string dex_metadata_fd_arg = "--dm-fd=" + std::to_string(dex_metadata_fd);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700432
Calin Juravle2efc4022018-02-13 18:31:32 -0800433 std::string compilation_reason_arg = compilation_reason == nullptr
434 ? ""
435 : std::string("--compilation-reason=") + compilation_reason;
436
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700437 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700438
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800439 // Disable cdex if update input vdex is true since this combination of options is not
440 // supported.
Mathieu Chartier1fb463e2018-01-09 15:16:10 -0800441 // Disable cdex for non-background compiles since we don't want to regress app install until
442 // there are enough benefits to justify the tradeoff.
443 const bool disable_cdex = !background_job_compile || (input_vdex_fd == output_vdex_fd);
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800444
Jeff Sharkey90aff262016-12-12 14:28:24 -0700445 const char* argv[9 // program name, mandatory arguments and the final NULL
446 + (have_dex2oat_isa_variant ? 1 : 0)
447 + (have_dex2oat_isa_features ? 1 : 0)
448 + (have_dex2oat_Xms_flag ? 2 : 0)
449 + (have_dex2oat_Xmx_flag ? 2 : 0)
450 + (have_dex2oat_compiler_filter_flag ? 1 : 0)
451 + (have_dex2oat_threads_flag ? 1 : 0)
452 + (have_dex2oat_swap_fd ? 1 : 0)
453 + (have_dex2oat_image_fd ? 1 : 0)
454 + (have_dex2oat_relocation_skip_flag ? 2 : 0)
455 + (generate_debug_info ? 1 : 0)
456 + (debuggable ? 1 : 0)
457 + (have_app_image_format ? 1 : 0)
458 + dex2oat_flags_count
459 + (profile_fd == -1 ? 0 : 1)
Calin Juravle52c45822017-07-13 22:50:21 -0700460 + (class_loader_context != nullptr ? 1 : 0)
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700461 + (has_base_dir ? 1 : 0)
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700462 + (have_dex2oat_large_app_threshold ? 1 : 0)
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800463 + (disable_cdex ? 1 : 0)
David Brazdil570d3982018-01-16 20:15:43 +0000464 + (generate_minidebug_info ? 1 : 0)
David Brazdil7fcbb812018-01-17 17:05:40 +0000465 + (target_sdk_version != 0 ? 2 : 0)
Calin Juravle62c5a372018-02-01 17:03:23 +0000466 + (enable_hidden_api_checks ? 2 : 0)
Calin Juravle2efc4022018-02-13 18:31:32 -0800467 + (dex_metadata_fd > -1 ? 1 : 0)
468 + (compilation_reason != nullptr ? 1 : 0)];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700469 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700470 argv[i++] = dex2oat_bin;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700471 argv[i++] = zip_fd_arg;
472 argv[i++] = zip_location_arg;
473 argv[i++] = input_vdex_fd_arg;
474 argv[i++] = output_vdex_fd_arg;
475 argv[i++] = oat_fd_arg;
476 argv[i++] = oat_location_arg;
477 argv[i++] = instruction_set_arg;
478 if (have_dex2oat_isa_variant) {
479 argv[i++] = instruction_set_variant_arg;
480 }
481 if (have_dex2oat_isa_features) {
482 argv[i++] = instruction_set_features_arg;
483 }
484 if (have_dex2oat_Xms_flag) {
485 argv[i++] = RUNTIME_ARG;
486 argv[i++] = dex2oat_Xms_arg;
487 }
488 if (have_dex2oat_Xmx_flag) {
489 argv[i++] = RUNTIME_ARG;
490 argv[i++] = dex2oat_Xmx_arg;
491 }
492 if (have_dex2oat_compiler_filter_flag) {
493 argv[i++] = dex2oat_compiler_filter_arg;
494 }
495 if (have_dex2oat_threads_flag) {
496 argv[i++] = dex2oat_threads_arg;
497 }
498 if (have_dex2oat_swap_fd) {
499 argv[i++] = dex2oat_swap_fd;
500 }
501 if (have_dex2oat_image_fd) {
502 argv[i++] = dex2oat_image_fd;
503 }
504 if (generate_debug_info) {
505 argv[i++] = "--generate-debug-info";
506 }
507 if (debuggable) {
508 argv[i++] = "--debuggable";
509 }
510 if (have_app_image_format) {
511 argv[i++] = image_format_arg;
512 }
513 if (have_dex2oat_large_app_threshold) {
514 argv[i++] = dex2oat_large_app_threshold_arg;
515 }
516 if (dex2oat_flags_count) {
517 i += split(dex2oat_flags, argv + i);
518 }
519 if (have_dex2oat_relocation_skip_flag) {
520 argv[i++] = RUNTIME_ARG;
521 argv[i++] = dex2oat_norelocation;
522 }
523 if (profile_fd != -1) {
524 argv[i++] = profile_arg;
525 }
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700526 if (has_base_dir) {
527 argv[i++] = base_dir;
528 }
Calin Juravle52c45822017-07-13 22:50:21 -0700529 if (class_loader_context != nullptr) {
530 argv[i++] = class_loader_context_arg;
531 }
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -0700532 if (generate_minidebug_info) {
533 argv[i++] = kMinidebugDex2oatFlag;
534 }
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -0800535 if (disable_cdex) {
536 argv[i++] = kDisableCompactDexFlag;
537 }
David Brazdil570d3982018-01-16 20:15:43 +0000538 if (target_sdk_version != 0) {
539 argv[i++] = RUNTIME_ARG;
540 argv[i++] = target_sdk_version_arg;
541 }
David Brazdil52249162018-02-12 18:04:59 -0800542 if (enable_hidden_api_checks) {
David Brazdil7fcbb812018-01-17 17:05:40 +0000543 argv[i++] = RUNTIME_ARG;
David Brazdil52249162018-02-12 18:04:59 -0800544 argv[i++] = "-Xhidden-api-checks";
David Brazdil7fcbb812018-01-17 17:05:40 +0000545 }
Calin Juravle52c45822017-07-13 22:50:21 -0700546
Calin Juravle62c5a372018-02-01 17:03:23 +0000547 if (dex_metadata_fd > -1) {
548 argv[i++] = dex_metadata_fd_arg.c_str();
549 }
Calin Juravle2efc4022018-02-13 18:31:32 -0800550
551 if(compilation_reason != nullptr) {
552 argv[i++] = compilation_reason_arg.c_str();
553 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700554 // Do not add after dex2oat_flags, they should override others for debugging.
555 argv[i] = NULL;
556
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700557 execv(dex2oat_bin, (char * const *)argv);
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800558 PLOG(ERROR) << "execv(" << dex2oat_bin << ") failed";
559 exit(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700560}
561
562/*
563 * Whether dexopt should use a swap file when compiling an APK.
564 *
565 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
566 * itself, anyways).
567 *
568 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
569 *
570 * Otherwise, return true if this is a low-mem device.
571 *
572 * Otherwise, return default value.
573 */
574static bool kAlwaysProvideSwapFile = false;
575static bool kDefaultProvideSwapFile = true;
576
577static bool ShouldUseSwapFileForDexopt() {
578 if (kAlwaysProvideSwapFile) {
579 return true;
580 }
581
582 // Check the "override" property. If it exists, return value == "true".
583 char dex2oat_prop_buf[kPropertyValueMax];
584 if (get_property("dalvik.vm.dex2oat-swap", dex2oat_prop_buf, "") > 0) {
585 if (strcmp(dex2oat_prop_buf, "true") == 0) {
586 return true;
587 } else {
588 return false;
589 }
590 }
591
592 // Shortcut for default value. This is an implementation optimization for the process sketched
593 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
594 // as low-mem is never returning false. The compiler will optimize this away if it can.
595 if (kDefaultProvideSwapFile) {
596 return true;
597 }
598
599 bool is_low_mem = property_get_bool("ro.config.low_ram", false);
600 if (is_low_mem) {
601 return true;
602 }
603
604 // Default value must be false here.
605 return kDefaultProvideSwapFile;
606}
607
Richard Uhler76cc0272016-12-08 10:46:35 +0000608static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700609 if (set_to_bg) {
610 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800611 PLOG(ERROR) << "set_sched_policy failed";
612 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700613 }
614 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800615 PLOG(ERROR) << "setpriority failed";
616 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700617 }
618 }
619}
620
Calin Juravle29591732017-11-20 17:46:19 -0800621static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
622 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800623 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800624 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800625 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800626 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800627 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700628 }
Calin Juravle114f0812017-03-08 19:05:07 -0800629 // Profiles should belong to the app; make sure of that by giving ownership to
630 // the app uid. If we cannot do that, there's no point in returning the fd
631 // since dex2oat/profman will fail with SElinux denials.
632 if (fchown(fd.get(), uid, uid) < 0) {
633 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800634 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800635 }
Calin Juravle29591732017-11-20 17:46:19 -0800636 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800637}
638
Calin Juravle29591732017-11-20 17:46:19 -0800639static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800640 // Do not follow symlinks when opening a profile:
641 // - primary profiles should not contain symlinks in their paths
642 // - secondary dex paths should have been already resolved and validated
643 flags |= O_NOFOLLOW;
644
Calin Juravle29591732017-11-20 17:46:19 -0800645 // Check if we need to create the profile
646 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
647 unique_fd fd;
648 if ((flags & O_CREAT) != 0) {
649 fd = create_profile(uid, profile, flags);
650 } else {
651 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
652 }
653
Calin Juravle114f0812017-03-08 19:05:07 -0800654 if (fd.get() < 0) {
655 if (errno != ENOENT) {
656 // Profiles might be missing for various reasons. For example, in a
657 // multi-user environment, the profile directory for one user can be created
658 // after we start a merge. In this case the current profile for that user
659 // will not be found.
660 // Also, the secondary dex profiles might be deleted by the app at any time,
661 // so we can't we need to prepare if they are missing.
662 PLOG(ERROR) << "Failed to open profile " << profile;
663 }
664 return invalid_unique_fd();
665 }
666
Jeff Sharkey90aff262016-12-12 14:28:24 -0700667 return fd;
668}
669
Calin Juravle824a64d2018-01-18 20:23:17 -0800670static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
671 const std::string& location, bool is_secondary_dex) {
672 std::string profile = create_current_profile_path(user, package_name, location,
673 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800674 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800675}
676
Calin Juravle824a64d2018-01-18 20:23:17 -0800677static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
678 const std::string& location, bool read_write, bool is_secondary_dex) {
679 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800680 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
681}
682
683static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800684 const std::string& location) {
685 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800686 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800687}
688
Calin Juravle824a64d2018-01-18 20:23:17 -0800689static void open_profile_files(uid_t uid, const std::string& package_name,
690 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800691 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700692 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800693 *reference_profile_fd = open_reference_profile(uid, package_name, location,
694 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700695
Calin Juravle114f0812017-03-08 19:05:07 -0800696 // For secondary dex files, we don't really need the user but we use it for sanity checks.
697 // Note: the user owning the dex file should be the current user.
698 std::vector<userid_t> users;
699 if (is_secondary_dex){
700 users.push_back(multiuser_get_user_id(uid));
701 } else {
702 users = get_known_users(/*volume_uuid*/ nullptr);
703 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700704 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800705 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
706 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700707 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800708 if (profile_fd.get() >= 0) {
709 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700710 }
711 }
712}
713
714static void drop_capabilities(uid_t uid) {
715 if (setgid(uid) != 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800716 PLOG(ERROR) << "setgid(" << uid << ") failed in installd during dexopt";
717 exit(DexoptReturnCodes::kSetGid);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700718 }
719 if (setuid(uid) != 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800720 PLOG(ERROR) << "setuid(" << uid << ") failed in installd during dexopt";
721 exit(DexoptReturnCodes::kSetUid);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700722 }
723 // drop capabilities
724 struct __user_cap_header_struct capheader;
725 struct __user_cap_data_struct capdata[2];
726 memset(&capheader, 0, sizeof(capheader));
727 memset(&capdata, 0, sizeof(capdata));
728 capheader.version = _LINUX_CAPABILITY_VERSION_3;
729 if (capset(&capheader, &capdata[0]) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800730 PLOG(ERROR) << "capset failed";
731 exit(DexoptReturnCodes::kCapSet);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700732 }
733}
734
735static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
736static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
737static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
738static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
739static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
740
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800741[[ noreturn ]]
Calin Juravlef63d4792018-01-30 17:43:34 +0000742static void run_profman(const std::vector<unique_fd>& profile_fds,
743 const unique_fd& reference_profile_fd,
744 const std::vector<unique_fd>* apk_fds,
745 bool copy_and_update) {
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700746 const char* profman_bin = is_debug_runtime() ? "/system/bin/profmand" : "/system/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700747
Calin Juravlef63d4792018-01-30 17:43:34 +0000748 if (copy_and_update) {
749 CHECK_EQ(1u, profile_fds.size());
750 CHECK(apk_fds != nullptr);
751 CHECK_EQ(1u, apk_fds->size());
752 }
753 std::vector<std::string> profile_args(profile_fds.size());
754 for (size_t k = 0; k < profile_fds.size(); k++) {
755 profile_args[k] = "--profile-file-fd=" + std::to_string(profile_fds[k].get());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700756 }
Calin Juravle0d0a4922018-01-23 19:54:11 -0800757 std::string reference_profile_arg = "--reference-profile-file-fd="
758 + std::to_string(reference_profile_fd.get());
759
760 std::vector<std::string> apk_args;
761 if (apk_fds != nullptr) {
762 for (size_t k = 0; k < apk_fds->size(); k++) {
763 apk_args.push_back("--apk-fd=" + std::to_string((*apk_fds)[k].get()));
764 }
765 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700766
767 // program name, reference profile fd, the final NULL and the profile fds
Calin Juravlef63d4792018-01-30 17:43:34 +0000768 const char* argv[3 + profile_args.size() + apk_args.size() + (copy_and_update ? 1 : 0)];
Jeff Sharkey90aff262016-12-12 14:28:24 -0700769 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700770 argv[i++] = profman_bin;
Calin Juravle0d0a4922018-01-23 19:54:11 -0800771 argv[i++] = reference_profile_arg.c_str();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700772 for (size_t k = 0; k < profile_args.size(); k++) {
773 argv[i++] = profile_args[k].c_str();
774 }
Calin Juravle0d0a4922018-01-23 19:54:11 -0800775 for (size_t k = 0; k < apk_args.size(); k++) {
776 argv[i++] = apk_args[k].c_str();
777 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000778 if (copy_and_update) {
779 argv[i++] = "--copy-and-update-profile-key";
780 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700781 // Do not add after dex2oat_flags, they should override others for debugging.
782 argv[i] = NULL;
783
Andreas Gampe6a9cf722017-07-24 16:49:10 -0700784 execv(profman_bin, (char * const *)argv);
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800785 PLOG(ERROR) << "execv(" << profman_bin << ") failed";
786 exit(DexoptReturnCodes::kProfmanExec); /* only get here on exec failure */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700787}
788
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800789[[ noreturn ]]
Calin Juravlef63d4792018-01-30 17:43:34 +0000790static void run_profman_merge(const std::vector<unique_fd>& profiles_fd,
791 const unique_fd& reference_profile_fd,
792 const std::vector<unique_fd>* apk_fds = nullptr) {
793 run_profman(profiles_fd, reference_profile_fd, apk_fds, /*copy_and_update*/false);
794}
795
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800796[[ noreturn ]]
Calin Juravlef63d4792018-01-30 17:43:34 +0000797static void run_profman_copy_and_update(unique_fd&& profile_fd,
798 unique_fd&& reference_profile_fd,
799 unique_fd&& apk_fd) {
800 std::vector<unique_fd> profiles_fd;
801 profiles_fd.push_back(std::move(profile_fd));
802 std::vector<unique_fd> apk_fds;
803 apk_fds.push_back(std::move(apk_fd));
804
805 run_profman(profiles_fd, reference_profile_fd, &apk_fds, /*copy_and_update*/true);
806}
807
Jeff Sharkey90aff262016-12-12 14:28:24 -0700808// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800809// The location is the package name for primary apks or the dex path for secondary dex files.
810// Returns true if there is enough information in the current profiles that makes it
811// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700812// If the return value is true all the current profiles would have been merged into
813// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800814static bool analyze_profiles(uid_t uid, const std::string& package_name,
815 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800816 std::vector<unique_fd> profiles_fd;
817 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800818 open_profile_files(uid, package_name, location, is_secondary_dex,
819 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800820 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700821 // Skip profile guided compilation because no profiles were found.
822 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700823 return false;
824 }
825
Jeff Sharkey90aff262016-12-12 14:28:24 -0700826 pid_t pid = fork();
827 if (pid == 0) {
828 /* child -- drop privileges before continuing */
829 drop_capabilities(uid);
830 run_profman_merge(profiles_fd, reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700831 }
832 /* parent */
833 int return_code = wait_child(pid);
834 bool need_to_compile = false;
835 bool should_clear_current_profiles = false;
836 bool should_clear_reference_profile = false;
837 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800838 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700839 } else {
840 return_code = WEXITSTATUS(return_code);
841 switch (return_code) {
842 case PROFMAN_BIN_RETURN_CODE_COMPILE:
843 need_to_compile = true;
844 should_clear_current_profiles = true;
845 should_clear_reference_profile = false;
846 break;
847 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
848 need_to_compile = false;
849 should_clear_current_profiles = false;
850 should_clear_reference_profile = false;
851 break;
852 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800853 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700854 need_to_compile = false;
855 should_clear_current_profiles = true;
856 should_clear_reference_profile = true;
857 break;
858 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
859 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
860 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800861 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700862 need_to_compile = false;
863 should_clear_current_profiles = false;
864 should_clear_reference_profile = false;
865 break;
866 default:
867 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800868 LOG(WARNING) << "Unknown error code while processing profiles for location "
869 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700870 need_to_compile = false;
871 should_clear_current_profiles = true;
872 should_clear_reference_profile = true;
873 break;
874 }
875 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800876
Jeff Sharkey90aff262016-12-12 14:28:24 -0700877 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800878 if (is_secondary_dex) {
879 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800880 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
881 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800882 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800883 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800884 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700885 }
886 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800887 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700888 }
889 return need_to_compile;
890}
891
Calin Juravle114f0812017-03-08 19:05:07 -0800892// Decides if profile guided compilation is needed or not based on existing profiles.
893// The analysis is done for the primary apks of the given package.
894// Returns true if there is enough information in the current profiles that makes it
895// worth to recompile the package.
896// If the return value is true all the current profiles would have been merged into
897// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800898bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
899 const std::string& profile_name) {
900 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800901}
902
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800903[[ noreturn ]]
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800904static void run_profman_dump(const std::vector<unique_fd>& profile_fds,
905 const unique_fd& reference_profile_fd,
Jeff Sharkey90aff262016-12-12 14:28:24 -0700906 const std::vector<std::string>& dex_locations,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800907 const std::vector<unique_fd>& apk_fds,
908 const unique_fd& output_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700909 std::vector<std::string> profman_args;
910 static const char* PROFMAN_BIN = "/system/bin/profman";
911 profman_args.push_back(PROFMAN_BIN);
912 profman_args.push_back("--dump-only");
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800913 profman_args.push_back(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700914 if (reference_profile_fd != -1) {
915 profman_args.push_back(StringPrintf("--reference-profile-file-fd=%d",
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800916 reference_profile_fd.get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700917 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800918 for (size_t i = 0; i < profile_fds.size(); i++) {
919 profman_args.push_back(StringPrintf("--profile-file-fd=%d", profile_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700920 }
921 for (const std::string& dex_location : dex_locations) {
922 profman_args.push_back(StringPrintf("--dex-location=%s", dex_location.c_str()));
923 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800924 for (size_t i = 0; i < apk_fds.size(); i++) {
925 profman_args.push_back(StringPrintf("--apk-fd=%d", apk_fds[i].get()));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700926 }
927 const char **argv = new const char*[profman_args.size() + 1];
928 size_t i = 0;
929 for (const std::string& profman_arg : profman_args) {
930 argv[i++] = profman_arg.c_str();
931 }
932 argv[i] = NULL;
933
934 execv(PROFMAN_BIN, (char * const *)argv);
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800935 PLOG(ERROR) << "execv(" << PROFMAN_BIN << ") failed";
936 exit(DexoptReturnCodes::kProfmanExec); /* only get here on exec failure */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700937}
938
Calin Juravle408cd4a2018-01-20 23:34:18 -0800939bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
940 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800941 std::vector<unique_fd> profile_fds;
942 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800943 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
944 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700945
Calin Juravle408cd4a2018-01-20 23:34:18 -0800946 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800947 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700948
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800949 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700950 const bool has_profiles = !profile_fds.empty();
951
952 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800953 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700954 return false;
955 }
956
Calin Juravle114f0812017-03-08 19:05:07 -0800957 unique_fd output_fd(open(out_file_name.c_str(),
958 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700959 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800960 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700961 return false;
962 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800963
Jeff Sharkey90aff262016-12-12 14:28:24 -0700964 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800965 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800966 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
967 if (apk_fd == -1) {
968 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
969 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700970 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800971 dex_locations.push_back(get_location_from_path(code_path.c_str()));
972 apk_fds.push_back(std::move(apk_fd));
973
Jeff Sharkey90aff262016-12-12 14:28:24 -0700974
975 pid_t pid = fork();
976 if (pid == 0) {
977 /* child -- drop privileges before continuing */
978 drop_capabilities(uid);
979 run_profman_dump(profile_fds, reference_profile_fd, dex_locations,
980 apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700981 }
982 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700983 int return_code = wait_child(pid);
984 if (!WIFEXITED(return_code)) {
985 LOG(WARNING) << "profman failed for package " << pkgname << ": "
986 << return_code;
987 return false;
988 }
989 return true;
990}
991
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700992bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800993 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700994 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
995 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800996 package_name,
997 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700998 /*read_write*/ true,
999 /*secondary*/ false));
1000 if (in_fd.get() < 0) {
1001 PLOG(WARNING) << "Could not open profile " << system_profile;
1002 return false;
1003 }
1004 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -08001005 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001006 return false;
1007 }
1008
Mathieu Chartier78f71fe2017-06-14 13:02:26 -07001009 // As a security measure we want to write the profile information with the reduced capabilities
1010 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001011 pid_t pid = fork();
1012 if (pid == 0) {
1013 /* child -- drop privileges before continuing */
1014 drop_capabilities(packageUid);
1015
1016 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
1017 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -08001018 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001019 }
1020 // This implies that the app owning this profile is running
1021 // (and has acquired the lock).
1022 //
1023 // The app never acquires the lock for the reference profiles of primary apks.
1024 // Only dex2oat from installd will do that. Since installd is single threaded
1025 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -08001026 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001027 return false;
1028 }
1029
1030 bool truncated = ftruncate(out_fd.get(), 0) == 0;
1031 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -08001032 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001033 }
1034
1035 // Copy over data.
1036 static constexpr size_t kBufferSize = 4 * 1024;
1037 char buffer[kBufferSize];
1038 while (true) {
1039 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
1040 if (bytes == 0) {
1041 break;
1042 }
1043 write(out_fd.get(), buffer, bytes);
1044 }
1045 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -08001046 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001047 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -07001048 // Use _exit since we don't want to run the global destructors in the child.
1049 // b/62597429
1050 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -07001051 }
1052 /* parent */
1053 int return_code = wait_child(pid);
1054 return return_code == 0;
1055}
1056
Jeff Sharkey90aff262016-12-12 14:28:24 -07001057static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
1058 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
1059 if (EndsWith(oat_path, ".dex")) {
1060 std::string new_path = oat_path;
1061 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -08001062 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -07001063 return new_path;
1064 }
1065
1066 // An odex entry. Not that this may not be an extension, e.g., in the OTA
1067 // case (where the base name will have an extension for the B artifact).
1068 size_t odex_pos = oat_path.rfind(".odex");
1069 if (odex_pos != std::string::npos) {
1070 std::string new_path = oat_path;
1071 new_path.replace(odex_pos, strlen(".odex"), new_ext);
1072 CHECK_NE(new_path.find(new_ext), std::string::npos);
1073 return new_path;
1074 }
1075
1076 // Don't know how to handle this.
1077 return "";
1078}
1079
1080// Translate the given oat path to an art (app image) path. An empty string
1081// denotes an error.
1082static std::string create_image_filename(const std::string& oat_path) {
1083 return replace_file_extension(oat_path, ".art");
1084}
1085
1086// Translate the given oat path to a vdex path. An empty string denotes an error.
1087static std::string create_vdex_filename(const std::string& oat_path) {
1088 return replace_file_extension(oat_path, ".vdex");
1089}
1090
Jeff Sharkey90aff262016-12-12 14:28:24 -07001091static int open_output_file(const char* file_name, bool recreate, int permissions) {
1092 int flags = O_RDWR | O_CREAT;
1093 if (recreate) {
1094 if (unlink(file_name) < 0) {
1095 if (errno != ENOENT) {
1096 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
1097 }
1098 }
1099 flags |= O_EXCL;
1100 }
1101 return open(file_name, flags, permissions);
1102}
1103
Calin Juravle2289c0a2017-02-15 12:44:14 -08001104static bool set_permissions_and_ownership(
1105 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1106 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1107 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001108 if (fchmod(fd,
1109 S_IRUSR|S_IWUSR|S_IRGRP |
1110 (is_public ? S_IROTH : 0)) < 0) {
1111 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1112 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001113 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001114 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1115 return false;
1116 }
1117 return true;
1118}
1119
1120static bool IsOutputDalvikCache(const char* oat_dir) {
1121 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1122 // into '!'. Play it safe by handling it both.
1123 // TODO: ensure we never get null.
1124 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1125 return oat_dir == nullptr || oat_dir[0] == '!';
1126}
1127
Calin Juravled23dee72017-07-06 16:29:11 -07001128// Best-effort check whether we can fit the the path into our buffers.
1129// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1130// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1131// extension to the cache path (5 bytes).
1132// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1133static bool validate_dex_path_size(const std::string& dex_path) {
1134 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1135 LOG(ERROR) << "dex_path too long: " << dex_path;
1136 return false;
1137 }
1138 return true;
1139}
1140
Jeff Sharkey90aff262016-12-12 14:28:24 -07001141static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001142 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001143 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001144 return false;
1145 }
1146
1147 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001148 // Oat dirs for secondary dex files are already validated.
1149 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001150 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1151 return false;
1152 }
1153 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1154 return false;
1155 }
1156 } else {
1157 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1158 return false;
1159 }
1160 }
1161 return true;
1162}
1163
1164// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1165// on destruction. It will also run the given cleanup (unless told not to) after closing.
1166//
1167// Usage example:
1168//
Calin Juravle7a570e82017-01-14 16:23:30 -08001169// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001170// [name]() {
1171// unlink(name.c_str());
1172// });
1173// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1174// wrapper if captured as a reference.
1175//
1176// if (file.get() == -1) {
1177// // Error opening...
1178// }
1179//
1180// ...
1181// if (error) {
1182// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1183// // and delete the file (after the fd is closed).
1184// return -1;
1185// }
1186//
1187// (Success case)
1188// file.SetCleanup(false);
1189// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1190// // (leaving the file around; after the fd is closed).
1191//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001192class Dex2oatFileWrapper {
1193 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001194 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001195 }
1196
Calin Juravle7a570e82017-01-14 16:23:30 -08001197 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1198 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1199
1200 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1201 value_ = other.value_;
1202 cleanup_ = other.cleanup_;
1203 do_cleanup_ = other.do_cleanup_;
1204 auto_close_ = other.auto_close_;
1205 other.release();
1206 }
1207
1208 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1209 value_ = other.value_;
1210 cleanup_ = other.cleanup_;
1211 do_cleanup_ = other.do_cleanup_;
1212 auto_close_ = other.auto_close_;
1213 other.release();
1214 return *this;
1215 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001216
1217 ~Dex2oatFileWrapper() {
1218 reset(-1);
1219 }
1220
1221 int get() {
1222 return value_;
1223 }
1224
1225 void SetCleanup(bool cleanup) {
1226 do_cleanup_ = cleanup;
1227 }
1228
1229 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001230 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001231 close(value_);
1232 }
1233 if (do_cleanup_ && cleanup_ != nullptr) {
1234 cleanup_();
1235 }
1236
1237 value_ = new_value;
1238 }
1239
Calin Juravle7a570e82017-01-14 16:23:30 -08001240 void reset(int new_value, std::function<void ()> new_cleanup) {
1241 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001242 close(value_);
1243 }
1244 if (do_cleanup_ && cleanup_ != nullptr) {
1245 cleanup_();
1246 }
1247
1248 value_ = new_value;
1249 cleanup_ = new_cleanup;
1250 }
1251
Calin Juravle7a570e82017-01-14 16:23:30 -08001252 void DisableAutoClose() {
1253 auto_close_ = false;
1254 }
1255
Jeff Sharkey90aff262016-12-12 14:28:24 -07001256 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001257 void release() {
1258 value_ = -1;
1259 do_cleanup_ = false;
1260 cleanup_ = nullptr;
1261 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001262 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001263 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001264 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001265 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001266};
1267
Calin Juravle7a570e82017-01-14 16:23:30 -08001268// (re)Creates the app image if needed.
1269Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path, bool profile_guided,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001270 bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001271
1272 // We don't create an image for secondary dex files.
1273 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001274 return Dex2oatFileWrapper();
1275 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001276
Calin Juravle7a570e82017-01-14 16:23:30 -08001277 const std::string image_path = create_image_filename(out_oat_path);
1278 if (image_path.empty()) {
1279 // Happens when the out_oat_path has an unknown extension.
1280 return Dex2oatFileWrapper();
1281 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001282
1283 // Use app images only if it is enabled (by a set image format) and we are compiling
1284 // profile-guided (so the app image doesn't conservatively contain all classes).
1285 if (!profile_guided) {
1286 // In case there is a stale image, remove it now. Ignore any error.
1287 unlink(image_path.c_str());
1288 return Dex2oatFileWrapper();
1289 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001290 char app_image_format[kPropertyValueMax];
1291 bool have_app_image_format =
1292 get_property("dalvik.vm.appimageformat", app_image_format, NULL) > 0;
1293 if (!have_app_image_format) {
1294 return Dex2oatFileWrapper();
1295 }
1296 // Recreate is true since we do not want to modify a mapped image. If the app is
1297 // already running and we modify the image file, it can cause crashes (b/27493510).
1298 Dex2oatFileWrapper wrapper_fd(
1299 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1300 [image_path]() { unlink(image_path.c_str()); });
1301 if (wrapper_fd.get() < 0) {
1302 // Could not create application image file. Go on since we can compile without it.
1303 LOG(ERROR) << "installd could not create '" << image_path
1304 << "' for image file during dexopt";
1305 // If we have a valid image file path but no image fd, explicitly erase the image file.
1306 if (unlink(image_path.c_str()) < 0) {
1307 if (errno != ENOENT) {
1308 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1309 }
1310 }
1311 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001312 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001313 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1314 wrapper_fd.reset(-1);
1315 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001316
Calin Juravle7a570e82017-01-14 16:23:30 -08001317 return wrapper_fd;
1318}
1319
1320// Creates the dexopt swap file if necessary and return its fd.
1321// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001322unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001323 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001324 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001325 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001326 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001327 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001328 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001329 if (swap_fd.get() < 0) {
1330 // Could not create swap file. Optimistically go on and hope that we can compile
1331 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001332 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001333 } else {
1334 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001335 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001336 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1337 }
1338 }
1339 return swap_fd;
1340}
1341
1342// Opens the reference profiles if needed.
1343// 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 -08001344Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001345 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -08001346 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +00001347 // If we are not profile guided compilation, or we are compiling system server
1348 // do not bother to open the profiles; we won't be using them.
1349 if (!profile_guided || (pkgname[0] == '*')) {
1350 return Dex2oatFileWrapper();
1351 }
1352
1353 // If this is a secondary dex path which is public do not open the profile.
1354 // We cannot compile public secondary dex paths with profiles. That's because
1355 // it will expose how the dex files are used by their owner.
1356 //
1357 // Note that the PackageManager is responsible to set the is_public flag for
1358 // primary apks and we do not check it here. In some cases, e.g. when
1359 // compiling with a public profile from the .dm file the PackageManager will
1360 // set is_public toghether with the profile guided compilation.
1361 if (is_secondary_dex && is_public) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001362 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001363 }
Calin Juravle114f0812017-03-08 19:05:07 -08001364
1365 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001366 std::string location;
1367 if (is_secondary_dex) {
1368 location = dex_path;
1369 } else {
1370 if (profile_name == nullptr) {
1371 // This path is taken for system server re-compilation lunched from ZygoteInit.
1372 return Dex2oatFileWrapper();
1373 } else {
1374 location = profile_name;
1375 }
1376 }
Calin Juravle824a64d2018-01-18 20:23:17 -08001377 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1378 is_secondary_dex);
1379 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1380 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001381 };
1382 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001383}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001384
Calin Juravle7a570e82017-01-14 16:23:30 -08001385// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1386// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001387bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001388 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001389 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001390 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1391 CHECK(in_vdex_wrapper_fd != nullptr);
1392 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001393 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1394 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001395 char in_odex_path[PKG_PATH_MAX];
1396 int dexopt_action = abs(dexopt_needed);
1397 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001398 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001399
1400 // Infer the name of the output VDEX.
1401 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1402 if (out_vdex_path_str.empty()) {
1403 return false;
1404 }
1405
1406 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001407 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001408 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1409 const char* path = nullptr;
1410 if (is_odex_location) {
1411 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1412 path = in_odex_path;
1413 } else {
1414 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001415 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001416 }
1417 } else {
1418 path = out_oat_path;
1419 }
1420 in_vdex_path_str = create_vdex_filename(path);
1421 if (in_vdex_path_str.empty()) {
1422 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001423 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001424 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001425 // We can update in place when all these conditions are met:
1426 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1427 // on /system typically cannot be updated in place).
1428 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1429 // cannot be currently used by a running process.
1430 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1431 // different vdex files to operate.
1432 update_vdex_in_place =
1433 (in_vdex_path_str == out_vdex_path_str) &&
1434 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1435 !profile_guided;
1436 if (update_vdex_in_place) {
1437 // Open the file read-write to be able to update it.
1438 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1439 if (in_vdex_wrapper_fd->get() == -1) {
1440 // If we failed to open the file, we cannot update it in place.
1441 update_vdex_in_place = false;
1442 }
1443 } else {
1444 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1445 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001446 }
1447
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001448 // If we are updating the vdex in place, we do not need to recreate a vdex,
1449 // and can use the same existing one.
1450 if (update_vdex_in_place) {
1451 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1452 // have bogus stale vdex files.
1453 out_vdex_wrapper_fd->reset(
1454 in_vdex_wrapper_fd->get(),
1455 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1456 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1457 // wrapper).
1458 in_vdex_wrapper_fd->DisableAutoClose();
1459 } else {
1460 out_vdex_wrapper_fd->reset(
1461 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1462 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1463 if (out_vdex_wrapper_fd->get() < 0) {
1464 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1465 return false;
1466 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001467 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001468 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001469 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001470 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1471 return false;
1472 }
1473
1474 // If we got here we successfully opened the vdex files.
1475 return true;
1476}
1477
1478// Opens the output oat file for the given apk.
1479// If successful it stores the output path into out_oat_path and returns true.
1480Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001481 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1482 char* out_oat_path) {
1483 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001484 return Dex2oatFileWrapper();
1485 }
1486 const std::string out_oat_path_str(out_oat_path);
1487 Dex2oatFileWrapper wrapper_fd(
1488 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1489 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1490 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001491 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001492 } else if (!set_permissions_and_ownership(
1493 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001494 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1495 wrapper_fd.reset(-1);
1496 }
1497 return wrapper_fd;
1498}
1499
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001500// Creates RDONLY fds for oat and vdex files, if exist.
1501// Returns false if it fails to create oat out path for the given apk path.
1502// Note that the method returns true even if the files could not be opened.
1503bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1504 const std::string& oat_dir,
1505 const std::string& instruction_set,
1506 bool is_secondary_dex,
1507 unique_fd* oat_file_fd,
1508 unique_fd* vdex_file_fd) {
1509 char oat_path[PKG_PATH_MAX];
1510 if (!create_oat_out_path(apk_path.c_str(),
1511 instruction_set.c_str(),
1512 oat_dir.c_str(),
1513 is_secondary_dex,
1514 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001515 LOG(ERROR) << "Could not create oat out path for "
1516 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001517 return false;
1518 }
1519 oat_file_fd->reset(open(oat_path, O_RDONLY));
1520 if (oat_file_fd->get() < 0) {
1521 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1522 }
1523
1524 std::string vdex_filename = create_vdex_filename(oat_path);
1525 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1526 if (vdex_file_fd->get() < 0) {
1527 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1528 }
1529
1530 return true;
1531}
1532
Calin Juravle7a570e82017-01-14 16:23:30 -08001533// Updates the access times of out_oat_path based on those from apk_path.
1534void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1535 struct stat input_stat;
1536 memset(&input_stat, 0, sizeof(input_stat));
1537 if (stat(apk_path, &input_stat) != 0) {
1538 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1539 return;
1540 }
1541
1542 struct utimbuf ut;
1543 ut.actime = input_stat.st_atime;
1544 ut.modtime = input_stat.st_mtime;
1545 if (utime(out_oat_path, &ut) != 0) {
1546 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1547 }
1548}
1549
Calin Juravle80a21252017-01-17 14:43:25 -08001550// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001551// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1552// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1553// the profile has changed.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001554static void exec_dexoptanalyzer(const std::string& dex_file, int vdex_fd, int oat_fd,
1555 int zip_fd, const std::string& instruction_set, const std::string& compiler_filter,
1556 bool profile_was_updated, bool downgrade,
Calin Juravle58cab072017-09-12 01:02:26 -07001557 const char* class_loader_context) {
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001558 CHECK_GE(zip_fd, 0);
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001559 const char* dexoptanalyzer_bin =
1560 is_debug_runtime()
1561 ? "/system/bin/dexoptanalyzerd"
1562 : "/system/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001563 static const unsigned int MAX_INSTRUCTION_SET_LEN = 7;
1564
Calin Juravled23dee72017-07-06 16:29:11 -07001565 if (instruction_set.size() >= MAX_INSTRUCTION_SET_LEN) {
1566 LOG(ERROR) << "Instruction set " << instruction_set
1567 << " longer than max length of " << MAX_INSTRUCTION_SET_LEN;
Calin Juravle80a21252017-01-17 14:43:25 -08001568 return;
1569 }
1570
Calin Juravled23dee72017-07-06 16:29:11 -07001571 std::string dex_file_arg = "--dex-file=" + dex_file;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001572 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1573 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1574 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
Calin Juravled23dee72017-07-06 16:29:11 -07001575 std::string isa_arg = "--isa=" + instruction_set;
1576 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
Calin Juravle114f0812017-03-08 19:05:07 -08001577 const char* assume_profile_changed = "--assume-profile-changed";
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001578 const char* downgrade_flag = "--downgrade";
Calin Juravle58cab072017-09-12 01:02:26 -07001579 std::string class_loader_context_arg = "--class-loader-context=";
1580 if (class_loader_context != nullptr) {
1581 class_loader_context_arg += class_loader_context;
1582 }
Calin Juravle80a21252017-01-17 14:43:25 -08001583
Calin Juravle80a21252017-01-17 14:43:25 -08001584 // program name, dex file, isa, filter, the final NULL
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001585 const int argc = 6 +
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001586 (profile_was_updated ? 1 : 0) +
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001587 (vdex_fd >= 0 ? 1 : 0) +
1588 (oat_fd >= 0 ? 1 : 0) +
Calin Juravle58cab072017-09-12 01:02:26 -07001589 (downgrade ? 1 : 0) +
1590 (class_loader_context != nullptr ? 1 : 0);
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001591 const char* argv[argc];
Calin Juravle80a21252017-01-17 14:43:25 -08001592 int i = 0;
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001593 argv[i++] = dexoptanalyzer_bin;
Calin Juravled23dee72017-07-06 16:29:11 -07001594 argv[i++] = dex_file_arg.c_str();
1595 argv[i++] = isa_arg.c_str();
1596 argv[i++] = compiler_filter_arg.c_str();
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001597 if (oat_fd >= 0) {
1598 argv[i++] = oat_fd_arg.c_str();
1599 }
1600 if (vdex_fd >= 0) {
1601 argv[i++] = vdex_fd_arg.c_str();
1602 }
1603 argv[i++] = zip_fd_arg.c_str();
Calin Juravle114f0812017-03-08 19:05:07 -08001604 if (profile_was_updated) {
1605 argv[i++] = assume_profile_changed;
1606 }
Shubham Ajmera54ef8622017-06-22 11:10:27 -07001607 if (downgrade) {
1608 argv[i++] = downgrade_flag;
1609 }
Calin Juravle58cab072017-09-12 01:02:26 -07001610 if (class_loader_context != nullptr) {
Calin Juravle91501072017-10-26 15:44:53 -07001611 argv[i++] = class_loader_context_arg.c_str();
Calin Juravle58cab072017-09-12 01:02:26 -07001612 }
Calin Juravle80a21252017-01-17 14:43:25 -08001613 argv[i] = NULL;
1614
Andreas Gampe6a9cf722017-07-24 16:49:10 -07001615 execv(dexoptanalyzer_bin, (char * const *)argv);
1616 ALOGE("execv(%s) failed: %s\n", dexoptanalyzer_bin, strerror(errno));
Calin Juravle80a21252017-01-17 14:43:25 -08001617}
1618
1619// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001620static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001621 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001622 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001623 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001624 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001625 return false;
1626 }
Calin Juravle114f0812017-03-08 19:05:07 -08001627 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001628
Calin Juravle80a21252017-01-17 14:43:25 -08001629 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001630 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1631 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001632 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001633 return false;
1634 }
1635
1636 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001637 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001638
Calin Juravle7d765462017-09-04 15:57:10 -07001639 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001640 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001641 return false;
1642 }
1643
1644 return true;
1645}
1646
Calin Juravle7d765462017-09-04 15:57:10 -07001647// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1648// secondary dex files. This return codes are returned by the child process created for
1649// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001650
Andreas Gampe194fe422018-02-28 20:16:19 -08001651enum DexoptAnalyzerSkipCodes {
1652 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001653 // Specific errors are encoded in the name.
1654 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1655 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1656 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1657 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1658 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001659 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001660 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001661};
Calin Juravle7d765462017-09-04 15:57:10 -07001662
1663// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001664// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1665// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001666// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1667// of dexoptanalyzer.
1668static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001669 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001670 // The result values are defined in dexoptanalyzer.
1671 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001672 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001673 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001674 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001675 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001676 case 5: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001677 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001678 case 6: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001679 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001680 case 7: // dexoptanalyzer: dex2oat_for_relocation_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001681 *dexopt_needed_out = -DEX2OAT_FOR_RELOCATION; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001682 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1683 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
1684 case 4: // dexoptanalyzer: dex2oat_for_relocation_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001685 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1686 " Expected odex file status for secondary dex %s"
1687 " : dexoptanalyzer result=%d",
1688 dex_path.c_str(),
1689 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001690 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001691 }
1692
1693 // Use a second switch for enum switch-case analysis.
1694 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001695 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001696 // If the file does not exist there's no need for dexopt.
1697 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1698 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001699
1700 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1701 *error_msg = "Dexoptanalyzer path validation failed";
1702 return false;
1703 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1704 *error_msg = "Dexoptanalyzer open zip failed";
1705 return false;
1706 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1707 *error_msg = "Dexoptanalyzer dir preparation failed";
1708 return false;
1709 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1710 *error_msg = "Dexoptanalyzer open output failed";
1711 return false;
1712 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1713 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001714 return false;
1715 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001716
1717 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1718 dex_path.c_str(),
1719 result);
1720 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001721}
1722
Calin Juravle7d765462017-09-04 15:57:10 -07001723enum SecondaryDexAccess {
1724 kSecondaryDexAccessReadOk = 0,
1725 kSecondaryDexAccessDoesNotExist = 1,
1726 kSecondaryDexAccessPermissionError = 2,
1727 kSecondaryDexAccessIOError = 3
1728};
1729
1730static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1731 // Check if the path exists and can be read. If not, there's nothing to do.
1732 if (access(dex_path.c_str(), R_OK) == 0) {
1733 return kSecondaryDexAccessReadOk;
1734 } else {
1735 if (errno == ENOENT) {
1736 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1737 return kSecondaryDexAccessDoesNotExist;
1738 } else {
1739 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1740 return errno == EACCES
1741 ? kSecondaryDexAccessPermissionError
1742 : kSecondaryDexAccessIOError;
1743 }
1744 }
1745}
1746
1747static bool is_file_public(const std::string& filename) {
1748 struct stat file_stat;
1749 if (stat(filename.c_str(), &file_stat) == 0) {
1750 return (file_stat.st_mode & S_IROTH) != 0;
1751 }
1752 return false;
1753}
1754
1755// Create the oat file structure for the secondary dex 'dex_path' and assign
1756// the individual path component to the 'out_' parameters.
1757static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001758 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001759 size_t dirIndex = dex_path.rfind('/');
1760 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001761 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001762 return false;
1763 }
1764 // TODO(calin): we have similar computations in at lest 3 other places
1765 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1766 // using string append.
1767 std::string apk_dir = dex_path.substr(0, dirIndex);
1768 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1769 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1770
1771 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1772 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001773 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001774 return false;
1775 }
1776 return true;
1777}
1778
1779// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1780// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001781static bool validate_dexopt_storage_flags(int dexopt_flags,
1782 int* out_storage_flag,
1783 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001784 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1785 *out_storage_flag = FLAG_STORAGE_CE;
1786 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001787 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001788 return false;
1789 }
1790 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1791 *out_storage_flag = FLAG_STORAGE_DE;
1792 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001793 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001794 return false;
1795 }
1796 return true;
1797}
1798
Calin Juravlec9eab382017-01-25 01:17:17 -08001799// 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 -08001800// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1801// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001802// When returning true, the output parameters will be:
1803// - is_public_out: whether or not the oat file should not be made public
1804// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1805// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001806static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001807 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001808 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001809 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
1810 /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001811 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001812 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001813 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1814 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001815 return false;
1816 }
Calin Juravle7d765462017-09-04 15:57:10 -07001817 // Compute the oat dir as it's not easy to extract it from the child computation.
1818 char oat_path[PKG_PATH_MAX];
1819 char oat_dir[PKG_PATH_MAX];
1820 char oat_isa_dir[PKG_PATH_MAX];
1821 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001822 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1823 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001824 return false;
1825 }
Calin Juravle7d765462017-09-04 15:57:10 -07001826 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001827
Calin Juravle80a21252017-01-17 14:43:25 -08001828 pid_t pid = fork();
1829 if (pid == 0) {
1830 // child -- drop privileges before continuing.
1831 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001832
1833 // Validate the path structure.
1834 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1835 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001836 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001837 }
1838
1839 // Open the dex file.
1840 unique_fd zip_fd;
1841 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1842 if (zip_fd.get() < 0) {
1843 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001844 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001845 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001846 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001847 }
1848 }
1849
1850 // Prepare the oat directories.
1851 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001852 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001853 }
1854
1855 // Open the vdex/oat files if any.
1856 unique_fd oat_file_fd;
1857 unique_fd vdex_file_fd;
1858 if (!maybe_open_oat_and_vdex_file(dex_path,
1859 *oat_dir_out,
1860 instruction_set,
1861 true /* is_secondary_dex */,
1862 &oat_file_fd,
1863 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001864 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001865 }
1866
1867 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001868 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1869 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001870
1871 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001872 exec_dexoptanalyzer(dex_path,
1873 vdex_file_fd.get(),
1874 oat_file_fd.get(),
1875 zip_fd.get(),
1876 instruction_set,
Calin Juravle7d765462017-09-04 15:57:10 -07001877 compiler_filter, profile_was_updated,
1878 downgrade,
1879 class_loader_context);
1880 PLOG(ERROR) << "Failed to exec dexoptanalyzer";
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001881 _exit(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001882 }
1883
1884 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001885 int result = wait_child(pid);
1886 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001887 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1888 dex_path.c_str(),
1889 result);
1890 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001891 return false;
1892 }
1893 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001894 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001895 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1896 result,
1897 dexopt_needed_out,
1898 error_msg);
1899 if (!success) {
1900 LOG(ERROR) << *error_msg;
1901 }
Calin Juravle7d765462017-09-04 15:57:10 -07001902
1903 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1904
Calin Juravle80a21252017-01-17 14:43:25 -08001905 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001906 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1907 // makes the code simpler; force compilation is only needed during tests).
1908 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001909 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001910 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001911 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1912 }
1913
Calin Juravle7d765462017-09-04 15:57:10 -07001914 // Check if we should make the oat file public.
1915 // Note that if the dex file is not public the compiled code cannot be made public.
1916 // It is ok to check this flag outside in the parent process.
1917 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1918
Calin Juravle80a21252017-01-17 14:43:25 -08001919 return success;
1920}
1921
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001922static std::string format_dexopt_error(int status, const char* dex_path) {
1923 if (WIFEXITED(status)) {
1924 int int_code = WEXITSTATUS(status);
1925 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1926 if (code_name != nullptr) {
1927 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1928 }
1929 }
1930 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001931}
1932
Calin Juravlec9eab382017-01-25 01:17:17 -08001933int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001934 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001935 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001936 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001937 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001938 CHECK(pkgname != nullptr);
1939 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001940 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001941 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1942 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001943
Calin Juravled23dee72017-07-06 16:29:11 -07001944 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001945 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001946 return -1;
1947 }
1948
1949 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001950 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1951 class_loader_context);
1952 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001953 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001954 }
1955
Calin Juravleebc8a792017-04-04 20:21:05 -07001956 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001957 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1958 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1959 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001960 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001961 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001962 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001963
1964 // Check if we're dealing with a secondary dex file and if we need to compile it.
1965 std::string oat_dir_str;
1966 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001967 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001968 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Andreas Gampe194fe422018-02-28 20:16:19 -08001969 downgrade, class_loader_context, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001970 oat_dir = oat_dir_str.c_str();
1971 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1972 return 0; // Nothing to do, report success.
1973 }
1974 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001975 if (error_msg->empty()) { // TODO: Make this a CHECK.
1976 *error_msg = "Failed processing secondary.";
1977 }
Calin Juravle80a21252017-01-17 14:43:25 -08001978 return -1; // We had an error, logged in the process method.
1979 }
1980 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001981 // Currently these flags are only use for secondary dex files.
1982 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001983 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1984 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1985 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001986
1987 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001988 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001989 if (input_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001990 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1991 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001992 return -1;
1993 }
1994
1995 // Create the output OAT file.
1996 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001997 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001998 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001999 if (out_oat_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08002000 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08002001 return -1;
2002 }
2003
2004 // Open vdex files.
2005 Dex2oatFileWrapper in_vdex_fd;
2006 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07002007 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
2008 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08002009 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07002010 return -1;
2011 }
2012
Calin Juravlecb556e32017-04-04 20:22:50 -07002013 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
2014 // selinux context (we generate them on the fly during the dexopt invocation and they don't
2015 // fully inherit their parent context).
2016 // Note that for primary apk the oat files are created before, in a separate installd
2017 // call which also does the restorecon. TODO(calin): unify the paths.
2018 if (is_secondary_dex) {
2019 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
2020 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08002021 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
2022 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07002023 return -1;
2024 }
2025 }
2026
Jeff Sharkey90aff262016-12-12 14:28:24 -07002027 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08002028 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002029
Calin Juravle7a570e82017-01-14 16:23:30 -08002030 // Create the app image file if needed.
2031 Dex2oatFileWrapper image_fd =
Calin Juravle2289c0a2017-02-15 12:44:14 -08002032 maybe_open_app_image(out_oat_path, profile_guided, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002033
Calin Juravle7a570e82017-01-14 16:23:30 -08002034 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08002035 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08002036 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08002037
Calin Juravle62c5a372018-02-01 17:03:23 +00002038 unique_fd dex_metadata_fd;
2039 if (dex_metadata_path != nullptr) {
2040 dex_metadata_fd.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)));
2041 if (dex_metadata_fd.get() < 0) {
2042 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
2043 }
2044 }
2045
Andreas Gampe023b2242018-02-28 16:03:25 -08002046 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07002047
2048 pid_t pid = fork();
2049 if (pid == 0) {
2050 /* child -- drop privileges before continuing */
2051 drop_capabilities(uid);
2052
Richard Uhler76cc0272016-12-08 10:46:35 +00002053 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002054 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08002055 PLOG(ERROR) << "flock(" << out_oat_path << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002056 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002057 }
2058
Richard Uhler76cc0272016-12-08 10:46:35 +00002059 run_dex2oat(input_fd.get(),
2060 out_oat_fd.get(),
2061 in_vdex_fd.get(),
Calin Juravle7a570e82017-01-14 16:23:30 -08002062 out_vdex_fd.get(),
Richard Uhler76cc0272016-12-08 10:46:35 +00002063 image_fd.get(),
Jeff Hao10b8a6e2017-04-05 17:11:39 -07002064 dex_path,
Richard Uhler76cc0272016-12-08 10:46:35 +00002065 out_oat_path,
2066 swap_fd.get(),
2067 instruction_set,
2068 compiler_filter,
Richard Uhler76cc0272016-12-08 10:46:35 +00002069 debuggable,
2070 boot_complete,
Andreas Gampea73a0cb2017-11-02 18:14:42 -07002071 background_job_compile,
Richard Uhler76cc0272016-12-08 10:46:35 +00002072 reference_profile_fd.get(),
David Brazdil570d3982018-01-16 20:15:43 +00002073 class_loader_context,
David Brazdil7fcbb812018-01-17 17:05:40 +00002074 target_sdk_version,
Calin Juravle62c5a372018-02-01 17:03:23 +00002075 enable_hidden_api_checks,
Calin Juravle2efc4022018-02-13 18:31:32 -08002076 dex_metadata_fd.get(),
2077 compilation_reason);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002078 } else {
2079 int res = wait_child(pid);
2080 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08002081 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07002082 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08002083 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
2084 << std::hex << std::setw(4) << res << ", process failed";
2085 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07002086 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002087 }
2088 }
2089
Calin Juravlec9eab382017-01-25 01:17:17 -08002090 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002091
2092 // We've been successful, don't delete output.
2093 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08002094 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07002095 image_fd.SetCleanup(false);
2096 reference_profile_fd.SetCleanup(false);
2097
2098 return 0;
2099}
2100
Calin Juravlec9eab382017-01-25 01:17:17 -08002101// Try to remove the given directory. Log an error if the directory exists
2102// and is empty but could not be removed.
2103static bool rmdir_if_empty(const char* dir) {
2104 if (rmdir(dir) == 0) {
2105 return true;
2106 }
2107 if (errno == ENOENT || errno == ENOTEMPTY) {
2108 return true;
2109 }
2110 PLOG(ERROR) << "Failed to remove dir: " << dir;
2111 return false;
2112}
2113
2114// Try to unlink the given file. Log an error if the file exists and could not
2115// be unlinked.
2116static bool unlink_if_exists(const std::string& file) {
2117 if (unlink(file.c_str()) == 0) {
2118 return true;
2119 }
2120 if (errno == ENOENT) {
2121 return true;
2122
2123 }
2124 PLOG(ERROR) << "Could not unlink: " << file;
2125 return false;
2126}
2127
Calin Juravle7d765462017-09-04 15:57:10 -07002128enum ReconcileSecondaryDexResult {
2129 kReconcileSecondaryDexExists = 0,
2130 kReconcileSecondaryDexCleanedUp = 1,
2131 kReconcileSecondaryDexValidationError = 2,
2132 kReconcileSecondaryDexCleanUpError = 3,
2133 kReconcileSecondaryDexAccessIOError = 4,
2134};
Calin Juravlec9eab382017-01-25 01:17:17 -08002135
2136// Reconcile the secondary dex 'dex_path' and its generated oat files.
2137// Return true if all the parameters are valid and the secondary dex file was
2138// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
2139// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
2140// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
2141// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
2142// Return false if there were errors during processing. In this case
2143// out_secondary_dex_exists will be set to false.
2144bool reconcile_secondary_dex_file(const std::string& dex_path,
2145 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
2146 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2147 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07002148 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08002149 if (isas.size() == 0) {
2150 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
2151 return false;
2152 }
2153
Calin Juravle7d765462017-09-04 15:57:10 -07002154 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2155 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2156 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002157 return false;
2158 }
2159
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002160 // As a security measure we want to unlink art artifacts with the reduced capabilities
2161 // of the package user id. So we fork and drop capabilities in the child.
2162 pid_t pid = fork();
2163 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002164 /* child -- drop privileges before continuing */
2165 drop_capabilities(uid);
2166
2167 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2168 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2169 uid, storage_flag)) {
2170 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2171 _exit(kReconcileSecondaryDexValidationError);
2172 }
2173
2174 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2175 switch (access_check) {
2176 case kSecondaryDexAccessDoesNotExist:
2177 // File does not exist. Proceed with cleaning.
2178 break;
2179 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2180 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2181 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2182 default:
2183 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2184 _exit(kReconcileSecondaryDexValidationError);
2185 }
2186
2187 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002188 char oat_path[PKG_PATH_MAX];
2189 char oat_dir[PKG_PATH_MAX];
2190 char oat_isa_dir[PKG_PATH_MAX];
2191 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002192 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08002193 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002194 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08002195 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
2196 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002197 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002198 }
Calin Juravle51314092017-05-18 15:33:05 -07002199
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002200 // Delete oat/vdex/art files.
2201 result = unlink_if_exists(oat_path) && result;
2202 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2203 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002204
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002205 // Delete profiles.
2206 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002207 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002208 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002209 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002210 result = unlink_if_exists(current_profile) && result;
2211 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002212
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002213 // We upgraded once the location of current profile for secondary dex files.
2214 // Check for any previous left-overs and remove them as well.
2215 std::string old_current_profile = dex_path + ".prof";
2216 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002217
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002218 // Try removing the directories as well, they might be empty.
2219 result = rmdir_if_empty(oat_isa_dir) && result;
2220 result = rmdir_if_empty(oat_dir) && result;
2221 }
Calin Juravle7d765462017-09-04 15:57:10 -07002222 if (!result) {
2223 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2224 }
2225 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002226 }
2227
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002228 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002229 if (!WIFEXITED(return_code)) {
2230 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2231 } else {
2232 return_code = WEXITSTATUS(return_code);
2233 }
2234
2235 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2236
2237 switch (return_code) {
2238 case kReconcileSecondaryDexCleanedUp:
2239 case kReconcileSecondaryDexValidationError:
2240 // If we couldn't validate assume the dex file does not exist.
2241 // This will purge the entry from the PM records.
2242 *out_secondary_dex_exists = false;
2243 return true;
2244 case kReconcileSecondaryDexExists:
2245 *out_secondary_dex_exists = true;
2246 return true;
2247 case kReconcileSecondaryDexAccessIOError:
2248 // We had an access IO error.
2249 // Return false so that we can try again.
2250 // The value of out_secondary_dex_exists does not matter in this case and by convention
2251 // is set to false.
2252 *out_secondary_dex_exists = false;
2253 return false;
2254 default:
2255 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2256 *out_secondary_dex_exists = false;
2257 return false;
2258 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002259}
2260
Alan Stokesa25d90c2017-10-16 10:56:00 +01002261// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2262// Returns true if all parameters are valid and the hash successfully computed and stored in
2263// out_secondary_dex_hash.
2264// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2265// the app.
2266// For any other errors (e.g. if any of the parameters are invalid) returns false.
2267bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2268 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2269 std::vector<uint8_t>* out_secondary_dex_hash) {
2270 out_secondary_dex_hash->clear();
2271
2272 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2273
2274 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2275 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2276 << storage_flag;
2277 return false;
2278 }
2279
2280 // Pipe to get the hash result back from our child process.
2281 unique_fd pipe_read, pipe_write;
2282 if (!Pipe(&pipe_read, &pipe_write)) {
2283 PLOG(ERROR) << "Failed to create pipe";
2284 return false;
2285 }
2286
2287 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2288 // access data the app itself can access.
2289 pid_t pid = fork();
2290 if (pid == 0) {
2291 // child -- drop privileges before continuing
2292 drop_capabilities(uid);
2293 pipe_read.reset();
2294
2295 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2296 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002297 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002298 }
2299
2300 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2301 if (fd == -1) {
2302 if (errno == EACCES || errno == ENOENT) {
2303 // Not treated as an error.
2304 _exit(0);
2305 }
2306 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002307 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002308 }
2309
2310 SHA256_CTX ctx;
2311 SHA256_Init(&ctx);
2312
2313 std::vector<uint8_t> buffer(65536);
2314 while (true) {
2315 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2316 if (bytes_read == 0) {
2317 break;
2318 } else if (bytes_read == -1) {
2319 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002320 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002321 }
2322
2323 SHA256_Update(&ctx, buffer.data(), bytes_read);
2324 }
2325
2326 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2327 SHA256_Final(hash.data(), &ctx);
2328 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002329 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002330 }
2331
2332 _exit(0);
2333 }
2334
2335 // parent
2336 pipe_write.reset();
2337
2338 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2339 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2340 out_secondary_dex_hash->clear();
2341 }
2342 return wait_child(pid) == 0;
2343}
2344
Jeff Sharkey90aff262016-12-12 14:28:24 -07002345// Helper for move_ab, so that we can have common failure-case cleanup.
2346static bool unlink_and_rename(const char* from, const char* to) {
2347 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2348 // return a failure.
2349 struct stat s;
2350 if (stat(to, &s) == 0) {
2351 if (!S_ISREG(s.st_mode)) {
2352 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2353 return false;
2354 }
2355 if (unlink(to) != 0) {
2356 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2357 return false;
2358 }
2359 } else {
2360 // This may be a permission problem. We could investigate the error code, but we'll just
2361 // let the rename failure do the work for us.
2362 }
2363
2364 // Try to rename "to" to "from."
2365 if (rename(from, to) != 0) {
2366 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2367 return false;
2368 }
2369 return true;
2370}
2371
2372// Move/rename a B artifact (from) to an A artifact (to).
2373static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2374 // Check whether B exists.
2375 {
2376 struct stat s;
2377 if (stat(b_path.c_str(), &s) != 0) {
2378 // Silently ignore for now. The service calling this isn't smart enough to understand
2379 // lack of artifacts at the moment.
2380 return false;
2381 }
2382 if (!S_ISREG(s.st_mode)) {
2383 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2384 // Try to unlink, but swallow errors.
2385 unlink(b_path.c_str());
2386 return false;
2387 }
2388 }
2389
2390 // Rename B to A.
2391 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2392 // Delete the b_path so we don't try again (or fail earlier).
2393 if (unlink(b_path.c_str()) != 0) {
2394 PLOG(ERROR) << "Could not unlink " << b_path;
2395 }
2396
2397 return false;
2398 }
2399
2400 return true;
2401}
2402
2403bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2404 // Get the current slot suffix. No suffix, no A/B.
2405 std::string slot_suffix;
2406 {
2407 char buf[kPropertyValueMax];
2408 if (get_property("ro.boot.slot_suffix", buf, nullptr) <= 0) {
2409 return false;
2410 }
2411 slot_suffix = buf;
2412
2413 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2414 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2415 return false;
2416 }
2417 }
2418
2419 // Validate other inputs.
2420 if (validate_apk_path(apk_path) != 0) {
2421 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2422 return false;
2423 }
2424 if (validate_apk_path(oat_dir) != 0) {
2425 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2426 return false;
2427 }
2428
2429 char a_path[PKG_PATH_MAX];
2430 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2431 return false;
2432 }
2433 const std::string a_vdex_path = create_vdex_filename(a_path);
2434 const std::string a_image_path = create_image_filename(a_path);
2435
2436 // B path = A path + slot suffix.
2437 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2438 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2439 const std::string b_image_path = StringPrintf("%s.%s",
2440 a_image_path.c_str(),
2441 slot_suffix.c_str());
2442
2443 bool success = true;
2444 if (move_ab_path(b_path, a_path)) {
2445 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2446 // Note: we can live without an app image. As such, ignore failure to move the image file.
2447 // If we decide to require the app image, or the app image being moved correctly,
2448 // then change accordingly.
2449 constexpr bool kIgnoreAppImageFailure = true;
2450
2451 if (!a_image_path.empty()) {
2452 if (!move_ab_path(b_image_path, a_image_path)) {
2453 unlink(a_image_path.c_str());
2454 if (!kIgnoreAppImageFailure) {
2455 success = false;
2456 }
2457 }
2458 }
2459 } else {
2460 // Cleanup: delete B image, ignore errors.
2461 unlink(b_image_path.c_str());
2462 success = false;
2463 }
2464 } else {
2465 // Cleanup: delete B image, ignore errors.
2466 unlink(b_vdex_path.c_str());
2467 unlink(b_image_path.c_str());
2468 success = false;
2469 }
2470 return success;
2471}
2472
2473bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2474 // Delete the oat/odex file.
2475 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002476 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002477 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002478 return false;
2479 }
2480
2481 // In case of a permission failure report the issue. Otherwise just print a warning.
2482 auto unlink_and_check = [](const char* path) -> bool {
2483 int result = unlink(path);
2484 if (result != 0) {
2485 if (errno == EACCES || errno == EPERM) {
2486 PLOG(ERROR) << "Could not unlink " << path;
2487 return false;
2488 }
2489 PLOG(WARNING) << "Could not unlink " << path;
2490 }
2491 return true;
2492 };
2493
2494 // Delete the oat/odex file.
2495 bool return_value_oat = unlink_and_check(out_path);
2496
2497 // Derive and delete the app image.
2498 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2499
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002500 // Derive and delete the vdex file.
2501 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2502
Jeff Sharkey90aff262016-12-12 14:28:24 -07002503 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002504 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002505}
2506
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002507static bool is_absolute_path(const std::string& path) {
2508 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2509 LOG(ERROR) << "Invalid absolute path " << path;
2510 return false;
2511 } else {
2512 return true;
2513 }
2514}
2515
2516static bool is_valid_instruction_set(const std::string& instruction_set) {
2517 // TODO: add explicit whitelisting of instruction sets
2518 if (instruction_set.find('/') != std::string::npos) {
2519 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2520 return false;
2521 } else {
2522 return true;
2523 }
2524}
2525
2526bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2527 const char *apk_path, const char *instruction_set) {
2528 std::string oat_dir_ = oat_dir;
2529 std::string apk_path_ = apk_path;
2530 std::string instruction_set_ = instruction_set;
2531
2532 if (!is_absolute_path(oat_dir_)) return false;
2533 if (!is_absolute_path(apk_path_)) return false;
2534 if (!is_valid_instruction_set(instruction_set_)) return false;
2535
2536 std::string::size_type end = apk_path_.rfind('.');
2537 std::string::size_type start = apk_path_.rfind('/', end);
2538 if (end == std::string::npos || start == std::string::npos) {
2539 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2540 return false;
2541 }
2542
2543 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2544 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2545 const char* res = res_.c_str();
2546 if (strlen(res) >= PKG_PATH_MAX) {
2547 LOG(ERROR) << "Result too large";
2548 return false;
2549 } else {
2550 strlcpy(path, res, PKG_PATH_MAX);
2551 return true;
2552 }
2553}
2554
2555bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2556 const char *instruction_set) {
2557 std::string apk_path_ = apk_path;
2558 std::string instruction_set_ = instruction_set;
2559
2560 if (!is_absolute_path(apk_path_)) return false;
2561 if (!is_valid_instruction_set(instruction_set_)) return false;
2562
2563 std::string::size_type end = apk_path_.rfind('.');
2564 std::string::size_type start = apk_path_.rfind('/', end);
2565 if (end == std::string::npos || start == std::string::npos) {
2566 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2567 return false;
2568 }
2569
2570 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2571 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2572}
2573
2574bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2575 const char *instruction_set) {
2576 std::string src_ = src;
2577 std::string instruction_set_ = instruction_set;
2578
2579 if (!is_absolute_path(src_)) return false;
2580 if (!is_valid_instruction_set(instruction_set_)) return false;
2581
2582 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2583 if (*it == '/') {
2584 *it = '@';
2585 }
2586 }
2587
2588 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2589 + DALVIK_CACHE_POSTFIX;
2590 const char* res = res_.c_str();
2591 if (strlen(res) >= PKG_PATH_MAX) {
2592 LOG(ERROR) << "Result too large";
2593 return false;
2594 } else {
2595 strlcpy(path, res, PKG_PATH_MAX);
2596 return true;
2597 }
2598}
2599
Calin Juravle0d0a4922018-01-23 19:54:11 -08002600bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds) {
2601 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2602 for (const std::string& elem : classpaths_elems) {
2603 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2604 if (fd < 0) {
2605 PLOG(ERROR) << "Could not open classpath elem " << elem;
2606 return false;
2607 } else {
2608 apk_fds->push_back(std::move(fd));
2609 }
2610 }
2611 return true;
2612}
2613
2614static bool create_app_profile_snapshot(int32_t app_id,
2615 const std::string& package_name,
2616 const std::string& profile_name,
2617 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002618 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2619
Calin Juravle824a64d2018-01-18 20:23:17 -08002620 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002621 if (snapshot_fd < 0) {
2622 return false;
2623 }
2624
2625 std::vector<unique_fd> profiles_fd;
2626 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002627 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2628 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002629 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2630 return false;
2631 }
2632
2633 profiles_fd.push_back(std::move(reference_profile_fd));
2634
Calin Juravle0d0a4922018-01-23 19:54:11 -08002635 // Open the class paths elements. These will be used to filter out profile data that does
2636 // not belong to the classpath during merge.
2637 std::vector<unique_fd> apk_fds;
2638 if (!open_classpath_files(classpath, &apk_fds)) {
2639 return false;
2640 }
2641
Calin Juravle29591732017-11-20 17:46:19 -08002642 pid_t pid = fork();
2643 if (pid == 0) {
2644 /* child -- drop privileges before continuing */
2645 drop_capabilities(app_shared_gid);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002646 run_profman_merge(profiles_fd, snapshot_fd, &apk_fds);
Calin Juravle29591732017-11-20 17:46:19 -08002647 }
2648
2649 /* parent */
2650 int return_code = wait_child(pid);
2651 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002652 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002653 return false;
2654 }
2655
2656 return true;
2657}
2658
Calin Juravle0d0a4922018-01-23 19:54:11 -08002659static bool create_boot_image_profile_snapshot(const std::string& package_name,
2660 const std::string& profile_name,
2661 const std::string& classpath) {
2662 // The reference profile directory for the android package might not be prepared. Do it now.
2663 const std::string ref_profile_dir =
2664 create_primary_reference_profile_package_dir_path(package_name);
2665 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2666 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2667 return false;
2668 }
2669
2670 // Open and create the snapshot profile.
2671 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2672
2673 // Collect all non empty profiles.
2674 // The collection will traverse all applications profiles and find the non empty files.
2675 // This has the potential of inspecting a large number of files and directories (depending
2676 // on the number of applications and users). So there is a slight increase in the chance
2677 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2678 // fail the snapshot and aggregate whatever profile we could open.
2679 //
2680 // The profile snapshot is a best effort based on available data it's ok if some data
2681 // from some apps is missing. It will be counter productive for the snapshot to fail
2682 // because we could not open or read some of the files.
2683 std::vector<std::string> profiles;
2684 if (!collect_profiles(&profiles)) {
2685 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2686 }
2687
2688 // If we have no profiles return early.
2689 if (profiles.empty()) {
2690 return true;
2691 }
2692
2693 // Open the classpath elements. These will be used to filter out profile data that does
2694 // not belong to the classpath during merge.
2695 std::vector<unique_fd> apk_fds;
2696 if (!open_classpath_files(classpath, &apk_fds)) {
2697 return false;
2698 }
2699
2700 // If we could not open any files from the classpath return an error.
2701 if (apk_fds.empty()) {
2702 LOG(ERROR) << "Could not open any of the classpath elements.";
2703 return false;
2704 }
2705
2706 // Aggregate the profiles in batches of kAggregationBatchSize.
2707 // We do this to avoid opening a huge a amount of files.
2708 static constexpr size_t kAggregationBatchSize = 10;
2709
2710 std::vector<unique_fd> profiles_fd;
2711 for (size_t i = 0; i < profiles.size(); ) {
2712 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2713 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2714 if (fd.get() >= 0) {
2715 profiles_fd.push_back(std::move(fd));
2716 }
2717 }
2718 pid_t pid = fork();
2719 if (pid == 0) {
2720 /* child -- drop privileges before continuing */
2721 drop_capabilities(AID_SYSTEM);
2722
2723 run_profman_merge(profiles_fd, snapshot_fd, &apk_fds);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002724 }
2725
2726 /* parent */
2727 int return_code = wait_child(pid);
2728 if (!WIFEXITED(return_code)) {
2729 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2730 return false;
2731 }
2732 return true;
2733 }
2734 return true;
2735}
2736
2737bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2738 const std::string& profile_name, const std::string& classpath) {
2739 if (app_id == -1) {
2740 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2741 } else {
2742 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2743 }
2744}
2745
Calin Juravlec3b049e2018-01-18 22:32:58 -08002746bool prepare_app_profile(const std::string& package_name,
2747 userid_t user_id,
2748 appid_t app_id,
2749 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002750 const std::string& code_path,
Calin Juravlec3b049e2018-01-18 22:32:58 -08002751 const std::unique_ptr<std::string>& dex_metadata) {
2752 // Prepare the current profile.
2753 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2754 /*is_secondary_dex*/ false);
2755 uid_t uid = multiuser_get_uid(user_id, app_id);
2756 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2757 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2758 return false;
2759 }
2760
2761 // Check if we need to install the profile from the dex metadata.
2762 if (dex_metadata == nullptr) {
2763 return true;
2764 }
2765
2766 // We have a dex metdata. Merge the profile into the reference profile.
2767 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2768 /*read_write*/ true, /*is_secondary_dex*/ false);
2769 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2770 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002771 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2772 if (apk_fd < 0) {
2773 PLOG(ERROR) << "Could not open code path " << code_path;
2774 return false;
2775 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002776
2777 pid_t pid = fork();
2778 if (pid == 0) {
2779 /* child -- drop privileges before continuing */
2780 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2781 drop_capabilities(app_shared_gid);
2782
Calin Juravlef63d4792018-01-30 17:43:34 +00002783 // The copy and update takes ownership over the fds.
2784 run_profman_copy_and_update(std::move(dex_metadata_fd),
2785 std::move(ref_profile_fd),
2786 std::move(apk_fd));
Calin Juravlec3b049e2018-01-18 22:32:58 -08002787 }
2788
2789 /* parent */
2790 int return_code = wait_child(pid);
2791 if (!WIFEXITED(return_code)) {
2792 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2793 return false;
2794 }
2795 return true;
2796}
2797
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002798} // namespace installd
2799} // namespace android