blob: 582ca48a567fa931e2e5573cdd51f350df13edc6 [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
2 * Copyright (C) 2007 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
Jerry Zhang6a648042018-05-04 11:24:10 -070017#include "recovery.h"
Tao Bao2ac56af2018-04-25 16:47:04 -070018
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080019#include <ctype.h>
20#include <errno.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080021#include <getopt.h>
Tao Bao862a4c12016-06-02 11:16:50 -070022#include <inttypes.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080023#include <limits.h>
24#include <linux/input.h>
25#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080028#include <sys/types.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080029#include <unistd.h>
30
Tao Bao3aec6962018-04-20 09:24:58 -070031#include <functional>
Tao Bao7f19d102019-04-26 22:56:56 -070032#include <iterator>
Tao Baoc4a18ef2017-02-10 00:13:30 -080033#include <memory>
Tao Bao862a4c12016-06-02 11:16:50 -070034#include <string>
35#include <vector>
Tao Bao04ca4262015-09-10 15:32:24 -070036
Elliott Hughes4b166f02015-12-04 15:30:20 -080037#include <android-base/file.h>
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -070038#include <android-base/logging.h>
Tianjie Xu3c62b672016-02-05 18:25:58 -080039#include <android-base/parseint.h>
Elliott Hughescb220402016-09-23 15:30:55 -070040#include <android-base/properties.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -080041#include <android-base/stringprintf.h>
Tao Bao862a4c12016-06-02 11:16:50 -070042#include <android-base/strings.h>
Elliott Hughescb220402016-09-23 15:30:55 -070043#include <cutils/properties.h> /* for property_list */
Tao Baof90d9a12019-05-10 10:40:59 -070044#include <fs_mgr/roots.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070045#include <ziparchive/zip_archive.h>
Yabin Cui99281df2016-02-17 12:21:52 -080046
Tao Bao7f19d102019-04-26 22:56:56 -070047#include "bootloader_message/bootloader_message.h"
David Andersonedee8362018-05-16 13:43:22 -070048#include "fsck_unshare_blocks.h"
xunchang24788852019-03-22 16:08:52 -070049#include "install/adb_install.h"
Tianjie Xuf6158eb2019-06-11 16:09:07 -070050#include "install/fuse_install.h"
xunchang24788852019-03-22 16:08:52 -070051#include "install/install.h"
52#include "install/package.h"
Alessio Balsinia9665ce2019-12-09 09:26:05 +000053#include "install/snapshot_utils.h"
xunchang316e9712019-04-12 16:22:15 -070054#include "install/wipe_data.h"
Tao Bao7f19d102019-04-26 22:56:56 -070055#include "install/wipe_device.h"
Tianjie Xub63a2212019-07-29 14:21:49 -070056#include "otautil/boot_state.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070057#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070058#include "otautil/paths.h"
Tao Bao2c526392018-05-03 23:01:13 -070059#include "otautil/sysutil.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070060#include "recovery_ui/screen_ui.h"
61#include "recovery_ui/ui.h"
Tao Bao832c9cd2019-09-27 23:32:00 -070062#include "recovery_utils/battery_utils.h"
Tao Baoe3f09a72019-10-01 11:55:36 -070063#include "recovery_utils/logging.h"
64#include "recovery_utils/roots.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080065
Tao Baoaac9d9f2018-04-29 23:38:59 -070066static constexpr const char* COMMAND_FILE = "/cache/recovery/command";
Tao Baoaac9d9f2018-04-29 23:38:59 -070067static constexpr const char* LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
68static constexpr const char* LAST_LOG_FILE = "/cache/recovery/last_log";
69static constexpr const char* LOCALE_FILE = "/cache/recovery/last_locale";
Tianjie Xu06e57ac2016-07-11 14:04:08 -070070
Tao Baoaac9d9f2018-04-29 23:38:59 -070071static constexpr const char* CACHE_ROOT = "/cache";
Nick Kralevicha9ad0322014-10-22 18:38:48 -070072
xunchang316e9712019-04-12 16:22:15 -070073static bool save_current_log = false;
Tao Baoac9d94d2016-11-03 11:37:15 -070074
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080075/*
76 * The recovery tool communicates with the main system through /cache files.
77 * /cache/recovery/command - INPUT - command line for tool, one arg per line
78 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080079 *
80 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -070081 * --update_package=path - verify install an OTA package file
Tianjie Xue5218612019-06-25 13:59:39 -070082 * --install_with_fuse - install the update package with FUSE. This allows installation of large
83 * packages on LP32 builds. Since the mmap will otherwise fail due to out of memory.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080084 * --wipe_data - erase user data (and cache), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070085 * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user
86 * data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080087 * --wipe_cache - wipe cache (but not user data), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070088 * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519).
Oscar Montemayor05231562009-11-30 08:40:57 -080089 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -070090 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080091 *
92 * After completing, we remove /cache/recovery/command and reboot.
93 * Arguments may also be supplied in the bootloader control block (BCB).
94 * These important scenarios must be safely restartable at any point:
95 *
96 * FACTORY RESET
97 * 1. user selects "factory reset"
98 * 2. main system writes "--wipe_data" to /cache/recovery/command
99 * 3. main system reboots into recovery
100 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
101 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700102 * 5. erase_volume() reformats /data
103 * 6. erase_volume() reformats /cache
Tianjie Xu164c60a2019-05-15 13:59:39 -0700104 * 7. FinishRecovery() erases BCB
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800105 * -- after this, rebooting will restart the main system --
106 * 8. main() calls reboot() to boot main system
107 *
108 * OTA INSTALL
109 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700110 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800111 * 3. main system reboots into recovery
112 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
113 * -- after this, rebooting will attempt to reinstall the update --
Tao Baoadc99ef2019-04-29 23:48:02 -0700114 * 5. InstallPackage() attempts to install the update
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800115 * NOTE: the package install must itself be restartable from any point
Tianjie Xu164c60a2019-05-15 13:59:39 -0700116 * 6. FinishRecovery() erases BCB
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800117 * -- after this, rebooting will (try to) restart the main system --
118 * 7. ** if install failed **
Tao Baoadc99ef2019-04-29 23:48:02 -0700119 * 7a. PromptAndWait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800120 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800121 */
122
Tianjie Xu164c60a2019-05-15 13:59:39 -0700123static bool IsRoDebuggable() {
124 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800125}
126
Tao Baoec579032017-07-21 12:13:15 -0700127// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700128// copy our log file to cache as well (for the system to read). This function is
129// idempotent: call it as many times as you like.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700130static void FinishRecovery(RecoveryUI* ui) {
Tao Bao551d2c32018-05-09 20:53:13 -0700131 std::string locale = ui->GetLocale();
Tao Baoec579032017-07-21 12:13:15 -0700132 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
133 // (e.g., directly from the bootloader) it will use the last-known locale.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700134 if (!locale.empty() && HasCache()) {
Tao Baoec579032017-07-21 12:13:15 -0700135 LOG(INFO) << "Saving locale \"" << locale << "\"";
136 if (ensure_path_mounted(LOCALE_FILE) != 0) {
137 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
138 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
139 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700140 }
Tao Baoec579032017-07-21 12:13:15 -0700141 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700142
Tianjie Xu164c60a2019-05-15 13:59:39 -0700143 copy_logs(save_current_log);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800144
Tao Baoec579032017-07-21 12:13:15 -0700145 // Reset to normal system boot so recovery won't cycle indefinitely.
146 std::string err;
147 if (!clear_bootloader_message(&err)) {
148 LOG(ERROR) << "Failed to clear BCB message: " << err;
149 }
150
151 // Remove the command file, so recovery won't repeat indefinitely.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700152 if (HasCache()) {
Tao Baoec579032017-07-21 12:13:15 -0700153 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
154 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700155 }
Tao Baoec579032017-07-21 12:13:15 -0700156 ensure_path_unmounted(CACHE_ROOT);
157 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800158
Tao Baoec579032017-07-21 12:13:15 -0700159 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800160}
161
Elliott Hughes30694c92015-03-25 15:16:51 -0700162static bool yes_no(Device* device, const char* question1, const char* question2) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700163 std::vector<std::string> headers{ question1, question2 };
164 std::vector<std::string> items{ " No", " Yes" };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700165
Tianjie Xu164c60a2019-05-15 13:59:39 -0700166 size_t chosen_item = device->GetUI()->ShowMenu(
Tao Bao3aec6962018-04-20 09:24:58 -0700167 headers, items, 0, true,
168 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
169 return (chosen_item == 1);
Elliott Hughes30694c92015-03-25 15:16:51 -0700170}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800171
Paul Crowley08404b42016-12-19 13:04:23 -0800172static bool ask_to_wipe_data(Device* device) {
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700173 std::vector<std::string> headers{ "Wipe all user data?", " THIS CAN NOT BE UNDONE!" };
174 std::vector<std::string> items{ " Cancel", " Factory data reset" };
175
Tianjie Xu164c60a2019-05-15 13:59:39 -0700176 size_t chosen_item = device->GetUI()->ShowPromptWipeDataConfirmationMenu(
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700177 headers, items,
178 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
179
180 return (chosen_item == 1);
Paul Crowley08404b42016-12-19 13:04:23 -0800181}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700182
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700183static InstallResult prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700184 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tianjie Xub99e6062018-10-16 15:13:09 -0700185 std::vector<std::string> wipe_data_menu_headers{
Tao Bao2bbc6d62017-08-13 23:48:55 -0700186 "Can't load Android system. Your data may be corrupt. "
187 "If you continue to get this message, you may need to "
188 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700189 "stored on this device.",
Tao Baofc5499f2017-02-23 19:06:53 -0800190 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700191 // clang-format off
Tianjie Xub99e6062018-10-16 15:13:09 -0700192 std::vector<std::string> wipe_data_menu_items {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700193 "Try again",
194 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800195 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700196 // clang-format on
Tao Baofc5499f2017-02-23 19:06:53 -0800197 for (;;) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700198 size_t chosen_item = device->GetUI()->ShowPromptWipeDataMenu(
Tianjie Xub99e6062018-10-16 15:13:09 -0700199 wipe_data_menu_headers, wipe_data_menu_items,
Tao Bao3aec6962018-04-20 09:24:58 -0700200 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700201 // If ShowMenu() returned RecoveryUI::KeyError::INTERRUPTED, WaitKey() was interrupted.
202 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700203 return INSTALL_KEY_INTERRUPTED;
Jerry Zhangb76af932018-05-22 12:08:35 -0700204 }
Tao Baofc5499f2017-02-23 19:06:53 -0800205 if (chosen_item != 1) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700206 return INSTALL_SUCCESS; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800207 }
Tianjie Xub99e6062018-10-16 15:13:09 -0700208
Tao Baofc5499f2017-02-23 19:06:53 -0800209 if (ask_to_wipe_data(device)) {
Tianjie Xub63a2212019-07-29 14:21:49 -0700210 CHECK(device->GetReason().has_value());
211 bool convert_fbe = device->GetReason().value() == "convert_fbe";
xunchang316e9712019-04-12 16:22:15 -0700212 if (WipeData(device, convert_fbe)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700213 return INSTALL_SUCCESS;
214 } else {
215 return INSTALL_ERROR;
216 }
Tao Baofc5499f2017-02-23 19:06:53 -0800217 }
218 }
Paul Crowley08404b42016-12-19 13:04:23 -0800219}
220
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700221static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800222 std::vector<std::string> entries;
Tianjie Xu164c60a2019-05-15 13:59:39 -0700223 if (HasCache()) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800224 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
225 auto add_to_entries = [&](const char* filename) {
226 std::string log_file(filename);
227 if (i > 0) {
228 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700229 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800230
Yifan Hongd81b8e32018-12-17 14:29:06 -0800231 if (ensure_path_mounted(log_file) == 0 && access(log_file.c_str(), R_OK) == 0) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800232 entries.push_back(std::move(log_file));
233 }
234 };
235
236 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
237 add_to_entries(LAST_LOG_FILE);
238
239 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
240 add_to_entries(LAST_KMSG_FILE);
241 }
242 } else {
243 // If cache partition is not found, view /tmp/recovery.log instead.
Tao Bao641fa972018-04-25 18:59:40 -0700244 if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800245 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700246 } else {
Tao Bao641fa972018-04-25 18:59:40 -0700247 entries.push_back(Paths::Get().temporary_log_file());
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700248 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800249 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700250
Tao Bao08fc6be2017-03-07 00:56:27 -0800251 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700252
Tao Bao1fe1afe2018-05-01 15:56:05 -0700253 std::vector<std::string> headers{ "Select file to view" };
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700254
Tao Bao1fe1afe2018-05-01 15:56:05 -0700255 size_t chosen_item = 0;
Tao Bao08fc6be2017-03-07 00:56:27 -0800256 while (true) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700257 chosen_item = device->GetUI()->ShowMenu(
Tao Bao1fe1afe2018-05-01 15:56:05 -0700258 headers, entries, chosen_item, true,
Tao Bao3aec6962018-04-20 09:24:58 -0700259 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700260
261 // Handle WaitKey() interrupt.
262 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
263 break;
264 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800265 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700266
Tianjie Xu164c60a2019-05-15 13:59:39 -0700267 device->GetUI()->ShowFile(entries[chosen_item]);
Tao Bao08fc6be2017-03-07 00:56:27 -0800268 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700269}
270
Tianjie Xu164c60a2019-05-15 13:59:39 -0700271static void run_graphics_test(RecoveryUI* ui) {
Tao Baodb7e8982017-03-06 23:53:16 -0800272 // Switch to graphics screen.
273 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700274
Tao Baodb7e8982017-03-06 23:53:16 -0800275 ui->SetProgressType(RecoveryUI::INDETERMINATE);
276 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
277 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700278
Tao Baodb7e8982017-03-06 23:53:16 -0800279 ui->SetBackground(RecoveryUI::ERROR);
280 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700281
Tao Baodb7e8982017-03-06 23:53:16 -0800282 ui->SetBackground(RecoveryUI::NO_COMMAND);
283 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700284
Tao Baodb7e8982017-03-06 23:53:16 -0800285 ui->SetBackground(RecoveryUI::ERASING);
286 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700287
Tao Baodb7e8982017-03-06 23:53:16 -0800288 // Calling SetBackground() after SetStage() to trigger a redraw.
289 ui->SetStage(1, 3);
290 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
291 sleep(1);
292 ui->SetStage(2, 3);
293 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
294 sleep(1);
295 ui->SetStage(3, 3);
296 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
297 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700298
Tao Baodb7e8982017-03-06 23:53:16 -0800299 ui->SetStage(-1, -1);
300 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -0700301
Tao Baodb7e8982017-03-06 23:53:16 -0800302 ui->SetProgressType(RecoveryUI::DETERMINATE);
303 ui->ShowProgress(1.0, 10.0);
304 float fraction = 0.0;
305 for (size_t i = 0; i < 100; ++i) {
306 fraction += .01;
307 ui->SetProgress(fraction);
308 usleep(100000);
309 }
310
311 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -0700312}
313
Tao Baoadc99ef2019-04-29 23:48:02 -0700314// Shows the recovery UI and waits for user input. Returns one of the device builtin actions, such
315// as REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default, which
316// is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
317static Device::BuiltinAction PromptAndWait(Device* device, InstallResult status) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700318 auto ui = device->GetUI();
Tao Bao50dd5322017-03-07 14:57:04 -0800319 for (;;) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700320 FinishRecovery(ui);
Tao Bao50dd5322017-03-07 14:57:04 -0800321 switch (status) {
322 case INSTALL_SUCCESS:
323 case INSTALL_NONE:
Tao Baoadc99ef2019-04-29 23:48:02 -0700324 case INSTALL_SKIPPED:
325 case INSTALL_RETRY:
326 case INSTALL_KEY_INTERRUPTED:
Tao Bao50dd5322017-03-07 14:57:04 -0800327 ui->SetBackground(RecoveryUI::NO_COMMAND);
328 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -0700329
Tao Bao50dd5322017-03-07 14:57:04 -0800330 case INSTALL_ERROR:
331 case INSTALL_CORRUPT:
332 ui->SetBackground(RecoveryUI::ERROR);
333 break;
Tao Baoadc99ef2019-04-29 23:48:02 -0700334
335 case INSTALL_REBOOT:
336 // All the reboots should have been handled prior to entering PromptAndWait() or immediately
337 // after installing a package.
338 LOG(FATAL) << "Invalid status code of INSTALL_REBOOT";
339 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800340 }
Tao Bao50dd5322017-03-07 14:57:04 -0800341 ui->SetProgressType(RecoveryUI::EMPTY);
342
Tao Bao1fe1afe2018-05-01 15:56:05 -0700343 size_t chosen_item = ui->ShowMenu(
344 {}, device->GetMenuItems(), 0, false,
Tao Bao3aec6962018-04-20 09:24:58 -0700345 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700346 // Handle Interrupt key
347 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
348 return Device::KEY_INTERRUPTED;
349 }
Tao Bao50dd5322017-03-07 14:57:04 -0800350 // Device-specific code may take some action here. It may return one of the core actions
351 // handled in the switch statement below.
Jerry Zhangb76af932018-05-22 12:08:35 -0700352 Device::BuiltinAction chosen_action =
353 (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::TIMED_OUT))
354 ? Device::REBOOT
355 : device->InvokeMenuItem(chosen_item);
Tao Bao50dd5322017-03-07 14:57:04 -0800356
Tao Bao50dd5322017-03-07 14:57:04 -0800357 switch (chosen_action) {
Mark Salyzyn488cc052019-05-20 10:36:16 -0700358 case Device::REBOOT_FROM_FASTBOOT: // Can not happen
359 case Device::SHUTDOWN_FROM_FASTBOOT: // Can not happen
Tao Bao50dd5322017-03-07 14:57:04 -0800360 case Device::NO_ACTION:
361 break;
362
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700363 case Device::ENTER_FASTBOOT:
364 case Device::ENTER_RECOVERY:
Tao Baod9cb0142019-04-23 11:46:25 -0700365 case Device::REBOOT:
366 case Device::REBOOT_BOOTLOADER:
367 case Device::REBOOT_FASTBOOT:
368 case Device::REBOOT_RECOVERY:
369 case Device::REBOOT_RESCUE:
370 case Device::SHUTDOWN:
Tao Bao50dd5322017-03-07 14:57:04 -0800371 return chosen_action;
372
373 case Device::WIPE_DATA:
xunchang316e9712019-04-12 16:22:15 -0700374 save_current_log = true;
Tao Bao50dd5322017-03-07 14:57:04 -0800375 if (ui->IsTextVisible()) {
376 if (ask_to_wipe_data(device)) {
xunchang316e9712019-04-12 16:22:15 -0700377 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800378 }
379 } else {
xunchang316e9712019-04-12 16:22:15 -0700380 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800381 return Device::NO_ACTION;
382 }
383 break;
384
xunchang316e9712019-04-12 16:22:15 -0700385 case Device::WIPE_CACHE: {
386 save_current_log = true;
387 std::function<bool()> confirm_func = [&device]() {
388 return yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!");
389 };
390 WipeCache(ui, ui->IsTextVisible() ? confirm_func : nullptr);
Tao Bao50dd5322017-03-07 14:57:04 -0800391 if (!ui->IsTextVisible()) return Device::NO_ACTION;
392 break;
xunchang316e9712019-04-12 16:22:15 -0700393 }
Tao Bao10f441a2019-04-19 15:22:15 -0700394
Tao Bao50dd5322017-03-07 14:57:04 -0800395 case Device::APPLY_ADB_SIDELOAD:
Tao Baoc6dc3252019-04-16 14:22:25 -0700396 case Device::APPLY_SDCARD:
397 case Device::ENTER_RESCUE: {
xunchang316e9712019-04-12 16:22:15 -0700398 save_current_log = true;
Tao Baoc6dc3252019-04-16 14:22:25 -0700399
400 bool adb = true;
Tao Bao10f441a2019-04-19 15:22:15 -0700401 Device::BuiltinAction reboot_action;
Tao Baoc6dc3252019-04-16 14:22:25 -0700402 if (chosen_action == Device::ENTER_RESCUE) {
403 // Switch to graphics screen.
404 ui->ShowText(false);
xunchangfedeef62019-04-22 12:18:14 -0700405 status = ApplyFromAdb(device, true /* rescue_mode */, &reboot_action);
Tao Baoc6dc3252019-04-16 14:22:25 -0700406 } else if (chosen_action == Device::APPLY_ADB_SIDELOAD) {
xunchangfedeef62019-04-22 12:18:14 -0700407 status = ApplyFromAdb(device, false /* rescue_mode */, &reboot_action);
xunchang3cc23d52019-03-18 15:03:33 -0700408 } else {
Tao Baoc6dc3252019-04-16 14:22:25 -0700409 adb = false;
Tianjie Xuf6158eb2019-06-11 16:09:07 -0700410 status = ApplyFromSdcard(device);
Tao Bao50dd5322017-03-07 14:57:04 -0800411 }
xunchang3cc23d52019-03-18 15:03:33 -0700412
Tao Bao10f441a2019-04-19 15:22:15 -0700413 ui->Print("\nInstall from %s completed with status %d.\n", adb ? "ADB" : "SD card", status);
414 if (status == INSTALL_REBOOT) {
415 return reboot_action;
416 }
417
xunchang3cc23d52019-03-18 15:03:33 -0700418 if (status != INSTALL_SUCCESS) {
419 ui->SetBackground(RecoveryUI::ERROR);
420 ui->Print("Installation aborted.\n");
Tianjie Xu164c60a2019-05-15 13:59:39 -0700421 copy_logs(save_current_log);
xunchang3cc23d52019-03-18 15:03:33 -0700422 } else if (!ui->IsTextVisible()) {
423 return Device::NO_ACTION; // reboot if logs aren't visible
xunchang3cc23d52019-03-18 15:03:33 -0700424 }
Tao Bao50dd5322017-03-07 14:57:04 -0800425 break;
xunchang3cc23d52019-03-18 15:03:33 -0700426 }
Tao Bao50dd5322017-03-07 14:57:04 -0800427
428 case Device::VIEW_RECOVERY_LOGS:
429 choose_recovery_file(device);
430 break;
431
432 case Device::RUN_GRAPHICS_TEST:
Tianjie Xu164c60a2019-05-15 13:59:39 -0700433 run_graphics_test(ui);
Tao Bao50dd5322017-03-07 14:57:04 -0800434 break;
435
Tianjie Xu29d55752017-09-20 17:53:46 -0700436 case Device::RUN_LOCALE_TEST: {
437 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
Tao Bao39c49182018-05-07 22:50:33 -0700438 screen_ui->CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700439 break;
440 }
Alessio Balsinia9665ce2019-12-09 09:26:05 +0000441
Tao Bao50dd5322017-03-07 14:57:04 -0800442 case Device::MOUNT_SYSTEM:
Alessio Balsinia9665ce2019-12-09 09:26:05 +0000443 // For Virtual A/B, set up the snapshot devices (if exist).
444 if (!CreateSnapshotPartitions()) {
445 ui->Print("Virtual A/B: snapshot partitions creation failed.\n");
446 break;
447 }
Tao Baof90d9a12019-05-10 10:40:59 -0700448 if (ensure_path_mounted_at(android::fs_mgr::GetSystemRoot(), "/mnt/system") != -1) {
Yifan Hong49327802018-11-26 14:59:09 -0800449 ui->Print("Mounted /system.\n");
Tao Bao50dd5322017-03-07 14:57:04 -0800450 }
451 break;
Jerry Zhangb76af932018-05-22 12:08:35 -0700452
453 case Device::KEY_INTERRUPTED:
454 return Device::KEY_INTERRUPTED;
Tao Bao50dd5322017-03-07 14:57:04 -0800455 }
456 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800457}
458
Tao Bao99f0d9e2016-10-13 12:46:38 -0700459static void print_property(const char* key, const char* name, void* /* cookie */) {
460 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800461}
462
Tao Bao832c9cd2019-09-27 23:32:00 -0700463static bool IsBatteryOk(int* required_battery_level) {
464 // GmsCore enters recovery mode to install package when having enough battery percentage.
465 // Normally, the threshold is 40% without charger and 20% with charger. So we check the battery
466 // level against a slightly lower limit.
467 constexpr int BATTERY_OK_PERCENTAGE = 20;
468 constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
Yabin Cui99281df2016-02-17 12:21:52 -0800469
Tao Bao832c9cd2019-09-27 23:32:00 -0700470 auto battery_info = GetBatteryInfo();
471 *required_battery_level =
472 battery_info.charging ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE;
473 return battery_info.capacity >= *required_battery_level;
Yabin Cui99281df2016-02-17 12:21:52 -0800474}
475
Tianjie Xu99b73be2017-11-28 17:23:06 -0800476// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -0700477static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
478 std::vector<std::string> options;
479 for (const auto& arg : args) {
480 if (!android::base::StartsWith(arg, "--retry_count")) {
481 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -0800482 }
Tianjie Xu72449c92017-05-16 18:07:31 -0700483 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800484
Tianjie Xu99b73be2017-11-28 17:23:06 -0800485 // Update the retry counter in BCB.
486 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -0700487 std::string err;
488 if (!update_bootloader_message(options, &err)) {
489 LOG(ERROR) << err;
490 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800491}
492
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700493static bool bootreason_in_blacklist() {
Tao Baoefc35592017-01-08 22:45:47 -0800494 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
495 if (!bootreason.empty()) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700496 // More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
497 static const std::vector<std::string> kBootreasonBlacklist{
498 "kernel_panic",
499 "Panic",
500 };
501 for (const auto& str : kBootreasonBlacklist) {
502 if (android::base::EqualsIgnoreCase(str, bootreason)) return true;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700503 }
Tao Baoefc35592017-01-08 22:45:47 -0800504 }
505 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700506}
507
Tao Bao641fa972018-04-25 18:59:40 -0700508static void log_failure_code(ErrorCode code, const std::string& update_package) {
509 std::vector<std::string> log_buffer = {
510 update_package,
511 "0", // install result
512 "error: " + std::to_string(code),
513 };
514 std::string log_content = android::base::Join(log_buffer, "\n");
515 const std::string& install_file = Paths::Get().temporary_install_file();
516 if (!android::base::WriteStringToFile(log_content, install_file)) {
517 PLOG(ERROR) << "Failed to write " << install_file;
518 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700519
Tao Bao641fa972018-04-25 18:59:40 -0700520 // Also write the info into last_log.
521 LOG(INFO) << log_content;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700522}
523
Jerry Zhang6a648042018-05-04 11:24:10 -0700524Device::BuiltinAction start_recovery(Device* device, const std::vector<std::string>& args) {
Tao Baof9f17342018-04-27 10:44:04 -0700525 static constexpr struct option OPTIONS[] = {
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700526 { "fastboot", no_argument, nullptr, 0 },
David Andersonedee8362018-05-16 13:43:22 -0700527 { "fsck_unshare_blocks", no_argument, nullptr, 0 },
Tianjie Xue5218612019-06-25 13:59:39 -0700528 { "install_with_fuse", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700529 { "just_exit", no_argument, nullptr, 'x' },
530 { "locale", required_argument, nullptr, 0 },
531 { "prompt_and_wipe_data", no_argument, nullptr, 0 },
532 { "reason", required_argument, nullptr, 0 },
Tao Baod9cb0142019-04-23 11:46:25 -0700533 { "rescue", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700534 { "retry_count", required_argument, nullptr, 0 },
535 { "security", no_argument, nullptr, 0 },
536 { "show_text", no_argument, nullptr, 't' },
537 { "shutdown_after", no_argument, nullptr, 0 },
538 { "sideload", no_argument, nullptr, 0 },
539 { "sideload_auto_reboot", no_argument, nullptr, 0 },
540 { "update_package", required_argument, nullptr, 0 },
541 { "wipe_ab", no_argument, nullptr, 0 },
542 { "wipe_cache", no_argument, nullptr, 0 },
543 { "wipe_data", no_argument, nullptr, 0 },
544 { "wipe_package_size", required_argument, nullptr, 0 },
545 { nullptr, 0, nullptr, 0 },
546 };
547
Tianjie Xu99b73be2017-11-28 17:23:06 -0800548 const char* update_package = nullptr;
Tianjie Xue5218612019-06-25 13:59:39 -0700549 bool install_with_fuse = false; // memory map the update package by default.
Tianjie Xu99b73be2017-11-28 17:23:06 -0800550 bool should_wipe_data = false;
551 bool should_prompt_and_wipe_data = false;
552 bool should_wipe_cache = false;
553 bool should_wipe_ab = false;
554 size_t wipe_package_size = 0;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800555 bool sideload = false;
556 bool sideload_auto_reboot = false;
Tao Baod9cb0142019-04-23 11:46:25 -0700557 bool rescue = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800558 bool just_exit = false;
559 bool shutdown_after = false;
David Andersonedee8362018-05-16 13:43:22 -0700560 bool fsck_unshare_blocks = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800561 int retry_count = 0;
562 bool security_update = false;
Jerry Zhang2dea53e2018-05-02 17:15:03 -0700563 std::string locale;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800564
Tao Bao1700cc42018-07-16 22:09:59 -0700565 auto args_to_parse = StringVectorToNullTerminatedArray(args);
566
Tianjie Xu99b73be2017-11-28 17:23:06 -0800567 int arg;
568 int option_index;
Tao Bao1700cc42018-07-16 22:09:59 -0700569 // Parse everything before the last element (which must be a nullptr). getopt_long(3) expects a
570 // null-terminated char* array, but without counting null as an arg (i.e. argv[argc] should be
571 // nullptr).
572 while ((arg = getopt_long(args_to_parse.size() - 1, args_to_parse.data(), "", OPTIONS,
Tianjie Xu99b73be2017-11-28 17:23:06 -0800573 &option_index)) != -1) {
574 switch (arg) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800575 case 't':
Jerry Zhang6a648042018-05-04 11:24:10 -0700576 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800577 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800578 case 'x':
579 just_exit = true;
580 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800581 case 0: {
582 std::string option = OPTIONS[option_index].name;
David Andersonedee8362018-05-16 13:43:22 -0700583 if (option == "fsck_unshare_blocks") {
584 fsck_unshare_blocks = true;
Tianjie Xue5218612019-06-25 13:59:39 -0700585 } else if (option == "install_with_fuse") {
586 install_with_fuse = true;
Tianjie Xub63a2212019-07-29 14:21:49 -0700587 } else if (option == "locale" || option == "fastboot" || option == "reason") {
Jerry Zhang6a648042018-05-04 11:24:10 -0700588 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800589 } else if (option == "prompt_and_wipe_data") {
590 should_prompt_and_wipe_data = true;
Tao Baod9cb0142019-04-23 11:46:25 -0700591 } else if (option == "rescue") {
592 rescue = true;
Tao Baof9f17342018-04-27 10:44:04 -0700593 } else if (option == "retry_count") {
594 android::base::ParseInt(optarg, &retry_count, 0);
595 } else if (option == "security") {
596 security_update = true;
597 } else if (option == "sideload") {
598 sideload = true;
599 } else if (option == "sideload_auto_reboot") {
600 sideload = true;
601 sideload_auto_reboot = true;
602 } else if (option == "shutdown_after") {
603 shutdown_after = true;
604 } else if (option == "update_package") {
605 update_package = optarg;
606 } else if (option == "wipe_ab") {
607 should_wipe_ab = true;
608 } else if (option == "wipe_cache") {
609 should_wipe_cache = true;
610 } else if (option == "wipe_data") {
611 should_wipe_data = true;
612 } else if (option == "wipe_package_size") {
613 android::base::ParseUint(optarg, &wipe_package_size);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800614 }
615 break;
616 }
617 case '?':
618 LOG(ERROR) << "Invalid command argument";
619 continue;
Doug Zongker9270a202012-01-09 15:16:13 -0800620 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800621 }
Jerry Zhang49fd5d22018-05-17 12:54:41 -0700622 optind = 1;
Doug Zongker9270a202012-01-09 15:16:13 -0800623
Tianjie Xub63a2212019-07-29 14:21:49 -0700624 printf("stage is [%s]\n", device->GetStage().value_or("").c_str());
625 printf("reason is [%s]\n", device->GetReason().value_or("").c_str());
Doug Zongker02ec6b82012-08-22 17:26:40 -0700626
Tianjie Xu164c60a2019-05-15 13:59:39 -0700627 auto ui = device->GetUI();
628
Tianjie Xu99b73be2017-11-28 17:23:06 -0800629 // Set background string to "installing security update" for security update,
630 // otherwise set it to "installing system update".
631 ui->SetSystemUpdateText(security_update);
632
633 int st_cur, st_max;
Tianjie Xub63a2212019-07-29 14:21:49 -0700634 if (!device->GetStage().has_value() &&
635 sscanf(device->GetStage().value().c_str(), "%d/%d", &st_cur, &st_max) == 2) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800636 ui->SetStage(st_cur, st_max);
637 }
638
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700639 std::vector<std::string> title_lines =
640 android::base::Split(android::base::GetProperty("ro.bootimage.build.fingerprint", ""), ":");
641 title_lines.insert(std::begin(title_lines), "Android Recovery");
642 ui->SetTitle(title_lines);
643
Jerry Zhangb76af932018-05-22 12:08:35 -0700644 ui->ResetKeyInterruptStatus();
Tianjie Xu99b73be2017-11-28 17:23:06 -0800645 device->StartRecovery();
646
647 printf("Command:");
648 for (const auto& arg : args) {
649 printf(" \"%s\"", arg.c_str());
650 }
651 printf("\n\n");
652
653 property_list(print_property, nullptr);
654 printf("\n");
655
Tao Baoadc99ef2019-04-29 23:48:02 -0700656 InstallResult status = INSTALL_SUCCESS;
Tao Bao10f441a2019-04-19 15:22:15 -0700657 // next_action indicates the next target to reboot into upon finishing the install. It could be
658 // overridden to a different reboot target per user request.
659 Device::BuiltinAction next_action = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800660
661 if (update_package != nullptr) {
662 // It's not entirely true that we will modify the flash. But we want
663 // to log the update attempt since update_package is non-NULL.
xunchang316e9712019-04-12 16:22:15 -0700664 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800665
Tao Bao832c9cd2019-09-27 23:32:00 -0700666 if (int required_battery_level; retry_count == 0 && !IsBatteryOk(&required_battery_level)) {
Tao Bao6d90a9d2018-04-26 10:40:36 -0700667 ui->Print("battery capacity is not enough for installing package: %d%% needed\n",
668 required_battery_level);
Tao Bao832c9cd2019-09-27 23:32:00 -0700669 // Log the error code to last_install when installation skips due to low battery.
Tianjie Xu99b73be2017-11-28 17:23:06 -0800670 log_failure_code(kLowBattery, update_package);
671 status = INSTALL_SKIPPED;
Tianjie Xua6f49bd2018-03-26 14:32:11 -0700672 } else if (retry_count == 0 && bootreason_in_blacklist()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800673 // Skip update-on-reboot when bootreason is kernel_panic or similar
674 ui->Print("bootreason is in the blacklist; skip OTA installation\n");
675 log_failure_code(kBootreasonInBlacklist, update_package);
676 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -0700677 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800678 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
679 // identify the interrupted update due to unexpected reboots.
680 if (retry_count == 0) {
681 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -0700682 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800683
Tianjie Xu58a27692019-08-06 12:32:05 -0700684 bool should_use_fuse = false;
685 if (!SetupPackageMount(update_package, &should_use_fuse)) {
686 LOG(INFO) << "Failed to set up the package access, skipping installation";
687 status = INSTALL_ERROR;
688 } else if (install_with_fuse || should_use_fuse) {
Tianjie Xue5218612019-06-25 13:59:39 -0700689 LOG(INFO) << "Installing package " << update_package << " with fuse";
690 status = InstallWithFuseFromPath(update_package, ui);
691 } else if (auto memory_package = Package::CreateMemoryPackage(
692 update_package,
693 std::bind(&RecoveryUI::SetProgress, ui, std::placeholders::_1));
694 memory_package != nullptr) {
695 status = InstallPackage(memory_package.get(), update_package, should_wipe_cache,
696 retry_count, ui);
697 } else {
698 // We may fail to memory map the package on 32 bit builds for packages with 2GiB+ size.
699 // In such cases, we will try to install the package with fuse. This is not the default
700 // installation method because it introduces a layer of indirection from the kernel space.
701 LOG(WARNING) << "Failed to memory map package " << update_package
702 << "; falling back to install with fuse";
703 status = InstallWithFuseFromPath(update_package, ui);
704 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800705 if (status != INSTALL_SUCCESS) {
706 ui->Print("Installation aborted.\n");
Tao Baoaac9d9f2018-04-29 23:38:59 -0700707
708 // When I/O error or bspatch/imgpatch error happens, reboot and retry installation
709 // RETRY_LIMIT times before we abandon this OTA update.
710 static constexpr int RETRY_LIMIT = 4;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800711 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700712 copy_logs(save_current_log);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800713 retry_count += 1;
714 set_retry_bootloader_message(retry_count, args);
715 // Print retry count on screen.
716 ui->Print("Retry attempt %d\n", retry_count);
717
Tao Bao782dcc12019-04-29 11:23:16 -0700718 // Reboot back into recovery to retry the update.
719 if (!Reboot("recovery")) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800720 ui->Print("Reboot failed\n");
721 } else {
722 while (true) {
723 pause();
724 }
725 }
Tianjie Xud9d16292017-04-20 18:08:21 -0700726 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800727 // If this is an eng or userdebug build, then automatically
728 // turn the text display on if the script fails so the error
729 // message is visible.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700730 if (IsRoDebuggable()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800731 ui->ShowText(true);
Tao Baoc679f932015-03-30 09:43:49 -0700732 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800733 }
Doug Zongker8674a722010-09-15 11:08:23 -0700734 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800735 } else if (should_wipe_data) {
xunchang316e9712019-04-12 16:22:15 -0700736 save_current_log = true;
Tianjie Xub63a2212019-07-29 14:21:49 -0700737 CHECK(device->GetReason().has_value());
738 bool convert_fbe = device->GetReason().value() == "convert_fbe";
xunchang316e9712019-04-12 16:22:15 -0700739 if (!WipeData(device, convert_fbe)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800740 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -0700741 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800742 } else if (should_prompt_and_wipe_data) {
Tao Baoa5bbcb92018-09-17 14:32:47 -0700743 // Trigger the logging to capture the cause, even if user chooses to not wipe data.
xunchang316e9712019-04-12 16:22:15 -0700744 save_current_log = true;
Tao Baoa5bbcb92018-09-17 14:32:47 -0700745
Tianjie Xu99b73be2017-11-28 17:23:06 -0800746 ui->ShowText(true);
747 ui->SetBackground(RecoveryUI::ERROR);
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700748 status = prompt_and_wipe_data(device);
749 if (status != INSTALL_KEY_INTERRUPTED) {
750 ui->ShowText(false);
Tao Bao75238632015-05-27 14:46:17 -0700751 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800752 } else if (should_wipe_cache) {
xunchang316e9712019-04-12 16:22:15 -0700753 save_current_log = true;
754 if (!WipeCache(ui, nullptr)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800755 status = INSTALL_ERROR;
756 }
757 } else if (should_wipe_ab) {
Tao Bao7f19d102019-04-26 22:56:56 -0700758 if (!WipeAbDevice(device, wipe_package_size)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800759 status = INSTALL_ERROR;
760 }
761 } else if (sideload) {
Tao Bao10f441a2019-04-19 15:22:15 -0700762 // 'adb reboot sideload' acts the same as user presses key combinations to enter the sideload
763 // mode. When 'sideload-auto-reboot' is used, text display will NOT be turned on by default. And
764 // it will reboot after sideload finishes even if there are errors. This is to enable automated
Tianjie Xu99b73be2017-11-28 17:23:06 -0800765 // testing.
xunchang316e9712019-04-12 16:22:15 -0700766 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800767 if (!sideload_auto_reboot) {
768 ui->ShowText(true);
769 }
xunchangfedeef62019-04-22 12:18:14 -0700770 status = ApplyFromAdb(device, false /* rescue_mode */, &next_action);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800771 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
772 if (sideload_auto_reboot) {
Tao Bao10f441a2019-04-19 15:22:15 -0700773 status = INSTALL_REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800774 ui->Print("Rebooting automatically.\n");
775 }
Tao Baod9cb0142019-04-23 11:46:25 -0700776 } else if (rescue) {
777 save_current_log = true;
xunchangfedeef62019-04-22 12:18:14 -0700778 status = ApplyFromAdb(device, true /* rescue_mode */, &next_action);
Tao Baod9cb0142019-04-23 11:46:25 -0700779 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
David Andersonedee8362018-05-16 13:43:22 -0700780 } else if (fsck_unshare_blocks) {
781 if (!do_fsck_unshare_blocks()) {
782 status = INSTALL_ERROR;
783 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800784 } else if (!just_exit) {
785 // If this is an eng or userdebug build, automatically turn on the text display if no command
786 // is specified. Note that this should be called before setting the background to avoid
787 // flickering the background image.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700788 if (IsRoDebuggable()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800789 ui->ShowText(true);
790 }
791 status = INSTALL_NONE; // No command specified
792 ui->SetBackground(RecoveryUI::NO_COMMAND);
793 }
794
795 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
796 ui->SetBackground(RecoveryUI::ERROR);
797 if (!ui->IsTextVisible()) {
798 sleep(5);
799 }
800 }
801
Tao Bao10f441a2019-04-19 15:22:15 -0700802 // Determine the next action.
803 // - If the state is INSTALL_REBOOT, device will reboot into the target as specified in
804 // `next_action`.
805 // - If the recovery menu is visible, prompt and wait for commands.
806 // - If the state is INSTALL_NONE, wait for commands (e.g. in user build, one manually boots
807 // into recovery to sideload a package or to wipe the device).
808 // - In all other cases, reboot the device. Therefore, normal users will observe the device
809 // rebooting a) immediately upon successful finish (INSTALL_SUCCESS); or b) an "error" screen
810 // for 5s followed by an automatic reboot.
811 if (status != INSTALL_REBOOT) {
812 if (status == INSTALL_NONE || ui->IsTextVisible()) {
Tao Baoadc99ef2019-04-29 23:48:02 -0700813 auto temp = PromptAndWait(device, status);
Tao Bao10f441a2019-04-19 15:22:15 -0700814 if (temp != Device::NO_ACTION) {
815 next_action = temp;
816 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800817 }
818 }
819
820 // Save logs and clean up before rebooting or shutting down.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700821 FinishRecovery(ui);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800822
Tao Bao10f441a2019-04-19 15:22:15 -0700823 return next_action;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800824}