blob: 97ca0a504f9083fb2f663765430667ca7fb2cc87 [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>
Yifan Hong056538c2018-07-11 17:04:12 -070045#include <healthhalutils/HealthHalUtils.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070046#include <ziparchive/zip_archive.h>
Yabin Cui99281df2016-02-17 12:21:52 -080047
Tao Bao7f19d102019-04-26 22:56:56 -070048#include "bootloader_message/bootloader_message.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080049#include "common.h"
David Andersonedee8362018-05-16 13:43:22 -070050#include "fsck_unshare_blocks.h"
xunchang24788852019-03-22 16:08:52 -070051#include "install/adb_install.h"
Tianjie Xuf6158eb2019-06-11 16:09:07 -070052#include "install/fuse_install.h"
xunchang24788852019-03-22 16:08:52 -070053#include "install/install.h"
54#include "install/package.h"
xunchang316e9712019-04-12 16:22:15 -070055#include "install/wipe_data.h"
Tao Bao7f19d102019-04-26 22:56:56 -070056#include "install/wipe_device.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070057#include "otautil/error_code.h"
xunchang316e9712019-04-12 16:22:15 -070058#include "otautil/logging.h"
Tao Bao641fa972018-04-25 18:59:40 -070059#include "otautil/paths.h"
xunchang24788852019-03-22 16:08:52 -070060#include "otautil/roots.h"
Tao Bao2c526392018-05-03 23:01:13 -070061#include "otautil/sysutil.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070062#include "recovery_ui/screen_ui.h"
63#include "recovery_ui/ui.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
Tao Baobd0ddcd2017-05-04 13:03:18 -070072// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
73// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
74static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
75
xunchang316e9712019-04-12 16:22:15 -070076static bool save_current_log = false;
Tao Baoa8d72bc2016-12-25 18:46:50 -080077std::string stage;
Tao Baoac9d94d2016-11-03 11:37:15 -070078const char* reason = nullptr;
Tao Baoac9d94d2016-11-03 11:37:15 -070079
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080080/*
81 * The recovery tool communicates with the main system through /cache files.
82 * /cache/recovery/command - INPUT - command line for tool, one arg per line
83 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080084 *
85 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -070086 * --update_package=path - verify install an OTA package file
Tianjie Xue5218612019-06-25 13:59:39 -070087 * --install_with_fuse - install the update package with FUSE. This allows installation of large
88 * 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 -080089 * --wipe_data - erase user data (and cache), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070090 * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user
91 * data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080092 * --wipe_cache - wipe cache (but not user data), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070093 * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519).
Oscar Montemayor05231562009-11-30 08:40:57 -080094 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -070095 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080096 *
97 * After completing, we remove /cache/recovery/command and reboot.
98 * Arguments may also be supplied in the bootloader control block (BCB).
99 * These important scenarios must be safely restartable at any point:
100 *
101 * FACTORY RESET
102 * 1. user selects "factory reset"
103 * 2. main system writes "--wipe_data" to /cache/recovery/command
104 * 3. main system reboots into recovery
105 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
106 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700107 * 5. erase_volume() reformats /data
108 * 6. erase_volume() reformats /cache
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800109 * 7. finish_recovery() erases BCB
110 * -- after this, rebooting will restart the main system --
111 * 8. main() calls reboot() to boot main system
112 *
113 * OTA INSTALL
114 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700115 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800116 * 3. main system reboots into recovery
117 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
118 * -- after this, rebooting will attempt to reinstall the update --
Tao Baoadc99ef2019-04-29 23:48:02 -0700119 * 5. InstallPackage() attempts to install the update
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800120 * NOTE: the package install must itself be restartable from any point
121 * 6. finish_recovery() erases BCB
122 * -- after this, rebooting will (try to) restart the main system --
123 * 7. ** if install failed **
Tao Baoadc99ef2019-04-29 23:48:02 -0700124 * 7a. PromptAndWait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800125 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800126 */
127
Elliott Hughesf14af802015-02-10 14:46:14 -0800128bool is_ro_debuggable() {
Elliott Hughescb220402016-09-23 15:30:55 -0700129 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800130}
131
Tao Baoec579032017-07-21 12:13:15 -0700132// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700133// copy our log file to cache as well (for the system to read). This function is
134// idempotent: call it as many times as you like.
Tao Bao551d2c32018-05-09 20:53:13 -0700135static void finish_recovery() {
136 std::string locale = ui->GetLocale();
Tao Baoec579032017-07-21 12:13:15 -0700137 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
138 // (e.g., directly from the bootloader) it will use the last-known locale.
139 if (!locale.empty() && has_cache) {
140 LOG(INFO) << "Saving locale \"" << locale << "\"";
141 if (ensure_path_mounted(LOCALE_FILE) != 0) {
142 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
143 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
144 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700145 }
Tao Baoec579032017-07-21 12:13:15 -0700146 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700147
xunchang316e9712019-04-12 16:22:15 -0700148 copy_logs(save_current_log, has_cache, sehandle);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800149
Tao Baoec579032017-07-21 12:13:15 -0700150 // Reset to normal system boot so recovery won't cycle indefinitely.
151 std::string err;
152 if (!clear_bootloader_message(&err)) {
153 LOG(ERROR) << "Failed to clear BCB message: " << err;
154 }
155
156 // Remove the command file, so recovery won't repeat indefinitely.
157 if (has_cache) {
158 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
159 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700160 }
Tao Baoec579032017-07-21 12:13:15 -0700161 ensure_path_unmounted(CACHE_ROOT);
162 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800163
Tao Baoec579032017-07-21 12:13:15 -0700164 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800165}
166
Elliott Hughes30694c92015-03-25 15:16:51 -0700167static bool yes_no(Device* device, const char* question1, const char* question2) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700168 std::vector<std::string> headers{ question1, question2 };
169 std::vector<std::string> items{ " No", " Yes" };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700170
Tao Bao1fe1afe2018-05-01 15:56:05 -0700171 size_t chosen_item = ui->ShowMenu(
Tao Bao3aec6962018-04-20 09:24:58 -0700172 headers, items, 0, true,
173 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
174 return (chosen_item == 1);
Elliott Hughes30694c92015-03-25 15:16:51 -0700175}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800176
Paul Crowley08404b42016-12-19 13:04:23 -0800177static bool ask_to_wipe_data(Device* device) {
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700178 std::vector<std::string> headers{ "Wipe all user data?", " THIS CAN NOT BE UNDONE!" };
179 std::vector<std::string> items{ " Cancel", " Factory data reset" };
180
181 size_t chosen_item = ui->ShowPromptWipeDataConfirmationMenu(
182 headers, items,
183 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
184
185 return (chosen_item == 1);
Paul Crowley08404b42016-12-19 13:04:23 -0800186}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700187
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700188static InstallResult prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700189 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tianjie Xub99e6062018-10-16 15:13:09 -0700190 std::vector<std::string> wipe_data_menu_headers{
Tao Bao2bbc6d62017-08-13 23:48:55 -0700191 "Can't load Android system. Your data may be corrupt. "
192 "If you continue to get this message, you may need to "
193 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700194 "stored on this device.",
Tao Baofc5499f2017-02-23 19:06:53 -0800195 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700196 // clang-format off
Tianjie Xub99e6062018-10-16 15:13:09 -0700197 std::vector<std::string> wipe_data_menu_items {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700198 "Try again",
199 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800200 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700201 // clang-format on
Tao Baofc5499f2017-02-23 19:06:53 -0800202 for (;;) {
Tianjie Xub99e6062018-10-16 15:13:09 -0700203 size_t chosen_item = ui->ShowPromptWipeDataMenu(
204 wipe_data_menu_headers, wipe_data_menu_items,
Tao Bao3aec6962018-04-20 09:24:58 -0700205 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700206 // If ShowMenu() returned RecoveryUI::KeyError::INTERRUPTED, WaitKey() was interrupted.
207 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700208 return INSTALL_KEY_INTERRUPTED;
Jerry Zhangb76af932018-05-22 12:08:35 -0700209 }
Tao Baofc5499f2017-02-23 19:06:53 -0800210 if (chosen_item != 1) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700211 return INSTALL_SUCCESS; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800212 }
Tianjie Xub99e6062018-10-16 15:13:09 -0700213
Tao Baofc5499f2017-02-23 19:06:53 -0800214 if (ask_to_wipe_data(device)) {
xunchang316e9712019-04-12 16:22:15 -0700215 bool convert_fbe = reason && strcmp(reason, "convert_fbe") == 0;
216 if (WipeData(device, convert_fbe)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700217 return INSTALL_SUCCESS;
218 } else {
219 return INSTALL_ERROR;
220 }
Tao Baofc5499f2017-02-23 19:06:53 -0800221 }
222 }
Paul Crowley08404b42016-12-19 13:04:23 -0800223}
224
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700225static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800226 std::vector<std::string> entries;
227 if (has_cache) {
228 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
229 auto add_to_entries = [&](const char* filename) {
230 std::string log_file(filename);
231 if (i > 0) {
232 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700233 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800234
Yifan Hongd81b8e32018-12-17 14:29:06 -0800235 if (ensure_path_mounted(log_file) == 0 && access(log_file.c_str(), R_OK) == 0) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800236 entries.push_back(std::move(log_file));
237 }
238 };
239
240 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
241 add_to_entries(LAST_LOG_FILE);
242
243 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
244 add_to_entries(LAST_KMSG_FILE);
245 }
246 } else {
247 // If cache partition is not found, view /tmp/recovery.log instead.
Tao Bao641fa972018-04-25 18:59:40 -0700248 if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800249 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700250 } else {
Tao Bao641fa972018-04-25 18:59:40 -0700251 entries.push_back(Paths::Get().temporary_log_file());
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700252 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800253 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700254
Tao Bao08fc6be2017-03-07 00:56:27 -0800255 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700256
Tao Bao1fe1afe2018-05-01 15:56:05 -0700257 std::vector<std::string> headers{ "Select file to view" };
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700258
Tao Bao1fe1afe2018-05-01 15:56:05 -0700259 size_t chosen_item = 0;
Tao Bao08fc6be2017-03-07 00:56:27 -0800260 while (true) {
Tao Bao3aec6962018-04-20 09:24:58 -0700261 chosen_item = ui->ShowMenu(
Tao Bao1fe1afe2018-05-01 15:56:05 -0700262 headers, entries, chosen_item, true,
Tao Bao3aec6962018-04-20 09:24:58 -0700263 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700264
265 // Handle WaitKey() interrupt.
266 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
267 break;
268 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800269 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700270
Tao Bao1d156b92018-05-02 12:43:18 -0700271 ui->ShowFile(entries[chosen_item]);
Tao Bao08fc6be2017-03-07 00:56:27 -0800272 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700273}
274
Tao Baodb7e8982017-03-06 23:53:16 -0800275static void run_graphics_test() {
276 // Switch to graphics screen.
277 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700278
Tao Baodb7e8982017-03-06 23:53:16 -0800279 ui->SetProgressType(RecoveryUI::INDETERMINATE);
280 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
281 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700282
Tao Baodb7e8982017-03-06 23:53:16 -0800283 ui->SetBackground(RecoveryUI::ERROR);
284 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700285
Tao Baodb7e8982017-03-06 23:53:16 -0800286 ui->SetBackground(RecoveryUI::NO_COMMAND);
287 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700288
Tao Baodb7e8982017-03-06 23:53:16 -0800289 ui->SetBackground(RecoveryUI::ERASING);
290 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700291
Tao Baodb7e8982017-03-06 23:53:16 -0800292 // Calling SetBackground() after SetStage() to trigger a redraw.
293 ui->SetStage(1, 3);
294 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
295 sleep(1);
296 ui->SetStage(2, 3);
297 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
298 sleep(1);
299 ui->SetStage(3, 3);
300 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
301 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700302
Tao Baodb7e8982017-03-06 23:53:16 -0800303 ui->SetStage(-1, -1);
304 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -0700305
Tao Baodb7e8982017-03-06 23:53:16 -0800306 ui->SetProgressType(RecoveryUI::DETERMINATE);
307 ui->ShowProgress(1.0, 10.0);
308 float fraction = 0.0;
309 for (size_t i = 0; i < 100; ++i) {
310 fraction += .01;
311 ui->SetProgress(fraction);
312 usleep(100000);
313 }
314
315 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -0700316}
317
Tao Baoadc99ef2019-04-29 23:48:02 -0700318// Shows the recovery UI and waits for user input. Returns one of the device builtin actions, such
319// as REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default, which
320// is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
321static Device::BuiltinAction PromptAndWait(Device* device, InstallResult status) {
Tao Bao50dd5322017-03-07 14:57:04 -0800322 for (;;) {
Tao Bao551d2c32018-05-09 20:53:13 -0700323 finish_recovery();
Tao Bao50dd5322017-03-07 14:57:04 -0800324 switch (status) {
325 case INSTALL_SUCCESS:
326 case INSTALL_NONE:
Tao Baoadc99ef2019-04-29 23:48:02 -0700327 case INSTALL_SKIPPED:
328 case INSTALL_RETRY:
329 case INSTALL_KEY_INTERRUPTED:
Tao Bao50dd5322017-03-07 14:57:04 -0800330 ui->SetBackground(RecoveryUI::NO_COMMAND);
331 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -0700332
Tao Bao50dd5322017-03-07 14:57:04 -0800333 case INSTALL_ERROR:
334 case INSTALL_CORRUPT:
335 ui->SetBackground(RecoveryUI::ERROR);
336 break;
Tao Baoadc99ef2019-04-29 23:48:02 -0700337
338 case INSTALL_REBOOT:
339 // All the reboots should have been handled prior to entering PromptAndWait() or immediately
340 // after installing a package.
341 LOG(FATAL) << "Invalid status code of INSTALL_REBOOT";
342 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800343 }
Tao Bao50dd5322017-03-07 14:57:04 -0800344 ui->SetProgressType(RecoveryUI::EMPTY);
345
Tao Bao1fe1afe2018-05-01 15:56:05 -0700346 size_t chosen_item = ui->ShowMenu(
347 {}, device->GetMenuItems(), 0, false,
Tao Bao3aec6962018-04-20 09:24:58 -0700348 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700349 // Handle Interrupt key
350 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
351 return Device::KEY_INTERRUPTED;
352 }
Tao Bao50dd5322017-03-07 14:57:04 -0800353 // Device-specific code may take some action here. It may return one of the core actions
354 // handled in the switch statement below.
Jerry Zhangb76af932018-05-22 12:08:35 -0700355 Device::BuiltinAction chosen_action =
356 (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::TIMED_OUT))
357 ? Device::REBOOT
358 : device->InvokeMenuItem(chosen_item);
Tao Bao50dd5322017-03-07 14:57:04 -0800359
Tao Bao50dd5322017-03-07 14:57:04 -0800360 switch (chosen_action) {
Mark Salyzyn488cc052019-05-20 10:36:16 -0700361 case Device::REBOOT_FROM_FASTBOOT: // Can not happen
362 case Device::SHUTDOWN_FROM_FASTBOOT: // Can not happen
Tao Bao50dd5322017-03-07 14:57:04 -0800363 case Device::NO_ACTION:
364 break;
365
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700366 case Device::ENTER_FASTBOOT:
367 case Device::ENTER_RECOVERY:
Tao Baod9cb0142019-04-23 11:46:25 -0700368 case Device::REBOOT:
369 case Device::REBOOT_BOOTLOADER:
370 case Device::REBOOT_FASTBOOT:
371 case Device::REBOOT_RECOVERY:
372 case Device::REBOOT_RESCUE:
373 case Device::SHUTDOWN:
Tao Bao50dd5322017-03-07 14:57:04 -0800374 return chosen_action;
375
376 case Device::WIPE_DATA:
xunchang316e9712019-04-12 16:22:15 -0700377 save_current_log = true;
Tao Bao50dd5322017-03-07 14:57:04 -0800378 if (ui->IsTextVisible()) {
379 if (ask_to_wipe_data(device)) {
xunchang316e9712019-04-12 16:22:15 -0700380 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800381 }
382 } else {
xunchang316e9712019-04-12 16:22:15 -0700383 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800384 return Device::NO_ACTION;
385 }
386 break;
387
xunchang316e9712019-04-12 16:22:15 -0700388 case Device::WIPE_CACHE: {
389 save_current_log = true;
390 std::function<bool()> confirm_func = [&device]() {
391 return yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!");
392 };
393 WipeCache(ui, ui->IsTextVisible() ? confirm_func : nullptr);
Tao Bao50dd5322017-03-07 14:57:04 -0800394 if (!ui->IsTextVisible()) return Device::NO_ACTION;
395 break;
xunchang316e9712019-04-12 16:22:15 -0700396 }
Tao Bao10f441a2019-04-19 15:22:15 -0700397
Tao Bao50dd5322017-03-07 14:57:04 -0800398 case Device::APPLY_ADB_SIDELOAD:
Tao Baoc6dc3252019-04-16 14:22:25 -0700399 case Device::APPLY_SDCARD:
400 case Device::ENTER_RESCUE: {
xunchang316e9712019-04-12 16:22:15 -0700401 save_current_log = true;
Tao Baoc6dc3252019-04-16 14:22:25 -0700402
403 bool adb = true;
Tao Bao10f441a2019-04-19 15:22:15 -0700404 Device::BuiltinAction reboot_action;
Tao Baoc6dc3252019-04-16 14:22:25 -0700405 if (chosen_action == Device::ENTER_RESCUE) {
406 // Switch to graphics screen.
407 ui->ShowText(false);
xunchangfedeef62019-04-22 12:18:14 -0700408 status = ApplyFromAdb(device, true /* rescue_mode */, &reboot_action);
Tao Baoc6dc3252019-04-16 14:22:25 -0700409 } else if (chosen_action == Device::APPLY_ADB_SIDELOAD) {
xunchangfedeef62019-04-22 12:18:14 -0700410 status = ApplyFromAdb(device, false /* rescue_mode */, &reboot_action);
xunchang3cc23d52019-03-18 15:03:33 -0700411 } else {
Tao Baoc6dc3252019-04-16 14:22:25 -0700412 adb = false;
Tianjie Xuf6158eb2019-06-11 16:09:07 -0700413 status = ApplyFromSdcard(device);
Tao Bao50dd5322017-03-07 14:57:04 -0800414 }
xunchang3cc23d52019-03-18 15:03:33 -0700415
Tao Bao10f441a2019-04-19 15:22:15 -0700416 ui->Print("\nInstall from %s completed with status %d.\n", adb ? "ADB" : "SD card", status);
417 if (status == INSTALL_REBOOT) {
418 return reboot_action;
419 }
420
xunchang3cc23d52019-03-18 15:03:33 -0700421 if (status != INSTALL_SUCCESS) {
422 ui->SetBackground(RecoveryUI::ERROR);
423 ui->Print("Installation aborted.\n");
xunchang316e9712019-04-12 16:22:15 -0700424 copy_logs(save_current_log, has_cache, sehandle);
xunchang3cc23d52019-03-18 15:03:33 -0700425 } else if (!ui->IsTextVisible()) {
426 return Device::NO_ACTION; // reboot if logs aren't visible
xunchang3cc23d52019-03-18 15:03:33 -0700427 }
Tao Bao50dd5322017-03-07 14:57:04 -0800428 break;
xunchang3cc23d52019-03-18 15:03:33 -0700429 }
Tao Bao50dd5322017-03-07 14:57:04 -0800430
431 case Device::VIEW_RECOVERY_LOGS:
432 choose_recovery_file(device);
433 break;
434
435 case Device::RUN_GRAPHICS_TEST:
436 run_graphics_test();
437 break;
438
Tianjie Xu29d55752017-09-20 17:53:46 -0700439 case Device::RUN_LOCALE_TEST: {
440 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
Tao Bao39c49182018-05-07 22:50:33 -0700441 screen_ui->CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700442 break;
443 }
Tao Bao50dd5322017-03-07 14:57:04 -0800444 case Device::MOUNT_SYSTEM:
Tao Baof90d9a12019-05-10 10:40:59 -0700445 if (ensure_path_mounted_at(android::fs_mgr::GetSystemRoot(), "/mnt/system") != -1) {
Yifan Hong49327802018-11-26 14:59:09 -0800446 ui->Print("Mounted /system.\n");
Tao Bao50dd5322017-03-07 14:57:04 -0800447 }
448 break;
Jerry Zhangb76af932018-05-22 12:08:35 -0700449
450 case Device::KEY_INTERRUPTED:
451 return Device::KEY_INTERRUPTED;
Tao Bao50dd5322017-03-07 14:57:04 -0800452 }
453 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800454}
455
Tao Bao99f0d9e2016-10-13 12:46:38 -0700456static void print_property(const char* key, const char* name, void* /* cookie */) {
457 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800458}
459
Tao Bao6d90a9d2018-04-26 10:40:36 -0700460static bool is_battery_ok(int* required_battery_level) {
Yifan Honge8e4c402017-11-08 14:56:03 -0800461 using android::hardware::health::V1_0::BatteryStatus;
Yifan Hong056538c2018-07-11 17:04:12 -0700462 using android::hardware::health::V2_0::get_health_service;
463 using android::hardware::health::V2_0::IHealth;
Yifan Honge8e4c402017-11-08 14:56:03 -0800464 using android::hardware::health::V2_0::Result;
465 using android::hardware::health::V2_0::toString;
Yabin Cui99281df2016-02-17 12:21:52 -0800466
Yifan Hong056538c2018-07-11 17:04:12 -0700467 android::sp<IHealth> health = get_health_service();
Yifan Honge8e4c402017-11-08 14:56:03 -0800468
Tao Bao6d90a9d2018-04-26 10:40:36 -0700469 static constexpr int BATTERY_READ_TIMEOUT_IN_SEC = 10;
Yifan Honge8e4c402017-11-08 14:56:03 -0800470 int wait_second = 0;
471 while (true) {
472 auto charge_status = BatteryStatus::UNKNOWN;
Yifan Hong056538c2018-07-11 17:04:12 -0700473
474 if (health == nullptr) {
475 LOG(WARNING) << "no health implementation is found, assuming defaults";
476 } else {
477 health
478 ->getChargeStatus([&charge_status](auto res, auto out_status) {
479 if (res == Result::SUCCESS) {
480 charge_status = out_status;
481 }
482 })
483 .isOk(); // should not have transport error
484 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800485
486 // Treat unknown status as charged.
487 bool charged = (charge_status != BatteryStatus::DISCHARGING &&
488 charge_status != BatteryStatus::NOT_CHARGING);
489
490 Result res = Result::UNKNOWN;
491 int32_t capacity = INT32_MIN;
Yifan Hong056538c2018-07-11 17:04:12 -0700492 if (health != nullptr) {
493 health
494 ->getCapacity([&res, &capacity](auto out_res, auto out_capacity) {
495 res = out_res;
496 capacity = out_capacity;
497 })
498 .isOk(); // should not have transport error
499 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800500
Yifan Hong056538c2018-07-11 17:04:12 -0700501 LOG(INFO) << "charge_status " << toString(charge_status) << ", charged " << charged
502 << ", status " << toString(res) << ", capacity " << capacity;
Yifan Honge8e4c402017-11-08 14:56:03 -0800503 // At startup, the battery drivers in devices like N5X/N6P take some time to load
504 // the battery profile. Before the load finishes, it reports value 50 as a fake
505 // capacity. BATTERY_READ_TIMEOUT_IN_SEC is set that the battery drivers are expected
506 // to finish loading the battery profile earlier than 10 seconds after kernel startup.
507 if (res == Result::SUCCESS && capacity == 50) {
508 if (wait_second < BATTERY_READ_TIMEOUT_IN_SEC) {
509 sleep(1);
510 wait_second++;
511 continue;
512 }
513 }
514 // If we can't read battery percentage, it may be a device without battery. In this
515 // situation, use 100 as a fake battery percentage.
516 if (res != Result::SUCCESS) {
517 capacity = 100;
518 }
Tao Bao6d90a9d2018-04-26 10:40:36 -0700519
520 // GmsCore enters recovery mode to install package when having enough battery percentage.
521 // Normally, the threshold is 40% without charger and 20% with charger. So we should check
522 // battery with a slightly lower limitation.
523 static constexpr int BATTERY_OK_PERCENTAGE = 20;
524 static constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
525 *required_battery_level = charged ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE;
526 return capacity >= *required_battery_level;
527 }
Yabin Cui99281df2016-02-17 12:21:52 -0800528}
529
Tianjie Xu99b73be2017-11-28 17:23:06 -0800530// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -0700531static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
532 std::vector<std::string> options;
533 for (const auto& arg : args) {
534 if (!android::base::StartsWith(arg, "--retry_count")) {
535 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -0800536 }
Tianjie Xu72449c92017-05-16 18:07:31 -0700537 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800538
Tianjie Xu99b73be2017-11-28 17:23:06 -0800539 // Update the retry counter in BCB.
540 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -0700541 std::string err;
542 if (!update_bootloader_message(options, &err)) {
543 LOG(ERROR) << err;
544 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800545}
546
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700547static bool bootreason_in_blacklist() {
Tao Baoefc35592017-01-08 22:45:47 -0800548 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
549 if (!bootreason.empty()) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700550 // More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
551 static const std::vector<std::string> kBootreasonBlacklist{
552 "kernel_panic",
553 "Panic",
554 };
555 for (const auto& str : kBootreasonBlacklist) {
556 if (android::base::EqualsIgnoreCase(str, bootreason)) return true;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700557 }
Tao Baoefc35592017-01-08 22:45:47 -0800558 }
559 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700560}
561
Tao Bao641fa972018-04-25 18:59:40 -0700562static void log_failure_code(ErrorCode code, const std::string& update_package) {
563 std::vector<std::string> log_buffer = {
564 update_package,
565 "0", // install result
566 "error: " + std::to_string(code),
567 };
568 std::string log_content = android::base::Join(log_buffer, "\n");
569 const std::string& install_file = Paths::Get().temporary_install_file();
570 if (!android::base::WriteStringToFile(log_content, install_file)) {
571 PLOG(ERROR) << "Failed to write " << install_file;
572 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700573
Tao Bao641fa972018-04-25 18:59:40 -0700574 // Also write the info into last_log.
575 LOG(INFO) << log_content;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700576}
577
Jerry Zhang6a648042018-05-04 11:24:10 -0700578Device::BuiltinAction start_recovery(Device* device, const std::vector<std::string>& args) {
Tao Baof9f17342018-04-27 10:44:04 -0700579 static constexpr struct option OPTIONS[] = {
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700580 { "fastboot", no_argument, nullptr, 0 },
David Andersonedee8362018-05-16 13:43:22 -0700581 { "fsck_unshare_blocks", no_argument, nullptr, 0 },
Tianjie Xue5218612019-06-25 13:59:39 -0700582 { "install_with_fuse", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700583 { "just_exit", no_argument, nullptr, 'x' },
584 { "locale", required_argument, nullptr, 0 },
585 { "prompt_and_wipe_data", no_argument, nullptr, 0 },
586 { "reason", required_argument, nullptr, 0 },
Tao Baod9cb0142019-04-23 11:46:25 -0700587 { "rescue", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700588 { "retry_count", required_argument, nullptr, 0 },
589 { "security", no_argument, nullptr, 0 },
590 { "show_text", no_argument, nullptr, 't' },
591 { "shutdown_after", no_argument, nullptr, 0 },
592 { "sideload", no_argument, nullptr, 0 },
593 { "sideload_auto_reboot", no_argument, nullptr, 0 },
594 { "update_package", required_argument, nullptr, 0 },
595 { "wipe_ab", no_argument, nullptr, 0 },
596 { "wipe_cache", no_argument, nullptr, 0 },
597 { "wipe_data", no_argument, nullptr, 0 },
598 { "wipe_package_size", required_argument, nullptr, 0 },
599 { nullptr, 0, nullptr, 0 },
600 };
601
Tianjie Xu99b73be2017-11-28 17:23:06 -0800602 const char* update_package = nullptr;
Tianjie Xue5218612019-06-25 13:59:39 -0700603 bool install_with_fuse = false; // memory map the update package by default.
Tianjie Xu99b73be2017-11-28 17:23:06 -0800604 bool should_wipe_data = false;
605 bool should_prompt_and_wipe_data = false;
606 bool should_wipe_cache = false;
607 bool should_wipe_ab = false;
608 size_t wipe_package_size = 0;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800609 bool sideload = false;
610 bool sideload_auto_reboot = false;
Tao Baod9cb0142019-04-23 11:46:25 -0700611 bool rescue = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800612 bool just_exit = false;
613 bool shutdown_after = false;
David Andersonedee8362018-05-16 13:43:22 -0700614 bool fsck_unshare_blocks = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800615 int retry_count = 0;
616 bool security_update = false;
Jerry Zhang2dea53e2018-05-02 17:15:03 -0700617 std::string locale;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800618
Tao Bao1700cc42018-07-16 22:09:59 -0700619 auto args_to_parse = StringVectorToNullTerminatedArray(args);
620
Tianjie Xu99b73be2017-11-28 17:23:06 -0800621 int arg;
622 int option_index;
Tao Bao1700cc42018-07-16 22:09:59 -0700623 // Parse everything before the last element (which must be a nullptr). getopt_long(3) expects a
624 // null-terminated char* array, but without counting null as an arg (i.e. argv[argc] should be
625 // nullptr).
626 while ((arg = getopt_long(args_to_parse.size() - 1, args_to_parse.data(), "", OPTIONS,
Tianjie Xu99b73be2017-11-28 17:23:06 -0800627 &option_index)) != -1) {
628 switch (arg) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800629 case 't':
Jerry Zhang6a648042018-05-04 11:24:10 -0700630 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800631 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800632 case 'x':
633 just_exit = true;
634 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800635 case 0: {
636 std::string option = OPTIONS[option_index].name;
David Andersonedee8362018-05-16 13:43:22 -0700637 if (option == "fsck_unshare_blocks") {
638 fsck_unshare_blocks = true;
Tianjie Xue5218612019-06-25 13:59:39 -0700639 } else if (option == "install_with_fuse") {
640 install_with_fuse = true;
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700641 } else if (option == "locale" || option == "fastboot") {
Jerry Zhang6a648042018-05-04 11:24:10 -0700642 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800643 } else if (option == "prompt_and_wipe_data") {
644 should_prompt_and_wipe_data = true;
Tao Baof9f17342018-04-27 10:44:04 -0700645 } else if (option == "reason") {
646 reason = optarg;
Tao Baod9cb0142019-04-23 11:46:25 -0700647 } else if (option == "rescue") {
648 rescue = true;
Tao Baof9f17342018-04-27 10:44:04 -0700649 } else if (option == "retry_count") {
650 android::base::ParseInt(optarg, &retry_count, 0);
651 } else if (option == "security") {
652 security_update = true;
653 } else if (option == "sideload") {
654 sideload = true;
655 } else if (option == "sideload_auto_reboot") {
656 sideload = true;
657 sideload_auto_reboot = true;
658 } else if (option == "shutdown_after") {
659 shutdown_after = true;
660 } else if (option == "update_package") {
661 update_package = optarg;
662 } else if (option == "wipe_ab") {
663 should_wipe_ab = true;
664 } else if (option == "wipe_cache") {
665 should_wipe_cache = true;
666 } else if (option == "wipe_data") {
667 should_wipe_data = true;
668 } else if (option == "wipe_package_size") {
669 android::base::ParseUint(optarg, &wipe_package_size);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800670 }
671 break;
672 }
673 case '?':
674 LOG(ERROR) << "Invalid command argument";
675 continue;
Doug Zongker9270a202012-01-09 15:16:13 -0800676 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800677 }
Jerry Zhang49fd5d22018-05-17 12:54:41 -0700678 optind = 1;
Doug Zongker9270a202012-01-09 15:16:13 -0800679
Tianjie Xu99b73be2017-11-28 17:23:06 -0800680 printf("stage is [%s]\n", stage.c_str());
681 printf("reason is [%s]\n", reason);
Doug Zongker02ec6b82012-08-22 17:26:40 -0700682
Tianjie Xu99b73be2017-11-28 17:23:06 -0800683 // Set background string to "installing security update" for security update,
684 // otherwise set it to "installing system update".
685 ui->SetSystemUpdateText(security_update);
686
687 int st_cur, st_max;
688 if (!stage.empty() && sscanf(stage.c_str(), "%d/%d", &st_cur, &st_max) == 2) {
689 ui->SetStage(st_cur, st_max);
690 }
691
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700692 std::vector<std::string> title_lines =
693 android::base::Split(android::base::GetProperty("ro.bootimage.build.fingerprint", ""), ":");
694 title_lines.insert(std::begin(title_lines), "Android Recovery");
695 ui->SetTitle(title_lines);
696
Jerry Zhangb76af932018-05-22 12:08:35 -0700697 ui->ResetKeyInterruptStatus();
Tianjie Xu99b73be2017-11-28 17:23:06 -0800698 device->StartRecovery();
699
700 printf("Command:");
701 for (const auto& arg : args) {
702 printf(" \"%s\"", arg.c_str());
703 }
704 printf("\n\n");
705
706 property_list(print_property, nullptr);
707 printf("\n");
708
709 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
710
Tao Baoadc99ef2019-04-29 23:48:02 -0700711 InstallResult status = INSTALL_SUCCESS;
Tao Bao10f441a2019-04-19 15:22:15 -0700712 // next_action indicates the next target to reboot into upon finishing the install. It could be
713 // overridden to a different reboot target per user request.
714 Device::BuiltinAction next_action = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800715
716 if (update_package != nullptr) {
717 // It's not entirely true that we will modify the flash. But we want
718 // to log the update attempt since update_package is non-NULL.
xunchang316e9712019-04-12 16:22:15 -0700719 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800720
Tao Bao6d90a9d2018-04-26 10:40:36 -0700721 int required_battery_level;
722 if (retry_count == 0 && !is_battery_ok(&required_battery_level)) {
723 ui->Print("battery capacity is not enough for installing package: %d%% needed\n",
724 required_battery_level);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800725 // Log the error code to last_install when installation skips due to
726 // low battery.
727 log_failure_code(kLowBattery, update_package);
728 status = INSTALL_SKIPPED;
Tianjie Xua6f49bd2018-03-26 14:32:11 -0700729 } else if (retry_count == 0 && bootreason_in_blacklist()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800730 // Skip update-on-reboot when bootreason is kernel_panic or similar
731 ui->Print("bootreason is in the blacklist; skip OTA installation\n");
732 log_failure_code(kBootreasonInBlacklist, update_package);
733 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -0700734 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800735 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
736 // identify the interrupted update due to unexpected reboots.
737 if (retry_count == 0) {
738 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -0700739 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800740
Tianjie Xu980f92e2019-06-11 15:43:43 -0700741 if (update_package[0] == '@') {
742 ensure_path_mounted(update_package + 1);
743 } else {
744 ensure_path_mounted(update_package);
745 }
Tianjie Xue5218612019-06-25 13:59:39 -0700746
747 if (install_with_fuse) {
748 LOG(INFO) << "Installing package " << update_package << " with fuse";
749 status = InstallWithFuseFromPath(update_package, ui);
750 } else if (auto memory_package = Package::CreateMemoryPackage(
751 update_package,
752 std::bind(&RecoveryUI::SetProgress, ui, std::placeholders::_1));
753 memory_package != nullptr) {
754 status = InstallPackage(memory_package.get(), update_package, should_wipe_cache,
755 retry_count, ui);
756 } else {
757 // We may fail to memory map the package on 32 bit builds for packages with 2GiB+ size.
758 // In such cases, we will try to install the package with fuse. This is not the default
759 // installation method because it introduces a layer of indirection from the kernel space.
760 LOG(WARNING) << "Failed to memory map package " << update_package
761 << "; falling back to install with fuse";
762 status = InstallWithFuseFromPath(update_package, ui);
763 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800764 if (status != INSTALL_SUCCESS) {
765 ui->Print("Installation aborted.\n");
Tao Baoaac9d9f2018-04-29 23:38:59 -0700766
767 // When I/O error or bspatch/imgpatch error happens, reboot and retry installation
768 // RETRY_LIMIT times before we abandon this OTA update.
769 static constexpr int RETRY_LIMIT = 4;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800770 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
xunchang316e9712019-04-12 16:22:15 -0700771 copy_logs(save_current_log, has_cache, sehandle);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800772 retry_count += 1;
773 set_retry_bootloader_message(retry_count, args);
774 // Print retry count on screen.
775 ui->Print("Retry attempt %d\n", retry_count);
776
Tao Bao782dcc12019-04-29 11:23:16 -0700777 // Reboot back into recovery to retry the update.
778 if (!Reboot("recovery")) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800779 ui->Print("Reboot failed\n");
780 } else {
781 while (true) {
782 pause();
783 }
784 }
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.
789 if (is_ro_debuggable()) {
790 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;
796 bool convert_fbe = reason && strcmp(reason, "convert_fbe") == 0;
797 if (!WipeData(device, convert_fbe)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800798 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -0700799 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800800 } else if (should_prompt_and_wipe_data) {
Tao Baoa5bbcb92018-09-17 14:32:47 -0700801 // Trigger the logging to capture the cause, even if user chooses to not wipe data.
xunchang316e9712019-04-12 16:22:15 -0700802 save_current_log = true;
Tao Baoa5bbcb92018-09-17 14:32:47 -0700803
Tianjie Xu99b73be2017-11-28 17:23:06 -0800804 ui->ShowText(true);
805 ui->SetBackground(RecoveryUI::ERROR);
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700806 status = prompt_and_wipe_data(device);
807 if (status != INSTALL_KEY_INTERRUPTED) {
808 ui->ShowText(false);
Tao Bao75238632015-05-27 14:46:17 -0700809 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800810 } else if (should_wipe_cache) {
xunchang316e9712019-04-12 16:22:15 -0700811 save_current_log = true;
812 if (!WipeCache(ui, nullptr)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800813 status = INSTALL_ERROR;
814 }
815 } else if (should_wipe_ab) {
Tao Bao7f19d102019-04-26 22:56:56 -0700816 if (!WipeAbDevice(device, wipe_package_size)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800817 status = INSTALL_ERROR;
818 }
819 } else if (sideload) {
Tao Bao10f441a2019-04-19 15:22:15 -0700820 // 'adb reboot sideload' acts the same as user presses key combinations to enter the sideload
821 // mode. When 'sideload-auto-reboot' is used, text display will NOT be turned on by default. And
822 // it will reboot after sideload finishes even if there are errors. This is to enable automated
Tianjie Xu99b73be2017-11-28 17:23:06 -0800823 // testing.
xunchang316e9712019-04-12 16:22:15 -0700824 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800825 if (!sideload_auto_reboot) {
826 ui->ShowText(true);
827 }
xunchangfedeef62019-04-22 12:18:14 -0700828 status = ApplyFromAdb(device, false /* rescue_mode */, &next_action);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800829 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
830 if (sideload_auto_reboot) {
Tao Bao10f441a2019-04-19 15:22:15 -0700831 status = INSTALL_REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800832 ui->Print("Rebooting automatically.\n");
833 }
Tao Baod9cb0142019-04-23 11:46:25 -0700834 } else if (rescue) {
835 save_current_log = true;
xunchangfedeef62019-04-22 12:18:14 -0700836 status = ApplyFromAdb(device, true /* rescue_mode */, &next_action);
Tao Baod9cb0142019-04-23 11:46:25 -0700837 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
David Andersonedee8362018-05-16 13:43:22 -0700838 } else if (fsck_unshare_blocks) {
839 if (!do_fsck_unshare_blocks()) {
840 status = INSTALL_ERROR;
841 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800842 } else if (!just_exit) {
843 // If this is an eng or userdebug build, automatically turn on the text display if no command
844 // is specified. Note that this should be called before setting the background to avoid
845 // flickering the background image.
846 if (is_ro_debuggable()) {
847 ui->ShowText(true);
848 }
849 status = INSTALL_NONE; // No command specified
850 ui->SetBackground(RecoveryUI::NO_COMMAND);
851 }
852
853 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
854 ui->SetBackground(RecoveryUI::ERROR);
855 if (!ui->IsTextVisible()) {
856 sleep(5);
857 }
858 }
859
Tao Bao10f441a2019-04-19 15:22:15 -0700860 // Determine the next action.
861 // - If the state is INSTALL_REBOOT, device will reboot into the target as specified in
862 // `next_action`.
863 // - If the recovery menu is visible, prompt and wait for commands.
864 // - If the state is INSTALL_NONE, wait for commands (e.g. in user build, one manually boots
865 // into recovery to sideload a package or to wipe the device).
866 // - In all other cases, reboot the device. Therefore, normal users will observe the device
867 // rebooting a) immediately upon successful finish (INSTALL_SUCCESS); or b) an "error" screen
868 // for 5s followed by an automatic reboot.
869 if (status != INSTALL_REBOOT) {
870 if (status == INSTALL_NONE || ui->IsTextVisible()) {
Tao Baoadc99ef2019-04-29 23:48:02 -0700871 auto temp = PromptAndWait(device, status);
Tao Bao10f441a2019-04-19 15:22:15 -0700872 if (temp != Device::NO_ACTION) {
873 next_action = temp;
874 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800875 }
876 }
877
878 // Save logs and clean up before rebooting or shutting down.
Tao Bao551d2c32018-05-09 20:53:13 -0700879 finish_recovery();
Tianjie Xu99b73be2017-11-28 17:23:06 -0800880
Tao Bao10f441a2019-04-19 15:22:15 -0700881 return next_action;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800882}