| /* |
| * Copyright (C) 2007 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 "private/recovery.h" |
| |
| #include <ctype.h> |
| #include <dirent.h> |
| #include <errno.h> |
| #include <fcntl.h> |
| #include <getopt.h> |
| #include <inttypes.h> |
| #include <limits.h> |
| #include <linux/fs.h> |
| #include <linux/input.h> |
| #include <stdarg.h> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <string.h> |
| #include <sys/klog.h> |
| #include <sys/stat.h> |
| #include <sys/types.h> |
| #include <sys/wait.h> |
| #include <time.h> |
| #include <unistd.h> |
| |
| #include <algorithm> |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include <android-base/file.h> |
| #include <android-base/logging.h> |
| #include <android-base/parseint.h> |
| #include <android-base/properties.h> |
| #include <android-base/stringprintf.h> |
| #include <android-base/strings.h> |
| #include <android-base/unique_fd.h> |
| #include <bootloader_message/bootloader_message.h> |
| #include <cutils/android_reboot.h> |
| #include <cutils/properties.h> /* for property_list */ |
| #include <healthd/BatteryMonitor.h> |
| #include <private/android_filesystem_config.h> /* for AID_SYSTEM */ |
| #include <private/android_logger.h> /* private pmsg functions */ |
| #include <selinux/android.h> |
| #include <selinux/label.h> |
| #include <selinux/selinux.h> |
| #include <ziparchive/zip_archive.h> |
| |
| #include "adb_install.h" |
| #include "common.h" |
| #include "device.h" |
| #include "fuse_sdcard_provider.h" |
| #include "fuse_sideload.h" |
| #include "install.h" |
| #include "minui/minui.h" |
| #include "otautil/DirUtil.h" |
| #include "otautil/error_code.h" |
| #include "otautil/paths.h" |
| #include "roots.h" |
| #include "rotate_logs.h" |
| #include "screen_ui.h" |
| #include "stub_ui.h" |
| #include "ui.h" |
| |
| static constexpr const char* CACHE_LOG_DIR = "/cache/recovery"; |
| static constexpr const char* COMMAND_FILE = "/cache/recovery/command"; |
| static constexpr const char* LOG_FILE = "/cache/recovery/log"; |
| static constexpr const char* LAST_INSTALL_FILE = "/cache/recovery/last_install"; |
| static constexpr const char* LAST_KMSG_FILE = "/cache/recovery/last_kmsg"; |
| static constexpr const char* LAST_LOG_FILE = "/cache/recovery/last_log"; |
| static constexpr const char* LOCALE_FILE = "/cache/recovery/last_locale"; |
| |
| static constexpr const char* CACHE_ROOT = "/cache"; |
| static constexpr const char* DATA_ROOT = "/data"; |
| static constexpr const char* METADATA_ROOT = "/metadata"; |
| static constexpr const char* SDCARD_ROOT = "/sdcard"; |
| |
| // We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed |
| // into target_files.zip. Assert the version defined in code and in Android.mk are consistent. |
| static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions."); |
| |
| static std::string locale; |
| static bool has_cache = false; |
| |
| RecoveryUI* ui = nullptr; |
| bool modified_flash = false; |
| std::string stage; |
| const char* reason = nullptr; |
| struct selabel_handle* sehandle; |
| |
| /* |
| * The recovery tool communicates with the main system through /cache files. |
| * /cache/recovery/command - INPUT - command line for tool, one arg per line |
| * /cache/recovery/log - OUTPUT - combined log file from recovery run(s) |
| * |
| * The arguments which may be supplied in the recovery.command file: |
| * --update_package=path - verify install an OTA package file |
| * --wipe_data - erase user data (and cache), then reboot |
| * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user |
| * data (and cache), then reboot |
| * --wipe_cache - wipe cache (but not user data), then reboot |
| * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519). |
| * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs |
| * --just_exit - do nothing; exit and reboot |
| * |
| * After completing, we remove /cache/recovery/command and reboot. |
| * Arguments may also be supplied in the bootloader control block (BCB). |
| * These important scenarios must be safely restartable at any point: |
| * |
| * FACTORY RESET |
| * 1. user selects "factory reset" |
| * 2. main system writes "--wipe_data" to /cache/recovery/command |
| * 3. main system reboots into recovery |
| * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data" |
| * -- after this, rebooting will restart the erase -- |
| * 5. erase_volume() reformats /data |
| * 6. erase_volume() reformats /cache |
| * 7. finish_recovery() erases BCB |
| * -- after this, rebooting will restart the main system -- |
| * 8. main() calls reboot() to boot main system |
| * |
| * OTA INSTALL |
| * 1. main system downloads OTA package to /cache/some-filename.zip |
| * 2. main system writes "--update_package=/cache/some-filename.zip" |
| * 3. main system reboots into recovery |
| * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..." |
| * -- after this, rebooting will attempt to reinstall the update -- |
| * 5. install_package() attempts to install the update |
| * NOTE: the package install must itself be restartable from any point |
| * 6. finish_recovery() erases BCB |
| * -- after this, rebooting will (try to) restart the main system -- |
| * 7. ** if install failed ** |
| * 7a. prompt_and_wait() shows an error icon and waits for the user |
| * 7b. the user reboots (pulling the battery, etc) into the main system |
| */ |
| |
| FILE* fopen_path(const std::string& path, const char* mode) { |
| if (ensure_path_mounted(path.c_str()) != 0) { |
| LOG(ERROR) << "Can't mount " << path; |
| return nullptr; |
| } |
| |
| // When writing, try to create the containing directory, if necessary. Use generous permissions, |
| // the system (init.rc) will reset them. |
| if (strchr("wa", mode[0])) { |
| mkdir_recursively(path, 0777, true, sehandle); |
| } |
| return fopen(path.c_str(), mode); |
| } |
| |
| void check_and_fclose(FILE* fp, const std::string& name) { |
| fflush(fp); |
| if (fsync(fileno(fp)) == -1) { |
| PLOG(ERROR) << "Failed to fsync " << name; |
| } |
| if (ferror(fp)) { |
| PLOG(ERROR) << "Error in " << name; |
| } |
| fclose(fp); |
| } |
| |
| bool is_ro_debuggable() { |
| return android::base::GetBoolProperty("ro.debuggable", false); |
| } |
| |
| bool reboot(const std::string& command) { |
| std::string cmd = command; |
| if (android::base::GetBoolProperty("ro.boot.quiescent", false)) { |
| cmd += ",quiescent"; |
| } |
| return android::base::SetProperty(ANDROID_RB_PROPERTY, cmd); |
| } |
| |
| // command line args come from, in decreasing precedence: |
| // - the actual command line |
| // - the bootloader control block (one per line, after "recovery") |
| // - the contents of COMMAND_FILE (one per line) |
| static std::vector<std::string> get_args(const int argc, char** const argv) { |
| CHECK_GT(argc, 0); |
| |
| bootloader_message boot = {}; |
| std::string err; |
| if (!read_bootloader_message(&boot, &err)) { |
| LOG(ERROR) << err; |
| // If fails, leave a zeroed bootloader_message. |
| boot = {}; |
| } |
| stage = std::string(boot.stage); |
| |
| if (boot.command[0] != 0) { |
| std::string boot_command = std::string(boot.command, sizeof(boot.command)); |
| LOG(INFO) << "Boot command: " << boot_command; |
| } |
| |
| if (boot.status[0] != 0) { |
| std::string boot_status = std::string(boot.status, sizeof(boot.status)); |
| LOG(INFO) << "Boot status: " << boot_status; |
| } |
| |
| std::vector<std::string> args(argv, argv + argc); |
| |
| // --- if arguments weren't supplied, look in the bootloader control block |
| if (args.size() == 1) { |
| boot.recovery[sizeof(boot.recovery) - 1] = '\0'; // Ensure termination |
| std::string boot_recovery(boot.recovery); |
| std::vector<std::string> tokens = android::base::Split(boot_recovery, "\n"); |
| if (!tokens.empty() && tokens[0] == "recovery") { |
| for (auto it = tokens.begin() + 1; it != tokens.end(); it++) { |
| // Skip empty and '\0'-filled tokens. |
| if (!it->empty() && (*it)[0] != '\0') args.push_back(std::move(*it)); |
| } |
| LOG(INFO) << "Got " << args.size() << " arguments from boot message"; |
| } else if (boot.recovery[0] != 0) { |
| LOG(ERROR) << "Bad boot message: \"" << boot_recovery << "\""; |
| } |
| } |
| |
| // --- if that doesn't work, try the command file (if we have /cache). |
| if (args.size() == 1 && has_cache) { |
| std::string content; |
| if (ensure_path_mounted(COMMAND_FILE) == 0 && |
| android::base::ReadFileToString(COMMAND_FILE, &content)) { |
| std::vector<std::string> tokens = android::base::Split(content, "\n"); |
| // All the arguments in COMMAND_FILE are needed (unlike the BCB message, |
| // COMMAND_FILE doesn't use filename as the first argument). |
| for (auto it = tokens.begin(); it != tokens.end(); it++) { |
| // Skip empty and '\0'-filled tokens. |
| if (!it->empty() && (*it)[0] != '\0') args.push_back(std::move(*it)); |
| } |
| LOG(INFO) << "Got " << args.size() << " arguments from " << COMMAND_FILE; |
| } |
| } |
| |
| // Write the arguments (excluding the filename in args[0]) back into the |
| // bootloader control block. So the device will always boot into recovery to |
| // finish the pending work, until finish_recovery() is called. |
| std::vector<std::string> options(args.cbegin() + 1, args.cend()); |
| if (!update_bootloader_message(options, &err)) { |
| LOG(ERROR) << "Failed to set BCB message: " << err; |
| } |
| |
| return args; |
| } |
| |
| // Set the BCB to reboot back into recovery (it won't resume the install from |
| // sdcard though). |
| static void set_sdcard_update_bootloader_message() { |
| std::vector<std::string> options; |
| std::string err; |
| if (!update_bootloader_message(options, &err)) { |
| LOG(ERROR) << "Failed to set BCB message: " << err; |
| } |
| } |
| |
| // Read from kernel log into buffer and write out to file. |
| static void save_kernel_log(const char* destination) { |
| int klog_buf_len = klogctl(KLOG_SIZE_BUFFER, 0, 0); |
| if (klog_buf_len <= 0) { |
| PLOG(ERROR) << "Error getting klog size"; |
| return; |
| } |
| |
| std::string buffer(klog_buf_len, 0); |
| int n = klogctl(KLOG_READ_ALL, &buffer[0], klog_buf_len); |
| if (n == -1) { |
| PLOG(ERROR) << "Error in reading klog"; |
| return; |
| } |
| buffer.resize(n); |
| android::base::WriteStringToFile(buffer, destination); |
| } |
| |
| // Writes content to the current pmsg session. |
| static ssize_t __pmsg_write(const std::string& filename, const std::string& buf) { |
| return __android_log_pmsg_file_write(LOG_ID_SYSTEM, ANDROID_LOG_INFO, filename.c_str(), |
| buf.data(), buf.size()); |
| } |
| |
| static void copy_log_file_to_pmsg(const std::string& source, const std::string& destination) { |
| std::string content; |
| android::base::ReadFileToString(source, &content); |
| __pmsg_write(destination, content); |
| } |
| |
| // How much of the temp log we have copied to the copy in cache. |
| static off_t tmplog_offset = 0; |
| |
| static void copy_log_file(const std::string& source, const std::string& destination, bool append) { |
| FILE* dest_fp = fopen_path(destination, append ? "ae" : "we"); |
| if (dest_fp == nullptr) { |
| PLOG(ERROR) << "Can't open " << destination; |
| } else { |
| FILE* source_fp = fopen(source.c_str(), "re"); |
| if (source_fp != nullptr) { |
| if (append) { |
| fseeko(source_fp, tmplog_offset, SEEK_SET); // Since last write |
| } |
| char buf[4096]; |
| size_t bytes; |
| while ((bytes = fread(buf, 1, sizeof(buf), source_fp)) != 0) { |
| fwrite(buf, 1, bytes, dest_fp); |
| } |
| if (append) { |
| tmplog_offset = ftello(source_fp); |
| } |
| check_and_fclose(source_fp, source); |
| } |
| check_and_fclose(dest_fp, destination); |
| } |
| } |
| |
| static void copy_logs() { |
| // We only rotate and record the log of the current session if there are actual attempts to modify |
| // the flash, such as wipes, installs from BCB or menu selections. This is to avoid unnecessary |
| // rotation (and possible deletion) of log files, if it does not do anything loggable. |
| if (!modified_flash) { |
| return; |
| } |
| |
| // Always write to pmsg, this allows the OTA logs to be caught in `logcat -L`. |
| copy_log_file_to_pmsg(Paths::Get().temporary_log_file(), LAST_LOG_FILE); |
| copy_log_file_to_pmsg(Paths::Get().temporary_install_file(), LAST_INSTALL_FILE); |
| |
| // We can do nothing for now if there's no /cache partition. |
| if (!has_cache) { |
| return; |
| } |
| |
| ensure_path_mounted(LAST_LOG_FILE); |
| ensure_path_mounted(LAST_KMSG_FILE); |
| rotate_logs(LAST_LOG_FILE, LAST_KMSG_FILE); |
| |
| // Copy logs to cache so the system can find out what happened. |
| copy_log_file(Paths::Get().temporary_log_file(), LOG_FILE, true); |
| copy_log_file(Paths::Get().temporary_log_file(), LAST_LOG_FILE, false); |
| copy_log_file(Paths::Get().temporary_install_file(), LAST_INSTALL_FILE, false); |
| save_kernel_log(LAST_KMSG_FILE); |
| chmod(LOG_FILE, 0600); |
| chown(LOG_FILE, AID_SYSTEM, AID_SYSTEM); |
| chmod(LAST_KMSG_FILE, 0600); |
| chown(LAST_KMSG_FILE, AID_SYSTEM, AID_SYSTEM); |
| chmod(LAST_LOG_FILE, 0640); |
| chmod(LAST_INSTALL_FILE, 0644); |
| sync(); |
| } |
| |
| // Clear the recovery command and prepare to boot a (hopefully working) system, |
| // copy our log file to cache as well (for the system to read). This function is |
| // idempotent: call it as many times as you like. |
| static void finish_recovery() { |
| // Save the locale to cache, so if recovery is next started up without a '--locale' argument |
| // (e.g., directly from the bootloader) it will use the last-known locale. |
| if (!locale.empty() && has_cache) { |
| LOG(INFO) << "Saving locale \"" << locale << "\""; |
| if (ensure_path_mounted(LOCALE_FILE) != 0) { |
| LOG(ERROR) << "Failed to mount " << LOCALE_FILE; |
| } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) { |
| PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE; |
| } |
| } |
| |
| copy_logs(); |
| |
| // Reset to normal system boot so recovery won't cycle indefinitely. |
| std::string err; |
| if (!clear_bootloader_message(&err)) { |
| LOG(ERROR) << "Failed to clear BCB message: " << err; |
| } |
| |
| // Remove the command file, so recovery won't repeat indefinitely. |
| if (has_cache) { |
| if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) { |
| LOG(WARNING) << "Can't unlink " << COMMAND_FILE; |
| } |
| ensure_path_unmounted(CACHE_ROOT); |
| } |
| |
| sync(); // For good measure. |
| } |
| |
| struct saved_log_file { |
| std::string name; |
| struct stat sb; |
| std::string data; |
| }; |
| |
| static bool erase_volume(const char* volume) { |
| bool is_cache = (strcmp(volume, CACHE_ROOT) == 0); |
| bool is_data = (strcmp(volume, DATA_ROOT) == 0); |
| |
| ui->SetBackground(RecoveryUI::ERASING); |
| ui->SetProgressType(RecoveryUI::INDETERMINATE); |
| |
| std::vector<saved_log_file> log_files; |
| |
| if (is_cache) { |
| // If we're reformatting /cache, we load any past logs |
| // (i.e. "/cache/recovery/last_*") and the current log |
| // ("/cache/recovery/log") into memory, so we can restore them after |
| // the reformat. |
| |
| ensure_path_mounted(volume); |
| |
| struct dirent* de; |
| std::unique_ptr<DIR, decltype(&closedir)> d(opendir(CACHE_LOG_DIR), closedir); |
| if (d) { |
| while ((de = readdir(d.get())) != nullptr) { |
| if (strncmp(de->d_name, "last_", 5) == 0 || strcmp(de->d_name, "log") == 0) { |
| std::string path = android::base::StringPrintf("%s/%s", CACHE_LOG_DIR, de->d_name); |
| |
| struct stat sb; |
| if (stat(path.c_str(), &sb) == 0) { |
| // truncate files to 512kb |
| if (sb.st_size > (1 << 19)) { |
| sb.st_size = 1 << 19; |
| } |
| |
| std::string data(sb.st_size, '\0'); |
| FILE* f = fopen(path.c_str(), "rbe"); |
| fread(&data[0], 1, data.size(), f); |
| fclose(f); |
| |
| log_files.emplace_back(saved_log_file{ path, sb, data }); |
| } |
| } |
| } |
| } else { |
| if (errno != ENOENT) { |
| PLOG(ERROR) << "Failed to opendir " << CACHE_LOG_DIR; |
| } |
| } |
| } |
| |
| ui->Print("Formatting %s...\n", volume); |
| |
| ensure_path_unmounted(volume); |
| |
| int result; |
| if (is_data && reason && strcmp(reason, "convert_fbe") == 0) { |
| static constexpr const char* CONVERT_FBE_DIR = "/tmp/convert_fbe"; |
| static constexpr const char* CONVERT_FBE_FILE = "/tmp/convert_fbe/convert_fbe"; |
| // Create convert_fbe breadcrumb file to signal init to convert to file based encryption, not |
| // full disk encryption. |
| if (mkdir(CONVERT_FBE_DIR, 0700) != 0) { |
| PLOG(ERROR) << "Failed to mkdir " << CONVERT_FBE_DIR; |
| return false; |
| } |
| FILE* f = fopen(CONVERT_FBE_FILE, "wbe"); |
| if (!f) { |
| PLOG(ERROR) << "Failed to convert to file encryption"; |
| return false; |
| } |
| fclose(f); |
| result = format_volume(volume, CONVERT_FBE_DIR); |
| remove(CONVERT_FBE_FILE); |
| rmdir(CONVERT_FBE_DIR); |
| } else { |
| result = format_volume(volume); |
| } |
| |
| if (is_cache) { |
| // Re-create the log dir and write back the log entries. |
| if (ensure_path_mounted(CACHE_LOG_DIR) == 0 && |
| mkdir_recursively(CACHE_LOG_DIR, 0777, false, sehandle) == 0) { |
| for (const auto& log : log_files) { |
| if (!android::base::WriteStringToFile(log.data, log.name, log.sb.st_mode, log.sb.st_uid, |
| log.sb.st_gid)) { |
| PLOG(ERROR) << "Failed to write to " << log.name; |
| } |
| } |
| } else { |
| PLOG(ERROR) << "Failed to mount / create " << CACHE_LOG_DIR; |
| } |
| |
| // Any part of the log we'd copied to cache is now gone. |
| // Reset the pointer so we copy from the beginning of the temp |
| // log. |
| tmplog_offset = 0; |
| copy_logs(); |
| } |
| |
| return (result == 0); |
| } |
| |
| // Display a menu with the specified 'headers' and 'items'. Device specific HandleMenuKey() may |
| // return a positive number beyond the given range. Caller sets 'menu_only' to true to ensure only |
| // a menu item gets selected. 'initial_selection' controls the initial cursor location. Returns the |
| // (non-negative) chosen item number, or -1 if timed out waiting for input. |
| static int get_menu_selection(const char* const* headers, const char* const* items, bool menu_only, |
| int initial_selection, Device* device) { |
| // Throw away keys pressed previously, so user doesn't accidentally trigger menu items. |
| ui->FlushKeys(); |
| |
| ui->StartMenu(headers, items, initial_selection); |
| |
| int selected = initial_selection; |
| int chosen_item = -1; |
| while (chosen_item < 0) { |
| int key = ui->WaitKey(); |
| if (key == -1) { // WaitKey() timed out. |
| if (ui->WasTextEverVisible()) { |
| continue; |
| } else { |
| LOG(INFO) << "Timed out waiting for key input; rebooting."; |
| ui->EndMenu(); |
| return -1; |
| } |
| } |
| |
| bool visible = ui->IsTextVisible(); |
| int action = device->HandleMenuKey(key, visible); |
| |
| if (action < 0) { |
| switch (action) { |
| case Device::kHighlightUp: |
| selected = ui->SelectMenu(--selected); |
| break; |
| case Device::kHighlightDown: |
| selected = ui->SelectMenu(++selected); |
| break; |
| case Device::kInvokeItem: |
| chosen_item = selected; |
| break; |
| case Device::kNoAction: |
| break; |
| } |
| } else if (!menu_only) { |
| chosen_item = action; |
| } |
| } |
| |
| ui->EndMenu(); |
| return chosen_item; |
| } |
| |
| // Returns the selected filename, or an empty string. |
| static std::string browse_directory(const std::string& path, Device* device) { |
| ensure_path_mounted(path.c_str()); |
| |
| std::unique_ptr<DIR, decltype(&closedir)> d(opendir(path.c_str()), closedir); |
| if (!d) { |
| PLOG(ERROR) << "error opening " << path; |
| return ""; |
| } |
| |
| std::vector<std::string> dirs; |
| std::vector<std::string> zips = { "../" }; // "../" is always the first entry. |
| |
| dirent* de; |
| while ((de = readdir(d.get())) != nullptr) { |
| std::string name(de->d_name); |
| |
| if (de->d_type == DT_DIR) { |
| // Skip "." and ".." entries. |
| if (name == "." || name == "..") continue; |
| dirs.push_back(name + "/"); |
| } else if (de->d_type == DT_REG && android::base::EndsWithIgnoreCase(name, ".zip")) { |
| zips.push_back(name); |
| } |
| } |
| |
| std::sort(dirs.begin(), dirs.end()); |
| std::sort(zips.begin(), zips.end()); |
| |
| // Append dirs to the zips list. |
| zips.insert(zips.end(), dirs.begin(), dirs.end()); |
| |
| const char* entries[zips.size() + 1]; |
| entries[zips.size()] = nullptr; |
| for (size_t i = 0; i < zips.size(); i++) { |
| entries[i] = zips[i].c_str(); |
| } |
| |
| const char* headers[] = { "Choose a package to install:", path.c_str(), nullptr }; |
| |
| int chosen_item = 0; |
| while (true) { |
| chosen_item = get_menu_selection(headers, entries, true, chosen_item, device); |
| |
| const std::string& item = zips[chosen_item]; |
| if (chosen_item == 0) { |
| // Go up but continue browsing (if the caller is browse_directory). |
| return ""; |
| } |
| |
| std::string new_path = path + "/" + item; |
| if (new_path.back() == '/') { |
| // Recurse down into a subdirectory. |
| new_path.pop_back(); |
| std::string result = browse_directory(new_path, device); |
| if (!result.empty()) return result; |
| } else { |
| // Selected a zip file: return the path to the caller. |
| return new_path; |
| } |
| } |
| |
| // Unreachable. |
| } |
| |
| static bool yes_no(Device* device, const char* question1, const char* question2) { |
| const char* headers[] = { question1, question2, NULL }; |
| const char* items[] = { " No", " Yes", NULL }; |
| |
| int chosen_item = get_menu_selection(headers, items, true, 0, device); |
| return (chosen_item == 1); |
| } |
| |
| static bool ask_to_wipe_data(Device* device) { |
| return yes_no(device, "Wipe all user data?", " THIS CAN NOT BE UNDONE!"); |
| } |
| |
| // Return true on success. |
| static bool wipe_data(Device* device) { |
| modified_flash = true; |
| |
| ui->Print("\n-- Wiping data...\n"); |
| bool success = device->PreWipeData(); |
| if (success) { |
| success &= erase_volume(DATA_ROOT); |
| if (has_cache) { |
| success &= erase_volume(CACHE_ROOT); |
| } |
| if (volume_for_mount_point(METADATA_ROOT) != nullptr) { |
| success &= erase_volume(METADATA_ROOT); |
| } |
| } |
| if (success) { |
| success &= device->PostWipeData(); |
| } |
| ui->Print("Data wipe %s.\n", success ? "complete" : "failed"); |
| return success; |
| } |
| |
| static bool prompt_and_wipe_data(Device* device) { |
| // Use a single string and let ScreenRecoveryUI handles the wrapping. |
| const char* const headers[] = { |
| "Can't load Android system. Your data may be corrupt. " |
| "If you continue to get this message, you may need to " |
| "perform a factory data reset and erase all user data " |
| "stored on this device.", |
| nullptr |
| }; |
| const char* const items[] = { |
| "Try again", |
| "Factory data reset", |
| NULL |
| }; |
| for (;;) { |
| int chosen_item = get_menu_selection(headers, items, true, 0, device); |
| if (chosen_item != 1) { |
| return true; // Just reboot, no wipe; not a failure, user asked for it |
| } |
| if (ask_to_wipe_data(device)) { |
| return wipe_data(device); |
| } |
| } |
| } |
| |
| // Return true on success. |
| static bool wipe_cache(bool should_confirm, Device* device) { |
| if (!has_cache) { |
| ui->Print("No /cache partition found.\n"); |
| return false; |
| } |
| |
| if (should_confirm && !yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!")) { |
| return false; |
| } |
| |
| modified_flash = true; |
| |
| ui->Print("\n-- Wiping cache...\n"); |
| bool success = erase_volume("/cache"); |
| ui->Print("Cache wipe %s.\n", success ? "complete" : "failed"); |
| return success; |
| } |
| |
| // Secure-wipe a given partition. It uses BLKSECDISCARD, if supported. Otherwise, it goes with |
| // BLKDISCARD (if device supports BLKDISCARDZEROES) or BLKZEROOUT. |
| static bool secure_wipe_partition(const std::string& partition) { |
| android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(partition.c_str(), O_WRONLY))); |
| if (fd == -1) { |
| PLOG(ERROR) << "Failed to open \"" << partition << "\""; |
| return false; |
| } |
| |
| uint64_t range[2] = { 0, 0 }; |
| if (ioctl(fd, BLKGETSIZE64, &range[1]) == -1 || range[1] == 0) { |
| PLOG(ERROR) << "Failed to get partition size"; |
| return false; |
| } |
| LOG(INFO) << "Secure-wiping \"" << partition << "\" from " << range[0] << " to " << range[1]; |
| |
| LOG(INFO) << " Trying BLKSECDISCARD..."; |
| if (ioctl(fd, BLKSECDISCARD, &range) == -1) { |
| PLOG(WARNING) << " Failed"; |
| |
| // Use BLKDISCARD if it zeroes out blocks, otherwise use BLKZEROOUT. |
| unsigned int zeroes; |
| if (ioctl(fd, BLKDISCARDZEROES, &zeroes) == 0 && zeroes != 0) { |
| LOG(INFO) << " Trying BLKDISCARD..."; |
| if (ioctl(fd, BLKDISCARD, &range) == -1) { |
| PLOG(ERROR) << " Failed"; |
| return false; |
| } |
| } else { |
| LOG(INFO) << " Trying BLKZEROOUT..."; |
| if (ioctl(fd, BLKZEROOUT, &range) == -1) { |
| PLOG(ERROR) << " Failed"; |
| return false; |
| } |
| } |
| } |
| |
| LOG(INFO) << " Done"; |
| return true; |
| } |
| |
| // Check if the wipe package matches expectation: |
| // 1. verify the package. |
| // 2. check metadata (ota-type, pre-device and serial number if having one). |
| static bool check_wipe_package(size_t wipe_package_size) { |
| if (wipe_package_size == 0) { |
| LOG(ERROR) << "wipe_package_size is zero"; |
| return false; |
| } |
| std::string wipe_package; |
| std::string err_str; |
| if (!read_wipe_package(&wipe_package, wipe_package_size, &err_str)) { |
| PLOG(ERROR) << "Failed to read wipe package"; |
| return false; |
| } |
| if (!verify_package(reinterpret_cast<const unsigned char*>(wipe_package.data()), |
| wipe_package.size())) { |
| LOG(ERROR) << "Failed to verify package"; |
| return false; |
| } |
| |
| // Extract metadata |
| ZipArchiveHandle zip; |
| int err = OpenArchiveFromMemory(static_cast<void*>(&wipe_package[0]), wipe_package.size(), |
| "wipe_package", &zip); |
| if (err != 0) { |
| LOG(ERROR) << "Can't open wipe package : " << ErrorCodeString(err); |
| return false; |
| } |
| std::string metadata; |
| if (!read_metadata_from_package(zip, &metadata)) { |
| CloseArchive(zip); |
| return false; |
| } |
| CloseArchive(zip); |
| |
| // Check metadata |
| std::vector<std::string> lines = android::base::Split(metadata, "\n"); |
| bool ota_type_matched = false; |
| bool device_type_matched = false; |
| bool has_serial_number = false; |
| bool serial_number_matched = false; |
| for (const auto& line : lines) { |
| if (line == "ota-type=BRICK") { |
| ota_type_matched = true; |
| } else if (android::base::StartsWith(line, "pre-device=")) { |
| std::string device_type = line.substr(strlen("pre-device=")); |
| std::string real_device_type = android::base::GetProperty("ro.build.product", ""); |
| device_type_matched = (device_type == real_device_type); |
| } else if (android::base::StartsWith(line, "serialno=")) { |
| std::string serial_no = line.substr(strlen("serialno=")); |
| std::string real_serial_no = android::base::GetProperty("ro.serialno", ""); |
| has_serial_number = true; |
| serial_number_matched = (serial_no == real_serial_no); |
| } |
| } |
| return ota_type_matched && device_type_matched && (!has_serial_number || serial_number_matched); |
| } |
| |
| // Wipes the current A/B device, with a secure wipe of all the partitions in RECOVERY_WIPE. |
| static bool wipe_ab_device(size_t wipe_package_size) { |
| ui->SetBackground(RecoveryUI::ERASING); |
| ui->SetProgressType(RecoveryUI::INDETERMINATE); |
| |
| if (!check_wipe_package(wipe_package_size)) { |
| LOG(ERROR) << "Failed to verify wipe package"; |
| return false; |
| } |
| static constexpr const char* RECOVERY_WIPE = "/etc/recovery.wipe"; |
| std::string partition_list; |
| if (!android::base::ReadFileToString(RECOVERY_WIPE, &partition_list)) { |
| LOG(ERROR) << "failed to read \"" << RECOVERY_WIPE << "\""; |
| return false; |
| } |
| |
| std::vector<std::string> lines = android::base::Split(partition_list, "\n"); |
| for (const std::string& line : lines) { |
| std::string partition = android::base::Trim(line); |
| // Ignore '#' comment or empty lines. |
| if (android::base::StartsWith(partition, "#") || partition.empty()) { |
| continue; |
| } |
| |
| // Proceed anyway even if it fails to wipe some partition. |
| secure_wipe_partition(partition); |
| } |
| return true; |
| } |
| |
| static void choose_recovery_file(Device* device) { |
| std::vector<std::string> entries; |
| if (has_cache) { |
| for (int i = 0; i < KEEP_LOG_COUNT; i++) { |
| auto add_to_entries = [&](const char* filename) { |
| std::string log_file(filename); |
| if (i > 0) { |
| log_file += "." + std::to_string(i); |
| } |
| |
| if (ensure_path_mounted(log_file.c_str()) == 0 && access(log_file.c_str(), R_OK) == 0) { |
| entries.push_back(std::move(log_file)); |
| } |
| }; |
| |
| // Add LAST_LOG_FILE + LAST_LOG_FILE.x |
| add_to_entries(LAST_LOG_FILE); |
| |
| // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x |
| add_to_entries(LAST_KMSG_FILE); |
| } |
| } else { |
| // If cache partition is not found, view /tmp/recovery.log instead. |
| if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) { |
| return; |
| } else { |
| entries.push_back(Paths::Get().temporary_log_file()); |
| } |
| } |
| |
| entries.push_back("Back"); |
| |
| std::vector<const char*> menu_entries(entries.size()); |
| std::transform(entries.cbegin(), entries.cend(), menu_entries.begin(), |
| [](const std::string& entry) { return entry.c_str(); }); |
| menu_entries.push_back(nullptr); |
| |
| const char* headers[] = { "Select file to view", nullptr }; |
| |
| int chosen_item = 0; |
| while (true) { |
| chosen_item = get_menu_selection(headers, menu_entries.data(), true, chosen_item, device); |
| if (entries[chosen_item] == "Back") break; |
| |
| ui->ShowFile(entries[chosen_item].c_str()); |
| } |
| } |
| |
| static void run_graphics_test() { |
| // Switch to graphics screen. |
| ui->ShowText(false); |
| |
| ui->SetProgressType(RecoveryUI::INDETERMINATE); |
| ui->SetBackground(RecoveryUI::INSTALLING_UPDATE); |
| sleep(1); |
| |
| ui->SetBackground(RecoveryUI::ERROR); |
| sleep(1); |
| |
| ui->SetBackground(RecoveryUI::NO_COMMAND); |
| sleep(1); |
| |
| ui->SetBackground(RecoveryUI::ERASING); |
| sleep(1); |
| |
| // Calling SetBackground() after SetStage() to trigger a redraw. |
| ui->SetStage(1, 3); |
| ui->SetBackground(RecoveryUI::INSTALLING_UPDATE); |
| sleep(1); |
| ui->SetStage(2, 3); |
| ui->SetBackground(RecoveryUI::INSTALLING_UPDATE); |
| sleep(1); |
| ui->SetStage(3, 3); |
| ui->SetBackground(RecoveryUI::INSTALLING_UPDATE); |
| sleep(1); |
| |
| ui->SetStage(-1, -1); |
| ui->SetBackground(RecoveryUI::INSTALLING_UPDATE); |
| |
| ui->SetProgressType(RecoveryUI::DETERMINATE); |
| ui->ShowProgress(1.0, 10.0); |
| float fraction = 0.0; |
| for (size_t i = 0; i < 100; ++i) { |
| fraction += .01; |
| ui->SetProgress(fraction); |
| usleep(100000); |
| } |
| |
| ui->ShowText(true); |
| } |
| |
| // How long (in seconds) we wait for the fuse-provided package file to |
| // appear, before timing out. |
| #define SDCARD_INSTALL_TIMEOUT 10 |
| |
| static int apply_from_sdcard(Device* device, bool* wipe_cache) { |
| modified_flash = true; |
| |
| if (ensure_path_mounted(SDCARD_ROOT) != 0) { |
| ui->Print("\n-- Couldn't mount %s.\n", SDCARD_ROOT); |
| return INSTALL_ERROR; |
| } |
| |
| std::string path = browse_directory(SDCARD_ROOT, device); |
| if (path.empty()) { |
| ui->Print("\n-- No package file selected.\n"); |
| ensure_path_unmounted(SDCARD_ROOT); |
| return INSTALL_ERROR; |
| } |
| |
| ui->Print("\n-- Install %s ...\n", path.c_str()); |
| set_sdcard_update_bootloader_message(); |
| |
| // We used to use fuse in a thread as opposed to a process. Since accessing |
| // through fuse involves going from kernel to userspace to kernel, it leads |
| // to deadlock when a page fault occurs. (Bug: 26313124) |
| pid_t child; |
| if ((child = fork()) == 0) { |
| bool status = start_sdcard_fuse(path.c_str()); |
| |
| _exit(status ? EXIT_SUCCESS : EXIT_FAILURE); |
| } |
| |
| // FUSE_SIDELOAD_HOST_PATHNAME will start to exist once the fuse in child |
| // process is ready. |
| int result = INSTALL_ERROR; |
| int status; |
| bool waited = false; |
| for (int i = 0; i < SDCARD_INSTALL_TIMEOUT; ++i) { |
| if (waitpid(child, &status, WNOHANG) == -1) { |
| result = INSTALL_ERROR; |
| waited = true; |
| break; |
| } |
| |
| struct stat sb; |
| if (stat(FUSE_SIDELOAD_HOST_PATHNAME, &sb) == -1) { |
| if (errno == ENOENT && i < SDCARD_INSTALL_TIMEOUT-1) { |
| sleep(1); |
| continue; |
| } else { |
| LOG(ERROR) << "Timed out waiting for the fuse-provided package."; |
| result = INSTALL_ERROR; |
| kill(child, SIGKILL); |
| break; |
| } |
| } |
| |
| result = install_package(FUSE_SIDELOAD_HOST_PATHNAME, wipe_cache, false, 0 /*retry_count*/); |
| break; |
| } |
| |
| if (!waited) { |
| // Calling stat() on this magic filename signals the fuse |
| // filesystem to shut down. |
| struct stat sb; |
| stat(FUSE_SIDELOAD_HOST_EXIT_PATHNAME, &sb); |
| |
| waitpid(child, &status, 0); |
| } |
| |
| if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) { |
| LOG(ERROR) << "Error exit from the fuse process: " << WEXITSTATUS(status); |
| } |
| |
| ensure_path_unmounted(SDCARD_ROOT); |
| return result; |
| } |
| |
| // Returns REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default, |
| // which is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery. |
| static Device::BuiltinAction prompt_and_wait(Device* device, int status) { |
| for (;;) { |
| finish_recovery(); |
| switch (status) { |
| case INSTALL_SUCCESS: |
| case INSTALL_NONE: |
| ui->SetBackground(RecoveryUI::NO_COMMAND); |
| break; |
| |
| case INSTALL_ERROR: |
| case INSTALL_CORRUPT: |
| ui->SetBackground(RecoveryUI::ERROR); |
| break; |
| } |
| ui->SetProgressType(RecoveryUI::EMPTY); |
| |
| int chosen_item = get_menu_selection(nullptr, device->GetMenuItems(), false, 0, device); |
| |
| // Device-specific code may take some action here. It may return one of the core actions |
| // handled in the switch statement below. |
| Device::BuiltinAction chosen_action = |
| (chosen_item == -1) ? Device::REBOOT : device->InvokeMenuItem(chosen_item); |
| |
| bool should_wipe_cache = false; |
| switch (chosen_action) { |
| case Device::NO_ACTION: |
| break; |
| |
| case Device::REBOOT: |
| case Device::SHUTDOWN: |
| case Device::REBOOT_BOOTLOADER: |
| return chosen_action; |
| |
| case Device::WIPE_DATA: |
| if (ui->IsTextVisible()) { |
| if (ask_to_wipe_data(device)) { |
| wipe_data(device); |
| } |
| } else { |
| wipe_data(device); |
| return Device::NO_ACTION; |
| } |
| break; |
| |
| case Device::WIPE_CACHE: |
| wipe_cache(ui->IsTextVisible(), device); |
| if (!ui->IsTextVisible()) return Device::NO_ACTION; |
| break; |
| |
| case Device::APPLY_ADB_SIDELOAD: |
| case Device::APPLY_SDCARD: |
| { |
| bool adb = (chosen_action == Device::APPLY_ADB_SIDELOAD); |
| if (adb) { |
| status = apply_from_adb(&should_wipe_cache); |
| } else { |
| status = apply_from_sdcard(device, &should_wipe_cache); |
| } |
| |
| if (status == INSTALL_SUCCESS && should_wipe_cache) { |
| if (!wipe_cache(false, device)) { |
| status = INSTALL_ERROR; |
| } |
| } |
| |
| if (status != INSTALL_SUCCESS) { |
| ui->SetBackground(RecoveryUI::ERROR); |
| ui->Print("Installation aborted.\n"); |
| copy_logs(); |
| } else if (!ui->IsTextVisible()) { |
| return Device::NO_ACTION; // reboot if logs aren't visible |
| } else { |
| ui->Print("\nInstall from %s complete.\n", adb ? "ADB" : "SD card"); |
| } |
| } |
| break; |
| |
| case Device::VIEW_RECOVERY_LOGS: |
| choose_recovery_file(device); |
| break; |
| |
| case Device::RUN_GRAPHICS_TEST: |
| run_graphics_test(); |
| break; |
| |
| case Device::RUN_LOCALE_TEST: { |
| ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui); |
| screen_ui->CheckBackgroundTextImages(locale); |
| break; |
| } |
| case Device::MOUNT_SYSTEM: |
| // For a system image built with the root directory (i.e. system_root_image == "true"), we |
| // mount it to /system_root, and symlink /system to /system_root/system to make adb shell |
| // work (the symlink is created through the build system). (Bug: 22855115) |
| if (android::base::GetBoolProperty("ro.build.system_root_image", false)) { |
| if (ensure_path_mounted_at("/", "/system_root") != -1) { |
| ui->Print("Mounted /system.\n"); |
| } |
| } else { |
| if (ensure_path_mounted("/system") != -1) { |
| ui->Print("Mounted /system.\n"); |
| } |
| } |
| break; |
| } |
| } |
| } |
| |
| static void print_property(const char* key, const char* name, void* /* cookie */) { |
| printf("%s=%s\n", key, name); |
| } |
| |
| static std::string load_locale_from_cache() { |
| if (ensure_path_mounted(LOCALE_FILE) != 0) { |
| LOG(ERROR) << "Can't mount " << LOCALE_FILE; |
| return ""; |
| } |
| |
| std::string content; |
| if (!android::base::ReadFileToString(LOCALE_FILE, &content)) { |
| PLOG(ERROR) << "Can't read " << LOCALE_FILE; |
| return ""; |
| } |
| |
| return android::base::Trim(content); |
| } |
| |
| void ui_print(const char* format, ...) { |
| std::string buffer; |
| va_list ap; |
| va_start(ap, format); |
| android::base::StringAppendV(&buffer, format, ap); |
| va_end(ap); |
| |
| if (ui != nullptr) { |
| ui->Print("%s", buffer.c_str()); |
| } else { |
| fputs(buffer.c_str(), stdout); |
| } |
| } |
| |
| static bool is_battery_ok(int* required_battery_level) { |
| struct healthd_config healthd_config = { |
| .batteryStatusPath = android::String8(android::String8::kEmptyString), |
| .batteryHealthPath = android::String8(android::String8::kEmptyString), |
| .batteryPresentPath = android::String8(android::String8::kEmptyString), |
| .batteryCapacityPath = android::String8(android::String8::kEmptyString), |
| .batteryVoltagePath = android::String8(android::String8::kEmptyString), |
| .batteryTemperaturePath = android::String8(android::String8::kEmptyString), |
| .batteryTechnologyPath = android::String8(android::String8::kEmptyString), |
| .batteryCurrentNowPath = android::String8(android::String8::kEmptyString), |
| .batteryCurrentAvgPath = android::String8(android::String8::kEmptyString), |
| .batteryChargeCounterPath = android::String8(android::String8::kEmptyString), |
| .batteryFullChargePath = android::String8(android::String8::kEmptyString), |
| .batteryCycleCountPath = android::String8(android::String8::kEmptyString), |
| .energyCounter = nullptr, |
| .boot_min_cap = 0, |
| .screen_on = nullptr |
| }; |
| healthd_board_init(&healthd_config); |
| |
| android::BatteryMonitor monitor; |
| monitor.init(&healthd_config); |
| |
| static constexpr int BATTERY_READ_TIMEOUT_IN_SEC = 10; |
| int wait_second = 0; |
| while (true) { |
| int charge_status = monitor.getChargeStatus(); |
| // Treat unknown status as charged. |
| bool charged = (charge_status != android::BATTERY_STATUS_DISCHARGING && |
| charge_status != android::BATTERY_STATUS_NOT_CHARGING); |
| android::BatteryProperty capacity; |
| android::status_t status = monitor.getProperty(android::BATTERY_PROP_CAPACITY, &capacity); |
| ui_print("charge_status %d, charged %d, status %d, capacity %" PRId64 "\n", charge_status, |
| charged, status, capacity.valueInt64); |
| // At startup, the battery drivers in devices like N5X/N6P take some time to load |
| // the battery profile. Before the load finishes, it reports value 50 as a fake |
| // capacity. BATTERY_READ_TIMEOUT_IN_SEC is set that the battery drivers are expected |
| // to finish loading the battery profile earlier than 10 seconds after kernel startup. |
| if (status == 0 && capacity.valueInt64 == 50) { |
| if (wait_second < BATTERY_READ_TIMEOUT_IN_SEC) { |
| sleep(1); |
| wait_second++; |
| continue; |
| } |
| } |
| // If we can't read battery percentage, it may be a device without battery. In this situation, |
| // use 100 as a fake battery percentage. |
| if (status != 0) { |
| capacity.valueInt64 = 100; |
| } |
| |
| // GmsCore enters recovery mode to install package when having enough battery percentage. |
| // Normally, the threshold is 40% without charger and 20% with charger. So we should check |
| // battery with a slightly lower limitation. |
| static constexpr int BATTERY_OK_PERCENTAGE = 20; |
| static constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15; |
| *required_battery_level = charged ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE; |
| return capacity.valueInt64 >= *required_battery_level; |
| } |
| } |
| |
| // Set the retry count to |retry_count| in BCB. |
| static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) { |
| std::vector<std::string> options; |
| for (const auto& arg : args) { |
| if (!android::base::StartsWith(arg, "--retry_count")) { |
| options.push_back(arg); |
| } |
| } |
| |
| // Update the retry counter in BCB. |
| options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count)); |
| std::string err; |
| if (!update_bootloader_message(options, &err)) { |
| LOG(ERROR) << err; |
| } |
| } |
| |
| static bool bootreason_in_blacklist() { |
| std::string bootreason = android::base::GetProperty("ro.boot.bootreason", ""); |
| if (!bootreason.empty()) { |
| // More bootreasons can be found in "system/core/bootstat/bootstat.cpp". |
| static const std::vector<std::string> kBootreasonBlacklist{ |
| "kernel_panic", |
| "Panic", |
| }; |
| for (const auto& str : kBootreasonBlacklist) { |
| if (android::base::EqualsIgnoreCase(str, bootreason)) return true; |
| } |
| } |
| return false; |
| } |
| |
| static void log_failure_code(ErrorCode code, const std::string& update_package) { |
| std::vector<std::string> log_buffer = { |
| update_package, |
| "0", // install result |
| "error: " + std::to_string(code), |
| }; |
| std::string log_content = android::base::Join(log_buffer, "\n"); |
| const std::string& install_file = Paths::Get().temporary_install_file(); |
| if (!android::base::WriteStringToFile(log_content, install_file)) { |
| PLOG(ERROR) << "Failed to write " << install_file; |
| } |
| |
| // Also write the info into last_log. |
| LOG(INFO) << log_content; |
| } |
| |
| int start_recovery(int argc, char** argv) { |
| time_t start = time(nullptr); |
| |
| printf("Starting recovery (pid %d) on %s", getpid(), ctime(&start)); |
| |
| load_volume_table(); |
| has_cache = volume_for_mount_point(CACHE_ROOT) != nullptr; |
| |
| std::vector<std::string> args = get_args(argc, argv); |
| std::vector<char*> args_to_parse(args.size()); |
| std::transform(args.cbegin(), args.cend(), args_to_parse.begin(), |
| [](const std::string& arg) { return const_cast<char*>(arg.c_str()); }); |
| |
| static constexpr struct option OPTIONS[] = { |
| { "just_exit", no_argument, nullptr, 'x' }, |
| { "locale", required_argument, nullptr, 0 }, |
| { "prompt_and_wipe_data", no_argument, nullptr, 0 }, |
| { "reason", required_argument, nullptr, 0 }, |
| { "retry_count", required_argument, nullptr, 0 }, |
| { "security", no_argument, nullptr, 0 }, |
| { "show_text", no_argument, nullptr, 't' }, |
| { "shutdown_after", no_argument, nullptr, 0 }, |
| { "sideload", no_argument, nullptr, 0 }, |
| { "sideload_auto_reboot", no_argument, nullptr, 0 }, |
| { "update_package", required_argument, nullptr, 0 }, |
| { "wipe_ab", no_argument, nullptr, 0 }, |
| { "wipe_cache", no_argument, nullptr, 0 }, |
| { "wipe_data", no_argument, nullptr, 0 }, |
| { "wipe_package_size", required_argument, nullptr, 0 }, |
| { nullptr, 0, nullptr, 0 }, |
| }; |
| |
| const char* update_package = nullptr; |
| bool should_wipe_data = false; |
| bool should_prompt_and_wipe_data = false; |
| bool should_wipe_cache = false; |
| bool should_wipe_ab = false; |
| size_t wipe_package_size = 0; |
| bool show_text = false; |
| bool sideload = false; |
| bool sideload_auto_reboot = false; |
| bool just_exit = false; |
| bool shutdown_after = false; |
| int retry_count = 0; |
| bool security_update = false; |
| |
| int arg; |
| int option_index; |
| while ((arg = getopt_long(args_to_parse.size(), args_to_parse.data(), "", OPTIONS, |
| &option_index)) != -1) { |
| switch (arg) { |
| case 't': |
| show_text = true; |
| break; |
| case 'x': |
| just_exit = true; |
| break; |
| case 0: { |
| std::string option = OPTIONS[option_index].name; |
| if (option == "locale") { |
| locale = optarg; |
| } else if (option == "prompt_and_wipe_data") { |
| should_prompt_and_wipe_data = true; |
| } else if (option == "reason") { |
| reason = optarg; |
| } else if (option == "retry_count") { |
| android::base::ParseInt(optarg, &retry_count, 0); |
| } else if (option == "security") { |
| security_update = true; |
| } else if (option == "sideload") { |
| sideload = true; |
| } else if (option == "sideload_auto_reboot") { |
| sideload = true; |
| sideload_auto_reboot = true; |
| } else if (option == "shutdown_after") { |
| shutdown_after = true; |
| } else if (option == "update_package") { |
| update_package = optarg; |
| } else if (option == "wipe_ab") { |
| should_wipe_ab = true; |
| } else if (option == "wipe_cache") { |
| should_wipe_cache = true; |
| } else if (option == "wipe_data") { |
| should_wipe_data = true; |
| } else if (option == "wipe_package_size") { |
| android::base::ParseUint(optarg, &wipe_package_size); |
| } |
| break; |
| } |
| case '?': |
| LOG(ERROR) << "Invalid command argument"; |
| continue; |
| } |
| } |
| |
| if (locale.empty()) { |
| if (has_cache) { |
| locale = load_locale_from_cache(); |
| } |
| |
| if (locale.empty()) { |
| static constexpr const char* DEFAULT_LOCALE = "en-US"; |
| locale = DEFAULT_LOCALE; |
| } |
| } |
| |
| printf("locale is [%s]\n", locale.c_str()); |
| printf("stage is [%s]\n", stage.c_str()); |
| printf("reason is [%s]\n", reason); |
| |
| Device* device = make_device(); |
| if (android::base::GetBoolProperty("ro.boot.quiescent", false)) { |
| printf("Quiescent recovery mode.\n"); |
| ui = new StubRecoveryUI(); |
| } else { |
| ui = device->GetUI(); |
| |
| if (!ui->Init(locale)) { |
| printf("Failed to initialize UI, use stub UI instead.\n"); |
| ui = new StubRecoveryUI(); |
| } |
| } |
| |
| // Set background string to "installing security update" for security update, |
| // otherwise set it to "installing system update". |
| ui->SetSystemUpdateText(security_update); |
| |
| int st_cur, st_max; |
| if (!stage.empty() && sscanf(stage.c_str(), "%d/%d", &st_cur, &st_max) == 2) { |
| ui->SetStage(st_cur, st_max); |
| } |
| |
| ui->SetBackground(RecoveryUI::NONE); |
| if (show_text) ui->ShowText(true); |
| |
| sehandle = selinux_android_file_context_handle(); |
| selinux_android_set_sehandle(sehandle); |
| if (!sehandle) { |
| ui->Print("Warning: No file_contexts\n"); |
| } |
| |
| device->StartRecovery(); |
| |
| printf("Command:"); |
| for (const auto& arg : args) { |
| printf(" \"%s\"", arg.c_str()); |
| } |
| printf("\n\n"); |
| |
| property_list(print_property, nullptr); |
| printf("\n"); |
| |
| ui->Print("Supported API: %d\n", kRecoveryApiVersion); |
| |
| int status = INSTALL_SUCCESS; |
| |
| if (update_package != nullptr) { |
| // It's not entirely true that we will modify the flash. But we want |
| // to log the update attempt since update_package is non-NULL. |
| modified_flash = true; |
| |
| int required_battery_level; |
| if (retry_count == 0 && !is_battery_ok(&required_battery_level)) { |
| ui->Print("battery capacity is not enough for installing package: %d%% needed\n", |
| required_battery_level); |
| // Log the error code to last_install when installation skips due to |
| // low battery. |
| log_failure_code(kLowBattery, update_package); |
| status = INSTALL_SKIPPED; |
| } else if (retry_count == 0 && bootreason_in_blacklist()) { |
| // Skip update-on-reboot when bootreason is kernel_panic or similar |
| ui->Print("bootreason is in the blacklist; skip OTA installation\n"); |
| log_failure_code(kBootreasonInBlacklist, update_package); |
| status = INSTALL_SKIPPED; |
| } else { |
| // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later |
| // identify the interrupted update due to unexpected reboots. |
| if (retry_count == 0) { |
| set_retry_bootloader_message(retry_count + 1, args); |
| } |
| |
| status = install_package(update_package, &should_wipe_cache, true, retry_count); |
| if (status == INSTALL_SUCCESS && should_wipe_cache) { |
| wipe_cache(false, device); |
| } |
| if (status != INSTALL_SUCCESS) { |
| ui->Print("Installation aborted.\n"); |
| |
| // When I/O error or bspatch/imgpatch error happens, reboot and retry installation |
| // RETRY_LIMIT times before we abandon this OTA update. |
| static constexpr int RETRY_LIMIT = 4; |
| if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) { |
| copy_logs(); |
| retry_count += 1; |
| set_retry_bootloader_message(retry_count, args); |
| // Print retry count on screen. |
| ui->Print("Retry attempt %d\n", retry_count); |
| |
| // Reboot and retry the update |
| if (!reboot("reboot,recovery")) { |
| ui->Print("Reboot failed\n"); |
| } else { |
| while (true) { |
| pause(); |
| } |
| } |
| } |
| // If this is an eng or userdebug build, then automatically |
| // turn the text display on if the script fails so the error |
| // message is visible. |
| if (is_ro_debuggable()) { |
| ui->ShowText(true); |
| } |
| } |
| } |
| } else if (should_wipe_data) { |
| if (!wipe_data(device)) { |
| status = INSTALL_ERROR; |
| } |
| } else if (should_prompt_and_wipe_data) { |
| ui->ShowText(true); |
| ui->SetBackground(RecoveryUI::ERROR); |
| if (!prompt_and_wipe_data(device)) { |
| status = INSTALL_ERROR; |
| } |
| ui->ShowText(false); |
| } else if (should_wipe_cache) { |
| if (!wipe_cache(false, device)) { |
| status = INSTALL_ERROR; |
| } |
| } else if (should_wipe_ab) { |
| if (!wipe_ab_device(wipe_package_size)) { |
| status = INSTALL_ERROR; |
| } |
| } else if (sideload) { |
| // 'adb reboot sideload' acts the same as user presses key combinations |
| // to enter the sideload mode. When 'sideload-auto-reboot' is used, text |
| // display will NOT be turned on by default. And it will reboot after |
| // sideload finishes even if there are errors. Unless one turns on the |
| // text display during the installation. This is to enable automated |
| // testing. |
| if (!sideload_auto_reboot) { |
| ui->ShowText(true); |
| } |
| status = apply_from_adb(&should_wipe_cache); |
| if (status == INSTALL_SUCCESS && should_wipe_cache) { |
| if (!wipe_cache(false, device)) { |
| status = INSTALL_ERROR; |
| } |
| } |
| ui->Print("\nInstall from ADB complete (status: %d).\n", status); |
| if (sideload_auto_reboot) { |
| ui->Print("Rebooting automatically.\n"); |
| } |
| } else if (!just_exit) { |
| // If this is an eng or userdebug build, automatically turn on the text display if no command |
| // is specified. Note that this should be called before setting the background to avoid |
| // flickering the background image. |
| if (is_ro_debuggable()) { |
| ui->ShowText(true); |
| } |
| status = INSTALL_NONE; // No command specified |
| ui->SetBackground(RecoveryUI::NO_COMMAND); |
| } |
| |
| if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) { |
| ui->SetBackground(RecoveryUI::ERROR); |
| if (!ui->IsTextVisible()) { |
| sleep(5); |
| } |
| } |
| |
| Device::BuiltinAction after = shutdown_after ? Device::SHUTDOWN : Device::REBOOT; |
| // 1. If the recovery menu is visible, prompt and wait for commands. |
| // 2. If the state is INSTALL_NONE, wait for commands. (i.e. In user build, manually reboot into |
| // recovery to sideload a package.) |
| // 3. sideload_auto_reboot is an option only available in user-debug build, reboot the device |
| // without waiting. |
| // 4. In all other cases, reboot the device. Therefore, normal users will observe the device |
| // reboot after it shows the "error" screen for 5s. |
| if ((status == INSTALL_NONE && !sideload_auto_reboot) || ui->IsTextVisible()) { |
| Device::BuiltinAction temp = prompt_and_wait(device, status); |
| if (temp != Device::NO_ACTION) { |
| after = temp; |
| } |
| } |
| |
| // Save logs and clean up before rebooting or shutting down. |
| finish_recovery(); |
| |
| switch (after) { |
| case Device::SHUTDOWN: |
| ui->Print("Shutting down...\n"); |
| android::base::SetProperty(ANDROID_RB_PROPERTY, "shutdown,"); |
| break; |
| |
| case Device::REBOOT_BOOTLOADER: |
| ui->Print("Rebooting to bootloader...\n"); |
| android::base::SetProperty(ANDROID_RB_PROPERTY, "reboot,bootloader"); |
| break; |
| |
| default: |
| ui->Print("Rebooting...\n"); |
| reboot("reboot,"); |
| break; |
| } |
| while (true) { |
| pause(); |
| } |
| // Should be unreachable. |
| return EXIT_SUCCESS; |
| } |