blob: 0c977c3616853291886d2bda3db3a2efb2571838 [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"
xunchang24788852019-03-22 16:08:52 -070048#include "install/adb_install.h"
Tianjie Xuf6158eb2019-06-11 16:09:07 -070049#include "install/fuse_install.h"
xunchang24788852019-03-22 16:08:52 -070050#include "install/install.h"
Alessio Balsinia9665ce2019-12-09 09:26:05 +000051#include "install/snapshot_utils.h"
xunchang316e9712019-04-12 16:22:15 -070052#include "install/wipe_data.h"
Tao Bao7f19d102019-04-26 22:56:56 -070053#include "install/wipe_device.h"
Tianjie Xub63a2212019-07-29 14:21:49 -070054#include "otautil/boot_state.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070055#include "otautil/error_code.h"
Jacky Liu068329e2021-12-21 00:32:50 +080056#include "otautil/package.h"
Tao Bao641fa972018-04-25 18:59:40 -070057#include "otautil/paths.h"
Tao Bao2c526392018-05-03 23:01:13 -070058#include "otautil/sysutil.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070059#include "recovery_ui/screen_ui.h"
60#include "recovery_ui/ui.h"
Tao Bao832c9cd2019-09-27 23:32:00 -070061#include "recovery_utils/battery_utils.h"
Tao Baoe3f09a72019-10-01 11:55:36 -070062#include "recovery_utils/logging.h"
63#include "recovery_utils/roots.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080064
Tao Baoaac9d9f2018-04-29 23:38:59 -070065static constexpr const char* COMMAND_FILE = "/cache/recovery/command";
Tao Baoaac9d9f2018-04-29 23:38:59 -070066static constexpr const char* LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
67static constexpr const char* LAST_LOG_FILE = "/cache/recovery/last_log";
68static constexpr const char* LOCALE_FILE = "/cache/recovery/last_locale";
Tianjie Xu06e57ac2016-07-11 14:04:08 -070069
Tao Baoaac9d9f2018-04-29 23:38:59 -070070static constexpr const char* CACHE_ROOT = "/cache";
Nick Kralevicha9ad0322014-10-22 18:38:48 -070071
xunchang316e9712019-04-12 16:22:15 -070072static bool save_current_log = false;
Tao Baoac9d94d2016-11-03 11:37:15 -070073
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080074/*
75 * The recovery tool communicates with the main system through /cache files.
76 * /cache/recovery/command - INPUT - command line for tool, one arg per line
77 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080078 *
79 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -070080 * --update_package=path - verify install an OTA package file
Tianjie Xue5218612019-06-25 13:59:39 -070081 * --install_with_fuse - install the update package with FUSE. This allows installation of large
82 * 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 -080083 * --wipe_data - erase user data (and cache), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070084 * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user
85 * data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080086 * --wipe_cache - wipe cache (but not user data), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070087 * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519).
Oscar Montemayor05231562009-11-30 08:40:57 -080088 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -070089 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080090 *
91 * After completing, we remove /cache/recovery/command and reboot.
92 * Arguments may also be supplied in the bootloader control block (BCB).
93 * These important scenarios must be safely restartable at any point:
94 *
95 * FACTORY RESET
96 * 1. user selects "factory reset"
97 * 2. main system writes "--wipe_data" to /cache/recovery/command
98 * 3. main system reboots into recovery
99 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
100 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700101 * 5. erase_volume() reformats /data
102 * 6. erase_volume() reformats /cache
Tianjie Xu164c60a2019-05-15 13:59:39 -0700103 * 7. FinishRecovery() erases BCB
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800104 * -- after this, rebooting will restart the main system --
105 * 8. main() calls reboot() to boot main system
106 *
107 * OTA INSTALL
108 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700109 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800110 * 3. main system reboots into recovery
111 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
112 * -- after this, rebooting will attempt to reinstall the update --
Tao Baoadc99ef2019-04-29 23:48:02 -0700113 * 5. InstallPackage() attempts to install the update
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800114 * NOTE: the package install must itself be restartable from any point
Tianjie Xu164c60a2019-05-15 13:59:39 -0700115 * 6. FinishRecovery() erases BCB
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800116 * -- after this, rebooting will (try to) restart the main system --
117 * 7. ** if install failed **
Tao Baoadc99ef2019-04-29 23:48:02 -0700118 * 7a. PromptAndWait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800119 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800120 */
121
Tianjie Xu164c60a2019-05-15 13:59:39 -0700122static bool IsRoDebuggable() {
123 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800124}
125
Tao Baoec579032017-07-21 12:13:15 -0700126// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700127// copy our log file to cache as well (for the system to read). This function is
128// idempotent: call it as many times as you like.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700129static void FinishRecovery(RecoveryUI* ui) {
Tao Bao551d2c32018-05-09 20:53:13 -0700130 std::string locale = ui->GetLocale();
Tao Baoec579032017-07-21 12:13:15 -0700131 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
132 // (e.g., directly from the bootloader) it will use the last-known locale.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700133 if (!locale.empty() && HasCache()) {
Tao Baoec579032017-07-21 12:13:15 -0700134 LOG(INFO) << "Saving locale \"" << locale << "\"";
135 if (ensure_path_mounted(LOCALE_FILE) != 0) {
136 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
137 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
138 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700139 }
Tao Baoec579032017-07-21 12:13:15 -0700140 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700141
Tianjie Xu164c60a2019-05-15 13:59:39 -0700142 copy_logs(save_current_log);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800143
Tao Baoec579032017-07-21 12:13:15 -0700144 // Reset to normal system boot so recovery won't cycle indefinitely.
145 std::string err;
146 if (!clear_bootloader_message(&err)) {
147 LOG(ERROR) << "Failed to clear BCB message: " << err;
148 }
149
150 // Remove the command file, so recovery won't repeat indefinitely.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700151 if (HasCache()) {
Tao Baoec579032017-07-21 12:13:15 -0700152 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
153 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700154 }
Tao Baoec579032017-07-21 12:13:15 -0700155 ensure_path_unmounted(CACHE_ROOT);
156 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800157
Tao Baoec579032017-07-21 12:13:15 -0700158 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800159}
160
Elliott Hughes30694c92015-03-25 15:16:51 -0700161static bool yes_no(Device* device, const char* question1, const char* question2) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700162 std::vector<std::string> headers{ question1, question2 };
163 std::vector<std::string> items{ " No", " Yes" };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700164
Tianjie Xu164c60a2019-05-15 13:59:39 -0700165 size_t chosen_item = device->GetUI()->ShowMenu(
Tao Bao3aec6962018-04-20 09:24:58 -0700166 headers, items, 0, true,
167 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
168 return (chosen_item == 1);
Elliott Hughes30694c92015-03-25 15:16:51 -0700169}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800170
Paul Crowley08404b42016-12-19 13:04:23 -0800171static bool ask_to_wipe_data(Device* device) {
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700172 std::vector<std::string> headers{ "Wipe all user data?", " THIS CAN NOT BE UNDONE!" };
173 std::vector<std::string> items{ " Cancel", " Factory data reset" };
174
Tianjie Xu164c60a2019-05-15 13:59:39 -0700175 size_t chosen_item = device->GetUI()->ShowPromptWipeDataConfirmationMenu(
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700176 headers, items,
177 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
178
179 return (chosen_item == 1);
Paul Crowley08404b42016-12-19 13:04:23 -0800180}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700181
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700182static InstallResult prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700183 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tianjie Xub99e6062018-10-16 15:13:09 -0700184 std::vector<std::string> wipe_data_menu_headers{
Tao Bao2bbc6d62017-08-13 23:48:55 -0700185 "Can't load Android system. Your data may be corrupt. "
186 "If you continue to get this message, you may need to "
187 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700188 "stored on this device.",
Tao Baofc5499f2017-02-23 19:06:53 -0800189 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700190 // clang-format off
Tianjie Xub99e6062018-10-16 15:13:09 -0700191 std::vector<std::string> wipe_data_menu_items {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700192 "Try again",
193 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800194 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700195 // clang-format on
Tao Baofc5499f2017-02-23 19:06:53 -0800196 for (;;) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700197 size_t chosen_item = device->GetUI()->ShowPromptWipeDataMenu(
Tianjie Xub99e6062018-10-16 15:13:09 -0700198 wipe_data_menu_headers, wipe_data_menu_items,
Tao Bao3aec6962018-04-20 09:24:58 -0700199 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700200 // If ShowMenu() returned RecoveryUI::KeyError::INTERRUPTED, WaitKey() was interrupted.
201 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700202 return INSTALL_KEY_INTERRUPTED;
Jerry Zhangb76af932018-05-22 12:08:35 -0700203 }
Tao Baofc5499f2017-02-23 19:06:53 -0800204 if (chosen_item != 1) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700205 return INSTALL_SUCCESS; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800206 }
Tianjie Xub99e6062018-10-16 15:13:09 -0700207
Tao Baofc5499f2017-02-23 19:06:53 -0800208 if (ask_to_wipe_data(device)) {
Tianjie Xub63a2212019-07-29 14:21:49 -0700209 CHECK(device->GetReason().has_value());
210 bool convert_fbe = device->GetReason().value() == "convert_fbe";
xunchang316e9712019-04-12 16:22:15 -0700211 if (WipeData(device, convert_fbe)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700212 return INSTALL_SUCCESS;
213 } else {
214 return INSTALL_ERROR;
215 }
Tao Baofc5499f2017-02-23 19:06:53 -0800216 }
217 }
Paul Crowley08404b42016-12-19 13:04:23 -0800218}
219
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700220static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800221 std::vector<std::string> entries;
Tianjie Xu164c60a2019-05-15 13:59:39 -0700222 if (HasCache()) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800223 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
224 auto add_to_entries = [&](const char* filename) {
225 std::string log_file(filename);
226 if (i > 0) {
227 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700228 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800229
Yifan Hongd81b8e32018-12-17 14:29:06 -0800230 if (ensure_path_mounted(log_file) == 0 && access(log_file.c_str(), R_OK) == 0) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800231 entries.push_back(std::move(log_file));
232 }
233 };
234
235 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
236 add_to_entries(LAST_LOG_FILE);
237
238 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
239 add_to_entries(LAST_KMSG_FILE);
240 }
241 } else {
242 // If cache partition is not found, view /tmp/recovery.log instead.
Tao Bao641fa972018-04-25 18:59:40 -0700243 if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800244 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700245 } else {
Tao Bao641fa972018-04-25 18:59:40 -0700246 entries.push_back(Paths::Get().temporary_log_file());
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700247 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800248 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700249
Tao Bao08fc6be2017-03-07 00:56:27 -0800250 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700251
Tao Bao1fe1afe2018-05-01 15:56:05 -0700252 std::vector<std::string> headers{ "Select file to view" };
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700253
Tao Bao1fe1afe2018-05-01 15:56:05 -0700254 size_t chosen_item = 0;
Tao Bao08fc6be2017-03-07 00:56:27 -0800255 while (true) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700256 chosen_item = device->GetUI()->ShowMenu(
Tao Bao1fe1afe2018-05-01 15:56:05 -0700257 headers, entries, chosen_item, true,
Tao Bao3aec6962018-04-20 09:24:58 -0700258 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700259
260 // Handle WaitKey() interrupt.
261 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
262 break;
263 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800264 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700265
Tianjie Xu164c60a2019-05-15 13:59:39 -0700266 device->GetUI()->ShowFile(entries[chosen_item]);
Tao Bao08fc6be2017-03-07 00:56:27 -0800267 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700268}
269
Tianjie Xu164c60a2019-05-15 13:59:39 -0700270static void run_graphics_test(RecoveryUI* ui) {
Tao Baodb7e8982017-03-06 23:53:16 -0800271 // Switch to graphics screen.
272 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700273
Tao Baodb7e8982017-03-06 23:53:16 -0800274 ui->SetProgressType(RecoveryUI::INDETERMINATE);
275 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
276 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700277
Tao Baodb7e8982017-03-06 23:53:16 -0800278 ui->SetBackground(RecoveryUI::ERROR);
279 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700280
Tao Baodb7e8982017-03-06 23:53:16 -0800281 ui->SetBackground(RecoveryUI::NO_COMMAND);
282 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700283
Tao Baodb7e8982017-03-06 23:53:16 -0800284 ui->SetBackground(RecoveryUI::ERASING);
285 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700286
Tao Baodb7e8982017-03-06 23:53:16 -0800287 // Calling SetBackground() after SetStage() to trigger a redraw.
288 ui->SetStage(1, 3);
289 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
290 sleep(1);
291 ui->SetStage(2, 3);
292 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
293 sleep(1);
294 ui->SetStage(3, 3);
295 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
296 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700297
Tao Baodb7e8982017-03-06 23:53:16 -0800298 ui->SetStage(-1, -1);
299 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -0700300
Tao Baodb7e8982017-03-06 23:53:16 -0800301 ui->SetProgressType(RecoveryUI::DETERMINATE);
302 ui->ShowProgress(1.0, 10.0);
303 float fraction = 0.0;
304 for (size_t i = 0; i < 100; ++i) {
305 fraction += .01;
306 ui->SetProgress(fraction);
307 usleep(100000);
308 }
309
310 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -0700311}
312
Yifan Hong13b09962020-01-29 16:51:33 -0800313static void WriteUpdateInProgress() {
314 std::string err;
315 if (!update_bootloader_message({ "--reason=update_in_progress" }, &err)) {
316 LOG(ERROR) << "Failed to WriteUpdateInProgress: " << err;
Yifan Hongc9163fd2020-01-27 17:37:39 -0800317 }
Yifan Hong13b09962020-01-29 16:51:33 -0800318}
Yifan Hongc9163fd2020-01-27 17:37:39 -0800319
Yifan Hong13b09962020-01-29 16:51:33 -0800320static bool AskToReboot(Device* device, Device::BuiltinAction chosen_action) {
Yifan Hongc9163fd2020-01-27 17:37:39 -0800321 bool is_non_ab = android::base::GetProperty("ro.boot.slot_suffix", "").empty();
322 bool is_virtual_ab = android::base::GetBoolProperty("ro.virtual_ab.enabled", false);
323 if (!is_non_ab && !is_virtual_ab) {
324 // Only prompt for non-A/B or Virtual A/B devices.
325 return true;
326 }
327
328 std::string header_text;
329 std::string item_text;
330 switch (chosen_action) {
331 case Device::REBOOT:
332 header_text = "reboot";
333 item_text = " Reboot system now";
334 break;
335 case Device::SHUTDOWN:
336 header_text = "power off";
337 item_text = " Power off";
338 break;
339 default:
340 LOG(FATAL) << "Invalid chosen action " << chosen_action;
341 break;
342 }
343
Yifan Hong13b09962020-01-29 16:51:33 -0800344 std::vector<std::string> headers{ "WARNING: Previous installation has failed.",
Yifan Hongc9163fd2020-01-27 17:37:39 -0800345 " Your device may fail to boot if you " + header_text +
346 " now.",
347 " Confirm reboot?" };
348 std::vector<std::string> items{ " Cancel", item_text };
349
350 size_t chosen_item = device->GetUI()->ShowMenu(
351 headers, items, 0, true /* menu_only */,
352 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
353
354 return (chosen_item == 1);
355}
356
Tao Baoadc99ef2019-04-29 23:48:02 -0700357// Shows the recovery UI and waits for user input. Returns one of the device builtin actions, such
358// as REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default, which
359// is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
360static Device::BuiltinAction PromptAndWait(Device* device, InstallResult status) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700361 auto ui = device->GetUI();
Yifan Hong13b09962020-01-29 16:51:33 -0800362 bool update_in_progress = (device->GetReason().value_or("") == "update_in_progress");
Tao Bao50dd5322017-03-07 14:57:04 -0800363 for (;;) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700364 FinishRecovery(ui);
Tao Bao50dd5322017-03-07 14:57:04 -0800365 switch (status) {
366 case INSTALL_SUCCESS:
367 case INSTALL_NONE:
Tao Baoadc99ef2019-04-29 23:48:02 -0700368 case INSTALL_SKIPPED:
369 case INSTALL_RETRY:
370 case INSTALL_KEY_INTERRUPTED:
Tao Bao50dd5322017-03-07 14:57:04 -0800371 ui->SetBackground(RecoveryUI::NO_COMMAND);
372 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -0700373
Tao Bao50dd5322017-03-07 14:57:04 -0800374 case INSTALL_ERROR:
375 case INSTALL_CORRUPT:
376 ui->SetBackground(RecoveryUI::ERROR);
377 break;
Tao Baoadc99ef2019-04-29 23:48:02 -0700378
379 case INSTALL_REBOOT:
380 // All the reboots should have been handled prior to entering PromptAndWait() or immediately
381 // after installing a package.
382 LOG(FATAL) << "Invalid status code of INSTALL_REBOOT";
383 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800384 }
Tao Bao50dd5322017-03-07 14:57:04 -0800385 ui->SetProgressType(RecoveryUI::EMPTY);
386
Yifan Hong13b09962020-01-29 16:51:33 -0800387 std::vector<std::string> headers;
388 if (update_in_progress) {
389 headers = { "WARNING: Previous installation has failed.",
390 " Your device may fail to boot if you reboot or power off now." };
391 }
392
Tao Bao1fe1afe2018-05-01 15:56:05 -0700393 size_t chosen_item = ui->ShowMenu(
Yifan Hong13b09962020-01-29 16:51:33 -0800394 headers, device->GetMenuItems(), 0, false,
Tao Bao3aec6962018-04-20 09:24:58 -0700395 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700396 // Handle Interrupt key
397 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
398 return Device::KEY_INTERRUPTED;
399 }
Tao Bao50dd5322017-03-07 14:57:04 -0800400 // Device-specific code may take some action here. It may return one of the core actions
401 // handled in the switch statement below.
Jerry Zhangb76af932018-05-22 12:08:35 -0700402 Device::BuiltinAction chosen_action =
403 (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::TIMED_OUT))
404 ? Device::REBOOT
405 : device->InvokeMenuItem(chosen_item);
Tao Bao50dd5322017-03-07 14:57:04 -0800406
Tao Bao50dd5322017-03-07 14:57:04 -0800407 switch (chosen_action) {
Mark Salyzyn488cc052019-05-20 10:36:16 -0700408 case Device::REBOOT_FROM_FASTBOOT: // Can not happen
409 case Device::SHUTDOWN_FROM_FASTBOOT: // Can not happen
Tao Bao50dd5322017-03-07 14:57:04 -0800410 case Device::NO_ACTION:
411 break;
412
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700413 case Device::ENTER_FASTBOOT:
414 case Device::ENTER_RECOVERY:
Tao Baod9cb0142019-04-23 11:46:25 -0700415 case Device::REBOOT_BOOTLOADER:
416 case Device::REBOOT_FASTBOOT:
417 case Device::REBOOT_RECOVERY:
418 case Device::REBOOT_RESCUE:
Tao Bao50dd5322017-03-07 14:57:04 -0800419 return chosen_action;
420
Yifan Hongc9163fd2020-01-27 17:37:39 -0800421 case Device::REBOOT:
422 case Device::SHUTDOWN:
Yifan Hong13b09962020-01-29 16:51:33 -0800423 if (!ui->IsTextVisible()) {
Kelvin Zhang9ebf0652020-08-13 18:15:17 -0400424 return chosen_action;
Yifan Hong13b09962020-01-29 16:51:33 -0800425 }
426 // okay to reboot; no need to ask.
427 if (!update_in_progress) {
Kelvin Zhang9ebf0652020-08-13 18:15:17 -0400428 return chosen_action;
Yifan Hong13b09962020-01-29 16:51:33 -0800429 }
430 // An update might have been failed. Ask if user really wants to reboot.
431 if (AskToReboot(device, chosen_action)) {
Kelvin Zhang9ebf0652020-08-13 18:15:17 -0400432 return chosen_action;
Yifan Hongc9163fd2020-01-27 17:37:39 -0800433 }
434 break;
435
Tao Bao50dd5322017-03-07 14:57:04 -0800436 case Device::WIPE_DATA:
xunchang316e9712019-04-12 16:22:15 -0700437 save_current_log = true;
Tao Bao50dd5322017-03-07 14:57:04 -0800438 if (ui->IsTextVisible()) {
439 if (ask_to_wipe_data(device)) {
xunchang316e9712019-04-12 16:22:15 -0700440 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800441 }
442 } else {
xunchang316e9712019-04-12 16:22:15 -0700443 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800444 return Device::NO_ACTION;
445 }
446 break;
447
xunchang316e9712019-04-12 16:22:15 -0700448 case Device::WIPE_CACHE: {
449 save_current_log = true;
450 std::function<bool()> confirm_func = [&device]() {
451 return yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!");
452 };
453 WipeCache(ui, ui->IsTextVisible() ? confirm_func : nullptr);
Tao Bao50dd5322017-03-07 14:57:04 -0800454 if (!ui->IsTextVisible()) return Device::NO_ACTION;
455 break;
xunchang316e9712019-04-12 16:22:15 -0700456 }
Tao Bao10f441a2019-04-19 15:22:15 -0700457
Tao Bao50dd5322017-03-07 14:57:04 -0800458 case Device::APPLY_ADB_SIDELOAD:
Tao Baoc6dc3252019-04-16 14:22:25 -0700459 case Device::APPLY_SDCARD:
460 case Device::ENTER_RESCUE: {
xunchang316e9712019-04-12 16:22:15 -0700461 save_current_log = true;
Tao Baoc6dc3252019-04-16 14:22:25 -0700462
Yifan Hong13b09962020-01-29 16:51:33 -0800463 update_in_progress = true;
464 WriteUpdateInProgress();
465
Tao Baoc6dc3252019-04-16 14:22:25 -0700466 bool adb = true;
Tao Bao10f441a2019-04-19 15:22:15 -0700467 Device::BuiltinAction reboot_action;
Tao Baoc6dc3252019-04-16 14:22:25 -0700468 if (chosen_action == Device::ENTER_RESCUE) {
469 // Switch to graphics screen.
470 ui->ShowText(false);
xunchangfedeef62019-04-22 12:18:14 -0700471 status = ApplyFromAdb(device, true /* rescue_mode */, &reboot_action);
Tao Baoc6dc3252019-04-16 14:22:25 -0700472 } else if (chosen_action == Device::APPLY_ADB_SIDELOAD) {
xunchangfedeef62019-04-22 12:18:14 -0700473 status = ApplyFromAdb(device, false /* rescue_mode */, &reboot_action);
xunchang3cc23d52019-03-18 15:03:33 -0700474 } else {
Tao Baoc6dc3252019-04-16 14:22:25 -0700475 adb = false;
Tianjie Xuf6158eb2019-06-11 16:09:07 -0700476 status = ApplyFromSdcard(device);
Tao Bao50dd5322017-03-07 14:57:04 -0800477 }
xunchang3cc23d52019-03-18 15:03:33 -0700478
Tao Bao10f441a2019-04-19 15:22:15 -0700479 ui->Print("\nInstall from %s completed with status %d.\n", adb ? "ADB" : "SD card", status);
480 if (status == INSTALL_REBOOT) {
481 return reboot_action;
482 }
483
Yifan Hong13b09962020-01-29 16:51:33 -0800484 if (status == INSTALL_SUCCESS) {
485 update_in_progress = false;
486 if (!ui->IsTextVisible()) {
487 return Device::NO_ACTION; // reboot if logs aren't visible
488 }
489 } else {
xunchang3cc23d52019-03-18 15:03:33 -0700490 ui->SetBackground(RecoveryUI::ERROR);
491 ui->Print("Installation aborted.\n");
Tianjie Xu164c60a2019-05-15 13:59:39 -0700492 copy_logs(save_current_log);
xunchang3cc23d52019-03-18 15:03:33 -0700493 }
Tao Bao50dd5322017-03-07 14:57:04 -0800494 break;
xunchang3cc23d52019-03-18 15:03:33 -0700495 }
Tao Bao50dd5322017-03-07 14:57:04 -0800496
497 case Device::VIEW_RECOVERY_LOGS:
498 choose_recovery_file(device);
499 break;
500
501 case Device::RUN_GRAPHICS_TEST:
Tianjie Xu164c60a2019-05-15 13:59:39 -0700502 run_graphics_test(ui);
Tao Bao50dd5322017-03-07 14:57:04 -0800503 break;
504
Tianjie Xu29d55752017-09-20 17:53:46 -0700505 case Device::RUN_LOCALE_TEST: {
506 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
Tao Bao39c49182018-05-07 22:50:33 -0700507 screen_ui->CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700508 break;
509 }
Alessio Balsinia9665ce2019-12-09 09:26:05 +0000510
Tao Bao50dd5322017-03-07 14:57:04 -0800511 case Device::MOUNT_SYSTEM:
Alessio Balsinia9665ce2019-12-09 09:26:05 +0000512 // For Virtual A/B, set up the snapshot devices (if exist).
513 if (!CreateSnapshotPartitions()) {
514 ui->Print("Virtual A/B: snapshot partitions creation failed.\n");
515 break;
516 }
Tao Baof90d9a12019-05-10 10:40:59 -0700517 if (ensure_path_mounted_at(android::fs_mgr::GetSystemRoot(), "/mnt/system") != -1) {
Yifan Hong49327802018-11-26 14:59:09 -0800518 ui->Print("Mounted /system.\n");
Tao Bao50dd5322017-03-07 14:57:04 -0800519 }
520 break;
Jerry Zhangb76af932018-05-22 12:08:35 -0700521
522 case Device::KEY_INTERRUPTED:
523 return Device::KEY_INTERRUPTED;
Tao Bao50dd5322017-03-07 14:57:04 -0800524 }
525 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800526}
527
Tao Bao99f0d9e2016-10-13 12:46:38 -0700528static void print_property(const char* key, const char* name, void* /* cookie */) {
529 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800530}
531
Tao Bao832c9cd2019-09-27 23:32:00 -0700532static bool IsBatteryOk(int* required_battery_level) {
533 // GmsCore enters recovery mode to install package when having enough battery percentage.
534 // Normally, the threshold is 40% without charger and 20% with charger. So we check the battery
535 // level against a slightly lower limit.
536 constexpr int BATTERY_OK_PERCENTAGE = 20;
537 constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
Yabin Cui99281df2016-02-17 12:21:52 -0800538
Tao Bao832c9cd2019-09-27 23:32:00 -0700539 auto battery_info = GetBatteryInfo();
540 *required_battery_level =
541 battery_info.charging ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE;
542 return battery_info.capacity >= *required_battery_level;
Yabin Cui99281df2016-02-17 12:21:52 -0800543}
544
Tianjie Xu99b73be2017-11-28 17:23:06 -0800545// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -0700546static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
547 std::vector<std::string> options;
548 for (const auto& arg : args) {
549 if (!android::base::StartsWith(arg, "--retry_count")) {
550 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -0800551 }
Tianjie Xu72449c92017-05-16 18:07:31 -0700552 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800553
Tianjie Xu99b73be2017-11-28 17:23:06 -0800554 // Update the retry counter in BCB.
555 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -0700556 std::string err;
557 if (!update_bootloader_message(options, &err)) {
558 LOG(ERROR) << err;
559 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800560}
561
Tianjie1bc976a2020-07-22 17:25:11 -0700562static bool bootreason_in_blocklist() {
Tao Baoefc35592017-01-08 22:45:47 -0800563 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
564 if (!bootreason.empty()) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700565 // More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
Tianjie1bc976a2020-07-22 17:25:11 -0700566 static const std::vector<std::string> kBootreasonBlocklist{
Tao Baoaac9d9f2018-04-29 23:38:59 -0700567 "kernel_panic",
568 "Panic",
569 };
Tianjie1bc976a2020-07-22 17:25:11 -0700570 for (const auto& str : kBootreasonBlocklist) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700571 if (android::base::EqualsIgnoreCase(str, bootreason)) return true;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700572 }
Tao Baoefc35592017-01-08 22:45:47 -0800573 }
574 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700575}
576
Tao Bao641fa972018-04-25 18:59:40 -0700577static void log_failure_code(ErrorCode code, const std::string& update_package) {
578 std::vector<std::string> log_buffer = {
579 update_package,
580 "0", // install result
581 "error: " + std::to_string(code),
582 };
583 std::string log_content = android::base::Join(log_buffer, "\n");
584 const std::string& install_file = Paths::Get().temporary_install_file();
585 if (!android::base::WriteStringToFile(log_content, install_file)) {
586 PLOG(ERROR) << "Failed to write " << install_file;
587 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700588
Tao Bao641fa972018-04-25 18:59:40 -0700589 // Also write the info into last_log.
590 LOG(INFO) << log_content;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700591}
592
Jerry Zhang6a648042018-05-04 11:24:10 -0700593Device::BuiltinAction start_recovery(Device* device, const std::vector<std::string>& args) {
Tao Baof9f17342018-04-27 10:44:04 -0700594 static constexpr struct option OPTIONS[] = {
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700595 { "fastboot", no_argument, nullptr, 0 },
Tianjie Xue5218612019-06-25 13:59:39 -0700596 { "install_with_fuse", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700597 { "just_exit", no_argument, nullptr, 'x' },
598 { "locale", required_argument, nullptr, 0 },
599 { "prompt_and_wipe_data", no_argument, nullptr, 0 },
600 { "reason", required_argument, nullptr, 0 },
Tao Baod9cb0142019-04-23 11:46:25 -0700601 { "rescue", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700602 { "retry_count", required_argument, nullptr, 0 },
603 { "security", no_argument, nullptr, 0 },
604 { "show_text", no_argument, nullptr, 't' },
605 { "shutdown_after", no_argument, nullptr, 0 },
606 { "sideload", no_argument, nullptr, 0 },
607 { "sideload_auto_reboot", no_argument, nullptr, 0 },
608 { "update_package", required_argument, nullptr, 0 },
609 { "wipe_ab", no_argument, nullptr, 0 },
610 { "wipe_cache", no_argument, nullptr, 0 },
611 { "wipe_data", no_argument, nullptr, 0 },
612 { "wipe_package_size", required_argument, nullptr, 0 },
613 { nullptr, 0, nullptr, 0 },
614 };
615
Tianjie Xu99b73be2017-11-28 17:23:06 -0800616 const char* update_package = nullptr;
Tianjie Xue5218612019-06-25 13:59:39 -0700617 bool install_with_fuse = false; // memory map the update package by default.
Tianjie Xu99b73be2017-11-28 17:23:06 -0800618 bool should_wipe_data = false;
619 bool should_prompt_and_wipe_data = false;
620 bool should_wipe_cache = false;
621 bool should_wipe_ab = false;
622 size_t wipe_package_size = 0;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800623 bool sideload = false;
624 bool sideload_auto_reboot = false;
Tao Baod9cb0142019-04-23 11:46:25 -0700625 bool rescue = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800626 bool just_exit = false;
627 bool shutdown_after = false;
628 int retry_count = 0;
629 bool security_update = false;
Jerry Zhang2dea53e2018-05-02 17:15:03 -0700630 std::string locale;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800631
Tao Bao1700cc42018-07-16 22:09:59 -0700632 auto args_to_parse = StringVectorToNullTerminatedArray(args);
633
Tianjie Xu99b73be2017-11-28 17:23:06 -0800634 int arg;
635 int option_index;
Tao Bao1700cc42018-07-16 22:09:59 -0700636 // Parse everything before the last element (which must be a nullptr). getopt_long(3) expects a
637 // null-terminated char* array, but without counting null as an arg (i.e. argv[argc] should be
638 // nullptr).
639 while ((arg = getopt_long(args_to_parse.size() - 1, args_to_parse.data(), "", OPTIONS,
Tianjie Xu99b73be2017-11-28 17:23:06 -0800640 &option_index)) != -1) {
641 switch (arg) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800642 case 't':
Jerry Zhang6a648042018-05-04 11:24:10 -0700643 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800644 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800645 case 'x':
646 just_exit = true;
647 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800648 case 0: {
649 std::string option = OPTIONS[option_index].name;
David Anderson969787c2020-01-27 09:29:02 -0800650 if (option == "install_with_fuse") {
Tianjie Xue5218612019-06-25 13:59:39 -0700651 install_with_fuse = true;
Tianjie Xub63a2212019-07-29 14:21:49 -0700652 } else if (option == "locale" || option == "fastboot" || option == "reason") {
Jerry Zhang6a648042018-05-04 11:24:10 -0700653 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800654 } else if (option == "prompt_and_wipe_data") {
655 should_prompt_and_wipe_data = true;
Tao Baod9cb0142019-04-23 11:46:25 -0700656 } else if (option == "rescue") {
657 rescue = true;
Tao Baof9f17342018-04-27 10:44:04 -0700658 } else if (option == "retry_count") {
659 android::base::ParseInt(optarg, &retry_count, 0);
660 } else if (option == "security") {
661 security_update = true;
662 } else if (option == "sideload") {
663 sideload = true;
664 } else if (option == "sideload_auto_reboot") {
665 sideload = true;
666 sideload_auto_reboot = true;
667 } else if (option == "shutdown_after") {
668 shutdown_after = true;
669 } else if (option == "update_package") {
670 update_package = optarg;
671 } else if (option == "wipe_ab") {
672 should_wipe_ab = true;
673 } else if (option == "wipe_cache") {
674 should_wipe_cache = true;
675 } else if (option == "wipe_data") {
676 should_wipe_data = true;
677 } else if (option == "wipe_package_size") {
678 android::base::ParseUint(optarg, &wipe_package_size);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800679 }
680 break;
681 }
682 case '?':
683 LOG(ERROR) << "Invalid command argument";
684 continue;
Doug Zongker9270a202012-01-09 15:16:13 -0800685 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800686 }
Jerry Zhang49fd5d22018-05-17 12:54:41 -0700687 optind = 1;
Doug Zongker9270a202012-01-09 15:16:13 -0800688
Tianjie Xub63a2212019-07-29 14:21:49 -0700689 printf("stage is [%s]\n", device->GetStage().value_or("").c_str());
690 printf("reason is [%s]\n", device->GetReason().value_or("").c_str());
Doug Zongker02ec6b82012-08-22 17:26:40 -0700691
Tianjie Xu164c60a2019-05-15 13:59:39 -0700692 auto ui = device->GetUI();
693
Tianjie Xu99b73be2017-11-28 17:23:06 -0800694 // Set background string to "installing security update" for security update,
695 // otherwise set it to "installing system update".
696 ui->SetSystemUpdateText(security_update);
697
698 int st_cur, st_max;
Tianjie Xub63a2212019-07-29 14:21:49 -0700699 if (!device->GetStage().has_value() &&
700 sscanf(device->GetStage().value().c_str(), "%d/%d", &st_cur, &st_max) == 2) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800701 ui->SetStage(st_cur, st_max);
702 }
703
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700704 std::vector<std::string> title_lines =
Jiyong Parkbfd67642020-05-25 18:14:53 +0900705 android::base::Split(android::base::GetProperty("ro.build.fingerprint", ""), ":");
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700706 title_lines.insert(std::begin(title_lines), "Android Recovery");
707 ui->SetTitle(title_lines);
708
Jerry Zhangb76af932018-05-22 12:08:35 -0700709 ui->ResetKeyInterruptStatus();
Tianjie Xu99b73be2017-11-28 17:23:06 -0800710 device->StartRecovery();
711
712 printf("Command:");
713 for (const auto& arg : args) {
714 printf(" \"%s\"", arg.c_str());
715 }
716 printf("\n\n");
717
718 property_list(print_property, nullptr);
719 printf("\n");
720
Tao Baoadc99ef2019-04-29 23:48:02 -0700721 InstallResult status = INSTALL_SUCCESS;
Tao Bao10f441a2019-04-19 15:22:15 -0700722 // next_action indicates the next target to reboot into upon finishing the install. It could be
723 // overridden to a different reboot target per user request.
724 Device::BuiltinAction next_action = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800725
726 if (update_package != nullptr) {
727 // It's not entirely true that we will modify the flash. But we want
728 // to log the update attempt since update_package is non-NULL.
xunchang316e9712019-04-12 16:22:15 -0700729 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800730
Tao Bao832c9cd2019-09-27 23:32:00 -0700731 if (int required_battery_level; retry_count == 0 && !IsBatteryOk(&required_battery_level)) {
Tao Bao6d90a9d2018-04-26 10:40:36 -0700732 ui->Print("battery capacity is not enough for installing package: %d%% needed\n",
733 required_battery_level);
Tao Bao832c9cd2019-09-27 23:32:00 -0700734 // Log the error code to last_install when installation skips due to low battery.
Tianjie Xu99b73be2017-11-28 17:23:06 -0800735 log_failure_code(kLowBattery, update_package);
736 status = INSTALL_SKIPPED;
Tianjie1bc976a2020-07-22 17:25:11 -0700737 } else if (retry_count == 0 && bootreason_in_blocklist()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800738 // Skip update-on-reboot when bootreason is kernel_panic or similar
Tianjie1bc976a2020-07-22 17:25:11 -0700739 ui->Print("bootreason is in the blocklist; skip OTA installation\n");
740 log_failure_code(kBootreasonInBlocklist, update_package);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800741 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -0700742 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800743 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
744 // identify the interrupted update due to unexpected reboots.
745 if (retry_count == 0) {
746 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -0700747 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800748
Tianjie Xucd8faf72019-08-06 12:32:05 -0700749 bool should_use_fuse = false;
750 if (!SetupPackageMount(update_package, &should_use_fuse)) {
751 LOG(INFO) << "Failed to set up the package access, skipping installation";
752 status = INSTALL_ERROR;
753 } else if (install_with_fuse || should_use_fuse) {
Tianjie Xue5218612019-06-25 13:59:39 -0700754 LOG(INFO) << "Installing package " << update_package << " with fuse";
Kelvin Zhanga4208b52022-02-14 18:38:06 -0800755 status = InstallWithFuseFromPath(update_package, device);
Tianjie Xue5218612019-06-25 13:59:39 -0700756 } else if (auto memory_package = Package::CreateMemoryPackage(
757 update_package,
758 std::bind(&RecoveryUI::SetProgress, ui, std::placeholders::_1));
759 memory_package != nullptr) {
760 status = InstallPackage(memory_package.get(), update_package, should_wipe_cache,
Kelvin Zhanga4208b52022-02-14 18:38:06 -0800761 retry_count, device);
Tianjie Xue5218612019-06-25 13:59:39 -0700762 } else {
763 // We may fail to memory map the package on 32 bit builds for packages with 2GiB+ size.
764 // In such cases, we will try to install the package with fuse. This is not the default
765 // installation method because it introduces a layer of indirection from the kernel space.
766 LOG(WARNING) << "Failed to memory map package " << update_package
767 << "; falling back to install with fuse";
Kelvin Zhanga4208b52022-02-14 18:38:06 -0800768 status = InstallWithFuseFromPath(update_package, device);
Tianjie Xue5218612019-06-25 13:59:39 -0700769 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800770 if (status != INSTALL_SUCCESS) {
771 ui->Print("Installation aborted.\n");
Tao Baoaac9d9f2018-04-29 23:38:59 -0700772
773 // When I/O error or bspatch/imgpatch error happens, reboot and retry installation
774 // RETRY_LIMIT times before we abandon this OTA update.
775 static constexpr int RETRY_LIMIT = 4;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800776 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
Tianjie Xu164c60a2019-05-15 13:59:39 -0700777 copy_logs(save_current_log);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800778 retry_count += 1;
779 set_retry_bootloader_message(retry_count, args);
780 // Print retry count on screen.
781 ui->Print("Retry attempt %d\n", retry_count);
782
Tao Bao782dcc12019-04-29 11:23:16 -0700783 // Reboot back into recovery to retry the update.
Tianjie Xu00c4aba2020-03-13 14:25:02 -0700784 Reboot("recovery");
Tianjie Xud9d16292017-04-20 18:08:21 -0700785 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800786 // If this is an eng or userdebug build, then automatically
787 // turn the text display on if the script fails so the error
788 // message is visible.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700789 if (IsRoDebuggable()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800790 ui->ShowText(true);
Tao Baoc679f932015-03-30 09:43:49 -0700791 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800792 }
Doug Zongker8674a722010-09-15 11:08:23 -0700793 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800794 } else if (should_wipe_data) {
xunchang316e9712019-04-12 16:22:15 -0700795 save_current_log = true;
Tianjie Xub63a2212019-07-29 14:21:49 -0700796 CHECK(device->GetReason().has_value());
797 bool convert_fbe = device->GetReason().value() == "convert_fbe";
xunchang316e9712019-04-12 16:22:15 -0700798 if (!WipeData(device, convert_fbe)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800799 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -0700800 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800801 } else if (should_prompt_and_wipe_data) {
Tao Baoa5bbcb92018-09-17 14:32:47 -0700802 // Trigger the logging to capture the cause, even if user chooses to not wipe data.
xunchang316e9712019-04-12 16:22:15 -0700803 save_current_log = true;
Tao Baoa5bbcb92018-09-17 14:32:47 -0700804
Tianjie Xu99b73be2017-11-28 17:23:06 -0800805 ui->ShowText(true);
806 ui->SetBackground(RecoveryUI::ERROR);
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700807 status = prompt_and_wipe_data(device);
808 if (status != INSTALL_KEY_INTERRUPTED) {
809 ui->ShowText(false);
Tao Bao75238632015-05-27 14:46:17 -0700810 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800811 } else if (should_wipe_cache) {
xunchang316e9712019-04-12 16:22:15 -0700812 save_current_log = true;
813 if (!WipeCache(ui, nullptr)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800814 status = INSTALL_ERROR;
815 }
816 } else if (should_wipe_ab) {
Tao Bao7f19d102019-04-26 22:56:56 -0700817 if (!WipeAbDevice(device, wipe_package_size)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800818 status = INSTALL_ERROR;
819 }
820 } else if (sideload) {
Tao Bao10f441a2019-04-19 15:22:15 -0700821 // 'adb reboot sideload' acts the same as user presses key combinations to enter the sideload
822 // mode. When 'sideload-auto-reboot' is used, text display will NOT be turned on by default. And
823 // it will reboot after sideload finishes even if there are errors. This is to enable automated
Tianjie Xu99b73be2017-11-28 17:23:06 -0800824 // testing.
xunchang316e9712019-04-12 16:22:15 -0700825 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800826 if (!sideload_auto_reboot) {
827 ui->ShowText(true);
828 }
xunchangfedeef62019-04-22 12:18:14 -0700829 status = ApplyFromAdb(device, false /* rescue_mode */, &next_action);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800830 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
831 if (sideload_auto_reboot) {
Tao Bao10f441a2019-04-19 15:22:15 -0700832 status = INSTALL_REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800833 ui->Print("Rebooting automatically.\n");
834 }
Tao Baod9cb0142019-04-23 11:46:25 -0700835 } else if (rescue) {
836 save_current_log = true;
xunchangfedeef62019-04-22 12:18:14 -0700837 status = ApplyFromAdb(device, true /* rescue_mode */, &next_action);
Tao Baod9cb0142019-04-23 11:46:25 -0700838 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800839 } else if (!just_exit) {
840 // If this is an eng or userdebug build, automatically turn on the text display if no command
841 // is specified. Note that this should be called before setting the background to avoid
842 // flickering the background image.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700843 if (IsRoDebuggable()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800844 ui->ShowText(true);
845 }
846 status = INSTALL_NONE; // No command specified
847 ui->SetBackground(RecoveryUI::NO_COMMAND);
848 }
849
850 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
851 ui->SetBackground(RecoveryUI::ERROR);
852 if (!ui->IsTextVisible()) {
853 sleep(5);
854 }
855 }
856
Tao Bao10f441a2019-04-19 15:22:15 -0700857 // Determine the next action.
858 // - If the state is INSTALL_REBOOT, device will reboot into the target as specified in
859 // `next_action`.
860 // - If the recovery menu is visible, prompt and wait for commands.
861 // - If the state is INSTALL_NONE, wait for commands (e.g. in user build, one manually boots
862 // into recovery to sideload a package or to wipe the device).
863 // - In all other cases, reboot the device. Therefore, normal users will observe the device
864 // rebooting a) immediately upon successful finish (INSTALL_SUCCESS); or b) an "error" screen
865 // for 5s followed by an automatic reboot.
866 if (status != INSTALL_REBOOT) {
867 if (status == INSTALL_NONE || ui->IsTextVisible()) {
Tao Baoadc99ef2019-04-29 23:48:02 -0700868 auto temp = PromptAndWait(device, status);
Tao Bao10f441a2019-04-19 15:22:15 -0700869 if (temp != Device::NO_ACTION) {
870 next_action = temp;
871 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800872 }
873 }
874
875 // Save logs and clean up before rebooting or shutting down.
Tianjie Xu164c60a2019-05-15 13:59:39 -0700876 FinishRecovery(ui);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800877
Tao Bao10f441a2019-04-19 15:22:15 -0700878 return next_action;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800879}