blob: 4c75eb51e1bae8a9ad17997d70af235386b1ff13 [file] [log] [blame]
Andreas Gampe73dae112015-11-19 14:12:14 -08001/*
2 ** Copyright 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 */
16
17#include <algorithm>
18#include <inttypes.h>
Andreas Gampec4ced4f2017-04-14 20:39:56 -070019#include <limits>
Andreas Gampe73dae112015-11-19 14:12:14 -080020#include <random>
Andreas Gampe1842af32016-03-16 14:28:50 -070021#include <regex>
Andreas Gampe73dae112015-11-19 14:12:14 -080022#include <selinux/android.h>
23#include <selinux/avc.h>
24#include <stdlib.h>
25#include <string.h>
26#include <sys/capability.h>
27#include <sys/prctl.h>
28#include <sys/stat.h>
29#include <sys/wait.h>
30
31#include <android-base/logging.h>
32#include <android-base/macros.h>
33#include <android-base/stringprintf.h>
Andreas Gampe6db8db92016-06-03 10:22:19 -070034#include <android-base/strings.h>
Andreas Gampe73dae112015-11-19 14:12:14 -080035#include <cutils/fs.h>
Andreas Gampe73dae112015-11-19 14:12:14 -080036#include <cutils/properties.h>
Andreas Gampe54e1a402017-03-20 18:42:49 -070037#include <dex2oat_return_codes.h>
Mark Salyzyn7823e122016-09-29 08:08:05 -070038#include <log/log.h>
Andreas Gampe73dae112015-11-19 14:12:14 -080039#include <private/android_filesystem_config.h>
40
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070041#include "dexopt.h"
Jeff Sharkeyf3e30b92016-12-09 17:06:57 -070042#include "file_parsing.h"
43#include "globals.h"
Andreas Gampec4ced4f2017-04-14 20:39:56 -070044#include "installd_constants.h"
Jeff Sharkeyf3e30b92016-12-09 17:06:57 -070045#include "installd_deps.h" // Need to fill in requirements of commands.
Calin Juravledff47292018-02-01 14:44:56 +000046#include "otapreopt_parameters.h"
Jeff Sharkeyf3e30b92016-12-09 17:06:57 -070047#include "otapreopt_utils.h"
48#include "system_properties.h"
49#include "utils.h"
Jeff Sharkey6c2c0562016-12-07 12:12:00 -070050
Andreas Gampe73dae112015-11-19 14:12:14 -080051#ifndef LOG_TAG
52#define LOG_TAG "otapreopt"
53#endif
54
55#define BUFFER_MAX 1024 /* input buffer for commands */
56#define TOKEN_MAX 16 /* max number of arguments in buffer */
57#define REPLY_MAX 256 /* largest reply allowed */
58
Andreas Gampe56f79f92016-06-08 15:11:37 -070059using android::base::EndsWith;
Andreas Gampe6db8db92016-06-03 10:22:19 -070060using android::base::Join;
61using android::base::Split;
Andreas Gampe56f79f92016-06-08 15:11:37 -070062using android::base::StartsWith;
Andreas Gampe73dae112015-11-19 14:12:14 -080063using android::base::StringPrintf;
64
65namespace android {
66namespace installd {
67
Andreas Gampeef21fd22017-05-22 13:36:06 -070068// Check expected values for dexopt flags. If you need to change this:
69//
70// RUN AN A/B OTA TO MAKE SURE THINGS STILL WORK!
71//
72// You most likely need to increase the protocol version and all that entails!
73
74static_assert(DEXOPT_PUBLIC == 1 << 1, "DEXOPT_PUBLIC unexpected.");
75static_assert(DEXOPT_DEBUGGABLE == 1 << 2, "DEXOPT_DEBUGGABLE unexpected.");
76static_assert(DEXOPT_BOOTCOMPLETE == 1 << 3, "DEXOPT_BOOTCOMPLETE unexpected.");
77static_assert(DEXOPT_PROFILE_GUIDED == 1 << 4, "DEXOPT_PROFILE_GUIDED unexpected.");
78static_assert(DEXOPT_SECONDARY_DEX == 1 << 5, "DEXOPT_SECONDARY_DEX unexpected.");
79static_assert(DEXOPT_FORCE == 1 << 6, "DEXOPT_FORCE unexpected.");
80static_assert(DEXOPT_STORAGE_CE == 1 << 7, "DEXOPT_STORAGE_CE unexpected.");
81static_assert(DEXOPT_STORAGE_DE == 1 << 8, "DEXOPT_STORAGE_DE unexpected.");
David Brazdil52249162018-02-12 18:04:59 -080082static_assert(DEXOPT_ENABLE_HIDDEN_API_CHECKS == 1 << 10,
83 "DEXOPT_ENABLE_HIDDEN_API_CHECKS unexpected");
Mathieu Chartierf69c2f72018-03-06 13:55:58 -080084static_assert(DEXOPT_GENERATE_COMPACT_DEX == 1 << 11, "DEXOPT_GENERATE_COMPACT_DEX unexpected");
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -070085static_assert(DEXOPT_GENERATE_APP_IMAGE == 1 << 12, "DEXOPT_GENERATE_APP_IMAGE unexpected");
Andreas Gampeef21fd22017-05-22 13:36:06 -070086
Mathieu Chartier1dc3dfa2018-03-12 17:55:06 -070087static_assert(DEXOPT_MASK == (0x1dfe | DEXOPT_IDLE_BACKGROUND_JOB),
Andreas Gamped32eec22018-02-28 16:02:51 -080088 "DEXOPT_MASK unexpected.");
Andreas Gampeef21fd22017-05-22 13:36:06 -070089
90
91
Andreas Gampe73dae112015-11-19 14:12:14 -080092template<typename T>
93static constexpr T RoundDown(T x, typename std::decay<T>::type n) {
94 return DCHECK_CONSTEXPR(IsPowerOfTwo(n), , T(0))(x & -n);
95}
96
97template<typename T>
98static constexpr T RoundUp(T x, typename std::remove_reference<T>::type n) {
99 return RoundDown(x + n - 1, n);
100}
101
102class OTAPreoptService {
103 public:
Andreas Gampe73dae112015-11-19 14:12:14 -0800104 // Main driver. Performs the following steps.
105 //
106 // 1) Parse options (read system properties etc from B partition).
107 //
108 // 2) Read in package data.
109 //
110 // 3) Prepare environment variables.
111 //
112 // 4) Prepare(compile) boot image, if necessary.
113 //
114 // 5) Run update.
115 int Main(int argc, char** argv) {
Andreas Gamped089ca12016-06-27 14:25:30 -0700116 if (!ReadArguments(argc, argv)) {
117 LOG(ERROR) << "Failed reading command line.";
118 return 1;
119 }
120
Andreas Gampe73dae112015-11-19 14:12:14 -0800121 if (!ReadSystemProperties()) {
122 LOG(ERROR)<< "Failed reading system properties.";
Andreas Gamped089ca12016-06-27 14:25:30 -0700123 return 2;
Andreas Gampe73dae112015-11-19 14:12:14 -0800124 }
125
126 if (!ReadEnvironment()) {
127 LOG(ERROR) << "Failed reading environment properties.";
Andreas Gamped089ca12016-06-27 14:25:30 -0700128 return 3;
Andreas Gampe73dae112015-11-19 14:12:14 -0800129 }
130
Andreas Gamped089ca12016-06-27 14:25:30 -0700131 if (!CheckAndInitializeInstalldGlobals()) {
132 LOG(ERROR) << "Failed initializing globals.";
133 return 4;
Andreas Gampe73dae112015-11-19 14:12:14 -0800134 }
135
136 PrepareEnvironment();
137
Andreas Gamped089ca12016-06-27 14:25:30 -0700138 if (!PrepareBootImage(/* force */ false)) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800139 LOG(ERROR) << "Failed preparing boot image.";
Andreas Gamped089ca12016-06-27 14:25:30 -0700140 return 5;
Andreas Gampe73dae112015-11-19 14:12:14 -0800141 }
142
143 int dexopt_retcode = RunPreopt();
144
145 return dexopt_retcode;
146 }
147
Andreas Gamped089ca12016-06-27 14:25:30 -0700148 int GetProperty(const char* key, char* value, const char* default_value) const {
Andreas Gampe73dae112015-11-19 14:12:14 -0800149 const std::string* prop_value = system_properties_.GetProperty(key);
150 if (prop_value == nullptr) {
151 if (default_value == nullptr) {
152 return 0;
153 }
154 // Copy in the default value.
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600155 strlcpy(value, default_value, kPropertyValueMax - 1);
Andreas Gampe73dae112015-11-19 14:12:14 -0800156 value[kPropertyValueMax - 1] = 0;
157 return strlen(default_value);// TODO: Need to truncate?
158 }
Andreas Gampe7e01b2b2017-09-26 20:41:48 -0700159 size_t size = std::min(kPropertyValueMax - 1, prop_value->length()) + 1;
Jeff Sharkeyc1149c92017-09-21 14:51:09 -0600160 strlcpy(value, prop_value->data(), size);
Andreas Gampe7e01b2b2017-09-26 20:41:48 -0700161 return static_cast<int>(size - 1);
Andreas Gampe73dae112015-11-19 14:12:14 -0800162 }
163
Andreas Gamped089ca12016-06-27 14:25:30 -0700164 std::string GetOTADataDirectory() const {
Calin Juravledff47292018-02-01 14:44:56 +0000165 return StringPrintf("%s/%s", GetOtaDirectoryPrefix().c_str(), GetTargetSlot().c_str());
Andreas Gamped089ca12016-06-27 14:25:30 -0700166 }
167
168 const std::string& GetTargetSlot() const {
Calin Juravledff47292018-02-01 14:44:56 +0000169 return parameters_.target_slot;
Andreas Gamped089ca12016-06-27 14:25:30 -0700170 }
171
Andreas Gampe73dae112015-11-19 14:12:14 -0800172private:
Andreas Gamped089ca12016-06-27 14:25:30 -0700173
Andreas Gampe73dae112015-11-19 14:12:14 -0800174 bool ReadSystemProperties() {
Andreas Gampe1842af32016-03-16 14:28:50 -0700175 static constexpr const char* kPropertyFiles[] = {
176 "/default.prop", "/system/build.prop"
177 };
Andreas Gampe73dae112015-11-19 14:12:14 -0800178
Andreas Gampe1842af32016-03-16 14:28:50 -0700179 for (size_t i = 0; i < arraysize(kPropertyFiles); ++i) {
180 if (!system_properties_.Load(kPropertyFiles[i])) {
181 return false;
182 }
183 }
184
185 return true;
Andreas Gampe73dae112015-11-19 14:12:14 -0800186 }
187
188 bool ReadEnvironment() {
Andreas Gampe1842af32016-03-16 14:28:50 -0700189 // Parse the environment variables from init.environ.rc, which have the form
190 // export NAME VALUE
191 // For simplicity, don't respect string quotation. The values we are interested in can be
192 // encoded without them.
193 std::regex export_regex("\\s*export\\s+(\\S+)\\s+(\\S+)");
194 bool parse_result = ParseFile("/init.environ.rc", [&](const std::string& line) {
195 std::smatch export_match;
196 if (!std::regex_match(line, export_match, export_regex)) {
197 return true;
198 }
Andreas Gampe73dae112015-11-19 14:12:14 -0800199
Andreas Gampe1842af32016-03-16 14:28:50 -0700200 if (export_match.size() != 3) {
201 return true;
202 }
203
204 std::string name = export_match[1].str();
205 std::string value = export_match[2].str();
206
207 system_properties_.SetProperty(name, value);
208
209 return true;
210 });
211 if (!parse_result) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800212 return false;
213 }
Andreas Gampe1842af32016-03-16 14:28:50 -0700214
Andreas Gamped089ca12016-06-27 14:25:30 -0700215 if (system_properties_.GetProperty(kAndroidDataPathPropertyName) == nullptr) {
216 return false;
217 }
218 android_data_ = *system_properties_.GetProperty(kAndroidDataPathPropertyName);
219
220 if (system_properties_.GetProperty(kAndroidRootPathPropertyName) == nullptr) {
221 return false;
222 }
223 android_root_ = *system_properties_.GetProperty(kAndroidRootPathPropertyName);
224
225 if (system_properties_.GetProperty(kBootClassPathPropertyName) == nullptr) {
226 return false;
227 }
228 boot_classpath_ = *system_properties_.GetProperty(kBootClassPathPropertyName);
229
230 if (system_properties_.GetProperty(ASEC_MOUNTPOINT_ENV_NAME) == nullptr) {
231 return false;
232 }
233 asec_mountpoint_ = *system_properties_.GetProperty(ASEC_MOUNTPOINT_ENV_NAME);
234
235 return true;
236 }
237
238 const std::string& GetAndroidData() const {
239 return android_data_;
240 }
241
242 const std::string& GetAndroidRoot() const {
243 return android_root_;
244 }
245
246 const std::string GetOtaDirectoryPrefix() const {
247 return GetAndroidData() + "/ota";
248 }
249
250 bool CheckAndInitializeInstalldGlobals() {
251 // init_globals_from_data_and_root requires "ASEC_MOUNTPOINT" in the environment. We
252 // do not use any datapath that includes this, but we'll still have to set it.
253 CHECK(system_properties_.GetProperty(ASEC_MOUNTPOINT_ENV_NAME) != nullptr);
254 int result = setenv(ASEC_MOUNTPOINT_ENV_NAME, asec_mountpoint_.c_str(), 0);
255 if (result != 0) {
256 LOG(ERROR) << "Could not set ASEC_MOUNTPOINT environment variable";
257 return false;
258 }
259
260 if (!init_globals_from_data_and_root(GetAndroidData().c_str(), GetAndroidRoot().c_str())) {
261 LOG(ERROR) << "Could not initialize globals; exiting.";
262 return false;
263 }
264
265 // This is different from the normal installd. We only do the base
266 // directory, the rest will be created on demand when each app is compiled.
267 if (access(GetOtaDirectoryPrefix().c_str(), R_OK) < 0) {
268 LOG(ERROR) << "Could not access " << GetOtaDirectoryPrefix();
269 return false;
Andreas Gampe1842af32016-03-16 14:28:50 -0700270 }
Andreas Gampe73dae112015-11-19 14:12:14 -0800271
272 return true;
273 }
274
Shubham Ajmera54ef8622017-06-22 11:10:27 -0700275 bool ParseBool(const char* in) {
276 if (strcmp(in, "true") == 0) {
277 return true;
278 }
279 return false;
280 }
281
Andreas Gampec4ced4f2017-04-14 20:39:56 -0700282 bool ParseUInt(const char* in, uint32_t* out) {
283 char* end;
284 long long int result = strtoll(in, &end, 0);
285 if (in == end || *end != '\0') {
286 return false;
287 }
288 if (result < std::numeric_limits<uint32_t>::min() ||
289 std::numeric_limits<uint32_t>::max() < result) {
290 return false;
291 }
292 *out = static_cast<uint32_t>(result);
293 return true;
294 }
Andreas Gamped089ca12016-06-27 14:25:30 -0700295
Andreas Gampec4ced4f2017-04-14 20:39:56 -0700296 bool ReadArguments(int argc, char** argv) {
Calin Juravledff47292018-02-01 14:44:56 +0000297 return parameters_.ReadArguments(argc, const_cast<const char**>(argv));
Andreas Gampe73dae112015-11-19 14:12:14 -0800298 }
299
300 void PrepareEnvironment() {
Andreas Gamped089ca12016-06-27 14:25:30 -0700301 environ_.push_back(StringPrintf("BOOTCLASSPATH=%s", boot_classpath_.c_str()));
302 environ_.push_back(StringPrintf("ANDROID_DATA=%s", GetOTADataDirectory().c_str()));
303 environ_.push_back(StringPrintf("ANDROID_ROOT=%s", android_root_.c_str()));
Andreas Gampe73dae112015-11-19 14:12:14 -0800304
305 for (const std::string& e : environ_) {
306 putenv(const_cast<char*>(e.c_str()));
307 }
308 }
309
310 // Ensure that we have the right boot image. The first time any app is
311 // compiled, we'll try to generate it.
Andreas Gamped089ca12016-06-27 14:25:30 -0700312 bool PrepareBootImage(bool force) const {
Calin Juravledff47292018-02-01 14:44:56 +0000313 if (parameters_.instruction_set == nullptr) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800314 LOG(ERROR) << "Instruction set missing.";
315 return false;
316 }
Calin Juravledff47292018-02-01 14:44:56 +0000317 const char* isa = parameters_.instruction_set;
Andreas Gampe73dae112015-11-19 14:12:14 -0800318
319 // Check whether the file exists where expected.
Andreas Gamped089ca12016-06-27 14:25:30 -0700320 std::string dalvik_cache = GetOTADataDirectory() + "/" + DALVIK_CACHE;
Andreas Gampe73dae112015-11-19 14:12:14 -0800321 std::string isa_path = dalvik_cache + "/" + isa;
322 std::string art_path = isa_path + "/system@framework@boot.art";
323 std::string oat_path = isa_path + "/system@framework@boot.oat";
Andreas Gamped089ca12016-06-27 14:25:30 -0700324 bool cleared = false;
325 if (access(art_path.c_str(), F_OK) == 0 && access(oat_path.c_str(), F_OK) == 0) {
326 // Files exist, assume everything is alright if not forced. Otherwise clean up.
327 if (!force) {
328 return true;
329 }
330 ClearDirectory(isa_path);
331 cleared = true;
Andreas Gampe73dae112015-11-19 14:12:14 -0800332 }
333
Andreas Gamped089ca12016-06-27 14:25:30 -0700334 // Reset umask in otapreopt, so that we control the the access for the files we create.
335 umask(0);
336
Andreas Gampe73dae112015-11-19 14:12:14 -0800337 // Create the directories, if necessary.
338 if (access(dalvik_cache.c_str(), F_OK) != 0) {
Andreas Gamped089ca12016-06-27 14:25:30 -0700339 if (!CreatePath(dalvik_cache)) {
340 PLOG(ERROR) << "Could not create dalvik-cache dir " << dalvik_cache;
Andreas Gampe73dae112015-11-19 14:12:14 -0800341 return false;
342 }
343 }
344 if (access(isa_path.c_str(), F_OK) != 0) {
Andreas Gamped089ca12016-06-27 14:25:30 -0700345 if (!CreatePath(isa_path)) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800346 PLOG(ERROR) << "Could not create dalvik-cache isa dir";
347 return false;
348 }
349 }
350
Andreas Gampe5709b572016-02-12 17:42:59 -0800351 // Prepare to create.
Andreas Gamped089ca12016-06-27 14:25:30 -0700352 if (!cleared) {
353 ClearDirectory(isa_path);
354 }
Andreas Gampe73dae112015-11-19 14:12:14 -0800355
Andreas Gampe9fb85b02016-03-16 10:09:29 -0700356 std::string preopted_boot_art_path = StringPrintf("/system/framework/%s/boot.art", isa);
Andreas Gampe5709b572016-02-12 17:42:59 -0800357 if (access(preopted_boot_art_path.c_str(), F_OK) == 0) {
Chris Morin77c48752018-02-13 15:44:47 -0800358 return PatchoatBootImage(isa_path, isa);
Andreas Gampe5709b572016-02-12 17:42:59 -0800359 } else {
360 // No preopted boot image. Try to compile.
Andreas Gamped089ca12016-06-27 14:25:30 -0700361 return Dex2oatBootImage(boot_classpath_, art_path, oat_path, isa);
Andreas Gampe5709b572016-02-12 17:42:59 -0800362 }
363 }
364
Andreas Gamped089ca12016-06-27 14:25:30 -0700365 static bool CreatePath(const std::string& path) {
366 // Create the given path. Use string processing instead of dirname, as dirname's need for
367 // a writable char buffer is painful.
368
369 // First, try to use the full path.
370 if (mkdir(path.c_str(), 0711) == 0) {
371 return true;
372 }
373 if (errno != ENOENT) {
374 PLOG(ERROR) << "Could not create path " << path;
375 return false;
376 }
377
378 // Now find the parent and try that first.
379 size_t last_slash = path.find_last_of('/');
380 if (last_slash == std::string::npos || last_slash == 0) {
381 PLOG(ERROR) << "Could not create " << path;
382 return false;
383 }
384
385 if (!CreatePath(path.substr(0, last_slash))) {
386 return false;
387 }
388
389 if (mkdir(path.c_str(), 0711) == 0) {
390 return true;
391 }
392 PLOG(ERROR) << "Could not create " << path;
393 return false;
394 }
395
396 static void ClearDirectory(const std::string& dir) {
397 DIR* c_dir = opendir(dir.c_str());
398 if (c_dir == nullptr) {
399 PLOG(WARNING) << "Unable to open " << dir << " to delete it's contents";
400 return;
401 }
402
403 for (struct dirent* de = readdir(c_dir); de != nullptr; de = readdir(c_dir)) {
404 const char* name = de->d_name;
405 if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0) {
406 continue;
407 }
408 // We only want to delete regular files and symbolic links.
409 std::string file = StringPrintf("%s/%s", dir.c_str(), name);
410 if (de->d_type != DT_REG && de->d_type != DT_LNK) {
411 LOG(WARNING) << "Unexpected file "
412 << file
413 << " of type "
414 << std::hex
415 << de->d_type
416 << " encountered.";
417 } else {
418 // Try to unlink the file.
419 if (unlink(file.c_str()) != 0) {
420 PLOG(ERROR) << "Unable to unlink " << file;
421 }
422 }
423 }
424 CHECK_EQ(0, closedir(c_dir)) << "Unable to close directory.";
425 }
426
Chris Morin77c48752018-02-13 15:44:47 -0800427 bool PatchoatBootImage(const std::string& output_dir, const char* isa) const {
Andreas Gampe5709b572016-02-12 17:42:59 -0800428 // This needs to be kept in sync with ART, see art/runtime/gc/space/image_space.cc.
429
430 std::vector<std::string> cmd;
Andreas Gampe9fb85b02016-03-16 10:09:29 -0700431 cmd.push_back("/system/bin/patchoat");
Andreas Gampe5709b572016-02-12 17:42:59 -0800432
433 cmd.push_back("--input-image-location=/system/framework/boot.art");
Chris Morin77c48752018-02-13 15:44:47 -0800434 cmd.push_back(StringPrintf("--output-image-directory=%s", output_dir.c_str()));
Andreas Gampe5709b572016-02-12 17:42:59 -0800435
436 cmd.push_back(StringPrintf("--instruction-set=%s", isa));
437
438 int32_t base_offset = ChooseRelocationOffsetDelta(ART_BASE_ADDRESS_MIN_DELTA,
439 ART_BASE_ADDRESS_MAX_DELTA);
Andreas Gampefebf0bf2016-02-29 18:04:17 -0800440 cmd.push_back(StringPrintf("--base-offset-delta=%d", base_offset));
Andreas Gampe5709b572016-02-12 17:42:59 -0800441
442 std::string error_msg;
443 bool result = Exec(cmd, &error_msg);
444 if (!result) {
445 LOG(ERROR) << "Could not generate boot image: " << error_msg;
446 }
447 return result;
448 }
449
450 bool Dex2oatBootImage(const std::string& boot_cp,
451 const std::string& art_path,
452 const std::string& oat_path,
Andreas Gamped089ca12016-06-27 14:25:30 -0700453 const char* isa) const {
Andreas Gampe73dae112015-11-19 14:12:14 -0800454 // This needs to be kept in sync with ART, see art/runtime/gc/space/image_space.cc.
455 std::vector<std::string> cmd;
Andreas Gampe9fb85b02016-03-16 10:09:29 -0700456 cmd.push_back("/system/bin/dex2oat");
Andreas Gampe73dae112015-11-19 14:12:14 -0800457 cmd.push_back(StringPrintf("--image=%s", art_path.c_str()));
Andreas Gampe6db8db92016-06-03 10:22:19 -0700458 for (const std::string& boot_part : Split(boot_cp, ":")) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800459 cmd.push_back(StringPrintf("--dex-file=%s", boot_part.c_str()));
460 }
461 cmd.push_back(StringPrintf("--oat-file=%s", oat_path.c_str()));
462
463 int32_t base_offset = ChooseRelocationOffsetDelta(ART_BASE_ADDRESS_MIN_DELTA,
464 ART_BASE_ADDRESS_MAX_DELTA);
465 cmd.push_back(StringPrintf("--base=0x%x", ART_BASE_ADDRESS + base_offset));
466
467 cmd.push_back(StringPrintf("--instruction-set=%s", isa));
468
469 // These things are pushed by AndroidRuntime, see frameworks/base/core/jni/AndroidRuntime.cpp.
470 AddCompilerOptionFromSystemProperty("dalvik.vm.image-dex2oat-Xms",
471 "-Xms",
472 true,
473 cmd);
474 AddCompilerOptionFromSystemProperty("dalvik.vm.image-dex2oat-Xmx",
475 "-Xmx",
476 true,
477 cmd);
478 AddCompilerOptionFromSystemProperty("dalvik.vm.image-dex2oat-filter",
479 "--compiler-filter=",
480 false,
481 cmd);
Andreas Gampe9fb85b02016-03-16 10:09:29 -0700482 cmd.push_back("--image-classes=/system/etc/preloaded-classes");
Andreas Gampe73dae112015-11-19 14:12:14 -0800483 // TODO: Compiled-classes.
484 const std::string* extra_opts =
485 system_properties_.GetProperty("dalvik.vm.image-dex2oat-flags");
486 if (extra_opts != nullptr) {
Andreas Gampe6db8db92016-06-03 10:22:19 -0700487 std::vector<std::string> extra_vals = Split(*extra_opts, " ");
Andreas Gampe73dae112015-11-19 14:12:14 -0800488 cmd.insert(cmd.end(), extra_vals.begin(), extra_vals.end());
489 }
490 // TODO: Should we lower this? It's usually set close to max, because
491 // normally there's not much else going on at boot.
492 AddCompilerOptionFromSystemProperty("dalvik.vm.image-dex2oat-threads",
493 "-j",
494 false,
495 cmd);
496 AddCompilerOptionFromSystemProperty(
497 StringPrintf("dalvik.vm.isa.%s.variant", isa).c_str(),
498 "--instruction-set-variant=",
499 false,
500 cmd);
501 AddCompilerOptionFromSystemProperty(
502 StringPrintf("dalvik.vm.isa.%s.features", isa).c_str(),
503 "--instruction-set-features=",
504 false,
505 cmd);
506
507 std::string error_msg;
508 bool result = Exec(cmd, &error_msg);
509 if (!result) {
510 LOG(ERROR) << "Could not generate boot image: " << error_msg;
511 }
512 return result;
513 }
514
515 static const char* ParseNull(const char* arg) {
516 return (strcmp(arg, "!") == 0) ? nullptr : arg;
517 }
518
Andreas Gamped089ca12016-06-27 14:25:30 -0700519 bool ShouldSkipPreopt() const {
Andreas Gampe56f79f92016-06-08 15:11:37 -0700520 // There's one thing we have to be careful about: we may/will be asked to compile an app
521 // living in the system image. This may be a valid request - if the app wasn't compiled,
522 // e.g., if the system image wasn't large enough to include preopted files. However, the
523 // data we have is from the old system, so the driver (the OTA service) can't actually
524 // know. Thus, we will get requests for apps that have preopted components. To avoid
525 // duplication (we'd generate files that are not used and are *not* cleaned up), do two
526 // simple checks:
527 //
528 // 1) Does the apk_path start with the value of ANDROID_ROOT? (~in the system image)
529 // (For simplicity, assume the value of ANDROID_ROOT does not contain a symlink.)
530 //
531 // 2) If you replace the name in the apk_path with "oat," does the path exist?
532 // (=have a subdirectory for preopted files)
533 //
534 // If the answer to both is yes, skip the dexopt.
535 //
536 // Note: while one may think it's OK to call dexopt and it will fail (because APKs should
537 // be stripped), that's not true for APKs signed outside the build system (so the
538 // jar content must be exactly the same).
539
540 // (This is ugly as it's the only thing where we need to understand the contents
Calin Juravledff47292018-02-01 14:44:56 +0000541 // of parameters_, but it beats postponing the decision or using the call-
Andreas Gampe56f79f92016-06-08 15:11:37 -0700542 // backs to do weird things.)
Calin Juravledff47292018-02-01 14:44:56 +0000543 const char* apk_path = parameters_.apk_path;
Andreas Gampec4ced4f2017-04-14 20:39:56 -0700544 CHECK(apk_path != nullptr);
Elliott Hughes969e4f82017-12-20 12:34:09 -0800545 if (StartsWith(apk_path, android_root_)) {
Andreas Gampec4ced4f2017-04-14 20:39:56 -0700546 const char* last_slash = strrchr(apk_path, '/');
Andreas Gampe56f79f92016-06-08 15:11:37 -0700547 if (last_slash != nullptr) {
Andreas Gampec4ced4f2017-04-14 20:39:56 -0700548 std::string path(apk_path, last_slash - apk_path + 1);
Andreas Gampe56f79f92016-06-08 15:11:37 -0700549 CHECK(EndsWith(path, "/"));
550 path = path + "oat";
551 if (access(path.c_str(), F_OK) == 0) {
Andreas Gamped089ca12016-06-27 14:25:30 -0700552 return true;
Andreas Gampe56f79f92016-06-08 15:11:37 -0700553 }
554 }
555 }
556
Andreas Gamped089ca12016-06-27 14:25:30 -0700557 // Another issue is unavailability of files in the new system. If the partition
558 // layout changes, otapreopt_chroot may not know about this. Then files from that
559 // partition will not be available and fail to build. This is problematic, as
560 // this tool will wipe the OTA artifact cache and try again (for robustness after
561 // a failed OTA with remaining cache artifacts).
Andreas Gampec4ced4f2017-04-14 20:39:56 -0700562 if (access(apk_path, F_OK) != 0) {
563 LOG(WARNING) << "Skipping preopt of non-existing package " << apk_path;
Andreas Gamped089ca12016-06-27 14:25:30 -0700564 return true;
565 }
566
567 return false;
568 }
569
Calin Juravledff47292018-02-01 14:44:56 +0000570 // Run dexopt with the parameters of parameters_.
Calin Juravle824a64d2018-01-18 20:23:17 -0800571 // TODO(calin): embed the profile name in the parameters.
Andreas Gampeb39d2f02017-04-17 20:04:02 -0700572 int Dexopt() {
Andreas Gampe023b2242018-02-28 16:03:25 -0800573 std::string dummy;
Calin Juravledff47292018-02-01 14:44:56 +0000574 return dexopt(parameters_.apk_path,
575 parameters_.uid,
576 parameters_.pkgName,
577 parameters_.instruction_set,
578 parameters_.dexopt_needed,
579 parameters_.oat_dir,
580 parameters_.dexopt_flags,
581 parameters_.compiler_filter,
582 parameters_.volume_uuid,
583 parameters_.shared_libraries,
584 parameters_.se_info,
585 parameters_.downgrade,
586 parameters_.target_sdk_version,
Calin Juravle62c5a372018-02-01 17:03:23 +0000587 parameters_.profile_name,
Calin Juravle2efc4022018-02-13 18:31:32 -0800588 parameters_.dex_metadata_path,
Andreas Gampe023b2242018-02-28 16:03:25 -0800589 parameters_.compilation_reason,
590 &dummy);
Andreas Gampe73dae112015-11-19 14:12:14 -0800591 }
592
Andreas Gampeb39d2f02017-04-17 20:04:02 -0700593 int RunPreopt() {
594 if (ShouldSkipPreopt()) {
595 return 0;
596 }
597
598 int dexopt_result = Dexopt();
599 if (dexopt_result == 0) {
600 return 0;
601 }
602
603 // If the dexopt failed, we may have a stale boot image from a previous OTA run.
604 // Then regenerate and retry.
605 if (WEXITSTATUS(dexopt_result) ==
606 static_cast<int>(art::dex2oat::ReturnCode::kCreateRuntime)) {
607 if (!PrepareBootImage(/* force */ true)) {
608 LOG(ERROR) << "Forced boot image creating failed. Original error return was "
609 << dexopt_result;
610 return dexopt_result;
611 }
612
613 int dexopt_result_boot_image_retry = Dexopt();
614 if (dexopt_result_boot_image_retry == 0) {
615 return 0;
616 }
617 }
618
619 // If this was a profile-guided run, we may have profile version issues. Try to downgrade,
620 // if possible.
Calin Juravledff47292018-02-01 14:44:56 +0000621 if ((parameters_.dexopt_flags & DEXOPT_PROFILE_GUIDED) == 0) {
Andreas Gampeb39d2f02017-04-17 20:04:02 -0700622 return dexopt_result;
623 }
624
625 LOG(WARNING) << "Downgrading compiler filter in an attempt to progress compilation";
Calin Juravledff47292018-02-01 14:44:56 +0000626 parameters_.dexopt_flags &= ~DEXOPT_PROFILE_GUIDED;
Andreas Gampeb39d2f02017-04-17 20:04:02 -0700627 return Dexopt();
628 }
629
Andreas Gampe73dae112015-11-19 14:12:14 -0800630 ////////////////////////////////////
631 // Helpers, mostly taken from ART //
632 ////////////////////////////////////
633
634 // Wrapper on fork/execv to run a command in a subprocess.
Andreas Gamped089ca12016-06-27 14:25:30 -0700635 static bool Exec(const std::vector<std::string>& arg_vector, std::string* error_msg) {
Andreas Gampe6db8db92016-06-03 10:22:19 -0700636 const std::string command_line = Join(arg_vector, ' ');
Andreas Gampe73dae112015-11-19 14:12:14 -0800637
638 CHECK_GE(arg_vector.size(), 1U) << command_line;
639
640 // Convert the args to char pointers.
641 const char* program = arg_vector[0].c_str();
642 std::vector<char*> args;
643 for (size_t i = 0; i < arg_vector.size(); ++i) {
644 const std::string& arg = arg_vector[i];
645 char* arg_str = const_cast<char*>(arg.c_str());
646 CHECK(arg_str != nullptr) << i;
647 args.push_back(arg_str);
648 }
649 args.push_back(nullptr);
650
651 // Fork and exec.
652 pid_t pid = fork();
653 if (pid == 0) {
654 // No allocation allowed between fork and exec.
655
656 // Change process groups, so we don't get reaped by ProcessManager.
657 setpgid(0, 0);
658
659 execv(program, &args[0]);
660
661 PLOG(ERROR) << "Failed to execv(" << command_line << ")";
662 // _exit to avoid atexit handlers in child.
663 _exit(1);
664 } else {
665 if (pid == -1) {
666 *error_msg = StringPrintf("Failed to execv(%s) because fork failed: %s",
667 command_line.c_str(), strerror(errno));
668 return false;
669 }
670
671 // wait for subprocess to finish
672 int status;
673 pid_t got_pid = TEMP_FAILURE_RETRY(waitpid(pid, &status, 0));
674 if (got_pid != pid) {
675 *error_msg = StringPrintf("Failed after fork for execv(%s) because waitpid failed: "
676 "wanted %d, got %d: %s",
677 command_line.c_str(), pid, got_pid, strerror(errno));
678 return false;
679 }
680 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
681 *error_msg = StringPrintf("Failed execv(%s) because non-0 exit status",
682 command_line.c_str());
683 return false;
684 }
685 }
686 return true;
687 }
688
689 // Choose a random relocation offset. Taken from art/runtime/gc/image_space.cc.
690 static int32_t ChooseRelocationOffsetDelta(int32_t min_delta, int32_t max_delta) {
691 constexpr size_t kPageSize = PAGE_SIZE;
692 CHECK_EQ(min_delta % kPageSize, 0u);
693 CHECK_EQ(max_delta % kPageSize, 0u);
694 CHECK_LT(min_delta, max_delta);
695
696 std::default_random_engine generator;
697 generator.seed(GetSeed());
698 std::uniform_int_distribution<int32_t> distribution(min_delta, max_delta);
699 int32_t r = distribution(generator);
700 if (r % 2 == 0) {
701 r = RoundUp(r, kPageSize);
702 } else {
703 r = RoundDown(r, kPageSize);
704 }
705 CHECK_LE(min_delta, r);
706 CHECK_GE(max_delta, r);
707 CHECK_EQ(r % kPageSize, 0u);
708 return r;
709 }
710
711 static uint64_t GetSeed() {
712#ifdef __BIONIC__
713 // Bionic exposes arc4random, use it.
714 uint64_t random_data;
715 arc4random_buf(&random_data, sizeof(random_data));
716 return random_data;
717#else
718#error "This is only supposed to run with bionic. Otherwise, implement..."
719#endif
720 }
721
722 void AddCompilerOptionFromSystemProperty(const char* system_property,
723 const char* prefix,
724 bool runtime,
Andreas Gamped089ca12016-06-27 14:25:30 -0700725 std::vector<std::string>& out) const {
726 const std::string* value = system_properties_.GetProperty(system_property);
Andreas Gampe73dae112015-11-19 14:12:14 -0800727 if (value != nullptr) {
728 if (runtime) {
729 out.push_back("--runtime-arg");
730 }
731 if (prefix != nullptr) {
732 out.push_back(StringPrintf("%s%s", prefix, value->c_str()));
733 } else {
734 out.push_back(*value);
735 }
736 }
737 }
738
Andreas Gamped089ca12016-06-27 14:25:30 -0700739 static constexpr const char* kBootClassPathPropertyName = "BOOTCLASSPATH";
740 static constexpr const char* kAndroidRootPathPropertyName = "ANDROID_ROOT";
741 static constexpr const char* kAndroidDataPathPropertyName = "ANDROID_DATA";
742 // The index of the instruction-set string inside the package parameters. Needed for
743 // some special-casing that requires knowledge of the instruction-set.
744 static constexpr size_t kISAIndex = 3;
745
Andreas Gampe73dae112015-11-19 14:12:14 -0800746 // Stores the system properties read out of the B partition. We need to use these properties
747 // to compile, instead of the A properties we could get from init/get_property.
748 SystemProperties system_properties_;
749
Andreas Gamped089ca12016-06-27 14:25:30 -0700750 // Some select properties that are always needed.
Andreas Gamped089ca12016-06-27 14:25:30 -0700751 std::string android_root_;
752 std::string android_data_;
753 std::string boot_classpath_;
754 std::string asec_mountpoint_;
755
Calin Juravledff47292018-02-01 14:44:56 +0000756 OTAPreoptParameters parameters_;
Andreas Gampe73dae112015-11-19 14:12:14 -0800757
758 // Store environment values we need to set.
759 std::vector<std::string> environ_;
760};
761
762OTAPreoptService gOps;
763
764////////////////////////
765// Plug-in functions. //
766////////////////////////
767
768int get_property(const char *key, char *value, const char *default_value) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800769 return gOps.GetProperty(key, value, default_value);
770}
771
772// Compute the output path of
773bool calculate_oat_file_path(char path[PKG_PATH_MAX], const char *oat_dir,
774 const char *apk_path,
775 const char *instruction_set) {
Dan Austin9c8f93a2016-06-03 16:15:54 -0700776 const char *file_name_start;
777 const char *file_name_end;
Andreas Gampe73dae112015-11-19 14:12:14 -0800778
779 file_name_start = strrchr(apk_path, '/');
780 if (file_name_start == nullptr) {
781 ALOGE("apk_path '%s' has no '/'s in it\n", apk_path);
782 return false;
783 }
784 file_name_end = strrchr(file_name_start, '.');
785 if (file_name_end == nullptr) {
786 ALOGE("apk_path '%s' has no extension\n", apk_path);
787 return false;
788 }
789
790 // Calculate file_name
791 file_name_start++; // Move past '/', is valid as file_name_end is valid.
792 size_t file_name_len = file_name_end - file_name_start;
793 std::string file_name(file_name_start, file_name_len);
794
795 // <apk_parent_dir>/oat/<isa>/<file_name>.odex.b
Andreas Gamped089ca12016-06-27 14:25:30 -0700796 snprintf(path,
797 PKG_PATH_MAX,
798 "%s/%s/%s.odex.%s",
799 oat_dir,
800 instruction_set,
801 file_name.c_str(),
802 gOps.GetTargetSlot().c_str());
Andreas Gampe73dae112015-11-19 14:12:14 -0800803 return true;
804}
805
806/*
807 * Computes the odex file for the given apk_path and instruction_set.
808 * /system/framework/whatever.jar -> /system/framework/oat/<isa>/whatever.odex
809 *
810 * Returns false if it failed to determine the odex file path.
811 */
812bool calculate_odex_file_path(char path[PKG_PATH_MAX], const char *apk_path,
813 const char *instruction_set) {
Andreas Gampe73dae112015-11-19 14:12:14 -0800814 const char *path_end = strrchr(apk_path, '/');
815 if (path_end == nullptr) {
816 ALOGE("apk_path '%s' has no '/'s in it?!\n", apk_path);
817 return false;
818 }
819 std::string path_component(apk_path, path_end - apk_path);
820
821 const char *name_begin = path_end + 1;
822 const char *extension_start = strrchr(name_begin, '.');
823 if (extension_start == nullptr) {
824 ALOGE("apk_path '%s' has no extension.\n", apk_path);
825 return false;
826 }
827 std::string name_component(name_begin, extension_start - name_begin);
828
Andreas Gamped089ca12016-06-27 14:25:30 -0700829 std::string new_path = StringPrintf("%s/oat/%s/%s.odex.%s",
Andreas Gampe73dae112015-11-19 14:12:14 -0800830 path_component.c_str(),
831 instruction_set,
Andreas Gamped089ca12016-06-27 14:25:30 -0700832 name_component.c_str(),
833 gOps.GetTargetSlot().c_str());
834 if (new_path.length() >= PKG_PATH_MAX) {
835 LOG(ERROR) << "apk_path of " << apk_path << " is too long: " << new_path;
836 return false;
837 }
Andreas Gampe73dae112015-11-19 14:12:14 -0800838 strcpy(path, new_path.c_str());
839 return true;
840}
841
842bool create_cache_path(char path[PKG_PATH_MAX],
843 const char *src,
844 const char *instruction_set) {
845 size_t srclen = strlen(src);
846
847 /* demand that we are an absolute path */
848 if ((src == 0) || (src[0] != '/') || strstr(src,"..")) {
849 return false;
850 }
851
852 if (srclen > PKG_PATH_MAX) { // XXX: PKG_NAME_MAX?
853 return false;
854 }
855
856 std::string from_src = std::string(src + 1);
857 std::replace(from_src.begin(), from_src.end(), '/', '@');
858
859 std::string assembled_path = StringPrintf("%s/%s/%s/%s%s",
Andreas Gamped089ca12016-06-27 14:25:30 -0700860 gOps.GetOTADataDirectory().c_str(),
Andreas Gampe73dae112015-11-19 14:12:14 -0800861 DALVIK_CACHE,
862 instruction_set,
863 from_src.c_str(),
David Brazdil249c1792016-09-06 15:35:28 +0100864 DALVIK_CACHE_POSTFIX);
Andreas Gampe73dae112015-11-19 14:12:14 -0800865
866 if (assembled_path.length() + 1 > PKG_PATH_MAX) {
867 return false;
868 }
869 strcpy(path, assembled_path.c_str());
870
871 return true;
872}
873
Andreas Gampe73dae112015-11-19 14:12:14 -0800874static int log_callback(int type, const char *fmt, ...) {
875 va_list ap;
876 int priority;
877
878 switch (type) {
879 case SELINUX_WARNING:
880 priority = ANDROID_LOG_WARN;
881 break;
882 case SELINUX_INFO:
883 priority = ANDROID_LOG_INFO;
884 break;
885 default:
886 priority = ANDROID_LOG_ERROR;
887 break;
888 }
889 va_start(ap, fmt);
890 LOG_PRI_VA(priority, "SELinux", fmt, ap);
891 va_end(ap);
892 return 0;
893}
894
895static int otapreopt_main(const int argc, char *argv[]) {
896 int selinux_enabled = (is_selinux_enabled() > 0);
897
898 setenv("ANDROID_LOG_TAGS", "*:v", 1);
899 android::base::InitLogging(argv);
900
Andreas Gampe73dae112015-11-19 14:12:14 -0800901 if (argc < 2) {
902 ALOGE("Expecting parameters");
903 exit(1);
904 }
905
906 union selinux_callback cb;
907 cb.func_log = log_callback;
908 selinux_set_callback(SELINUX_CB_LOG, cb);
909
Andreas Gampe73dae112015-11-19 14:12:14 -0800910 if (selinux_enabled && selinux_status_open(true) < 0) {
911 ALOGE("Could not open selinux status; exiting.\n");
912 exit(1);
913 }
914
915 int ret = android::installd::gOps.Main(argc, argv);
916
917 return ret;
918}
919
920} // namespace installd
921} // namespace android
922
923int main(const int argc, char *argv[]) {
924 return android::installd::otapreopt_main(argc, argv);
925}