blob: e3a35c71d48bf9847396184343945b75bc186d0f [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 */
Alan Stokescb27c342018-04-20 17:09:25 +010016#define LOG_TAG "installd"
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>
Suren Baghdasaryancd829052018-11-02 19:15:37 -070046#include <processgroup/sched_policy.h>
Calin Juravlecb556e32017-04-04 20:22:50 -070047#include <selinux/android.h>
Jeff Sharkey90aff262016-12-12 14:28:24 -070048#include <system/thread_defs.h>
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070049
50#include "dexopt.h"
Andreas Gampefa2dadd2018-02-28 19:52:47 -080051#include "dexopt_return_codes.h"
Jeff Sharkeyc1149c92017-09-21 14:51:09 -060052#include "globals.h"
Jeff Sharkey90aff262016-12-12 14:28:24 -070053#include "installd_deps.h"
54#include "otapreopt_utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070055#include "utils.h"
56
Jeff Sharkey90aff262016-12-12 14:28:24 -070057using android::base::EndsWith;
Mathieu Chartier9b2da082018-10-26 13:23:11 -070058using android::base::GetBoolProperty;
59using android::base::GetProperty;
Alan Stokesa25d90c2017-10-16 10:56:00 +010060using android::base::ReadFully;
61using android::base::StringPrintf;
62using android::base::WriteFully;
Calin Juravle1a0af3b2017-03-09 14:33:33 -080063using android::base::unique_fd;
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070064
65namespace android {
66namespace installd {
67
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070068// Should minidebug info be included in compiled artifacts? Even if this value is
69// "true," usage might still be conditional to other constraints, e.g., system
70// property overrides.
71static constexpr bool kEnableMinidebugInfo = true;
72
73static constexpr const char* kMinidebugInfoSystemProperty = "dalvik.vm.dex2oat-minidebuginfo";
74static constexpr bool kMinidebugInfoSystemPropertyDefault = false;
75static constexpr const char* kMinidebugDex2oatFlag = "--generate-mini-debug-info";
Mathieu Chartierb41ffcc2018-01-09 00:02:17 -080076static constexpr const char* kDisableCompactDexFlag = "--compact-dex-level=none";
Andreas Gampe2a2d7ba2017-11-02 19:39:29 -070077
Andreas Gampefa2dadd2018-02-28 19:52:47 -080078
Calin Juravle114f0812017-03-08 19:05:07 -080079// Deleter using free() for use with std::unique_ptr<>. See also UniqueCPtr<> below.
80struct FreeDelete {
81 // NOTE: Deleting a const object is valid but free() takes a non-const pointer.
82 void operator()(const void* ptr) const {
83 free(const_cast<void*>(ptr));
84 }
85};
86
87// Alias for std::unique_ptr<> that uses the C function free() to delete objects.
88template <typename T>
89using UniqueCPtr = std::unique_ptr<T, FreeDelete>;
90
Calin Juravle1a0af3b2017-03-09 14:33:33 -080091static unique_fd invalid_unique_fd() {
92 return unique_fd(-1);
93}
94
Andreas Gampe6a9cf722017-07-24 16:49:10 -070095static bool is_debug_runtime() {
96 return android::base::GetProperty("persist.sys.dalvik.vm.lib.2", "") == "libartd.so";
97}
98
David Sehra3b5ab62017-10-25 14:27:29 -070099static bool is_debuggable_build() {
100 return android::base::GetBoolProperty("ro.debuggable", false);
101}
102
Jeff Sharkey90aff262016-12-12 14:28:24 -0700103static bool clear_profile(const std::string& profile) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800104 unique_fd ufd(open(profile.c_str(), O_WRONLY | O_NOFOLLOW | O_CLOEXEC));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700105 if (ufd.get() < 0) {
106 if (errno != ENOENT) {
107 PLOG(WARNING) << "Could not open profile " << profile;
108 return false;
109 } else {
110 // Nothing to clear. That's ok.
111 return true;
112 }
113 }
114
115 if (flock(ufd.get(), LOCK_EX | LOCK_NB) != 0) {
116 if (errno != EWOULDBLOCK) {
117 PLOG(WARNING) << "Error locking profile " << profile;
118 }
119 // This implies that the app owning this profile is running
120 // (and has acquired the lock).
121 //
122 // If we can't acquire the lock bail out since clearing is useless anyway
123 // (the app will write again to the profile).
124 //
125 // Note:
126 // This does not impact the this is not an issue for the profiling correctness.
127 // In case this is needed because of an app upgrade, profiles will still be
128 // eventually cleared by the app itself due to checksum mismatch.
129 // If this is needed because profman advised, then keeping the data around
130 // until the next run is again not an issue.
131 //
132 // If the app attempts to acquire a lock while we've held one here,
133 // it will simply skip the current write cycle.
134 return false;
135 }
136
137 bool truncated = ftruncate(ufd.get(), 0) == 0;
138 if (!truncated) {
139 PLOG(WARNING) << "Could not truncate " << profile;
140 }
141 if (flock(ufd.get(), LOCK_UN) != 0) {
142 PLOG(WARNING) << "Error unlocking profile " << profile;
143 }
144 return truncated;
145}
146
Calin Juravle114f0812017-03-08 19:05:07 -0800147// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800148// The location is the profile name for primary apks or the dex path for secondary dex files.
149static bool clear_reference_profile(const std::string& package_name, const std::string& location,
150 bool is_secondary_dex) {
151 return clear_profile(create_reference_profile_path(package_name, location, is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700152}
153
Calin Juravle114f0812017-03-08 19:05:07 -0800154// Clear the reference profile for the given location.
Calin Juravle824a64d2018-01-18 20:23:17 -0800155// The location is the profile name for primary apks or the dex path for secondary dex files.
156static bool clear_current_profile(const std::string& package_name, const std::string& location,
157 userid_t user, bool is_secondary_dex) {
158 return clear_profile(create_current_profile_path(user, package_name, location,
159 is_secondary_dex));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700160}
161
Calin Juravle114f0812017-03-08 19:05:07 -0800162// Clear the reference profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800163// The location is the profile name for primary apks or the dex path for secondary dex files.
164bool clear_primary_reference_profile(const std::string& package_name,
165 const std::string& location) {
166 return clear_reference_profile(package_name, location, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800167}
168
169// Clear all current profile for the primary apk of the given package.
Calin Juravle824a64d2018-01-18 20:23:17 -0800170// The location is the profile name for primary apks or the dex path for secondary dex files.
171bool clear_primary_current_profiles(const std::string& package_name, const std::string& location) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700172 bool success = true;
Calin Juravle114f0812017-03-08 19:05:07 -0800173 // 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 -0700174 std::vector<userid_t> users = get_known_users(/*volume_uuid*/ nullptr);
175 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800176 success &= clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700177 }
178 return success;
179}
180
Calin Juravle114f0812017-03-08 19:05:07 -0800181// Clear the current profile for the primary apk of the given package and user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800182bool clear_primary_current_profile(const std::string& package_name, const std::string& location,
183 userid_t user) {
184 return clear_current_profile(package_name, location, user, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800185}
186
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700187static std::vector<std::string> SplitBySpaces(const std::string& str) {
188 if (str.empty()) {
189 return {};
190 }
191 return android::base::Split(str, " ");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700192}
193
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700194static const char* get_location_from_path(const char* path) {
195 static constexpr char kLocationSeparator = '/';
196 const char *location = strrchr(path, kLocationSeparator);
Yi Kong954cf642018-07-17 16:16:24 -0700197 if (location == nullptr) {
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700198 return path;
199 } else {
200 // Skip the separator character.
201 return location + 1;
202 }
203}
204
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800205// ExecVHelper prepares and holds pointers to parsed command line arguments so that no allocations
206// need to be performed between the fork and exec.
207class ExecVHelper {
208 public:
209 // Store a placeholder for the binary name.
210 ExecVHelper() : args_(1u, std::string()) {}
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800211
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800212 void PrepareArgs(const std::string& bin) {
213 CHECK(!args_.empty());
214 CHECK(args_[0].empty());
215 args_[0] = bin;
216 // Write char* into array.
217 for (const std::string& arg : args_) {
218 argv_.push_back(arg.c_str());
219 }
220 argv_.push_back(nullptr); // Add null terminator.
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800221 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800222
223 [[ noreturn ]]
224 void Exec(int exit_code) {
225 execv(argv_[0], (char * const *)&argv_[0]);
226 PLOG(ERROR) << "execv(" << argv_[0] << ") failed";
227 exit(exit_code);
228 }
229
230 // Add an arg if it's not empty.
231 void AddArg(const std::string& arg) {
232 if (!arg.empty()) {
233 args_.push_back(arg);
234 }
235 }
236
237 // Add a runtime arg if it's not empty.
238 void AddRuntimeArg(const std::string& arg) {
239 if (!arg.empty()) {
240 args_.push_back("--runtime-arg");
241 args_.push_back(arg);
242 }
243 }
244
245 protected:
246 // Holder arrays for backing arg storage.
247 std::vector<std::string> args_;
248
249 // Argument poiners.
250 std::vector<const char*> argv_;
251};
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700252
253static std::string MapPropertyToArg(const std::string& property,
254 const std::string& format,
255 const std::string& default_value = "") {
256 std::string prop = GetProperty(property, default_value);
257 if (!prop.empty()) {
258 return StringPrintf(format.c_str(), prop.c_str());
259 }
260 return "";
261}
262
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800263class RunDex2Oat : public ExecVHelper {
264 public:
265 RunDex2Oat(int zip_fd,
266 int oat_fd,
267 int input_vdex_fd,
268 int output_vdex_fd,
269 int image_fd,
270 const char* input_file_name,
271 const char* output_file_name,
272 int swap_fd,
273 const char* instruction_set,
274 const char* compiler_filter,
275 bool debuggable,
276 bool post_bootcomplete,
277 bool background_job_compile,
278 int profile_fd,
279 const char* class_loader_context,
280 int target_sdk_version,
281 bool enable_hidden_api_checks,
282 bool generate_compact_dex,
283 int dex_metadata_fd,
284 const char* compilation_reason) {
285 // Get the relative path to the input file.
286 const char* relative_input_file_name = get_location_from_path(input_file_name);
Jeff Hao10b8a6e2017-04-05 17:11:39 -0700287
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800288 std::string dex2oat_Xms_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xms", "-Xms%s");
289 std::string dex2oat_Xmx_arg = MapPropertyToArg("dalvik.vm.dex2oat-Xmx", "-Xmx%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700290
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800291 const char* threads_property = post_bootcomplete
292 ? "dalvik.vm.dex2oat-threads"
293 : "dalvik.vm.boot-dex2oat-threads";
294 std::string dex2oat_threads_arg = MapPropertyToArg(threads_property, "-j%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700295
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800296 const std::string dex2oat_isa_features_key =
297 StringPrintf("dalvik.vm.isa.%s.features", instruction_set);
298 std::string instruction_set_features_arg =
299 MapPropertyToArg(dex2oat_isa_features_key, "--instruction-set-features=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700300
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800301 const std::string dex2oat_isa_variant_key =
302 StringPrintf("dalvik.vm.isa.%s.variant", instruction_set);
303 std::string instruction_set_variant_arg =
304 MapPropertyToArg(dex2oat_isa_variant_key, "--instruction-set-variant=%s");
Jeff Sharkey90aff262016-12-12 14:28:24 -0700305
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800306 const char* dex2oat_norelocation = "-Xnorelocate";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700307
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800308 const std::string dex2oat_flags = GetProperty("dalvik.vm.dex2oat-flags", "");
309 std::vector<std::string> dex2oat_flags_args = SplitBySpaces(dex2oat_flags);
310 ALOGV("dalvik.vm.dex2oat-flags=%s\n", dex2oat_flags.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700311
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800312 // If we are booting without the real /data, don't spend time compiling.
313 std::string vold_decrypt = GetProperty("vold.decrypt", "");
314 bool skip_compilation = vold_decrypt == "trigger_restart_min_framework" ||
315 vold_decrypt == "1";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700316
Mathieu Chartier5880c032018-11-28 19:15:41 -0800317 const std::string resolve_startup_string_arg =
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800318 MapPropertyToArg("dalvik.vm.dex2oat-resolve-startup-strings",
319 "--resolve-startup-const-strings=%s");
Mathieu Chartier5880c032018-11-28 19:15:41 -0800320
321 const std::string image_block_size_arg =
322 MapPropertyToArg("dalvik.vm.dex2oat-max-image-block-size",
323 "--max-image-block-size=%s");
324
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800325 const bool generate_debug_info = GetBoolProperty("debug.generate-debug-info", false);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700326
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800327 std::string image_format_arg;
328 if (image_fd >= 0) {
329 image_format_arg = MapPropertyToArg("dalvik.vm.appimageformat", "--image-format=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000330 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000331
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800332 std::string dex2oat_large_app_threshold_arg =
333 MapPropertyToArg("dalvik.vm.dex2oat-very-large", "--very-large-app-threshold=%s");
Mathieu Chartier31636522018-11-09 23:53:07 +0000334
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800335 // If the runtime was requested to use libartd.so, we'll run dex2oatd, otherwise dex2oat.
Andreas Gampe3a77feb2018-12-10 23:13:49 +0000336 const char* dex2oat_bin = "/system/bin/dex2oat";
337 constexpr const char* kDex2oatDebugPath = "/system/bin/dex2oatd";
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800338 // Do not use dex2oatd for release candidates (give dex2oat more soak time).
339 bool is_release = android::base::GetProperty("ro.build.version.codename", "") == "REL";
340 if (is_debug_runtime() ||
341 (background_job_compile && is_debuggable_build() && !is_release)) {
342 if (access(kDex2oatDebugPath, X_OK) == 0) {
343 dex2oat_bin = kDex2oatDebugPath;
344 }
345 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000346
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800347 bool generate_minidebug_info = kEnableMinidebugInfo &&
348 GetBoolProperty(kMinidebugInfoSystemProperty, kMinidebugInfoSystemPropertyDefault);
Mathieu Chartier31636522018-11-09 23:53:07 +0000349
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800350 // clang FORTIFY doesn't let us use strlen in constant array bounds, so we
351 // use arraysize instead.
352 std::string zip_fd_arg = StringPrintf("--zip-fd=%d", zip_fd);
353 std::string zip_location_arg = StringPrintf("--zip-location=%s", relative_input_file_name);
354 std::string input_vdex_fd_arg = StringPrintf("--input-vdex-fd=%d", input_vdex_fd);
355 std::string output_vdex_fd_arg = StringPrintf("--output-vdex-fd=%d", output_vdex_fd);
356 std::string oat_fd_arg = StringPrintf("--oat-fd=%d", oat_fd);
357 std::string oat_location_arg = StringPrintf("--oat-location=%s", output_file_name);
358 std::string instruction_set_arg = StringPrintf("--instruction-set=%s", instruction_set);
359 std::string dex2oat_compiler_filter_arg;
360 std::string dex2oat_swap_fd;
361 std::string dex2oat_image_fd;
362 std::string target_sdk_version_arg;
363 if (target_sdk_version != 0) {
364 StringPrintf("-Xtarget-sdk-version:%d", target_sdk_version);
365 }
366 std::string class_loader_context_arg;
367 if (class_loader_context != nullptr) {
368 class_loader_context_arg = StringPrintf("--class-loader-context=%s",
369 class_loader_context);
370 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000371
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800372 if (swap_fd >= 0) {
373 dex2oat_swap_fd = StringPrintf("--swap-fd=%d", swap_fd);
374 }
375 if (image_fd >= 0) {
376 dex2oat_image_fd = StringPrintf("--app-image-fd=%d", image_fd);
377 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000378
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800379 // Compute compiler filter.
380 bool have_dex2oat_relocation_skip_flag = false;
381 if (skip_compilation) {
382 dex2oat_compiler_filter_arg = "--compiler-filter=extract";
383 have_dex2oat_relocation_skip_flag = true;
384 } else if (compiler_filter != nullptr) {
385 dex2oat_compiler_filter_arg = StringPrintf("--compiler-filter=%s", compiler_filter);
386 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000387
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800388 if (dex2oat_compiler_filter_arg.empty()) {
389 dex2oat_compiler_filter_arg = MapPropertyToArg("dalvik.vm.dex2oat-filter",
390 "--compiler-filter=%s");
391 }
392
393 // Check whether all apps should be compiled debuggable.
394 if (!debuggable) {
395 debuggable = GetProperty("dalvik.vm.always_debuggable", "") == "1";
396 }
397 std::string profile_arg;
398 if (profile_fd != -1) {
399 profile_arg = StringPrintf("--profile-file-fd=%d", profile_fd);
400 }
401
402 // Get the directory of the apk to pass as a base classpath directory.
403 std::string base_dir;
404 std::string apk_dir(input_file_name);
405 unsigned long dir_index = apk_dir.rfind('/');
406 bool has_base_dir = dir_index != std::string::npos;
407 if (has_base_dir) {
408 apk_dir = apk_dir.substr(0, dir_index);
409 base_dir = StringPrintf("--classpath-dir=%s", apk_dir.c_str());
410 }
411
412 std::string dex_metadata_fd_arg = "--dm-fd=" + std::to_string(dex_metadata_fd);
413
414 std::string compilation_reason_arg = compilation_reason == nullptr
415 ? ""
416 : std::string("--compilation-reason=") + compilation_reason;
417
418 ALOGV("Running %s in=%s out=%s\n", dex2oat_bin, relative_input_file_name, output_file_name);
419
420 // Disable cdex if update input vdex is true since this combination of options is not
421 // supported.
422 const bool disable_cdex = !generate_compact_dex || (input_vdex_fd == output_vdex_fd);
423
424 AddArg(zip_fd_arg);
425 AddArg(zip_location_arg);
426 AddArg(input_vdex_fd_arg);
427 AddArg(output_vdex_fd_arg);
428 AddArg(oat_fd_arg);
429 AddArg(oat_location_arg);
430 AddArg(instruction_set_arg);
431
432 AddArg(instruction_set_variant_arg);
433 AddArg(instruction_set_features_arg);
434
435 AddRuntimeArg(dex2oat_Xms_arg);
436 AddRuntimeArg(dex2oat_Xmx_arg);
437
438 AddArg(resolve_startup_string_arg);
Mathieu Chartier5880c032018-11-28 19:15:41 -0800439 AddArg(image_block_size_arg);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800440 AddArg(dex2oat_compiler_filter_arg);
441 AddArg(dex2oat_threads_arg);
442 AddArg(dex2oat_swap_fd);
443 AddArg(dex2oat_image_fd);
444
445 if (generate_debug_info) {
446 AddArg("--generate-debug-info");
447 }
448 if (debuggable) {
449 AddArg("--debuggable");
450 }
451 AddArg(image_format_arg);
452 AddArg(dex2oat_large_app_threshold_arg);
453
454 if (have_dex2oat_relocation_skip_flag) {
455 AddRuntimeArg(dex2oat_norelocation);
456 }
457 AddArg(profile_arg);
458 AddArg(base_dir);
459 AddArg(class_loader_context_arg);
460 if (generate_minidebug_info) {
461 AddArg(kMinidebugDex2oatFlag);
462 }
463 if (disable_cdex) {
464 AddArg(kDisableCompactDexFlag);
465 }
466 AddArg(target_sdk_version_arg);
467 if (enable_hidden_api_checks) {
468 AddRuntimeArg("-Xhidden-api-checks");
469 }
470
471 if (dex_metadata_fd > -1) {
472 AddArg(dex_metadata_fd_arg);
473 }
474
475 AddArg(compilation_reason_arg);
476
477 // Do not add args after dex2oat_flags, they should override others for debugging.
478 args_.insert(args_.end(), dex2oat_flags_args.begin(), dex2oat_flags_args.end());
479
480 PrepareArgs(dex2oat_bin);
Mathieu Chartier31636522018-11-09 23:53:07 +0000481 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800482};
Jeff Sharkey90aff262016-12-12 14:28:24 -0700483
484/*
485 * Whether dexopt should use a swap file when compiling an APK.
486 *
487 * If kAlwaysProvideSwapFile, do this on all devices (dex2oat will make a more informed decision
488 * itself, anyways).
489 *
490 * Otherwise, read "dalvik.vm.dex2oat-swap". If the property exists, return whether it is "true".
491 *
492 * Otherwise, return true if this is a low-mem device.
493 *
494 * Otherwise, return default value.
495 */
496static bool kAlwaysProvideSwapFile = false;
497static bool kDefaultProvideSwapFile = true;
498
499static bool ShouldUseSwapFileForDexopt() {
500 if (kAlwaysProvideSwapFile) {
501 return true;
502 }
503
504 // Check the "override" property. If it exists, return value == "true".
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700505 std::string dex2oat_prop_buf = GetProperty("dalvik.vm.dex2oat-swap", "");
506 if (!dex2oat_prop_buf.empty()) {
507 return dex2oat_prop_buf == "true";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700508 }
509
510 // Shortcut for default value. This is an implementation optimization for the process sketched
511 // above. If the default value is true, we can avoid to check whether this is a low-mem device,
512 // as low-mem is never returning false. The compiler will optimize this away if it can.
513 if (kDefaultProvideSwapFile) {
514 return true;
515 }
516
Mathieu Chartier9b2da082018-10-26 13:23:11 -0700517 if (GetBoolProperty("ro.config.low_ram", false)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700518 return true;
519 }
520
521 // Default value must be false here.
522 return kDefaultProvideSwapFile;
523}
524
Richard Uhler76cc0272016-12-08 10:46:35 +0000525static void SetDex2OatScheduling(bool set_to_bg) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700526 if (set_to_bg) {
527 if (set_sched_policy(0, SP_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800528 PLOG(ERROR) << "set_sched_policy failed";
529 exit(DexoptReturnCodes::kSetSchedPolicy);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700530 }
531 if (setpriority(PRIO_PROCESS, 0, ANDROID_PRIORITY_BACKGROUND) < 0) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -0800532 PLOG(ERROR) << "setpriority failed";
533 exit(DexoptReturnCodes::kSetPriority);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700534 }
535 }
536}
537
Calin Juravle29591732017-11-20 17:46:19 -0800538static unique_fd create_profile(uid_t uid, const std::string& profile, int32_t flags) {
539 unique_fd fd(TEMP_FAILURE_RETRY(open(profile.c_str(), flags, 0600)));
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800540 if (fd.get() < 0) {
Calin Juravle29591732017-11-20 17:46:19 -0800541 if (errno != EEXIST) {
Calin Juravle114f0812017-03-08 19:05:07 -0800542 PLOG(ERROR) << "Failed to create profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800543 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800544 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700545 }
Calin Juravle114f0812017-03-08 19:05:07 -0800546 // Profiles should belong to the app; make sure of that by giving ownership to
547 // the app uid. If we cannot do that, there's no point in returning the fd
548 // since dex2oat/profman will fail with SElinux denials.
549 if (fchown(fd.get(), uid, uid) < 0) {
550 PLOG(ERROR) << "Could not chwon profile " << profile;
Calin Juravle29591732017-11-20 17:46:19 -0800551 return invalid_unique_fd();
Calin Juravle114f0812017-03-08 19:05:07 -0800552 }
Calin Juravle29591732017-11-20 17:46:19 -0800553 return fd;
Calin Juravle114f0812017-03-08 19:05:07 -0800554}
555
Calin Juravle29591732017-11-20 17:46:19 -0800556static unique_fd open_profile(uid_t uid, const std::string& profile, int32_t flags) {
Calin Juravle114f0812017-03-08 19:05:07 -0800557 // Do not follow symlinks when opening a profile:
558 // - primary profiles should not contain symlinks in their paths
559 // - secondary dex paths should have been already resolved and validated
560 flags |= O_NOFOLLOW;
561
Calin Juravle29591732017-11-20 17:46:19 -0800562 // Check if we need to create the profile
563 // Reference profiles and snapshots are created on the fly; so they might not exist beforehand.
564 unique_fd fd;
565 if ((flags & O_CREAT) != 0) {
566 fd = create_profile(uid, profile, flags);
567 } else {
568 fd.reset(TEMP_FAILURE_RETRY(open(profile.c_str(), flags)));
569 }
570
Calin Juravle114f0812017-03-08 19:05:07 -0800571 if (fd.get() < 0) {
572 if (errno != ENOENT) {
573 // Profiles might be missing for various reasons. For example, in a
574 // multi-user environment, the profile directory for one user can be created
575 // after we start a merge. In this case the current profile for that user
576 // will not be found.
577 // Also, the secondary dex profiles might be deleted by the app at any time,
578 // so we can't we need to prepare if they are missing.
579 PLOG(ERROR) << "Failed to open profile " << profile;
580 }
581 return invalid_unique_fd();
582 }
583
Jeff Sharkey90aff262016-12-12 14:28:24 -0700584 return fd;
585}
586
Calin Juravle824a64d2018-01-18 20:23:17 -0800587static unique_fd open_current_profile(uid_t uid, userid_t user, const std::string& package_name,
588 const std::string& location, bool is_secondary_dex) {
589 std::string profile = create_current_profile_path(user, package_name, location,
590 is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800591 return open_profile(uid, profile, O_RDONLY);
Calin Juravle114f0812017-03-08 19:05:07 -0800592}
593
Calin Juravle824a64d2018-01-18 20:23:17 -0800594static unique_fd open_reference_profile(uid_t uid, const std::string& package_name,
595 const std::string& location, bool read_write, bool is_secondary_dex) {
596 std::string profile = create_reference_profile_path(package_name, location, is_secondary_dex);
Calin Juravle29591732017-11-20 17:46:19 -0800597 return open_profile(uid, profile, read_write ? (O_CREAT | O_RDWR) : O_RDONLY);
598}
599
600static unique_fd open_spnashot_profile(uid_t uid, const std::string& package_name,
Calin Juravle824a64d2018-01-18 20:23:17 -0800601 const std::string& location) {
602 std::string profile = create_snapshot_profile_path(package_name, location);
Calin Juravle29591732017-11-20 17:46:19 -0800603 return open_profile(uid, profile, O_CREAT | O_RDWR | O_TRUNC);
Calin Juravle114f0812017-03-08 19:05:07 -0800604}
605
Calin Juravle824a64d2018-01-18 20:23:17 -0800606static void open_profile_files(uid_t uid, const std::string& package_name,
607 const std::string& location, bool is_secondary_dex,
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800608 /*out*/ std::vector<unique_fd>* profiles_fd, /*out*/ unique_fd* reference_profile_fd) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700609 // Open the reference profile in read-write mode as profman might need to save the merge.
Calin Juravle824a64d2018-01-18 20:23:17 -0800610 *reference_profile_fd = open_reference_profile(uid, package_name, location,
611 /*read_write*/ true, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700612
Calin Juravle114f0812017-03-08 19:05:07 -0800613 // For secondary dex files, we don't really need the user but we use it for sanity checks.
614 // Note: the user owning the dex file should be the current user.
615 std::vector<userid_t> users;
616 if (is_secondary_dex){
617 users.push_back(multiuser_get_user_id(uid));
618 } else {
619 users = get_known_users(/*volume_uuid*/ nullptr);
620 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700621 for (auto user : users) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800622 unique_fd profile_fd = open_current_profile(uid, user, package_name, location,
623 is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700624 // Add to the lists only if both fds are valid.
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800625 if (profile_fd.get() >= 0) {
626 profiles_fd->push_back(std::move(profile_fd));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700627 }
628 }
629}
630
Jeff Sharkey90aff262016-12-12 14:28:24 -0700631static constexpr int PROFMAN_BIN_RETURN_CODE_COMPILE = 0;
632static constexpr int PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION = 1;
633static constexpr int PROFMAN_BIN_RETURN_CODE_BAD_PROFILES = 2;
634static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_IO = 3;
635static constexpr int PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING = 4;
636
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800637class RunProfman : public ExecVHelper {
638 public:
639 void SetupArgs(const std::vector<unique_fd>& profile_fds,
640 const unique_fd& reference_profile_fd,
641 const std::vector<unique_fd>& apk_fds,
642 const std::vector<std::string>& dex_locations,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800643 bool copy_and_update,
644 bool store_aggregation_counters) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800645 const char* profman_bin =
Andreas Gampe3a77feb2018-12-10 23:13:49 +0000646 is_debug_runtime() ? "/system/bin/profmand" : "/system/bin/profman";
Jeff Sharkey90aff262016-12-12 14:28:24 -0700647
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800648 if (copy_and_update) {
649 CHECK_EQ(1u, profile_fds.size());
650 CHECK_EQ(1u, apk_fds.size());
Mathieu Chartier31636522018-11-09 23:53:07 +0000651 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800652 if (reference_profile_fd != -1) {
653 AddArg("--reference-profile-file-fd=" + std::to_string(reference_profile_fd.get()));
Mathieu Chartier31636522018-11-09 23:53:07 +0000654 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800655
656 for (const unique_fd& fd : profile_fds) {
657 AddArg("--profile-file-fd=" + std::to_string(fd.get()));
658 }
659
660 for (const unique_fd& fd : apk_fds) {
661 AddArg("--apk-fd=" + std::to_string(fd.get()));
662 }
663
664 for (const std::string& dex_location : dex_locations) {
665 AddArg("--dex-location=" + dex_location);
666 }
667
668 if (copy_and_update) {
669 AddArg("--copy-and-update-profile-key");
670 }
671
Calin Juravleb3a929d2018-12-11 14:40:00 -0800672 if (store_aggregation_counters) {
673 AddArg("--store-aggregation-counters");
674 }
675
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800676 // Do not add after dex2oat_flags, they should override others for debugging.
677 PrepareArgs(profman_bin);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800678 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700679
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800680 void SetupMerge(const std::vector<unique_fd>& profiles_fd,
681 const unique_fd& reference_profile_fd,
682 const std::vector<unique_fd>& apk_fds = std::vector<unique_fd>(),
Calin Juravleb3a929d2018-12-11 14:40:00 -0800683 const std::vector<std::string>& dex_locations = std::vector<std::string>(),
684 bool store_aggregation_counters = false) {
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800685 SetupArgs(profiles_fd,
Calin Juravleb3a929d2018-12-11 14:40:00 -0800686 reference_profile_fd,
687 apk_fds,
688 dex_locations,
689 /*copy_and_update=*/false,
690 store_aggregation_counters);
Mathieu Chartier62d218d2018-11-05 09:34:24 -0800691 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700692
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800693 void SetupCopyAndUpdate(unique_fd&& profile_fd,
694 unique_fd&& reference_profile_fd,
695 unique_fd&& apk_fd,
696 const std::string& dex_location) {
697 // The fds need to stay open longer than the scope of the function, so put them into a local
698 // variable vector.
699 profiles_fd_.push_back(std::move(profile_fd));
700 apk_fds_.push_back(std::move(apk_fd));
701 reference_profile_fd_ = std::move(reference_profile_fd);
702 std::vector<std::string> dex_locations = {dex_location};
Calin Juravleb3a929d2018-12-11 14:40:00 -0800703 SetupArgs(profiles_fd_,
704 reference_profile_fd_,
705 apk_fds_,
706 dex_locations,
707 /*copy_and_update=*/true,
708 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800709 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000710
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800711 void SetupDump(const std::vector<unique_fd>& profiles_fd,
712 const unique_fd& reference_profile_fd,
713 const std::vector<std::string>& dex_locations,
714 const std::vector<unique_fd>& apk_fds,
715 const unique_fd& output_fd) {
716 AddArg("--dump-only");
717 AddArg(StringPrintf("--dump-output-to-fd=%d", output_fd.get()));
Calin Juravleb3a929d2018-12-11 14:40:00 -0800718 SetupArgs(profiles_fd,
719 reference_profile_fd,
720 apk_fds,
721 dex_locations,
722 /*copy_and_update=*/false,
723 /*store_aggregation_counters=*/false);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800724 }
Calin Juravlef63d4792018-01-30 17:43:34 +0000725
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800726 void Exec() {
727 ExecVHelper::Exec(DexoptReturnCodes::kProfmanExec);
728 }
Mathieu Chartier31636522018-11-09 23:53:07 +0000729
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800730 private:
731 unique_fd reference_profile_fd_;
732 std::vector<unique_fd> profiles_fd_;
733 std::vector<unique_fd> apk_fds_;
734};
Mathieu Chartier31636522018-11-09 23:53:07 +0000735
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800736
Calin Juravlef63d4792018-01-30 17:43:34 +0000737
Jeff Sharkey90aff262016-12-12 14:28:24 -0700738// Decides if profile guided compilation is needed or not based on existing profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800739// The location is the package name for primary apks or the dex path for secondary dex files.
740// Returns true if there is enough information in the current profiles that makes it
741// worth to recompile the given location.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700742// If the return value is true all the current profiles would have been merged into
743// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800744static bool analyze_profiles(uid_t uid, const std::string& package_name,
745 const std::string& location, bool is_secondary_dex) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800746 std::vector<unique_fd> profiles_fd;
747 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -0800748 open_profile_files(uid, package_name, location, is_secondary_dex,
749 &profiles_fd, &reference_profile_fd);
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800750 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -0700751 // Skip profile guided compilation because no profiles were found.
752 // Or if the reference profile info couldn't be opened.
Jeff Sharkey90aff262016-12-12 14:28:24 -0700753 return false;
754 }
755
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800756 RunProfman profman_merge;
757 profman_merge.SetupMerge(profiles_fd, reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700758 pid_t pid = fork();
759 if (pid == 0) {
760 /* child -- drop privileges before continuing */
761 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800762 profman_merge.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700763 }
764 /* parent */
765 int return_code = wait_child(pid);
766 bool need_to_compile = false;
767 bool should_clear_current_profiles = false;
768 bool should_clear_reference_profile = false;
769 if (!WIFEXITED(return_code)) {
Calin Juravle114f0812017-03-08 19:05:07 -0800770 LOG(WARNING) << "profman failed for location " << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700771 } else {
772 return_code = WEXITSTATUS(return_code);
773 switch (return_code) {
774 case PROFMAN_BIN_RETURN_CODE_COMPILE:
775 need_to_compile = true;
776 should_clear_current_profiles = true;
777 should_clear_reference_profile = false;
778 break;
779 case PROFMAN_BIN_RETURN_CODE_SKIP_COMPILATION:
780 need_to_compile = false;
781 should_clear_current_profiles = false;
782 should_clear_reference_profile = false;
783 break;
784 case PROFMAN_BIN_RETURN_CODE_BAD_PROFILES:
Calin Juravle114f0812017-03-08 19:05:07 -0800785 LOG(WARNING) << "Bad profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700786 need_to_compile = false;
787 should_clear_current_profiles = true;
788 should_clear_reference_profile = true;
789 break;
790 case PROFMAN_BIN_RETURN_CODE_ERROR_IO: // fall-through
791 case PROFMAN_BIN_RETURN_CODE_ERROR_LOCKING:
792 // Temporary IO problem (e.g. locking). Ignore but log a warning.
Calin Juravle114f0812017-03-08 19:05:07 -0800793 LOG(WARNING) << "IO error while reading profiles for location " << location;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700794 need_to_compile = false;
795 should_clear_current_profiles = false;
796 should_clear_reference_profile = false;
797 break;
798 default:
799 // Unknown return code or error. Unlink profiles.
Calin Juravle114f0812017-03-08 19:05:07 -0800800 LOG(WARNING) << "Unknown error code while processing profiles for location "
801 << location << ": " << return_code;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700802 need_to_compile = false;
803 should_clear_current_profiles = true;
804 should_clear_reference_profile = true;
805 break;
806 }
807 }
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800808
Jeff Sharkey90aff262016-12-12 14:28:24 -0700809 if (should_clear_current_profiles) {
Calin Juravle114f0812017-03-08 19:05:07 -0800810 if (is_secondary_dex) {
811 // For secondary dex files, the owning user is the current user.
Calin Juravle824a64d2018-01-18 20:23:17 -0800812 clear_current_profile(package_name, location, multiuser_get_user_id(uid),
813 is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -0800814 } else {
Calin Juravle824a64d2018-01-18 20:23:17 -0800815 clear_primary_current_profiles(package_name, location);
Calin Juravle114f0812017-03-08 19:05:07 -0800816 }
Jeff Sharkey90aff262016-12-12 14:28:24 -0700817 }
818 if (should_clear_reference_profile) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800819 clear_reference_profile(package_name, location, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700820 }
821 return need_to_compile;
822}
823
Calin Juravle114f0812017-03-08 19:05:07 -0800824// Decides if profile guided compilation is needed or not based on existing profiles.
825// The analysis is done for the primary apks of the given package.
826// Returns true if there is enough information in the current profiles that makes it
827// worth to recompile the package.
828// If the return value is true all the current profiles would have been merged into
829// the reference profiles accessible with open_reference_profile().
Calin Juravle824a64d2018-01-18 20:23:17 -0800830bool analyze_primary_profiles(uid_t uid, const std::string& package_name,
831 const std::string& profile_name) {
832 return analyze_profiles(uid, package_name, profile_name, /*is_secondary_dex*/false);
Calin Juravle114f0812017-03-08 19:05:07 -0800833}
834
Calin Juravle408cd4a2018-01-20 23:34:18 -0800835bool dump_profiles(int32_t uid, const std::string& pkgname, const std::string& profile_name,
836 const std::string& code_path) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800837 std::vector<unique_fd> profile_fds;
838 unique_fd reference_profile_fd;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800839 std::string out_file_name = StringPrintf("/data/misc/profman/%s-%s.txt",
840 pkgname.c_str(), profile_name.c_str());
Jeff Sharkey90aff262016-12-12 14:28:24 -0700841
Calin Juravle408cd4a2018-01-20 23:34:18 -0800842 open_profile_files(uid, pkgname, profile_name, /*is_secondary_dex*/false,
Calin Juravle114f0812017-03-08 19:05:07 -0800843 &profile_fds, &reference_profile_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700844
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800845 const bool has_reference_profile = (reference_profile_fd.get() != -1);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700846 const bool has_profiles = !profile_fds.empty();
847
848 if (!has_reference_profile && !has_profiles) {
Calin Juravle76268c52017-03-09 13:19:42 -0800849 LOG(ERROR) << "profman dump: no profiles to dump for " << pkgname;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700850 return false;
851 }
852
Calin Juravle114f0812017-03-08 19:05:07 -0800853 unique_fd output_fd(open(out_file_name.c_str(),
854 O_WRONLY | O_CREAT | O_TRUNC | O_NOFOLLOW, 0644));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700855 if (fchmod(output_fd, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH) < 0) {
Calin Juravle408cd4a2018-01-20 23:34:18 -0800856 LOG(ERROR) << "installd cannot chmod file for dump_profile" << out_file_name;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700857 return false;
858 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800859
Jeff Sharkey90aff262016-12-12 14:28:24 -0700860 std::vector<std::string> dex_locations;
Calin Juravle1a0af3b2017-03-09 14:33:33 -0800861 std::vector<unique_fd> apk_fds;
Calin Juravle408cd4a2018-01-20 23:34:18 -0800862 unique_fd apk_fd(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW));
863 if (apk_fd == -1) {
864 PLOG(ERROR) << "installd cannot open " << code_path.c_str();
865 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -0700866 }
Calin Juravle408cd4a2018-01-20 23:34:18 -0800867 dex_locations.push_back(get_location_from_path(code_path.c_str()));
868 apk_fds.push_back(std::move(apk_fd));
869
Jeff Sharkey90aff262016-12-12 14:28:24 -0700870
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800871 RunProfman profman_dump;
872 profman_dump.SetupDump(profile_fds, reference_profile_fd, dex_locations, apk_fds, output_fd);
Jeff Sharkey90aff262016-12-12 14:28:24 -0700873 pid_t pid = fork();
874 if (pid == 0) {
875 /* child -- drop privileges before continuing */
876 drop_capabilities(uid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -0800877 profman_dump.Exec();
Jeff Sharkey90aff262016-12-12 14:28:24 -0700878 }
879 /* parent */
Jeff Sharkey90aff262016-12-12 14:28:24 -0700880 int return_code = wait_child(pid);
881 if (!WIFEXITED(return_code)) {
882 LOG(WARNING) << "profman failed for package " << pkgname << ": "
883 << return_code;
884 return false;
885 }
886 return true;
887}
888
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700889bool copy_system_profile(const std::string& system_profile,
Calin Juravle824a64d2018-01-18 20:23:17 -0800890 uid_t packageUid, const std::string& package_name, const std::string& profile_name) {
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700891 unique_fd in_fd(open(system_profile.c_str(), O_RDONLY | O_NOFOLLOW | O_CLOEXEC));
892 unique_fd out_fd(open_reference_profile(packageUid,
Calin Juravle824a64d2018-01-18 20:23:17 -0800893 package_name,
894 profile_name,
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700895 /*read_write*/ true,
896 /*secondary*/ false));
897 if (in_fd.get() < 0) {
898 PLOG(WARNING) << "Could not open profile " << system_profile;
899 return false;
900 }
901 if (out_fd.get() < 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800902 PLOG(WARNING) << "Could not open profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700903 return false;
904 }
905
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700906 // As a security measure we want to write the profile information with the reduced capabilities
907 // of the package user id. So we fork and drop capabilities in the child.
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700908 pid_t pid = fork();
909 if (pid == 0) {
910 /* child -- drop privileges before continuing */
911 drop_capabilities(packageUid);
912
913 if (flock(out_fd.get(), LOCK_EX | LOCK_NB) != 0) {
914 if (errno != EWOULDBLOCK) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800915 PLOG(WARNING) << "Error locking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700916 }
917 // This implies that the app owning this profile is running
918 // (and has acquired the lock).
919 //
920 // The app never acquires the lock for the reference profiles of primary apks.
921 // Only dex2oat from installd will do that. Since installd is single threaded
922 // we should not see this case. Nevertheless be prepared for it.
Calin Juravle824a64d2018-01-18 20:23:17 -0800923 PLOG(WARNING) << "Failed to flock " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700924 return false;
925 }
926
927 bool truncated = ftruncate(out_fd.get(), 0) == 0;
928 if (!truncated) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800929 PLOG(WARNING) << "Could not truncate " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700930 }
931
932 // Copy over data.
933 static constexpr size_t kBufferSize = 4 * 1024;
934 char buffer[kBufferSize];
935 while (true) {
936 ssize_t bytes = read(in_fd.get(), buffer, kBufferSize);
937 if (bytes == 0) {
938 break;
939 }
940 write(out_fd.get(), buffer, bytes);
941 }
942 if (flock(out_fd.get(), LOCK_UN) != 0) {
Calin Juravle824a64d2018-01-18 20:23:17 -0800943 PLOG(WARNING) << "Error unlocking profile " << package_name;
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700944 }
Mathieu Chartier78f71fe2017-06-14 13:02:26 -0700945 // Use _exit since we don't want to run the global destructors in the child.
946 // b/62597429
947 _exit(0);
Mathieu Chartierf966f2a2017-05-10 12:48:37 -0700948 }
949 /* parent */
950 int return_code = wait_child(pid);
951 return return_code == 0;
952}
953
Jeff Sharkey90aff262016-12-12 14:28:24 -0700954static std::string replace_file_extension(const std::string& oat_path, const std::string& new_ext) {
955 // A standard dalvik-cache entry. Replace ".dex" with `new_ext`.
956 if (EndsWith(oat_path, ".dex")) {
957 std::string new_path = oat_path;
958 new_path.replace(new_path.length() - strlen(".dex"), strlen(".dex"), new_ext);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800959 CHECK(EndsWith(new_path, new_ext));
Jeff Sharkey90aff262016-12-12 14:28:24 -0700960 return new_path;
961 }
962
963 // An odex entry. Not that this may not be an extension, e.g., in the OTA
964 // case (where the base name will have an extension for the B artifact).
965 size_t odex_pos = oat_path.rfind(".odex");
966 if (odex_pos != std::string::npos) {
967 std::string new_path = oat_path;
968 new_path.replace(odex_pos, strlen(".odex"), new_ext);
969 CHECK_NE(new_path.find(new_ext), std::string::npos);
970 return new_path;
971 }
972
973 // Don't know how to handle this.
974 return "";
975}
976
977// Translate the given oat path to an art (app image) path. An empty string
978// denotes an error.
979static std::string create_image_filename(const std::string& oat_path) {
980 return replace_file_extension(oat_path, ".art");
981}
982
983// Translate the given oat path to a vdex path. An empty string denotes an error.
984static std::string create_vdex_filename(const std::string& oat_path) {
985 return replace_file_extension(oat_path, ".vdex");
986}
987
Jeff Sharkey90aff262016-12-12 14:28:24 -0700988static int open_output_file(const char* file_name, bool recreate, int permissions) {
989 int flags = O_RDWR | O_CREAT;
990 if (recreate) {
991 if (unlink(file_name) < 0) {
992 if (errno != ENOENT) {
993 PLOG(ERROR) << "open_output_file: Couldn't unlink " << file_name;
994 }
995 }
996 flags |= O_EXCL;
997 }
998 return open(file_name, flags, permissions);
999}
1000
Calin Juravle2289c0a2017-02-15 12:44:14 -08001001static bool set_permissions_and_ownership(
1002 int fd, bool is_public, int uid, const char* path, bool is_secondary_dex) {
1003 // Primary apks are owned by the system. Secondary dex files are owned by the app.
1004 int owning_uid = is_secondary_dex ? uid : AID_SYSTEM;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001005 if (fchmod(fd,
1006 S_IRUSR|S_IWUSR|S_IRGRP |
1007 (is_public ? S_IROTH : 0)) < 0) {
1008 ALOGE("installd cannot chmod '%s' during dexopt\n", path);
1009 return false;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001010 } else if (fchown(fd, owning_uid, uid) < 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001011 ALOGE("installd cannot chown '%s' during dexopt\n", path);
1012 return false;
1013 }
1014 return true;
1015}
1016
1017static bool IsOutputDalvikCache(const char* oat_dir) {
1018 // InstallerConnection.java (which invokes installd) transforms Java null arguments
1019 // into '!'. Play it safe by handling it both.
1020 // TODO: ensure we never get null.
1021 // TODO: pass a flag instead of inferring if the output is dalvik cache.
1022 return oat_dir == nullptr || oat_dir[0] == '!';
1023}
1024
Calin Juravled23dee72017-07-06 16:29:11 -07001025// Best-effort check whether we can fit the the path into our buffers.
1026// Note: the cache path will require an additional 5 bytes for ".swap", but we'll try to run
1027// without a swap file, if necessary. Reference profiles file also add an extra ".prof"
1028// extension to the cache path (5 bytes).
1029// TODO(calin): move away from char* buffers and PKG_PATH_MAX.
1030static bool validate_dex_path_size(const std::string& dex_path) {
1031 if (dex_path.size() >= (PKG_PATH_MAX - 8)) {
1032 LOG(ERROR) << "dex_path too long: " << dex_path;
1033 return false;
1034 }
1035 return true;
1036}
1037
Jeff Sharkey90aff262016-12-12 14:28:24 -07001038static bool create_oat_out_path(const char* apk_path, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001039 const char* oat_dir, bool is_secondary_dex, /*out*/ char* out_oat_path) {
Calin Juravled23dee72017-07-06 16:29:11 -07001040 if (!validate_dex_path_size(apk_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001041 return false;
1042 }
1043
1044 if (!IsOutputDalvikCache(oat_dir)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001045 // Oat dirs for secondary dex files are already validated.
1046 if (!is_secondary_dex && validate_apk_path(oat_dir)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001047 ALOGE("cannot validate apk path with oat_dir '%s'\n", oat_dir);
1048 return false;
1049 }
1050 if (!calculate_oat_file_path(out_oat_path, oat_dir, apk_path, instruction_set)) {
1051 return false;
1052 }
1053 } else {
1054 if (!create_cache_path(out_oat_path, apk_path, instruction_set)) {
1055 return false;
1056 }
1057 }
1058 return true;
1059}
1060
1061// Helper for fd management. This is similar to a unique_fd in that it closes the file descriptor
1062// on destruction. It will also run the given cleanup (unless told not to) after closing.
1063//
1064// Usage example:
1065//
Calin Juravle7a570e82017-01-14 16:23:30 -08001066// Dex2oatFileWrapper file(open(...),
Jeff Sharkey90aff262016-12-12 14:28:24 -07001067// [name]() {
1068// unlink(name.c_str());
1069// });
1070// // Note: care needs to be taken about name, as it needs to have a lifetime longer than the
1071// wrapper if captured as a reference.
1072//
1073// if (file.get() == -1) {
1074// // Error opening...
1075// }
1076//
1077// ...
1078// if (error) {
1079// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will run
1080// // and delete the file (after the fd is closed).
1081// return -1;
1082// }
1083//
1084// (Success case)
1085// file.SetCleanup(false);
1086// // At this point, when the Dex2oatFileWrapper is destructed, the cleanup function will not run
1087// // (leaving the file around; after the fd is closed).
1088//
Jeff Sharkey90aff262016-12-12 14:28:24 -07001089class Dex2oatFileWrapper {
1090 public:
Calin Juravle7a570e82017-01-14 16:23:30 -08001091 Dex2oatFileWrapper() : value_(-1), cleanup_(), do_cleanup_(true), auto_close_(true) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001092 }
1093
Calin Juravle7a570e82017-01-14 16:23:30 -08001094 Dex2oatFileWrapper(int value, std::function<void ()> cleanup)
1095 : value_(value), cleanup_(cleanup), do_cleanup_(true), auto_close_(true) {}
1096
1097 Dex2oatFileWrapper(Dex2oatFileWrapper&& other) {
1098 value_ = other.value_;
1099 cleanup_ = other.cleanup_;
1100 do_cleanup_ = other.do_cleanup_;
1101 auto_close_ = other.auto_close_;
1102 other.release();
1103 }
1104
1105 Dex2oatFileWrapper& operator=(Dex2oatFileWrapper&& other) {
1106 value_ = other.value_;
1107 cleanup_ = other.cleanup_;
1108 do_cleanup_ = other.do_cleanup_;
1109 auto_close_ = other.auto_close_;
1110 other.release();
1111 return *this;
1112 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001113
1114 ~Dex2oatFileWrapper() {
1115 reset(-1);
1116 }
1117
1118 int get() {
1119 return value_;
1120 }
1121
1122 void SetCleanup(bool cleanup) {
1123 do_cleanup_ = cleanup;
1124 }
1125
1126 void reset(int new_value) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001127 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001128 close(value_);
1129 }
1130 if (do_cleanup_ && cleanup_ != nullptr) {
1131 cleanup_();
1132 }
1133
1134 value_ = new_value;
1135 }
1136
Calin Juravle7a570e82017-01-14 16:23:30 -08001137 void reset(int new_value, std::function<void ()> new_cleanup) {
1138 if (auto_close_ && value_ >= 0) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001139 close(value_);
1140 }
1141 if (do_cleanup_ && cleanup_ != nullptr) {
1142 cleanup_();
1143 }
1144
1145 value_ = new_value;
1146 cleanup_ = new_cleanup;
1147 }
1148
Calin Juravle7a570e82017-01-14 16:23:30 -08001149 void DisableAutoClose() {
1150 auto_close_ = false;
1151 }
1152
Jeff Sharkey90aff262016-12-12 14:28:24 -07001153 private:
Calin Juravle7a570e82017-01-14 16:23:30 -08001154 void release() {
1155 value_ = -1;
1156 do_cleanup_ = false;
1157 cleanup_ = nullptr;
1158 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001159 int value_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001160 std::function<void ()> cleanup_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001161 bool do_cleanup_;
Calin Juravle7a570e82017-01-14 16:23:30 -08001162 bool auto_close_;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001163};
1164
Calin Juravle7a570e82017-01-14 16:23:30 -08001165// (re)Creates the app image if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001166Dex2oatFileWrapper maybe_open_app_image(const char* out_oat_path,
1167 bool generate_app_image, bool is_public, int uid, bool is_secondary_dex) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001168
1169 // We don't create an image for secondary dex files.
1170 if (is_secondary_dex) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001171 return Dex2oatFileWrapper();
1172 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001173
Calin Juravle7a570e82017-01-14 16:23:30 -08001174 const std::string image_path = create_image_filename(out_oat_path);
1175 if (image_path.empty()) {
1176 // Happens when the out_oat_path has an unknown extension.
1177 return Dex2oatFileWrapper();
1178 }
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001179
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001180 // In case there is a stale image, remove it now. Ignore any error.
1181 unlink(image_path.c_str());
1182
1183 // Not enabled, exit.
1184 if (!generate_app_image) {
Nicolas Geoffrayaa17ab42017-08-15 14:51:05 +01001185 return Dex2oatFileWrapper();
1186 }
Mathieu Chartier9b2da082018-10-26 13:23:11 -07001187 std::string app_image_format = GetProperty("dalvik.vm.appimageformat", "");
1188 if (app_image_format.empty()) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001189 return Dex2oatFileWrapper();
1190 }
1191 // Recreate is true since we do not want to modify a mapped image. If the app is
1192 // already running and we modify the image file, it can cause crashes (b/27493510).
1193 Dex2oatFileWrapper wrapper_fd(
1194 open_output_file(image_path.c_str(), true /*recreate*/, 0600 /*permissions*/),
1195 [image_path]() { unlink(image_path.c_str()); });
1196 if (wrapper_fd.get() < 0) {
1197 // Could not create application image file. Go on since we can compile without it.
1198 LOG(ERROR) << "installd could not create '" << image_path
1199 << "' for image file during dexopt";
1200 // If we have a valid image file path but no image fd, explicitly erase the image file.
1201 if (unlink(image_path.c_str()) < 0) {
1202 if (errno != ENOENT) {
1203 PLOG(ERROR) << "Couldn't unlink image file " << image_path;
1204 }
1205 }
1206 } else if (!set_permissions_and_ownership(
Calin Juravle2289c0a2017-02-15 12:44:14 -08001207 wrapper_fd.get(), is_public, uid, image_path.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001208 ALOGE("installd cannot set owner '%s' for image during dexopt\n", image_path.c_str());
1209 wrapper_fd.reset(-1);
1210 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001211
Calin Juravle7a570e82017-01-14 16:23:30 -08001212 return wrapper_fd;
1213}
1214
1215// Creates the dexopt swap file if necessary and return its fd.
1216// Returns -1 if there's no need for a swap or in case of errors.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001217unique_fd maybe_open_dexopt_swap_file(const char* out_oat_path) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001218 if (!ShouldUseSwapFileForDexopt()) {
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001219 return invalid_unique_fd();
Calin Juravle7a570e82017-01-14 16:23:30 -08001220 }
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001221 auto swap_file_name = std::string(out_oat_path) + ".swap";
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001222 unique_fd swap_fd(open_output_file(
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001223 swap_file_name.c_str(), /*recreate*/true, /*permissions*/0600));
Calin Juravle7a570e82017-01-14 16:23:30 -08001224 if (swap_fd.get() < 0) {
1225 // Could not create swap file. Optimistically go on and hope that we can compile
1226 // without it.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001227 ALOGE("installd could not create '%s' for swap during dexopt\n", swap_file_name.c_str());
Calin Juravle7a570e82017-01-14 16:23:30 -08001228 } else {
1229 // Immediately unlink. We don't really want to hit flash.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06001230 if (unlink(swap_file_name.c_str()) < 0) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001231 PLOG(ERROR) << "Couldn't unlink swap file " << swap_file_name;
1232 }
1233 }
1234 return swap_fd;
1235}
1236
1237// Opens the reference profiles if needed.
1238// 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 -08001239Dex2oatFileWrapper maybe_open_reference_profile(const std::string& pkgname,
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001240 const std::string& dex_path, const char* profile_name, bool profile_guided,
Calin Juravle824a64d2018-01-18 20:23:17 -08001241 bool is_public, int uid, bool is_secondary_dex) {
Calin Juravle5bd1c722018-02-01 17:23:54 +00001242 // If we are not profile guided compilation, or we are compiling system server
1243 // do not bother to open the profiles; we won't be using them.
1244 if (!profile_guided || (pkgname[0] == '*')) {
1245 return Dex2oatFileWrapper();
1246 }
1247
1248 // If this is a secondary dex path which is public do not open the profile.
1249 // We cannot compile public secondary dex paths with profiles. That's because
1250 // it will expose how the dex files are used by their owner.
1251 //
1252 // Note that the PackageManager is responsible to set the is_public flag for
1253 // primary apks and we do not check it here. In some cases, e.g. when
1254 // compiling with a public profile from the .dm file the PackageManager will
1255 // set is_public toghether with the profile guided compilation.
1256 if (is_secondary_dex && is_public) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001257 return Dex2oatFileWrapper();
Jeff Sharkey90aff262016-12-12 14:28:24 -07001258 }
Calin Juravle114f0812017-03-08 19:05:07 -08001259
1260 // Open reference profile in read only mode as dex2oat does not get write permissions.
Calin Juravlec4f6a0b2018-02-01 01:27:24 +00001261 std::string location;
1262 if (is_secondary_dex) {
1263 location = dex_path;
1264 } else {
1265 if (profile_name == nullptr) {
1266 // This path is taken for system server re-compilation lunched from ZygoteInit.
1267 return Dex2oatFileWrapper();
1268 } else {
1269 location = profile_name;
1270 }
1271 }
Calin Juravle824a64d2018-01-18 20:23:17 -08001272 unique_fd ufd = open_reference_profile(uid, pkgname, location, /*read_write*/false,
1273 is_secondary_dex);
1274 const auto& cleanup = [pkgname, location, is_secondary_dex]() {
1275 clear_reference_profile(pkgname, location, is_secondary_dex);
Calin Juravle114f0812017-03-08 19:05:07 -08001276 };
1277 return Dex2oatFileWrapper(ufd.release(), cleanup);
Calin Juravle7a570e82017-01-14 16:23:30 -08001278}
Jeff Sharkey90aff262016-12-12 14:28:24 -07001279
Calin Juravle7a570e82017-01-14 16:23:30 -08001280// Opens the vdex files and assigns the input fd to in_vdex_wrapper_fd and the output fd to
1281// out_vdex_wrapper_fd. Returns true for success or false in case of errors.
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001282bool open_vdex_files_for_dex2oat(const char* apk_path, const char* out_oat_path, int dexopt_needed,
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001283 const char* instruction_set, bool is_public, int uid, bool is_secondary_dex,
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001284 bool profile_guided, Dex2oatFileWrapper* in_vdex_wrapper_fd,
Calin Juravle7a570e82017-01-14 16:23:30 -08001285 Dex2oatFileWrapper* out_vdex_wrapper_fd) {
1286 CHECK(in_vdex_wrapper_fd != nullptr);
1287 CHECK(out_vdex_wrapper_fd != nullptr);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001288 // Open the existing VDEX. We do this before creating the new output VDEX, which will
1289 // unlink the old one.
Richard Uhler76cc0272016-12-08 10:46:35 +00001290 char in_odex_path[PKG_PATH_MAX];
1291 int dexopt_action = abs(dexopt_needed);
1292 bool is_odex_location = dexopt_needed < 0;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001293 std::string in_vdex_path_str;
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001294
1295 // Infer the name of the output VDEX.
1296 const std::string out_vdex_path_str = create_vdex_filename(out_oat_path);
1297 if (out_vdex_path_str.empty()) {
1298 return false;
1299 }
1300
1301 bool update_vdex_in_place = false;
Nicolas Geoffray3c95f2d2017-04-24 13:34:59 +00001302 if (dexopt_action != DEX2OAT_FROM_SCRATCH) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07001303 // Open the possibly existing vdex. If none exist, we pass -1 to dex2oat for input-vdex-fd.
1304 const char* path = nullptr;
1305 if (is_odex_location) {
1306 if (calculate_odex_file_path(in_odex_path, apk_path, instruction_set)) {
1307 path = in_odex_path;
1308 } else {
1309 ALOGE("installd cannot compute input vdex location for '%s'\n", apk_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001310 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001311 }
1312 } else {
1313 path = out_oat_path;
1314 }
1315 in_vdex_path_str = create_vdex_filename(path);
1316 if (in_vdex_path_str.empty()) {
1317 ALOGE("installd cannot compute input vdex location for '%s'\n", path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001318 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001319 }
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001320 // We can update in place when all these conditions are met:
1321 // 1) The vdex location to write to is the same as the vdex location to read (vdex files
1322 // on /system typically cannot be updated in place).
1323 // 2) We dex2oat due to boot image change, because we then know the existing vdex file
1324 // cannot be currently used by a running process.
1325 // 3) We are not doing a profile guided compilation, because dexlayout requires two
1326 // different vdex files to operate.
1327 update_vdex_in_place =
1328 (in_vdex_path_str == out_vdex_path_str) &&
1329 (dexopt_action == DEX2OAT_FOR_BOOT_IMAGE) &&
1330 !profile_guided;
1331 if (update_vdex_in_place) {
1332 // Open the file read-write to be able to update it.
1333 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDWR, 0));
1334 if (in_vdex_wrapper_fd->get() == -1) {
1335 // If we failed to open the file, we cannot update it in place.
1336 update_vdex_in_place = false;
1337 }
1338 } else {
1339 in_vdex_wrapper_fd->reset(open(in_vdex_path_str.c_str(), O_RDONLY, 0));
1340 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001341 }
1342
Nicolas Geoffrayb03814f2017-06-05 12:38:10 +00001343 // If we are updating the vdex in place, we do not need to recreate a vdex,
1344 // and can use the same existing one.
1345 if (update_vdex_in_place) {
1346 // We unlink the file in case the invocation of dex2oat fails, to ensure we don't
1347 // have bogus stale vdex files.
1348 out_vdex_wrapper_fd->reset(
1349 in_vdex_wrapper_fd->get(),
1350 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1351 // Disable auto close for the in wrapper fd (it will be done when destructing the out
1352 // wrapper).
1353 in_vdex_wrapper_fd->DisableAutoClose();
1354 } else {
1355 out_vdex_wrapper_fd->reset(
1356 open_output_file(out_vdex_path_str.c_str(), /*recreate*/true, /*permissions*/0644),
1357 [out_vdex_path_str]() { unlink(out_vdex_path_str.c_str()); });
1358 if (out_vdex_wrapper_fd->get() < 0) {
1359 ALOGE("installd cannot open vdex'%s' during dexopt\n", out_vdex_path_str.c_str());
1360 return false;
1361 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07001362 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001363 if (!set_permissions_and_ownership(out_vdex_wrapper_fd->get(), is_public, uid,
Calin Juravle2289c0a2017-02-15 12:44:14 -08001364 out_vdex_path_str.c_str(), is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001365 ALOGE("installd cannot set owner '%s' for vdex during dexopt\n", out_vdex_path_str.c_str());
1366 return false;
1367 }
1368
1369 // If we got here we successfully opened the vdex files.
1370 return true;
1371}
1372
1373// Opens the output oat file for the given apk.
1374// If successful it stores the output path into out_oat_path and returns true.
1375Dex2oatFileWrapper open_oat_out_file(const char* apk_path, const char* oat_dir,
Calin Juravle80a21252017-01-17 14:43:25 -08001376 bool is_public, int uid, const char* instruction_set, bool is_secondary_dex,
1377 char* out_oat_path) {
1378 if (!create_oat_out_path(apk_path, instruction_set, oat_dir, is_secondary_dex, out_oat_path)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001379 return Dex2oatFileWrapper();
1380 }
1381 const std::string out_oat_path_str(out_oat_path);
1382 Dex2oatFileWrapper wrapper_fd(
1383 open_output_file(out_oat_path, /*recreate*/true, /*permissions*/0644),
1384 [out_oat_path_str]() { unlink(out_oat_path_str.c_str()); });
1385 if (wrapper_fd.get() < 0) {
Calin Juravle80a21252017-01-17 14:43:25 -08001386 PLOG(ERROR) << "installd cannot open output during dexopt" << out_oat_path;
Calin Juravle2289c0a2017-02-15 12:44:14 -08001387 } else if (!set_permissions_and_ownership(
1388 wrapper_fd.get(), is_public, uid, out_oat_path, is_secondary_dex)) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001389 ALOGE("installd cannot set owner '%s' for output during dexopt\n", out_oat_path);
1390 wrapper_fd.reset(-1);
1391 }
1392 return wrapper_fd;
1393}
1394
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001395// Creates RDONLY fds for oat and vdex files, if exist.
1396// Returns false if it fails to create oat out path for the given apk path.
1397// Note that the method returns true even if the files could not be opened.
1398bool maybe_open_oat_and_vdex_file(const std::string& apk_path,
1399 const std::string& oat_dir,
1400 const std::string& instruction_set,
1401 bool is_secondary_dex,
1402 unique_fd* oat_file_fd,
1403 unique_fd* vdex_file_fd) {
1404 char oat_path[PKG_PATH_MAX];
1405 if (!create_oat_out_path(apk_path.c_str(),
1406 instruction_set.c_str(),
1407 oat_dir.c_str(),
1408 is_secondary_dex,
1409 oat_path)) {
Calin Juravle7d765462017-09-04 15:57:10 -07001410 LOG(ERROR) << "Could not create oat out path for "
1411 << apk_path << " with oat dir " << oat_dir;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001412 return false;
1413 }
1414 oat_file_fd->reset(open(oat_path, O_RDONLY));
1415 if (oat_file_fd->get() < 0) {
1416 PLOG(INFO) << "installd cannot open oat file during dexopt" << oat_path;
1417 }
1418
1419 std::string vdex_filename = create_vdex_filename(oat_path);
1420 vdex_file_fd->reset(open(vdex_filename.c_str(), O_RDONLY));
1421 if (vdex_file_fd->get() < 0) {
1422 PLOG(INFO) << "installd cannot open vdex file during dexopt" << vdex_filename;
1423 }
1424
1425 return true;
1426}
1427
Calin Juravle7a570e82017-01-14 16:23:30 -08001428// Updates the access times of out_oat_path based on those from apk_path.
1429void update_out_oat_access_times(const char* apk_path, const char* out_oat_path) {
1430 struct stat input_stat;
1431 memset(&input_stat, 0, sizeof(input_stat));
1432 if (stat(apk_path, &input_stat) != 0) {
1433 PLOG(ERROR) << "Could not stat " << apk_path << " during dexopt";
1434 return;
1435 }
1436
1437 struct utimbuf ut;
1438 ut.actime = input_stat.st_atime;
1439 ut.modtime = input_stat.st_mtime;
1440 if (utime(out_oat_path, &ut) != 0) {
1441 PLOG(WARNING) << "Could not update access times for " << apk_path << " during dexopt";
1442 }
1443}
1444
Calin Juravle80a21252017-01-17 14:43:25 -08001445// Runs (execv) dexoptanalyzer on the given arguments.
Calin Juravle114f0812017-03-08 19:05:07 -08001446// The analyzer will check if the dex_file needs to be (re)compiled to match the compiler_filter.
1447// If this is for a profile guided compilation, profile_was_updated will tell whether or not
1448// the profile has changed.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001449class RunDexoptAnalyzer : public ExecVHelper {
1450 public:
1451 RunDexoptAnalyzer(const std::string& dex_file,
1452 int vdex_fd,
1453 int oat_fd,
1454 int zip_fd,
1455 const std::string& instruction_set,
1456 const std::string& compiler_filter,
1457 bool profile_was_updated,
1458 bool downgrade,
1459 const char* class_loader_context) {
1460 CHECK_GE(zip_fd, 0);
1461 const char* dexoptanalyzer_bin =
Andreas Gampe3a77feb2018-12-10 23:13:49 +00001462 is_debug_runtime()
1463 ? "/system/bin/dexoptanalyzerd"
1464 : "/system/bin/dexoptanalyzer";
Calin Juravle80a21252017-01-17 14:43:25 -08001465
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001466 std::string dex_file_arg = "--dex-file=" + dex_file;
1467 std::string oat_fd_arg = "--oat-fd=" + std::to_string(oat_fd);
1468 std::string vdex_fd_arg = "--vdex-fd=" + std::to_string(vdex_fd);
1469 std::string zip_fd_arg = "--zip-fd=" + std::to_string(zip_fd);
1470 std::string isa_arg = "--isa=" + instruction_set;
1471 std::string compiler_filter_arg = "--compiler-filter=" + compiler_filter;
1472 const char* assume_profile_changed = "--assume-profile-changed";
1473 const char* downgrade_flag = "--downgrade";
1474 std::string class_loader_context_arg = "--class-loader-context=";
1475 if (class_loader_context != nullptr) {
1476 class_loader_context_arg += class_loader_context;
1477 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001478
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001479 // program name, dex file, isa, filter
1480 AddArg(dex_file_arg);
1481 AddArg(isa_arg);
1482 AddArg(compiler_filter_arg);
1483 if (oat_fd >= 0) {
1484 AddArg(oat_fd_arg);
1485 }
1486 if (vdex_fd >= 0) {
1487 AddArg(vdex_fd_arg);
1488 }
1489 AddArg(zip_fd_arg.c_str());
1490 if (profile_was_updated) {
1491 AddArg(assume_profile_changed);
1492 }
1493 if (downgrade) {
1494 AddArg(downgrade_flag);
1495 }
1496 if (class_loader_context != nullptr) {
1497 AddArg(class_loader_context_arg.c_str());
1498 }
Mathieu Chartier31636522018-11-09 23:53:07 +00001499
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001500 PrepareArgs(dexoptanalyzer_bin);
1501 }
1502};
Calin Juravle80a21252017-01-17 14:43:25 -08001503
1504// Prepares the oat dir for the secondary dex files.
Calin Juravle114f0812017-03-08 19:05:07 -08001505static bool prepare_secondary_dex_oat_dir(const std::string& dex_path, int uid,
Calin Juravle7d765462017-09-04 15:57:10 -07001506 const char* instruction_set) {
Calin Juravle114f0812017-03-08 19:05:07 -08001507 unsigned long dirIndex = dex_path.rfind('/');
Calin Juravle80a21252017-01-17 14:43:25 -08001508 if (dirIndex == std::string::npos) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001509 LOG(ERROR ) << "Unexpected dir structure for secondary dex " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001510 return false;
1511 }
Calin Juravle114f0812017-03-08 19:05:07 -08001512 std::string dex_dir = dex_path.substr(0, dirIndex);
Calin Juravle80a21252017-01-17 14:43:25 -08001513
Calin Juravle80a21252017-01-17 14:43:25 -08001514 // Create oat file output directory.
Calin Juravleebc8a792017-04-04 20:21:05 -07001515 mode_t oat_dir_mode = S_IRWXU | S_IRWXG | S_IXOTH;
1516 if (prepare_app_cache_dir(dex_dir, "oat", oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001517 LOG(ERROR) << "Could not prepare oat dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001518 return false;
1519 }
1520
1521 char oat_dir[PKG_PATH_MAX];
Calin Juravle114f0812017-03-08 19:05:07 -08001522 snprintf(oat_dir, PKG_PATH_MAX, "%s/oat", dex_dir.c_str());
Calin Juravle80a21252017-01-17 14:43:25 -08001523
Calin Juravle7d765462017-09-04 15:57:10 -07001524 if (prepare_app_cache_dir(oat_dir, instruction_set, oat_dir_mode, uid, uid) != 0) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001525 LOG(ERROR) << "Could not prepare oat/isa dir for secondary dex: " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001526 return false;
1527 }
1528
1529 return true;
1530}
1531
Calin Juravle7d765462017-09-04 15:57:10 -07001532// Return codes for identifying the reason why dexoptanalyzer was not invoked when processing
1533// secondary dex files. This return codes are returned by the child process created for
1534// analyzing secondary dex files in process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001535
Andreas Gampe194fe422018-02-28 20:16:19 -08001536enum DexoptAnalyzerSkipCodes {
1537 // The dexoptanalyzer was not invoked because of validation or IO errors.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001538 // Specific errors are encoded in the name.
1539 kSecondaryDexDexoptAnalyzerSkippedValidatePath = 200,
1540 kSecondaryDexDexoptAnalyzerSkippedOpenZip = 201,
1541 kSecondaryDexDexoptAnalyzerSkippedPrepareDir = 202,
1542 kSecondaryDexDexoptAnalyzerSkippedOpenOutput = 203,
1543 kSecondaryDexDexoptAnalyzerSkippedFailExec = 204,
Andreas Gampe194fe422018-02-28 20:16:19 -08001544 // The dexoptanalyzer was not invoked because the dex file does not exist anymore.
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001545 kSecondaryDexDexoptAnalyzerSkippedNoFile = 205,
Andreas Gampe194fe422018-02-28 20:16:19 -08001546};
Calin Juravle7d765462017-09-04 15:57:10 -07001547
1548// Verifies the result of analyzing secondary dex files from process_secondary_dex_dexopt.
Calin Juravle80a21252017-01-17 14:43:25 -08001549// If the result is valid returns true and sets dexopt_needed_out to a valid value.
1550// Returns false for errors or unexpected result values.
Calin Juravle7d765462017-09-04 15:57:10 -07001551// The result is expected to be either one of SECONDARY_DEX_* codes or a valid exit code
1552// of dexoptanalyzer.
1553static bool process_secondary_dexoptanalyzer_result(const std::string& dex_path, int result,
Andreas Gampe194fe422018-02-28 20:16:19 -08001554 int* dexopt_needed_out, std::string* error_msg) {
Calin Juravle80a21252017-01-17 14:43:25 -08001555 // The result values are defined in dexoptanalyzer.
1556 switch (result) {
Calin Juravle7d765462017-09-04 15:57:10 -07001557 case 0: // dexoptanalyzer: no_dexopt_needed
Calin Juravle80a21252017-01-17 14:43:25 -08001558 *dexopt_needed_out = NO_DEXOPT_NEEDED; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001559 case 1: // dexoptanalyzer: dex2oat_from_scratch
Calin Juravle80a21252017-01-17 14:43:25 -08001560 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001561 case 4: // dexoptanalyzer: dex2oat_for_bootimage_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001562 *dexopt_needed_out = -DEX2OAT_FOR_BOOT_IMAGE; return true;
Vladimir Marko1752a112018-09-03 18:15:16 +01001563 case 5: // dexoptanalyzer: dex2oat_for_filter_odex
Calin Juravle80a21252017-01-17 14:43:25 -08001564 *dexopt_needed_out = -DEX2OAT_FOR_FILTER; return true;
Calin Juravle7d765462017-09-04 15:57:10 -07001565 case 2: // dexoptanalyzer: dex2oat_for_bootimage_oat
1566 case 3: // dexoptanalyzer: dex2oat_for_filter_oat
Andreas Gampe194fe422018-02-28 20:16:19 -08001567 *error_msg = StringPrintf("Dexoptanalyzer return the status of an oat file."
1568 " Expected odex file status for secondary dex %s"
1569 " : dexoptanalyzer result=%d",
1570 dex_path.c_str(),
1571 result);
Calin Juravle80a21252017-01-17 14:43:25 -08001572 return false;
Andreas Gampe194fe422018-02-28 20:16:19 -08001573 }
1574
1575 // Use a second switch for enum switch-case analysis.
1576 switch (static_cast<DexoptAnalyzerSkipCodes>(result)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001577 case kSecondaryDexDexoptAnalyzerSkippedNoFile:
Calin Juravle7d765462017-09-04 15:57:10 -07001578 // If the file does not exist there's no need for dexopt.
1579 *dexopt_needed_out = NO_DEXOPT_NEEDED;
1580 return true;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001581
1582 case kSecondaryDexDexoptAnalyzerSkippedValidatePath:
1583 *error_msg = "Dexoptanalyzer path validation failed";
1584 return false;
1585 case kSecondaryDexDexoptAnalyzerSkippedOpenZip:
1586 *error_msg = "Dexoptanalyzer open zip failed";
1587 return false;
1588 case kSecondaryDexDexoptAnalyzerSkippedPrepareDir:
1589 *error_msg = "Dexoptanalyzer dir preparation failed";
1590 return false;
1591 case kSecondaryDexDexoptAnalyzerSkippedOpenOutput:
1592 *error_msg = "Dexoptanalyzer open output failed";
1593 return false;
1594 case kSecondaryDexDexoptAnalyzerSkippedFailExec:
1595 *error_msg = "Dexoptanalyzer failed to execute";
Calin Juravle80a21252017-01-17 14:43:25 -08001596 return false;
1597 }
Andreas Gampe194fe422018-02-28 20:16:19 -08001598
1599 *error_msg = StringPrintf("Unexpected result from analyzing secondary dex %s result=%d",
1600 dex_path.c_str(),
1601 result);
1602 return false;
Calin Juravle80a21252017-01-17 14:43:25 -08001603}
1604
Calin Juravle7d765462017-09-04 15:57:10 -07001605enum SecondaryDexAccess {
1606 kSecondaryDexAccessReadOk = 0,
1607 kSecondaryDexAccessDoesNotExist = 1,
1608 kSecondaryDexAccessPermissionError = 2,
1609 kSecondaryDexAccessIOError = 3
1610};
1611
1612static SecondaryDexAccess check_secondary_dex_access(const std::string& dex_path) {
1613 // Check if the path exists and can be read. If not, there's nothing to do.
1614 if (access(dex_path.c_str(), R_OK) == 0) {
1615 return kSecondaryDexAccessReadOk;
1616 } else {
1617 if (errno == ENOENT) {
1618 LOG(INFO) << "Secondary dex does not exist: " << dex_path;
1619 return kSecondaryDexAccessDoesNotExist;
1620 } else {
1621 PLOG(ERROR) << "Could not access secondary dex " << dex_path;
1622 return errno == EACCES
1623 ? kSecondaryDexAccessPermissionError
1624 : kSecondaryDexAccessIOError;
1625 }
1626 }
1627}
1628
1629static bool is_file_public(const std::string& filename) {
1630 struct stat file_stat;
1631 if (stat(filename.c_str(), &file_stat) == 0) {
1632 return (file_stat.st_mode & S_IROTH) != 0;
1633 }
1634 return false;
1635}
1636
1637// Create the oat file structure for the secondary dex 'dex_path' and assign
1638// the individual path component to the 'out_' parameters.
1639static bool create_secondary_dex_oat_layout(const std::string& dex_path, const std::string& isa,
Andreas Gampe194fe422018-02-28 20:16:19 -08001640 char* out_oat_dir, char* out_oat_isa_dir, char* out_oat_path, std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001641 size_t dirIndex = dex_path.rfind('/');
1642 if (dirIndex == std::string::npos) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001643 *error_msg = std::string("Unexpected dir structure for dex file ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001644 return false;
1645 }
1646 // TODO(calin): we have similar computations in at lest 3 other places
1647 // (InstalldNativeService, otapropt and dexopt). Unify them and get rid of snprintf by
1648 // using string append.
1649 std::string apk_dir = dex_path.substr(0, dirIndex);
1650 snprintf(out_oat_dir, PKG_PATH_MAX, "%s/oat", apk_dir.c_str());
1651 snprintf(out_oat_isa_dir, PKG_PATH_MAX, "%s/%s", out_oat_dir, isa.c_str());
1652
1653 if (!create_oat_out_path(dex_path.c_str(), isa.c_str(), out_oat_dir,
1654 /*is_secondary_dex*/true, out_oat_path)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001655 *error_msg = std::string("Could not create oat path for secondary dex ").append(dex_path);
Calin Juravle7d765462017-09-04 15:57:10 -07001656 return false;
1657 }
1658 return true;
1659}
1660
1661// Validate that the dexopt_flags contain a valid storage flag and convert that to an installd
1662// recognized storage flags (FLAG_STORAGE_CE or FLAG_STORAGE_DE).
Andreas Gampe194fe422018-02-28 20:16:19 -08001663static bool validate_dexopt_storage_flags(int dexopt_flags,
1664 int* out_storage_flag,
1665 std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001666 if ((dexopt_flags & DEXOPT_STORAGE_CE) != 0) {
1667 *out_storage_flag = FLAG_STORAGE_CE;
1668 if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001669 *error_msg = "Ambiguous secondary dex storage flag. Both, CE and DE, flags are set";
Calin Juravle7d765462017-09-04 15:57:10 -07001670 return false;
1671 }
1672 } else if ((dexopt_flags & DEXOPT_STORAGE_DE) != 0) {
1673 *out_storage_flag = FLAG_STORAGE_DE;
1674 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001675 *error_msg = "Secondary dex storage flag must be set";
Calin Juravle7d765462017-09-04 15:57:10 -07001676 return false;
1677 }
1678 return true;
1679}
1680
Calin Juravlec9eab382017-01-25 01:17:17 -08001681// 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 -08001682// be compiled. Returns false for errors (logged) or true if the secondary dex path was process
1683// successfully.
Calin Juravleebc8a792017-04-04 20:21:05 -07001684// When returning true, the output parameters will be:
1685// - is_public_out: whether or not the oat file should not be made public
1686// - dexopt_needed_out: valid OatFileAsssitant::DexOptNeeded
1687// - oat_dir_out: the oat dir path where the oat file should be stored
Calin Juravle7d765462017-09-04 15:57:10 -07001688static bool process_secondary_dex_dexopt(const std::string& dex_path, const char* pkgname,
Calin Juravle80a21252017-01-17 14:43:25 -08001689 int dexopt_flags, const char* volume_uuid, int uid, const char* instruction_set,
Calin Juravleebc8a792017-04-04 20:21:05 -07001690 const char* compiler_filter, bool* is_public_out, int* dexopt_needed_out,
Andreas Gampe194fe422018-02-28 20:16:19 -08001691 std::string* oat_dir_out, bool downgrade, const char* class_loader_context,
1692 /* out */ std::string* error_msg) {
Calin Juravle7d765462017-09-04 15:57:10 -07001693 LOG(DEBUG) << "Processing secondary dex path " << dex_path;
Calin Juravle80a21252017-01-17 14:43:25 -08001694 int storage_flag;
Andreas Gampe194fe422018-02-28 20:16:19 -08001695 if (!validate_dexopt_storage_flags(dexopt_flags, &storage_flag, error_msg)) {
1696 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001697 return false;
1698 }
Calin Juravle7d765462017-09-04 15:57:10 -07001699 // Compute the oat dir as it's not easy to extract it from the child computation.
1700 char oat_path[PKG_PATH_MAX];
1701 char oat_dir[PKG_PATH_MAX];
1702 char oat_isa_dir[PKG_PATH_MAX];
1703 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08001704 dex_path, instruction_set, oat_dir, oat_isa_dir, oat_path, error_msg)) {
1705 LOG(ERROR) << "Could not create secondary odex layout: " << *error_msg;
Calin Juravled23dee72017-07-06 16:29:11 -07001706 return false;
1707 }
Calin Juravle7d765462017-09-04 15:57:10 -07001708 oat_dir_out->assign(oat_dir);
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001709
Calin Juravle80a21252017-01-17 14:43:25 -08001710 pid_t pid = fork();
1711 if (pid == 0) {
1712 // child -- drop privileges before continuing.
1713 drop_capabilities(uid);
Calin Juravle7d765462017-09-04 15:57:10 -07001714
1715 // Validate the path structure.
1716 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid, uid, storage_flag)) {
1717 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001718 _exit(kSecondaryDexDexoptAnalyzerSkippedValidatePath);
Calin Juravle7d765462017-09-04 15:57:10 -07001719 }
1720
1721 // Open the dex file.
1722 unique_fd zip_fd;
1723 zip_fd.reset(open(dex_path.c_str(), O_RDONLY));
1724 if (zip_fd.get() < 0) {
1725 if (errno == ENOENT) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001726 _exit(kSecondaryDexDexoptAnalyzerSkippedNoFile);
Calin Juravle7d765462017-09-04 15:57:10 -07001727 } else {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001728 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenZip);
Calin Juravle7d765462017-09-04 15:57:10 -07001729 }
1730 }
1731
1732 // Prepare the oat directories.
1733 if (!prepare_secondary_dex_oat_dir(dex_path, uid, instruction_set)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001734 _exit(kSecondaryDexDexoptAnalyzerSkippedPrepareDir);
Calin Juravle7d765462017-09-04 15:57:10 -07001735 }
1736
1737 // Open the vdex/oat files if any.
1738 unique_fd oat_file_fd;
1739 unique_fd vdex_file_fd;
1740 if (!maybe_open_oat_and_vdex_file(dex_path,
1741 *oat_dir_out,
1742 instruction_set,
1743 true /* is_secondary_dex */,
1744 &oat_file_fd,
1745 &vdex_file_fd)) {
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001746 _exit(kSecondaryDexDexoptAnalyzerSkippedOpenOutput);
Calin Juravle7d765462017-09-04 15:57:10 -07001747 }
1748
1749 // Analyze profiles.
Calin Juravle824a64d2018-01-18 20:23:17 -08001750 bool profile_was_updated = analyze_profiles(uid, pkgname, dex_path,
1751 /*is_secondary_dex*/true);
Calin Juravle7d765462017-09-04 15:57:10 -07001752
1753 // Run dexoptanalyzer to get dexopt_needed code. This is not expected to return.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001754 // Note that we do not do it before the fork since opening the files is required to happen
1755 // after forking.
1756 RunDexoptAnalyzer run_dexopt_analyzer(dex_path,
1757 vdex_file_fd.get(),
1758 oat_file_fd.get(),
1759 zip_fd.get(),
1760 instruction_set,
1761 compiler_filter, profile_was_updated,
1762 downgrade,
1763 class_loader_context);
1764 run_dexopt_analyzer.Exec(kSecondaryDexDexoptAnalyzerSkippedFailExec);
Calin Juravle80a21252017-01-17 14:43:25 -08001765 }
1766
1767 /* parent */
Calin Juravle80a21252017-01-17 14:43:25 -08001768 int result = wait_child(pid);
1769 if (!WIFEXITED(result)) {
Andreas Gampe194fe422018-02-28 20:16:19 -08001770 *error_msg = StringPrintf("dexoptanalyzer failed for path %s: 0x%04x",
1771 dex_path.c_str(),
1772 result);
1773 LOG(ERROR) << *error_msg;
Calin Juravle80a21252017-01-17 14:43:25 -08001774 return false;
1775 }
1776 result = WEXITSTATUS(result);
Calin Juravle7d765462017-09-04 15:57:10 -07001777 // Check that we successfully executed dexoptanalyzer.
Andreas Gampe194fe422018-02-28 20:16:19 -08001778 bool success = process_secondary_dexoptanalyzer_result(dex_path,
1779 result,
1780 dexopt_needed_out,
1781 error_msg);
1782 if (!success) {
1783 LOG(ERROR) << *error_msg;
1784 }
Calin Juravle7d765462017-09-04 15:57:10 -07001785
1786 LOG(DEBUG) << "Processed secondary dex file " << dex_path << " result=" << result;
1787
Calin Juravle80a21252017-01-17 14:43:25 -08001788 // Run dexopt only if needed or forced.
Calin Juravle7d765462017-09-04 15:57:10 -07001789 // Note that dexoptanalyzer is executed even if force compilation is enabled (because it
1790 // makes the code simpler; force compilation is only needed during tests).
1791 if (success &&
Andreas Gampe3008bbe2018-02-28 20:24:48 -08001792 (result != kSecondaryDexDexoptAnalyzerSkippedNoFile) &&
Calin Juravle7d765462017-09-04 15:57:10 -07001793 ((dexopt_flags & DEXOPT_FORCE) != 0)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001794 *dexopt_needed_out = DEX2OAT_FROM_SCRATCH;
1795 }
1796
Calin Juravle7d765462017-09-04 15:57:10 -07001797 // Check if we should make the oat file public.
1798 // Note that if the dex file is not public the compiled code cannot be made public.
1799 // It is ok to check this flag outside in the parent process.
1800 *is_public_out = ((dexopt_flags & DEXOPT_PUBLIC) != 0) && is_file_public(dex_path);
1801
Calin Juravle80a21252017-01-17 14:43:25 -08001802 return success;
1803}
1804
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001805static std::string format_dexopt_error(int status, const char* dex_path) {
1806 if (WIFEXITED(status)) {
1807 int int_code = WEXITSTATUS(status);
1808 const char* code_name = get_return_code_name(static_cast<DexoptReturnCodes>(int_code));
1809 if (code_name != nullptr) {
1810 return StringPrintf("Dex2oat invocation for %s failed: %s", dex_path, code_name);
1811 }
1812 }
1813 return StringPrintf("Dex2oat invocation for %s failed with 0x%04x", dex_path, status);
Andreas Gampe023b2242018-02-28 16:03:25 -08001814}
1815
Calin Juravlec9eab382017-01-25 01:17:17 -08001816int dexopt(const char* dex_path, uid_t uid, const char* pkgname, const char* instruction_set,
Calin Juravle80a21252017-01-17 14:43:25 -08001817 int dexopt_needed, const char* oat_dir, int dexopt_flags, const char* compiler_filter,
Calin Juravle52c45822017-07-13 22:50:21 -07001818 const char* volume_uuid, const char* class_loader_context, const char* se_info,
Calin Juravle62c5a372018-02-01 17:03:23 +00001819 bool downgrade, int target_sdk_version, const char* profile_name,
Andreas Gampe023b2242018-02-28 16:03:25 -08001820 const char* dex_metadata_path, const char* compilation_reason, std::string* error_msg) {
Calin Juravle7a570e82017-01-14 16:23:30 -08001821 CHECK(pkgname != nullptr);
1822 CHECK(pkgname[0] != 0);
Andreas Gampe023b2242018-02-28 16:03:25 -08001823 CHECK(error_msg != nullptr);
Andreas Gamped32eec22018-02-28 16:02:51 -08001824 CHECK_EQ(dexopt_flags & ~DEXOPT_MASK, 0)
1825 << "dexopt flags contains unknown fields: " << dexopt_flags;
Calin Juravle7a570e82017-01-14 16:23:30 -08001826
Calin Juravled23dee72017-07-06 16:29:11 -07001827 if (!validate_dex_path_size(dex_path)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001828 *error_msg = StringPrintf("Failed to validate %s", dex_path);
Calin Juravle52c45822017-07-13 22:50:21 -07001829 return -1;
1830 }
1831
1832 if (class_loader_context != nullptr && strlen(class_loader_context) > PKG_PATH_MAX) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001833 *error_msg = StringPrintf("Class loader context exceeds the allowed size: %s",
1834 class_loader_context);
1835 LOG(ERROR) << *error_msg;
Calin Juravle52c45822017-07-13 22:50:21 -07001836 return -1;
Calin Juravled23dee72017-07-06 16:29:11 -07001837 }
1838
Calin Juravleebc8a792017-04-04 20:21:05 -07001839 bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
Calin Juravle7a570e82017-01-14 16:23:30 -08001840 bool debuggable = (dexopt_flags & DEXOPT_DEBUGGABLE) != 0;
1841 bool boot_complete = (dexopt_flags & DEXOPT_BOOTCOMPLETE) != 0;
1842 bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001843 bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
Andreas Gampea73a0cb2017-11-02 18:14:42 -07001844 bool background_job_compile = (dexopt_flags & DEXOPT_IDLE_BACKGROUND_JOB) != 0;
David Brazdil52249162018-02-12 18:04:59 -08001845 bool enable_hidden_api_checks = (dexopt_flags & DEXOPT_ENABLE_HIDDEN_API_CHECKS) != 0;
Mathieu Chartierf69c2f72018-03-06 13:55:58 -08001846 bool generate_compact_dex = (dexopt_flags & DEXOPT_GENERATE_COMPACT_DEX) != 0;
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001847 bool generate_app_image = (dexopt_flags & DEXOPT_GENERATE_APP_IMAGE) != 0;
Calin Juravle80a21252017-01-17 14:43:25 -08001848
1849 // Check if we're dealing with a secondary dex file and if we need to compile it.
1850 std::string oat_dir_str;
1851 if (is_secondary_dex) {
Calin Juravlec9eab382017-01-25 01:17:17 -08001852 if (process_secondary_dex_dexopt(dex_path, pkgname, dexopt_flags, volume_uuid, uid,
Calin Juravleebc8a792017-04-04 20:21:05 -07001853 instruction_set, compiler_filter, &is_public, &dexopt_needed, &oat_dir_str,
Andreas Gampe194fe422018-02-28 20:16:19 -08001854 downgrade, class_loader_context, error_msg)) {
Calin Juravle80a21252017-01-17 14:43:25 -08001855 oat_dir = oat_dir_str.c_str();
1856 if (dexopt_needed == NO_DEXOPT_NEEDED) {
1857 return 0; // Nothing to do, report success.
1858 }
1859 } else {
Andreas Gampe194fe422018-02-28 20:16:19 -08001860 if (error_msg->empty()) { // TODO: Make this a CHECK.
1861 *error_msg = "Failed processing secondary.";
1862 }
Calin Juravle80a21252017-01-17 14:43:25 -08001863 return -1; // We had an error, logged in the process method.
1864 }
1865 } else {
Calin Juravlec9eab382017-01-25 01:17:17 -08001866 // Currently these flags are only use for secondary dex files.
1867 // Verify that they are not set for primary apks.
Calin Juravle80a21252017-01-17 14:43:25 -08001868 CHECK((dexopt_flags & DEXOPT_STORAGE_CE) == 0);
1869 CHECK((dexopt_flags & DEXOPT_STORAGE_DE) == 0);
1870 }
Calin Juravle7a570e82017-01-14 16:23:30 -08001871
1872 // Open the input file.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001873 unique_fd input_fd(open(dex_path, O_RDONLY, 0));
Calin Juravle7a570e82017-01-14 16:23:30 -08001874 if (input_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001875 *error_msg = StringPrintf("installd cannot open '%s' for input during dexopt", dex_path);
1876 LOG(ERROR) << *error_msg;
Calin Juravle7a570e82017-01-14 16:23:30 -08001877 return -1;
1878 }
1879
1880 // Create the output OAT file.
1881 char out_oat_path[PKG_PATH_MAX];
Calin Juravlec9eab382017-01-25 01:17:17 -08001882 Dex2oatFileWrapper out_oat_fd = open_oat_out_file(dex_path, oat_dir, is_public, uid,
Calin Juravle80a21252017-01-17 14:43:25 -08001883 instruction_set, is_secondary_dex, out_oat_path);
Calin Juravle7a570e82017-01-14 16:23:30 -08001884 if (out_oat_fd.get() < 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001885 *error_msg = "Could not open out oat file.";
Calin Juravle7a570e82017-01-14 16:23:30 -08001886 return -1;
1887 }
1888
1889 // Open vdex files.
1890 Dex2oatFileWrapper in_vdex_fd;
1891 Dex2oatFileWrapper out_vdex_fd;
Shubham Ajmerab6bcd222017-10-19 10:08:03 -07001892 if (!open_vdex_files_for_dex2oat(dex_path, out_oat_path, dexopt_needed, instruction_set,
1893 is_public, uid, is_secondary_dex, profile_guided, &in_vdex_fd, &out_vdex_fd)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001894 *error_msg = "Could not open vdex files.";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001895 return -1;
1896 }
1897
Calin Juravlecb556e32017-04-04 20:22:50 -07001898 // Ensure that the oat dir and the compiler artifacts of secondary dex files have the correct
1899 // selinux context (we generate them on the fly during the dexopt invocation and they don't
1900 // fully inherit their parent context).
1901 // Note that for primary apk the oat files are created before, in a separate installd
1902 // call which also does the restorecon. TODO(calin): unify the paths.
1903 if (is_secondary_dex) {
1904 if (selinux_android_restorecon_pkgdir(oat_dir, se_info, uid,
1905 SELINUX_ANDROID_RESTORECON_RECURSE)) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001906 *error_msg = std::string("Failed to restorecon ").append(oat_dir);
1907 LOG(ERROR) << *error_msg;
Calin Juravlecb556e32017-04-04 20:22:50 -07001908 return -1;
1909 }
1910 }
1911
Jeff Sharkey90aff262016-12-12 14:28:24 -07001912 // Create a swap file if necessary.
Calin Juravle1a0af3b2017-03-09 14:33:33 -08001913 unique_fd swap_fd = maybe_open_dexopt_swap_file(out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001914
Calin Juravle7a570e82017-01-14 16:23:30 -08001915 // Create the app image file if needed.
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -07001916 Dex2oatFileWrapper image_fd = maybe_open_app_image(
1917 out_oat_path, generate_app_image, is_public, uid, is_secondary_dex);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001918
Calin Juravle7a570e82017-01-14 16:23:30 -08001919 // Open the reference profile if needed.
Calin Juravle114f0812017-03-08 19:05:07 -08001920 Dex2oatFileWrapper reference_profile_fd = maybe_open_reference_profile(
Calin Juravle824a64d2018-01-18 20:23:17 -08001921 pkgname, dex_path, profile_name, profile_guided, is_public, uid, is_secondary_dex);
Calin Juravle7a570e82017-01-14 16:23:30 -08001922
Calin Juravle62c5a372018-02-01 17:03:23 +00001923 unique_fd dex_metadata_fd;
1924 if (dex_metadata_path != nullptr) {
1925 dex_metadata_fd.reset(TEMP_FAILURE_RETRY(open(dex_metadata_path, O_RDONLY | O_NOFOLLOW)));
1926 if (dex_metadata_fd.get() < 0) {
1927 PLOG(ERROR) << "Failed to open dex metadata file " << dex_metadata_path;
1928 }
1929 }
1930
Andreas Gampe023b2242018-02-28 16:03:25 -08001931 LOG(VERBOSE) << "DexInv: --- BEGIN '" << dex_path << "' ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001932
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001933 RunDex2Oat runner(input_fd.get(),
1934 out_oat_fd.get(),
1935 in_vdex_fd.get(),
1936 out_vdex_fd.get(),
1937 image_fd.get(),
1938 dex_path,
1939 out_oat_path,
1940 swap_fd.get(),
1941 instruction_set,
1942 compiler_filter,
1943 debuggable,
1944 boot_complete,
1945 background_job_compile,
1946 reference_profile_fd.get(),
1947 class_loader_context,
1948 target_sdk_version,
1949 enable_hidden_api_checks,
1950 generate_compact_dex,
1951 dex_metadata_fd.get(),
1952 compilation_reason);
1953
Jeff Sharkey90aff262016-12-12 14:28:24 -07001954 pid_t pid = fork();
1955 if (pid == 0) {
1956 /* child -- drop privileges before continuing */
1957 drop_capabilities(uid);
1958
Richard Uhler76cc0272016-12-08 10:46:35 +00001959 SetDex2OatScheduling(boot_complete);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001960 if (flock(out_oat_fd.get(), LOCK_EX | LOCK_NB) != 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001961 PLOG(ERROR) << "flock(" << out_oat_path << ") failed";
Andreas Gampefa2dadd2018-02-28 19:52:47 -08001962 _exit(DexoptReturnCodes::kFlock);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001963 }
1964
Mathieu Chartiercc66c442018-11-09 15:57:21 -08001965 runner.Exec(DexoptReturnCodes::kDex2oatExec);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001966 } else {
1967 int res = wait_child(pid);
1968 if (res == 0) {
Andreas Gampe023b2242018-02-28 16:03:25 -08001969 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' (success) ---";
Jeff Sharkey90aff262016-12-12 14:28:24 -07001970 } else {
Andreas Gampe023b2242018-02-28 16:03:25 -08001971 LOG(VERBOSE) << "DexInv: --- END '" << dex_path << "' --- status=0x"
1972 << std::hex << std::setw(4) << res << ", process failed";
1973 *error_msg = format_dexopt_error(res, dex_path);
Andreas Gampe013f02e2017-03-20 18:36:54 -07001974 return res;
Jeff Sharkey90aff262016-12-12 14:28:24 -07001975 }
1976 }
1977
Calin Juravlec9eab382017-01-25 01:17:17 -08001978 update_out_oat_access_times(dex_path, out_oat_path);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001979
1980 // We've been successful, don't delete output.
1981 out_oat_fd.SetCleanup(false);
Calin Juravle7a570e82017-01-14 16:23:30 -08001982 out_vdex_fd.SetCleanup(false);
Jeff Sharkey90aff262016-12-12 14:28:24 -07001983 image_fd.SetCleanup(false);
1984 reference_profile_fd.SetCleanup(false);
1985
1986 return 0;
1987}
1988
Calin Juravlec9eab382017-01-25 01:17:17 -08001989// Try to remove the given directory. Log an error if the directory exists
1990// and is empty but could not be removed.
1991static bool rmdir_if_empty(const char* dir) {
1992 if (rmdir(dir) == 0) {
1993 return true;
1994 }
1995 if (errno == ENOENT || errno == ENOTEMPTY) {
1996 return true;
1997 }
1998 PLOG(ERROR) << "Failed to remove dir: " << dir;
1999 return false;
2000}
2001
2002// Try to unlink the given file. Log an error if the file exists and could not
2003// be unlinked.
2004static bool unlink_if_exists(const std::string& file) {
2005 if (unlink(file.c_str()) == 0) {
2006 return true;
2007 }
2008 if (errno == ENOENT) {
2009 return true;
2010
2011 }
2012 PLOG(ERROR) << "Could not unlink: " << file;
2013 return false;
2014}
2015
Calin Juravle7d765462017-09-04 15:57:10 -07002016enum ReconcileSecondaryDexResult {
2017 kReconcileSecondaryDexExists = 0,
2018 kReconcileSecondaryDexCleanedUp = 1,
2019 kReconcileSecondaryDexValidationError = 2,
2020 kReconcileSecondaryDexCleanUpError = 3,
2021 kReconcileSecondaryDexAccessIOError = 4,
2022};
Calin Juravlec9eab382017-01-25 01:17:17 -08002023
2024// Reconcile the secondary dex 'dex_path' and its generated oat files.
2025// Return true if all the parameters are valid and the secondary dex file was
2026// processed successfully (i.e. the dex_path either exists, or if not, its corresponding
2027// oat/vdex/art files where deleted successfully). In this case, out_secondary_dex_exists
2028// will be true if the secondary dex file still exists. If the secondary dex file does not exist,
2029// the method cleans up any previously generated compiler artifacts (oat, vdex, art).
2030// Return false if there were errors during processing. In this case
2031// out_secondary_dex_exists will be set to false.
2032bool reconcile_secondary_dex_file(const std::string& dex_path,
2033 const std::string& pkgname, int uid, const std::vector<std::string>& isas,
2034 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2035 /*out*/bool* out_secondary_dex_exists) {
Calin Juravle7d765462017-09-04 15:57:10 -07002036 *out_secondary_dex_exists = false; // start by assuming the file does not exist.
Calin Juravlec9eab382017-01-25 01:17:17 -08002037 if (isas.size() == 0) {
2038 LOG(ERROR) << "reconcile_secondary_dex_file called with empty isas vector";
2039 return false;
2040 }
2041
Calin Juravle7d765462017-09-04 15:57:10 -07002042 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2043 LOG(ERROR) << "reconcile_secondary_dex_file called with invalid storage_flag: "
2044 << storage_flag;
Calin Juravlec9eab382017-01-25 01:17:17 -08002045 return false;
2046 }
2047
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002048 // As a security measure we want to unlink art artifacts with the reduced capabilities
2049 // of the package user id. So we fork and drop capabilities in the child.
2050 pid_t pid = fork();
2051 if (pid == 0) {
Calin Juravle7d765462017-09-04 15:57:10 -07002052 /* child -- drop privileges before continuing */
2053 drop_capabilities(uid);
2054
2055 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2056 if (!validate_secondary_dex_path(pkgname.c_str(), dex_path.c_str(), volume_uuid_cstr,
2057 uid, storage_flag)) {
2058 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
2059 _exit(kReconcileSecondaryDexValidationError);
2060 }
2061
2062 SecondaryDexAccess access_check = check_secondary_dex_access(dex_path);
2063 switch (access_check) {
2064 case kSecondaryDexAccessDoesNotExist:
2065 // File does not exist. Proceed with cleaning.
2066 break;
2067 case kSecondaryDexAccessReadOk: _exit(kReconcileSecondaryDexExists);
2068 case kSecondaryDexAccessIOError: _exit(kReconcileSecondaryDexAccessIOError);
2069 case kSecondaryDexAccessPermissionError: _exit(kReconcileSecondaryDexValidationError);
2070 default:
2071 LOG(ERROR) << "Unexpected result from check_secondary_dex_access: " << access_check;
2072 _exit(kReconcileSecondaryDexValidationError);
2073 }
2074
2075 // The secondary dex does not exist anymore or it's. Clear any generated files.
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002076 char oat_path[PKG_PATH_MAX];
2077 char oat_dir[PKG_PATH_MAX];
2078 char oat_isa_dir[PKG_PATH_MAX];
2079 bool result = true;
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002080 for (size_t i = 0; i < isas.size(); i++) {
Andreas Gampe194fe422018-02-28 20:16:19 -08002081 std::string error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002082 if (!create_secondary_dex_oat_layout(
Andreas Gampe194fe422018-02-28 20:16:19 -08002083 dex_path,isas[i], oat_dir, oat_isa_dir, oat_path, &error_msg)) {
2084 LOG(ERROR) << error_msg;
Calin Juravle7d765462017-09-04 15:57:10 -07002085 _exit(kReconcileSecondaryDexValidationError);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002086 }
Calin Juravle51314092017-05-18 15:33:05 -07002087
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002088 // Delete oat/vdex/art files.
2089 result = unlink_if_exists(oat_path) && result;
2090 result = unlink_if_exists(create_vdex_filename(oat_path)) && result;
2091 result = unlink_if_exists(create_image_filename(oat_path)) && result;
Calin Juravlec9eab382017-01-25 01:17:17 -08002092
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002093 // Delete profiles.
2094 std::string current_profile = create_current_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002095 multiuser_get_user_id(uid), pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002096 std::string reference_profile = create_reference_profile_path(
Calin Juravle824a64d2018-01-18 20:23:17 -08002097 pkgname, dex_path, /*is_secondary*/true);
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002098 result = unlink_if_exists(current_profile) && result;
2099 result = unlink_if_exists(reference_profile) && result;
Calin Juravle51314092017-05-18 15:33:05 -07002100
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002101 // We upgraded once the location of current profile for secondary dex files.
2102 // Check for any previous left-overs and remove them as well.
2103 std::string old_current_profile = dex_path + ".prof";
2104 result = unlink_if_exists(old_current_profile);
Calin Juravle3760ad32017-07-27 16:31:55 -07002105
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002106 // Try removing the directories as well, they might be empty.
2107 result = rmdir_if_empty(oat_isa_dir) && result;
2108 result = rmdir_if_empty(oat_dir) && result;
2109 }
Calin Juravle7d765462017-09-04 15:57:10 -07002110 if (!result) {
2111 PLOG(ERROR) << "Failed to clean secondary dex artifacts for location " << dex_path;
2112 }
2113 _exit(result ? kReconcileSecondaryDexCleanedUp : kReconcileSecondaryDexAccessIOError);
Calin Juravlec9eab382017-01-25 01:17:17 -08002114 }
2115
Shubham Ajmerae6d7ad52017-08-25 13:07:44 -07002116 int return_code = wait_child(pid);
Calin Juravle7d765462017-09-04 15:57:10 -07002117 if (!WIFEXITED(return_code)) {
2118 LOG(WARNING) << "reconcile dex failed for location " << dex_path << ": " << return_code;
2119 } else {
2120 return_code = WEXITSTATUS(return_code);
2121 }
2122
2123 LOG(DEBUG) << "Reconcile secondary dex path " << dex_path << " result=" << return_code;
2124
2125 switch (return_code) {
2126 case kReconcileSecondaryDexCleanedUp:
2127 case kReconcileSecondaryDexValidationError:
2128 // If we couldn't validate assume the dex file does not exist.
2129 // This will purge the entry from the PM records.
2130 *out_secondary_dex_exists = false;
2131 return true;
2132 case kReconcileSecondaryDexExists:
2133 *out_secondary_dex_exists = true;
2134 return true;
2135 case kReconcileSecondaryDexAccessIOError:
2136 // We had an access IO error.
2137 // Return false so that we can try again.
2138 // The value of out_secondary_dex_exists does not matter in this case and by convention
2139 // is set to false.
2140 *out_secondary_dex_exists = false;
2141 return false;
2142 default:
2143 LOG(ERROR) << "Unexpected code from reconcile_secondary_dex_file: " << return_code;
2144 *out_secondary_dex_exists = false;
2145 return false;
2146 }
Calin Juravlec9eab382017-01-25 01:17:17 -08002147}
2148
Alan Stokesa25d90c2017-10-16 10:56:00 +01002149// Compute and return the hash (SHA-256) of the secondary dex file at dex_path.
2150// Returns true if all parameters are valid and the hash successfully computed and stored in
2151// out_secondary_dex_hash.
2152// Also returns true with an empty hash if the file does not currently exist or is not accessible to
2153// the app.
2154// For any other errors (e.g. if any of the parameters are invalid) returns false.
2155bool hash_secondary_dex_file(const std::string& dex_path, const std::string& pkgname, int uid,
2156 const std::unique_ptr<std::string>& volume_uuid, int storage_flag,
2157 std::vector<uint8_t>* out_secondary_dex_hash) {
2158 out_secondary_dex_hash->clear();
2159
2160 const char* volume_uuid_cstr = volume_uuid == nullptr ? nullptr : volume_uuid->c_str();
2161
2162 if (storage_flag != FLAG_STORAGE_CE && storage_flag != FLAG_STORAGE_DE) {
2163 LOG(ERROR) << "hash_secondary_dex_file called with invalid storage_flag: "
2164 << storage_flag;
2165 return false;
2166 }
2167
2168 // Pipe to get the hash result back from our child process.
2169 unique_fd pipe_read, pipe_write;
2170 if (!Pipe(&pipe_read, &pipe_write)) {
2171 PLOG(ERROR) << "Failed to create pipe";
2172 return false;
2173 }
2174
2175 // Fork so that actual access to the files is done in the app's own UID, to ensure we only
2176 // access data the app itself can access.
2177 pid_t pid = fork();
2178 if (pid == 0) {
2179 // child -- drop privileges before continuing
2180 drop_capabilities(uid);
2181 pipe_read.reset();
2182
2183 if (!validate_secondary_dex_path(pkgname, dex_path, volume_uuid_cstr, uid, storage_flag)) {
2184 LOG(ERROR) << "Could not validate secondary dex path " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002185 _exit(DexoptReturnCodes::kHashValidatePath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002186 }
2187
2188 unique_fd fd(TEMP_FAILURE_RETRY(open(dex_path.c_str(), O_RDONLY | O_CLOEXEC | O_NOFOLLOW)));
2189 if (fd == -1) {
2190 if (errno == EACCES || errno == ENOENT) {
2191 // Not treated as an error.
2192 _exit(0);
2193 }
2194 PLOG(ERROR) << "Failed to open secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002195 _exit(DexoptReturnCodes::kHashOpenPath);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002196 }
2197
2198 SHA256_CTX ctx;
2199 SHA256_Init(&ctx);
2200
2201 std::vector<uint8_t> buffer(65536);
2202 while (true) {
2203 ssize_t bytes_read = TEMP_FAILURE_RETRY(read(fd, buffer.data(), buffer.size()));
2204 if (bytes_read == 0) {
2205 break;
2206 } else if (bytes_read == -1) {
2207 PLOG(ERROR) << "Failed to read secondary dex " << dex_path;
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002208 _exit(DexoptReturnCodes::kHashReadDex);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002209 }
2210
2211 SHA256_Update(&ctx, buffer.data(), bytes_read);
2212 }
2213
2214 std::array<uint8_t, SHA256_DIGEST_LENGTH> hash;
2215 SHA256_Final(hash.data(), &ctx);
2216 if (!WriteFully(pipe_write, hash.data(), hash.size())) {
Andreas Gampefa2dadd2018-02-28 19:52:47 -08002217 _exit(DexoptReturnCodes::kHashWrite);
Alan Stokesa25d90c2017-10-16 10:56:00 +01002218 }
2219
2220 _exit(0);
2221 }
2222
2223 // parent
2224 pipe_write.reset();
2225
2226 out_secondary_dex_hash->resize(SHA256_DIGEST_LENGTH);
2227 if (!ReadFully(pipe_read, out_secondary_dex_hash->data(), out_secondary_dex_hash->size())) {
2228 out_secondary_dex_hash->clear();
2229 }
2230 return wait_child(pid) == 0;
2231}
2232
Jeff Sharkey90aff262016-12-12 14:28:24 -07002233// Helper for move_ab, so that we can have common failure-case cleanup.
2234static bool unlink_and_rename(const char* from, const char* to) {
2235 // Check whether "from" exists, and if so whether it's regular. If it is, unlink. Otherwise,
2236 // return a failure.
2237 struct stat s;
2238 if (stat(to, &s) == 0) {
2239 if (!S_ISREG(s.st_mode)) {
2240 LOG(ERROR) << from << " is not a regular file to replace for A/B.";
2241 return false;
2242 }
2243 if (unlink(to) != 0) {
2244 LOG(ERROR) << "Could not unlink " << to << " to move A/B.";
2245 return false;
2246 }
2247 } else {
2248 // This may be a permission problem. We could investigate the error code, but we'll just
2249 // let the rename failure do the work for us.
2250 }
2251
2252 // Try to rename "to" to "from."
2253 if (rename(from, to) != 0) {
2254 PLOG(ERROR) << "Could not rename " << from << " to " << to;
2255 return false;
2256 }
2257 return true;
2258}
2259
2260// Move/rename a B artifact (from) to an A artifact (to).
2261static bool move_ab_path(const std::string& b_path, const std::string& a_path) {
2262 // Check whether B exists.
2263 {
2264 struct stat s;
2265 if (stat(b_path.c_str(), &s) != 0) {
2266 // Silently ignore for now. The service calling this isn't smart enough to understand
2267 // lack of artifacts at the moment.
2268 return false;
2269 }
2270 if (!S_ISREG(s.st_mode)) {
2271 LOG(ERROR) << "A/B artifact " << b_path << " is not a regular file.";
2272 // Try to unlink, but swallow errors.
2273 unlink(b_path.c_str());
2274 return false;
2275 }
2276 }
2277
2278 // Rename B to A.
2279 if (!unlink_and_rename(b_path.c_str(), a_path.c_str())) {
2280 // Delete the b_path so we don't try again (or fail earlier).
2281 if (unlink(b_path.c_str()) != 0) {
2282 PLOG(ERROR) << "Could not unlink " << b_path;
2283 }
2284
2285 return false;
2286 }
2287
2288 return true;
2289}
2290
2291bool move_ab(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2292 // Get the current slot suffix. No suffix, no A/B.
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002293 const std::string slot_suffix = GetProperty("ro.boot.slot_suffix", "");
2294 if (slot_suffix.empty()) {
2295 return false;
2296 }
Jeff Sharkey90aff262016-12-12 14:28:24 -07002297
Mathieu Chartier9b2da082018-10-26 13:23:11 -07002298 if (!ValidateTargetSlotSuffix(slot_suffix)) {
2299 LOG(ERROR) << "Target slot suffix not legal: " << slot_suffix;
2300 return false;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002301 }
2302
2303 // Validate other inputs.
2304 if (validate_apk_path(apk_path) != 0) {
2305 LOG(ERROR) << "Invalid apk_path: " << apk_path;
2306 return false;
2307 }
2308 if (validate_apk_path(oat_dir) != 0) {
2309 LOG(ERROR) << "Invalid oat_dir: " << oat_dir;
2310 return false;
2311 }
2312
2313 char a_path[PKG_PATH_MAX];
2314 if (!calculate_oat_file_path(a_path, oat_dir, apk_path, instruction_set)) {
2315 return false;
2316 }
2317 const std::string a_vdex_path = create_vdex_filename(a_path);
2318 const std::string a_image_path = create_image_filename(a_path);
2319
2320 // B path = A path + slot suffix.
2321 const std::string b_path = StringPrintf("%s.%s", a_path, slot_suffix.c_str());
2322 const std::string b_vdex_path = StringPrintf("%s.%s", a_vdex_path.c_str(), slot_suffix.c_str());
2323 const std::string b_image_path = StringPrintf("%s.%s",
2324 a_image_path.c_str(),
2325 slot_suffix.c_str());
2326
2327 bool success = true;
2328 if (move_ab_path(b_path, a_path)) {
2329 if (move_ab_path(b_vdex_path, a_vdex_path)) {
2330 // Note: we can live without an app image. As such, ignore failure to move the image file.
2331 // If we decide to require the app image, or the app image being moved correctly,
2332 // then change accordingly.
2333 constexpr bool kIgnoreAppImageFailure = true;
2334
2335 if (!a_image_path.empty()) {
2336 if (!move_ab_path(b_image_path, a_image_path)) {
2337 unlink(a_image_path.c_str());
2338 if (!kIgnoreAppImageFailure) {
2339 success = false;
2340 }
2341 }
2342 }
2343 } else {
2344 // Cleanup: delete B image, ignore errors.
2345 unlink(b_image_path.c_str());
2346 success = false;
2347 }
2348 } else {
2349 // Cleanup: delete B image, ignore errors.
2350 unlink(b_vdex_path.c_str());
2351 unlink(b_image_path.c_str());
2352 success = false;
2353 }
2354 return success;
2355}
2356
2357bool delete_odex(const char* apk_path, const char* instruction_set, const char* oat_dir) {
2358 // Delete the oat/odex file.
2359 char out_path[PKG_PATH_MAX];
Calin Juravle80a21252017-01-17 14:43:25 -08002360 if (!create_oat_out_path(apk_path, instruction_set, oat_dir,
Calin Juravle114f0812017-03-08 19:05:07 -08002361 /*is_secondary_dex*/false, out_path)) {
Jeff Sharkey90aff262016-12-12 14:28:24 -07002362 return false;
2363 }
2364
2365 // In case of a permission failure report the issue. Otherwise just print a warning.
2366 auto unlink_and_check = [](const char* path) -> bool {
2367 int result = unlink(path);
2368 if (result != 0) {
2369 if (errno == EACCES || errno == EPERM) {
2370 PLOG(ERROR) << "Could not unlink " << path;
2371 return false;
2372 }
2373 PLOG(WARNING) << "Could not unlink " << path;
2374 }
2375 return true;
2376 };
2377
2378 // Delete the oat/odex file.
2379 bool return_value_oat = unlink_and_check(out_path);
2380
2381 // Derive and delete the app image.
2382 bool return_value_art = unlink_and_check(create_image_filename(out_path).c_str());
2383
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002384 // Derive and delete the vdex file.
2385 bool return_value_vdex = unlink_and_check(create_vdex_filename(out_path).c_str());
2386
Jeff Sharkey90aff262016-12-12 14:28:24 -07002387 // Report success.
Nicolas Geoffray192fb962017-05-25 13:58:06 +01002388 return return_value_oat && return_value_art && return_value_vdex;
Jeff Sharkey90aff262016-12-12 14:28:24 -07002389}
2390
Jeff Sharkeyc1149c92017-09-21 14:51:09 -06002391static bool is_absolute_path(const std::string& path) {
2392 if (path.find('/') != 0 || path.find("..") != std::string::npos) {
2393 LOG(ERROR) << "Invalid absolute path " << path;
2394 return false;
2395 } else {
2396 return true;
2397 }
2398}
2399
2400static bool is_valid_instruction_set(const std::string& instruction_set) {
2401 // TODO: add explicit whitelisting of instruction sets
2402 if (instruction_set.find('/') != std::string::npos) {
2403 LOG(ERROR) << "Invalid instruction set " << instruction_set;
2404 return false;
2405 } else {
2406 return true;
2407 }
2408}
2409
2410bool calculate_oat_file_path_default(char path[PKG_PATH_MAX], const char *oat_dir,
2411 const char *apk_path, const char *instruction_set) {
2412 std::string oat_dir_ = oat_dir;
2413 std::string apk_path_ = apk_path;
2414 std::string instruction_set_ = instruction_set;
2415
2416 if (!is_absolute_path(oat_dir_)) return false;
2417 if (!is_absolute_path(apk_path_)) return false;
2418 if (!is_valid_instruction_set(instruction_set_)) return false;
2419
2420 std::string::size_type end = apk_path_.rfind('.');
2421 std::string::size_type start = apk_path_.rfind('/', end);
2422 if (end == std::string::npos || start == std::string::npos) {
2423 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2424 return false;
2425 }
2426
2427 std::string res_ = oat_dir_ + '/' + instruction_set + '/'
2428 + apk_path_.substr(start + 1, end - start - 1) + ".odex";
2429 const char* res = res_.c_str();
2430 if (strlen(res) >= PKG_PATH_MAX) {
2431 LOG(ERROR) << "Result too large";
2432 return false;
2433 } else {
2434 strlcpy(path, res, PKG_PATH_MAX);
2435 return true;
2436 }
2437}
2438
2439bool calculate_odex_file_path_default(char path[PKG_PATH_MAX], const char *apk_path,
2440 const char *instruction_set) {
2441 std::string apk_path_ = apk_path;
2442 std::string instruction_set_ = instruction_set;
2443
2444 if (!is_absolute_path(apk_path_)) return false;
2445 if (!is_valid_instruction_set(instruction_set_)) return false;
2446
2447 std::string::size_type end = apk_path_.rfind('.');
2448 std::string::size_type start = apk_path_.rfind('/', end);
2449 if (end == std::string::npos || start == std::string::npos) {
2450 LOG(ERROR) << "Invalid apk_path " << apk_path_;
2451 return false;
2452 }
2453
2454 std::string oat_dir = apk_path_.substr(0, start + 1) + "oat";
2455 return calculate_oat_file_path_default(path, oat_dir.c_str(), apk_path, instruction_set);
2456}
2457
2458bool create_cache_path_default(char path[PKG_PATH_MAX], const char *src,
2459 const char *instruction_set) {
2460 std::string src_ = src;
2461 std::string instruction_set_ = instruction_set;
2462
2463 if (!is_absolute_path(src_)) return false;
2464 if (!is_valid_instruction_set(instruction_set_)) return false;
2465
2466 for (auto it = src_.begin() + 1; it < src_.end(); ++it) {
2467 if (*it == '/') {
2468 *it = '@';
2469 }
2470 }
2471
2472 std::string res_ = android_data_dir + DALVIK_CACHE + '/' + instruction_set_ + src_
2473 + DALVIK_CACHE_POSTFIX;
2474 const char* res = res_.c_str();
2475 if (strlen(res) >= PKG_PATH_MAX) {
2476 LOG(ERROR) << "Result too large";
2477 return false;
2478 } else {
2479 strlcpy(path, res, PKG_PATH_MAX);
2480 return true;
2481 }
2482}
2483
Calin Juravle59f7ab82018-04-27 17:50:23 -07002484bool open_classpath_files(const std::string& classpath, std::vector<unique_fd>* apk_fds,
2485 std::vector<std::string>* dex_locations) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002486 std::vector<std::string> classpaths_elems = base::Split(classpath, ":");
2487 for (const std::string& elem : classpaths_elems) {
2488 unique_fd fd(TEMP_FAILURE_RETRY(open(elem.c_str(), O_RDONLY)));
2489 if (fd < 0) {
2490 PLOG(ERROR) << "Could not open classpath elem " << elem;
2491 return false;
2492 } else {
2493 apk_fds->push_back(std::move(fd));
Calin Juravle59f7ab82018-04-27 17:50:23 -07002494 dex_locations->push_back(elem);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002495 }
2496 }
2497 return true;
2498}
2499
2500static bool create_app_profile_snapshot(int32_t app_id,
2501 const std::string& package_name,
2502 const std::string& profile_name,
2503 const std::string& classpath) {
Calin Juravle29591732017-11-20 17:46:19 -08002504 int app_shared_gid = multiuser_get_shared_gid(/*user_id*/ 0, app_id);
2505
Calin Juravle824a64d2018-01-18 20:23:17 -08002506 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
Calin Juravle29591732017-11-20 17:46:19 -08002507 if (snapshot_fd < 0) {
2508 return false;
2509 }
2510
2511 std::vector<unique_fd> profiles_fd;
2512 unique_fd reference_profile_fd;
Calin Juravle824a64d2018-01-18 20:23:17 -08002513 open_profile_files(app_shared_gid, package_name, profile_name, /*is_secondary_dex*/ false,
2514 &profiles_fd, &reference_profile_fd);
Calin Juravle29591732017-11-20 17:46:19 -08002515 if (profiles_fd.empty() || (reference_profile_fd.get() < 0)) {
2516 return false;
2517 }
2518
2519 profiles_fd.push_back(std::move(reference_profile_fd));
2520
Calin Juravle0d0a4922018-01-23 19:54:11 -08002521 // Open the class paths elements. These will be used to filter out profile data that does
2522 // not belong to the classpath during merge.
2523 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002524 std::vector<std::string> dex_locations;
2525 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002526 return false;
2527 }
2528
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002529 RunProfman args;
2530 args.SetupMerge(profiles_fd, snapshot_fd, apk_fds, dex_locations);
Calin Juravle29591732017-11-20 17:46:19 -08002531 pid_t pid = fork();
2532 if (pid == 0) {
2533 /* child -- drop privileges before continuing */
2534 drop_capabilities(app_shared_gid);
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002535 args.Exec();
Calin Juravle29591732017-11-20 17:46:19 -08002536 }
2537
2538 /* parent */
2539 int return_code = wait_child(pid);
2540 if (!WIFEXITED(return_code)) {
Calin Juravle824a64d2018-01-18 20:23:17 -08002541 LOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
Calin Juravle29591732017-11-20 17:46:19 -08002542 return false;
2543 }
2544
2545 return true;
2546}
2547
Calin Juravle0d0a4922018-01-23 19:54:11 -08002548static bool create_boot_image_profile_snapshot(const std::string& package_name,
2549 const std::string& profile_name,
2550 const std::string& classpath) {
2551 // The reference profile directory for the android package might not be prepared. Do it now.
2552 const std::string ref_profile_dir =
2553 create_primary_reference_profile_package_dir_path(package_name);
2554 if (fs_prepare_dir(ref_profile_dir.c_str(), 0770, AID_SYSTEM, AID_SYSTEM) != 0) {
2555 PLOG(ERROR) << "Failed to prepare " << ref_profile_dir;
2556 return false;
2557 }
2558
Mathieu Chartiere0d64a12018-11-01 12:07:26 -07002559 // Return false for empty class path since it may otherwise return true below if profiles is
2560 // empty.
2561 if (classpath.empty()) {
2562 PLOG(ERROR) << "Class path is empty";
2563 return false;
2564 }
2565
Calin Juravle0d0a4922018-01-23 19:54:11 -08002566 // Open and create the snapshot profile.
2567 unique_fd snapshot_fd = open_spnashot_profile(AID_SYSTEM, package_name, profile_name);
2568
2569 // Collect all non empty profiles.
2570 // The collection will traverse all applications profiles and find the non empty files.
2571 // This has the potential of inspecting a large number of files and directories (depending
2572 // on the number of applications and users). So there is a slight increase in the chance
2573 // to get get occasionally I/O errors (e.g. for opening the file). When that happens do not
2574 // fail the snapshot and aggregate whatever profile we could open.
2575 //
2576 // The profile snapshot is a best effort based on available data it's ok if some data
2577 // from some apps is missing. It will be counter productive for the snapshot to fail
2578 // because we could not open or read some of the files.
2579 std::vector<std::string> profiles;
2580 if (!collect_profiles(&profiles)) {
2581 LOG(WARNING) << "There were errors while collecting the profiles for the boot image.";
2582 }
2583
2584 // If we have no profiles return early.
2585 if (profiles.empty()) {
2586 return true;
2587 }
2588
2589 // Open the classpath elements. These will be used to filter out profile data that does
2590 // not belong to the classpath during merge.
2591 std::vector<unique_fd> apk_fds;
Calin Juravle59f7ab82018-04-27 17:50:23 -07002592 std::vector<std::string> dex_locations;
2593 if (!open_classpath_files(classpath, &apk_fds, &dex_locations)) {
Calin Juravle0d0a4922018-01-23 19:54:11 -08002594 return false;
2595 }
2596
2597 // If we could not open any files from the classpath return an error.
2598 if (apk_fds.empty()) {
2599 LOG(ERROR) << "Could not open any of the classpath elements.";
2600 return false;
2601 }
2602
2603 // Aggregate the profiles in batches of kAggregationBatchSize.
2604 // We do this to avoid opening a huge a amount of files.
2605 static constexpr size_t kAggregationBatchSize = 10;
2606
2607 std::vector<unique_fd> profiles_fd;
2608 for (size_t i = 0; i < profiles.size(); ) {
2609 for (size_t k = 0; k < kAggregationBatchSize && i < profiles.size(); k++, i++) {
2610 unique_fd fd = open_profile(AID_SYSTEM, profiles[i], O_RDONLY);
2611 if (fd.get() >= 0) {
2612 profiles_fd.push_back(std::move(fd));
2613 }
2614 }
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002615 RunProfman args;
Calin Juravleb3a929d2018-12-11 14:40:00 -08002616 args.SetupMerge(profiles_fd,
2617 snapshot_fd,
2618 apk_fds,
2619 dex_locations,
2620 /*store_aggregation_counters=*/true);
Calin Juravle0d0a4922018-01-23 19:54:11 -08002621 pid_t pid = fork();
2622 if (pid == 0) {
2623 /* child -- drop privileges before continuing */
2624 drop_capabilities(AID_SYSTEM);
2625
Calin Juravle59f7ab82018-04-27 17:50:23 -07002626 // The introduction of new access flags into boot jars causes them to
2627 // fail dex file verification.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002628 args.Exec();
Calin Juravle0d0a4922018-01-23 19:54:11 -08002629 }
2630
2631 /* parent */
2632 int return_code = wait_child(pid);
2633 if (!WIFEXITED(return_code)) {
2634 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2635 return false;
2636 }
2637 return true;
2638 }
2639 return true;
2640}
2641
2642bool create_profile_snapshot(int32_t app_id, const std::string& package_name,
2643 const std::string& profile_name, const std::string& classpath) {
2644 if (app_id == -1) {
2645 return create_boot_image_profile_snapshot(package_name, profile_name, classpath);
2646 } else {
2647 return create_app_profile_snapshot(app_id, package_name, profile_name, classpath);
2648 }
2649}
2650
Calin Juravlec3b049e2018-01-18 22:32:58 -08002651bool prepare_app_profile(const std::string& package_name,
2652 userid_t user_id,
2653 appid_t app_id,
2654 const std::string& profile_name,
Calin Juravlef63d4792018-01-30 17:43:34 +00002655 const std::string& code_path,
Calin Juravlec3b049e2018-01-18 22:32:58 -08002656 const std::unique_ptr<std::string>& dex_metadata) {
2657 // Prepare the current profile.
2658 std::string cur_profile = create_current_profile_path(user_id, package_name, profile_name,
2659 /*is_secondary_dex*/ false);
2660 uid_t uid = multiuser_get_uid(user_id, app_id);
2661 if (fs_prepare_file_strict(cur_profile.c_str(), 0600, uid, uid) != 0) {
2662 PLOG(ERROR) << "Failed to prepare " << cur_profile;
2663 return false;
2664 }
2665
2666 // Check if we need to install the profile from the dex metadata.
2667 if (dex_metadata == nullptr) {
2668 return true;
2669 }
2670
2671 // We have a dex metdata. Merge the profile into the reference profile.
2672 unique_fd ref_profile_fd = open_reference_profile(uid, package_name, profile_name,
2673 /*read_write*/ true, /*is_secondary_dex*/ false);
2674 unique_fd dex_metadata_fd(TEMP_FAILURE_RETRY(
2675 open(dex_metadata->c_str(), O_RDONLY | O_NOFOLLOW)));
Calin Juravlef63d4792018-01-30 17:43:34 +00002676 unique_fd apk_fd(TEMP_FAILURE_RETRY(open(code_path.c_str(), O_RDONLY | O_NOFOLLOW)));
2677 if (apk_fd < 0) {
2678 PLOG(ERROR) << "Could not open code path " << code_path;
2679 return false;
2680 }
Calin Juravlec3b049e2018-01-18 22:32:58 -08002681
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002682 RunProfman args;
2683 args.SetupCopyAndUpdate(std::move(dex_metadata_fd),
2684 std::move(ref_profile_fd),
2685 std::move(apk_fd),
2686 code_path);
Calin Juravlec3b049e2018-01-18 22:32:58 -08002687 pid_t pid = fork();
2688 if (pid == 0) {
2689 /* child -- drop privileges before continuing */
2690 gid_t app_shared_gid = multiuser_get_shared_gid(user_id, app_id);
2691 drop_capabilities(app_shared_gid);
2692
Calin Juravlef63d4792018-01-30 17:43:34 +00002693 // The copy and update takes ownership over the fds.
Mathieu Chartiercc66c442018-11-09 15:57:21 -08002694 args.Exec();
Calin Juravlec3b049e2018-01-18 22:32:58 -08002695 }
2696
2697 /* parent */
2698 int return_code = wait_child(pid);
2699 if (!WIFEXITED(return_code)) {
2700 PLOG(WARNING) << "profman failed for " << package_name << ":" << profile_name;
2701 return false;
2702 }
2703 return true;
2704}
2705
Jeff Sharkey6c2c0562016-12-07 12:12:00 -07002706} // namespace installd
2707} // namespace android