blob: 822ab7fbb7d59aaa8b29ab388ff0d5955881e48a [file] [log] [blame]
/*
** Copyright 2016, The Android Open Source Project
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
** http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
#include <inttypes.h>
#include <selinux/android.h>
#include <selinux/avc.h>
#include <stdlib.h>
#include <string.h>
#include <sys/capability.h>
#include <sys/mman.h>
#include <sys/prctl.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <algorithm>
#include <iterator>
#include <limits>
#include <random>
#include <regex>
#include <android-base/logging.h>
#include <android-base/macros.h>
#include <android-base/stringprintf.h>
#include <android-base/strings.h>
#include <cutils/fs.h>
#include <cutils/properties.h>
#include <log/log.h>
#include <private/android_filesystem_config.h>
#include "android-base/file.h"
#include "dexopt.h"
#include "file_parsing.h"
#include "globals.h"
#include "installd_constants.h"
#include "installd_deps.h" // Need to fill in requirements of commands.
#include "otapreopt_parameters.h"
#include "otapreopt_utils.h"
#include "system_properties.h"
#include "unique_file.h"
#include "utils.h"
#ifndef LOG_TAG
#define LOG_TAG "otapreopt"
#endif
#define BUFFER_MAX 1024 /* input buffer for commands */
#define TOKEN_MAX 16 /* max number of arguments in buffer */
#define REPLY_MAX 256 /* largest reply allowed */
using android::base::EndsWith;
using android::base::Split;
using android::base::StartsWith;
using android::base::StringPrintf;
namespace android {
namespace installd {
// Check expected values for dexopt flags. If you need to change this:
//
// RUN AN A/B OTA TO MAKE SURE THINGS STILL WORK!
//
// You most likely need to increase the protocol version and all that entails!
static_assert(DEXOPT_PUBLIC == 1 << 1, "DEXOPT_PUBLIC unexpected.");
static_assert(DEXOPT_DEBUGGABLE == 1 << 2, "DEXOPT_DEBUGGABLE unexpected.");
static_assert(DEXOPT_BOOTCOMPLETE == 1 << 3, "DEXOPT_BOOTCOMPLETE unexpected.");
static_assert(DEXOPT_PROFILE_GUIDED == 1 << 4, "DEXOPT_PROFILE_GUIDED unexpected.");
static_assert(DEXOPT_SECONDARY_DEX == 1 << 5, "DEXOPT_SECONDARY_DEX unexpected.");
static_assert(DEXOPT_FORCE == 1 << 6, "DEXOPT_FORCE unexpected.");
static_assert(DEXOPT_STORAGE_CE == 1 << 7, "DEXOPT_STORAGE_CE unexpected.");
static_assert(DEXOPT_STORAGE_DE == 1 << 8, "DEXOPT_STORAGE_DE unexpected.");
static_assert(DEXOPT_ENABLE_HIDDEN_API_CHECKS == 1 << 10,
"DEXOPT_ENABLE_HIDDEN_API_CHECKS unexpected");
static_assert(DEXOPT_GENERATE_COMPACT_DEX == 1 << 11, "DEXOPT_GENERATE_COMPACT_DEX unexpected");
static_assert(DEXOPT_GENERATE_APP_IMAGE == 1 << 12, "DEXOPT_GENERATE_APP_IMAGE unexpected");
static_assert(DEXOPT_MASK == (0x3dfe | DEXOPT_IDLE_BACKGROUND_JOB),
"DEXOPT_MASK unexpected.");
constexpr const char* kAotCompilerFilters[]{
"space-profile", "space", "speed-profile", "speed", "everything-profile", "everything",
};
template<typename T>
static constexpr bool IsPowerOfTwo(T x) {
static_assert(std::is_integral<T>::value, "T must be integral");
// TODO: assert unsigned. There is currently many uses with signed values.
return (x & (x - 1)) == 0;
}
template<typename T>
static constexpr T RoundDown(T x, typename std::decay<T>::type n) {
return (x & -n);
}
template<typename T>
static constexpr T RoundUp(T x, typename std::remove_reference<T>::type n) {
return RoundDown(x + n - 1, n);
}
class OTAPreoptService {
public:
// Main driver. Performs the following steps.
//
// 1) Parse options (read system properties etc from B partition).
//
// 2) Read in package data.
//
// 3) Prepare environment variables.
//
// 4) Prepare(compile) boot image, if necessary.
//
// 5) Run update.
int Main(int argc, char** argv) {
if (!ReadArguments(argc, argv)) {
LOG(ERROR) << "Failed reading command line.";
return 1;
}
if (!ReadSystemProperties()) {
LOG(ERROR)<< "Failed reading system properties.";
return 2;
}
if (!ReadEnvironment()) {
LOG(ERROR) << "Failed reading environment properties.";
return 3;
}
if (!CheckAndInitializeInstalldGlobals()) {
LOG(ERROR) << "Failed initializing globals.";
return 4;
}
PrepareEnvironmentVariables();
if (!EnsureDalvikCache()) {
LOG(ERROR) << "Bad dalvik cache.";
return 5;
}
int dexopt_retcode = RunPreopt();
return dexopt_retcode;
}
int GetProperty(const char* key, char* value, const char* default_value) const {
const std::string* prop_value = system_properties_.GetProperty(key);
if (prop_value == nullptr) {
if (default_value == nullptr) {
return 0;
}
// Copy in the default value.
strlcpy(value, default_value, kPropertyValueMax - 1);
value[kPropertyValueMax - 1] = 0;
return strlen(default_value);// TODO: Need to truncate?
}
size_t size = std::min(kPropertyValueMax - 1, prop_value->length()) + 1;
strlcpy(value, prop_value->data(), size);
return static_cast<int>(size - 1);
}
std::string GetOTADataDirectory() const {
return StringPrintf("%s/%s", GetOtaDirectoryPrefix().c_str(), GetTargetSlot().c_str());
}
const std::string& GetTargetSlot() const {
return parameters_.target_slot;
}
private:
bool ReadSystemProperties() {
// TODO This file does not have a stable format. It should be read by
// code shared by init and otapreopt. See b/181182967#comment80
static constexpr const char* kPropertyFiles[] = {
"/system/build.prop"
};
for (size_t i = 0; i < arraysize(kPropertyFiles); ++i) {
if (!system_properties_.Load(kPropertyFiles[i])) {
return false;
}
}
return true;
}
bool ReadEnvironment() {
// Parse the environment variables from init.environ.rc, which have the form
// export NAME VALUE
// For simplicity, don't respect string quotation. The values we are interested in can be
// encoded without them.
//
// init.environ.rc and derive_classpath all have the same format for
// environment variable exports (since they are all meant to be read by
// init) and can be matched by the same regex.
std::regex export_regex("\\s*export\\s+(\\S+)\\s+(\\S+)");
auto parse_results = [&](auto& input) {
ParseFile(input, [&](const std::string& line) {
std::smatch export_match;
if (!std::regex_match(line, export_match, export_regex)) {
return true;
}
if (export_match.size() != 3) {
return true;
}
std::string name = export_match[1].str();
std::string value = export_match[2].str();
system_properties_.SetProperty(name, value);
return true;
});
};
// TODO Just like with the system-properties above we really should have
// common code between init and otapreopt to deal with reading these
// things. See b/181182967
// There have been a variety of places the various env-vars have been
// over the years. Expand or reduce this list as needed.
static constexpr const char* kEnvironmentVariableSources[] = {
"/init.environ.rc",
};
// First get everything from the static files.
for (const char* env_vars_file : kEnvironmentVariableSources) {
parse_results(env_vars_file);
}
// Next get everything from derive_classpath, since we're already in the
// chroot it will get the new versions of any dependencies.
{
android::base::unique_fd fd(memfd_create("derive_classpath_temp", MFD_CLOEXEC));
if (!fd.ok()) {
LOG(ERROR) << "Unable to create fd for derive_classpath";
return false;
}
std::string memfd_file = StringPrintf("/proc/%d/fd/%d", getpid(), fd.get());
std::string error_msg;
if (!Exec({"/apex/com.android.sdkext/bin/derive_classpath", memfd_file}, &error_msg)) {
PLOG(ERROR) << "Running derive_classpath failed: " << error_msg;
return false;
}
std::ifstream ifs(memfd_file);
parse_results(ifs);
}
if (system_properties_.GetProperty(kAndroidDataPathPropertyName) == nullptr) {
return false;
}
android_data_ = *system_properties_.GetProperty(kAndroidDataPathPropertyName);
if (system_properties_.GetProperty(kAndroidRootPathPropertyName) == nullptr) {
return false;
}
android_root_ = *system_properties_.GetProperty(kAndroidRootPathPropertyName);
if (system_properties_.GetProperty(kBootClassPathPropertyName) == nullptr) {
return false;
}
boot_classpath_ = *system_properties_.GetProperty(kBootClassPathPropertyName);
if (system_properties_.GetProperty(ASEC_MOUNTPOINT_ENV_NAME) == nullptr) {
return false;
}
asec_mountpoint_ = *system_properties_.GetProperty(ASEC_MOUNTPOINT_ENV_NAME);
return true;
}
const std::string& GetAndroidData() const {
return android_data_;
}
const std::string& GetAndroidRoot() const {
return android_root_;
}
const std::string GetOtaDirectoryPrefix() const {
return GetAndroidData() + "/ota";
}
bool CheckAndInitializeInstalldGlobals() {
// init_globals_from_data_and_root requires "ASEC_MOUNTPOINT" in the environment. We
// do not use any datapath that includes this, but we'll still have to set it.
CHECK(system_properties_.GetProperty(ASEC_MOUNTPOINT_ENV_NAME) != nullptr);
int result = setenv(ASEC_MOUNTPOINT_ENV_NAME, asec_mountpoint_.c_str(), 0);
if (result != 0) {
LOG(ERROR) << "Could not set ASEC_MOUNTPOINT environment variable";
return false;
}
if (!init_globals_from_data_and_root(GetAndroidData().c_str(), GetAndroidRoot().c_str())) {
LOG(ERROR) << "Could not initialize globals; exiting.";
return false;
}
// This is different from the normal installd. We only do the base
// directory, the rest will be created on demand when each app is compiled.
if (access(GetOtaDirectoryPrefix().c_str(), R_OK) < 0) {
PLOG(ERROR) << "Could not access " << GetOtaDirectoryPrefix();
return false;
}
return true;
}
bool ParseBool(const char* in) {
if (strcmp(in, "true") == 0) {
return true;
}
return false;
}
bool ParseUInt(const char* in, uint32_t* out) {
char* end;
long long int result = strtoll(in, &end, 0);
if (in == end || *end != '\0') {
return false;
}
if (result < std::numeric_limits<uint32_t>::min() ||
std::numeric_limits<uint32_t>::max() < result) {
return false;
}
*out = static_cast<uint32_t>(result);
return true;
}
bool ReadArguments(int argc, char** argv) {
return parameters_.ReadArguments(argc, const_cast<const char**>(argv));
}
void PrepareEnvironmentVariables() {
environ_.push_back(StringPrintf("BOOTCLASSPATH=%s", boot_classpath_.c_str()));
environ_.push_back(StringPrintf("ANDROID_DATA=%s", GetOTADataDirectory().c_str()));
environ_.push_back(StringPrintf("ANDROID_ROOT=%s", android_root_.c_str()));
for (const std::string& e : environ_) {
putenv(const_cast<char*>(e.c_str()));
}
}
// Ensure that we have the right cache file structures.
bool EnsureDalvikCache() const {
if (parameters_.instruction_set == nullptr) {
LOG(ERROR) << "Instruction set missing.";
return false;
}
const char* isa = parameters_.instruction_set;
std::string dalvik_cache = GetOTADataDirectory() + "/" + DALVIK_CACHE;
std::string isa_path = dalvik_cache + "/" + isa;
// Reset umask in otapreopt, so that we control the the access for the files we create.
umask(0);
// Create the directories, if necessary.
if (access(dalvik_cache.c_str(), F_OK) != 0) {
if (!CreatePath(dalvik_cache)) {
PLOG(ERROR) << "Could not create dalvik-cache dir " << dalvik_cache;
return false;
}
}
if (access(isa_path.c_str(), F_OK) != 0) {
if (!CreatePath(isa_path)) {
PLOG(ERROR) << "Could not create dalvik-cache isa dir";
return false;
}
}
return true;
}
static bool CreatePath(const std::string& path) {
// Create the given path. Use string processing instead of dirname, as dirname's need for
// a writable char buffer is painful.
// First, try to use the full path.
if (mkdir(path.c_str(), 0711) == 0) {
return true;
}
if (errno != ENOENT) {
PLOG(ERROR) << "Could not create path " << path;
return false;
}
// Now find the parent and try that first.
size_t last_slash = path.find_last_of('/');
if (last_slash == std::string::npos || last_slash == 0) {
PLOG(ERROR) << "Could not create " << path;
return false;
}
if (!CreatePath(path.substr(0, last_slash))) {
return false;
}
if (mkdir(path.c_str(), 0711) == 0) {
return true;
}
PLOG(ERROR) << "Could not create " << path;
return false;
}
static const char* ParseNull(const char* arg) {
return (strcmp(arg, "!") == 0) ? nullptr : arg;
}
bool IsAotCompilation() const {
if (std::find(std::begin(kAotCompilerFilters), std::end(kAotCompilerFilters),
std::string_view(parameters_.compiler_filter)) ==
std::end(kAotCompilerFilters)) {
return false;
}
int dexopt_flags = parameters_.dexopt_flags;
bool profile_guided = (dexopt_flags & DEXOPT_PROFILE_GUIDED) != 0;
bool is_secondary_dex = (dexopt_flags & DEXOPT_SECONDARY_DEX) != 0;
bool is_public = (dexopt_flags & DEXOPT_PUBLIC) != 0;
if (profile_guided) {
UniqueFile reference_profile =
maybe_open_reference_profile(parameters_.pkgName, parameters_.apk_path,
parameters_.profile_name, profile_guided,
is_public, parameters_.uid, is_secondary_dex);
// `maybe_open_reference_profile` installs a hook that clears the profile on
// destruction. Disable it.
reference_profile.DisableCleanup();
struct stat sbuf;
if (reference_profile.fd() == -1 ||
(fstat(reference_profile.fd(), &sbuf) != -1 && sbuf.st_size == 0)) {
return false;
}
}
return true;
}
bool ShouldSkipPreopt() const {
// There's one thing we have to be careful about: we may/will be asked to compile an app
// living in the system image. This may be a valid request - if the app wasn't compiled,
// e.g., if the system image wasn't large enough to include preopted files. However, the
// data we have is from the old system, so the driver (the OTA service) can't actually
// know. Thus, we will get requests for apps that have preopted components. To avoid
// duplication (we'd generate files that are not used and are *not* cleaned up), do two
// simple checks:
//
// 1) Does the apk_path start with the value of ANDROID_ROOT? (~in the system image)
// (For simplicity, assume the value of ANDROID_ROOT does not contain a symlink.)
//
// 2) If you replace the name in the apk_path with "oat," does the path exist?
// (=have a subdirectory for preopted files)
//
// If the answer to both is yes, skip the dexopt.
//
// Note: while one may think it's OK to call dexopt and it will fail (because APKs should
// be stripped), that's not true for APKs signed outside the build system (so the
// jar content must be exactly the same).
// (This is ugly as it's the only thing where we need to understand the contents
// of parameters_, but it beats postponing the decision or using the call-
// backs to do weird things.)
// In addition, no need to preopt for "verify". The existing vdex files in the OTA package
// and the /data partition will still be usable after the OTA update is applied.
const char* apk_path = parameters_.apk_path;
CHECK(apk_path != nullptr);
if (StartsWith(apk_path, android_root_) || !IsAotCompilation()) {
const char* last_slash = strrchr(apk_path, '/');
if (last_slash != nullptr) {
std::string path(apk_path, last_slash - apk_path + 1);
CHECK(EndsWith(path, "/"));
path = path + "oat";
if (access(path.c_str(), F_OK) == 0) {
LOG(INFO) << "Skipping A/B OTA preopt of already preopted package " << apk_path;
return true;
}
}
}
// Another issue is unavailability of files in the new system. If the partition
// layout changes, otapreopt_chroot may not know about this. Then files from that
// partition will not be available and fail to build. This is problematic, as
// this tool will wipe the OTA artifact cache and try again (for robustness after
// a failed OTA with remaining cache artifacts).
if (access(apk_path, F_OK) != 0) {
PLOG(WARNING) << "Skipping A/B OTA preopt of non-existing package " << apk_path;
return true;
}
return false;
}
// Run dexopt with the parameters of parameters_.
// TODO(calin): embed the profile name in the parameters.
int Dexopt() {
std::string error;
int dexopt_flags = parameters_.dexopt_flags;
// Make sure dex2oat is run with background priority.
dexopt_flags |= DEXOPT_BOOTCOMPLETE | DEXOPT_IDLE_BACKGROUND_JOB;
int res = dexopt(parameters_.apk_path,
parameters_.uid,
parameters_.pkgName,
parameters_.instruction_set,
parameters_.dexopt_needed,
parameters_.oat_dir,
dexopt_flags,
parameters_.compiler_filter,
parameters_.volume_uuid,
parameters_.shared_libraries,
parameters_.se_info,
parameters_.downgrade,
parameters_.target_sdk_version,
parameters_.profile_name,
parameters_.dex_metadata_path,
parameters_.compilation_reason,
&error);
if (res != 0) {
LOG(ERROR) << "During preopt of " << parameters_.apk_path << " got result " << res
<< " error: " << error;
}
return res;
}
int RunPreopt() {
if (ShouldSkipPreopt()) {
return 0;
}
int dexopt_result = Dexopt();
if (dexopt_result == 0) {
return 0;
}
if (WIFSIGNALED(dexopt_result)) {
LOG(WARNING) << "Interrupted by signal " << WTERMSIG(dexopt_result) ;
return dexopt_result;
}
// If this was a profile-guided run, we may have profile version issues. Try to downgrade,
// if possible.
if ((parameters_.dexopt_flags & DEXOPT_PROFILE_GUIDED) == 0) {
return dexopt_result;
}
LOG(WARNING) << "Downgrading compiler filter in an attempt to progress compilation";
parameters_.dexopt_flags &= ~DEXOPT_PROFILE_GUIDED;
return Dexopt();
}
static constexpr const char* kBootClassPathPropertyName = "BOOTCLASSPATH";
static constexpr const char* kAndroidRootPathPropertyName = "ANDROID_ROOT";
static constexpr const char* kAndroidDataPathPropertyName = "ANDROID_DATA";
// The index of the instruction-set string inside the package parameters. Needed for
// some special-casing that requires knowledge of the instruction-set.
static constexpr size_t kISAIndex = 3;
// Stores the system properties read out of the B partition. We need to use these properties
// to compile, instead of the A properties we could get from init/get_property.
SystemProperties system_properties_;
// Some select properties that are always needed.
std::string android_root_;
std::string android_data_;
std::string boot_classpath_;
std::string asec_mountpoint_;
OTAPreoptParameters parameters_;
// Store environment values we need to set.
std::vector<std::string> environ_;
};
OTAPreoptService gOps;
////////////////////////
// Plug-in functions. //
////////////////////////
int get_property(const char *key, char *value, const char *default_value) {
return gOps.GetProperty(key, value, default_value);
}
// Compute the output path of
bool calculate_oat_file_path(char path[PKG_PATH_MAX], const char *oat_dir,
const char *apk_path,
const char *instruction_set) {
const char *file_name_start;
const char *file_name_end;
file_name_start = strrchr(apk_path, '/');
if (file_name_start == nullptr) {
ALOGE("apk_path '%s' has no '/'s in it\n", apk_path);
return false;
}
file_name_end = strrchr(file_name_start, '.');
if (file_name_end == nullptr) {
ALOGE("apk_path '%s' has no extension\n", apk_path);
return false;
}
// Calculate file_name
file_name_start++; // Move past '/', is valid as file_name_end is valid.
size_t file_name_len = file_name_end - file_name_start;
std::string file_name(file_name_start, file_name_len);
// <apk_parent_dir>/oat/<isa>/<file_name>.odex.b
snprintf(path,
PKG_PATH_MAX,
"%s/%s/%s.odex.%s",
oat_dir,
instruction_set,
file_name.c_str(),
gOps.GetTargetSlot().c_str());
return true;
}
/*
* Computes the odex file for the given apk_path and instruction_set.
* /system/framework/whatever.jar -> /system/framework/oat/<isa>/whatever.odex
*
* Returns false if it failed to determine the odex file path.
*/
bool calculate_odex_file_path(char path[PKG_PATH_MAX], const char *apk_path,
const char *instruction_set) {
const char *path_end = strrchr(apk_path, '/');
if (path_end == nullptr) {
ALOGE("apk_path '%s' has no '/'s in it?!\n", apk_path);
return false;
}
std::string path_component(apk_path, path_end - apk_path);
const char *name_begin = path_end + 1;
const char *extension_start = strrchr(name_begin, '.');
if (extension_start == nullptr) {
ALOGE("apk_path '%s' has no extension.\n", apk_path);
return false;
}
std::string name_component(name_begin, extension_start - name_begin);
std::string new_path = StringPrintf("%s/oat/%s/%s.odex.%s",
path_component.c_str(),
instruction_set,
name_component.c_str(),
gOps.GetTargetSlot().c_str());
if (new_path.length() >= PKG_PATH_MAX) {
LOG(ERROR) << "apk_path of " << apk_path << " is too long: " << new_path;
return false;
}
strcpy(path, new_path.c_str());
return true;
}
bool create_cache_path(char path[PKG_PATH_MAX],
const char *src,
const char *instruction_set) {
size_t srclen = strlen(src);
/* demand that we are an absolute path */
if ((src == 0) || (src[0] != '/') || strstr(src,"..")) {
return false;
}
if (srclen > PKG_PATH_MAX) { // XXX: PKG_NAME_MAX?
return false;
}
std::string from_src = std::string(src + 1);
std::replace(from_src.begin(), from_src.end(), '/', '@');
std::string assembled_path = StringPrintf("%s/%s/%s/%s%s",
gOps.GetOTADataDirectory().c_str(),
DALVIK_CACHE,
instruction_set,
from_src.c_str(),
DALVIK_CACHE_POSTFIX);
if (assembled_path.length() + 1 > PKG_PATH_MAX) {
return false;
}
strcpy(path, assembled_path.c_str());
return true;
}
bool force_compile_without_image() {
// We don't have a boot image anyway. Compile without a boot image.
return true;
}
static int log_callback(int type, const char *fmt, ...) {
va_list ap;
int priority;
switch (type) {
case SELINUX_WARNING:
priority = ANDROID_LOG_WARN;
break;
case SELINUX_INFO:
priority = ANDROID_LOG_INFO;
break;
default:
priority = ANDROID_LOG_ERROR;
break;
}
va_start(ap, fmt);
LOG_PRI_VA(priority, "SELinux", fmt, ap);
va_end(ap);
return 0;
}
static int otapreopt_main(const int argc, char *argv[]) {
int selinux_enabled = (is_selinux_enabled() > 0);
setenv("ANDROID_LOG_TAGS", "*:v", 1);
android::base::InitLogging(argv);
if (argc < 2) {
ALOGE("Expecting parameters");
exit(1);
}
union selinux_callback cb;
cb.func_log = log_callback;
selinux_set_callback(SELINUX_CB_LOG, cb);
if (selinux_enabled && selinux_status_open(true) < 0) {
ALOGE("Could not open selinux status; exiting.\n");
exit(1);
}
int ret = android::installd::gOps.Main(argc, argv);
return ret;
}
} // namespace installd
} // namespace android
int main(const int argc, char *argv[]) {
return android::installd::otapreopt_main(argc, argv);
}