blob: 5fc673ec272fb181f59deed362817051d3d69966 [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>
21#include <fcntl.h>
22#include <getopt.h>
Tao Bao862a4c12016-06-02 11:16:50 -070023#include <inttypes.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080024#include <limits.h>
Tao Bao862a4c12016-06-02 11:16:50 -070025#include <linux/fs.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080026#include <linux/input.h>
27#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080030#include <sys/types.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080031#include <unistd.h>
32
Tao Baoc4a18ef2017-02-10 00:13:30 -080033#include <algorithm>
Tao Bao3aec6962018-04-20 09:24:58 -070034#include <functional>
Tao Baoc4a18ef2017-02-10 00:13:30 -080035#include <memory>
Tao Bao862a4c12016-06-02 11:16:50 -070036#include <string>
37#include <vector>
Tao Bao04ca4262015-09-10 15:32:24 -070038
Elliott Hughes4b166f02015-12-04 15:30:20 -080039#include <android-base/file.h>
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -070040#include <android-base/logging.h>
Tianjie Xu3c62b672016-02-05 18:25:58 -080041#include <android-base/parseint.h>
Elliott Hughescb220402016-09-23 15:30:55 -070042#include <android-base/properties.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -080043#include <android-base/stringprintf.h>
Tao Bao862a4c12016-06-02 11:16:50 -070044#include <android-base/strings.h>
45#include <android-base/unique_fd.h>
Yabin Cui8b309f62016-06-24 18:22:02 -070046#include <bootloader_message/bootloader_message.h>
Elliott Hughescb220402016-09-23 15:30:55 -070047#include <cutils/properties.h> /* for property_list */
Yifan Hong056538c2018-07-11 17:04:12 -070048#include <healthhalutils/HealthHalUtils.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070049#include <ziparchive/zip_archive.h>
Yabin Cui99281df2016-02-17 12:21:52 -080050
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080051#include "common.h"
David Andersonedee8362018-05-16 13:43:22 -070052#include "fsck_unshare_blocks.h"
xunchang24788852019-03-22 16:08:52 -070053#include "install/adb_install.h"
54#include "install/fuse_sdcard_install.h"
55#include "install/install.h"
56#include "install/package.h"
xunchang316e9712019-04-12 16:22:15 -070057#include "install/wipe_data.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070058#include "otautil/error_code.h"
xunchang316e9712019-04-12 16:22:15 -070059#include "otautil/logging.h"
Tao Bao641fa972018-04-25 18:59:40 -070060#include "otautil/paths.h"
xunchang24788852019-03-22 16:08:52 -070061#include "otautil/roots.h"
Tao Bao2c526392018-05-03 23:01:13 -070062#include "otautil/sysutil.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070063#include "recovery_ui/screen_ui.h"
64#include "recovery_ui/ui.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080065
Tao Baoaac9d9f2018-04-29 23:38:59 -070066static constexpr const char* COMMAND_FILE = "/cache/recovery/command";
Tao Baoaac9d9f2018-04-29 23:38:59 -070067static constexpr const char* LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
68static constexpr const char* LAST_LOG_FILE = "/cache/recovery/last_log";
69static constexpr const char* LOCALE_FILE = "/cache/recovery/last_locale";
Tianjie Xu06e57ac2016-07-11 14:04:08 -070070
Tao Baoaac9d9f2018-04-29 23:38:59 -070071static constexpr const char* CACHE_ROOT = "/cache";
Nick Kralevicha9ad0322014-10-22 18:38:48 -070072
Tao Baobd0ddcd2017-05-04 13:03:18 -070073// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
74// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
75static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
76
xunchang316e9712019-04-12 16:22:15 -070077static bool save_current_log = false;
Tao Baoa8d72bc2016-12-25 18:46:50 -080078std::string stage;
Tao Baoac9d94d2016-11-03 11:37:15 -070079const char* reason = nullptr;
Tao Baoac9d94d2016-11-03 11:37:15 -070080
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080081/*
82 * The recovery tool communicates with the main system through /cache files.
83 * /cache/recovery/command - INPUT - command line for tool, one arg per line
84 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080085 *
86 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -070087 * --update_package=path - verify install an OTA package file
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080088 * --wipe_data - erase user data (and cache), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070089 * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user
90 * data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080091 * --wipe_cache - wipe cache (but not user data), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070092 * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519).
Oscar Montemayor05231562009-11-30 08:40:57 -080093 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -070094 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080095 *
96 * After completing, we remove /cache/recovery/command and reboot.
97 * Arguments may also be supplied in the bootloader control block (BCB).
98 * These important scenarios must be safely restartable at any point:
99 *
100 * FACTORY RESET
101 * 1. user selects "factory reset"
102 * 2. main system writes "--wipe_data" to /cache/recovery/command
103 * 3. main system reboots into recovery
104 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
105 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700106 * 5. erase_volume() reformats /data
107 * 6. erase_volume() reformats /cache
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800108 * 7. finish_recovery() erases BCB
109 * -- after this, rebooting will restart the main system --
110 * 8. main() calls reboot() to boot main system
111 *
112 * OTA INSTALL
113 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700114 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800115 * 3. main system reboots into recovery
116 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
117 * -- after this, rebooting will attempt to reinstall the update --
118 * 5. install_package() attempts to install the update
119 * NOTE: the package install must itself be restartable from any point
120 * 6. finish_recovery() erases BCB
121 * -- after this, rebooting will (try to) restart the main system --
122 * 7. ** if install failed **
123 * 7a. prompt_and_wait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800124 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800125 */
126
Elliott Hughesf14af802015-02-10 14:46:14 -0800127bool is_ro_debuggable() {
Elliott Hughescb220402016-09-23 15:30:55 -0700128 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800129}
130
Tao Baoec579032017-07-21 12:13:15 -0700131// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700132// copy our log file to cache as well (for the system to read). This function is
133// idempotent: call it as many times as you like.
Tao Bao551d2c32018-05-09 20:53:13 -0700134static void finish_recovery() {
135 std::string locale = ui->GetLocale();
Tao Baoec579032017-07-21 12:13:15 -0700136 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
137 // (e.g., directly from the bootloader) it will use the last-known locale.
138 if (!locale.empty() && has_cache) {
139 LOG(INFO) << "Saving locale \"" << locale << "\"";
140 if (ensure_path_mounted(LOCALE_FILE) != 0) {
141 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
142 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
143 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700144 }
Tao Baoec579032017-07-21 12:13:15 -0700145 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700146
xunchang316e9712019-04-12 16:22:15 -0700147 copy_logs(save_current_log, has_cache, sehandle);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800148
Tao Baoec579032017-07-21 12:13:15 -0700149 // Reset to normal system boot so recovery won't cycle indefinitely.
150 std::string err;
151 if (!clear_bootloader_message(&err)) {
152 LOG(ERROR) << "Failed to clear BCB message: " << err;
153 }
154
155 // Remove the command file, so recovery won't repeat indefinitely.
156 if (has_cache) {
157 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
158 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700159 }
Tao Baoec579032017-07-21 12:13:15 -0700160 ensure_path_unmounted(CACHE_ROOT);
161 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800162
Tao Baoec579032017-07-21 12:13:15 -0700163 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800164}
165
Elliott Hughes30694c92015-03-25 15:16:51 -0700166static bool yes_no(Device* device, const char* question1, const char* question2) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700167 std::vector<std::string> headers{ question1, question2 };
168 std::vector<std::string> items{ " No", " Yes" };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700169
Tao Bao1fe1afe2018-05-01 15:56:05 -0700170 size_t chosen_item = ui->ShowMenu(
Tao Bao3aec6962018-04-20 09:24:58 -0700171 headers, items, 0, true,
172 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
173 return (chosen_item == 1);
Elliott Hughes30694c92015-03-25 15:16:51 -0700174}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800175
Paul Crowley08404b42016-12-19 13:04:23 -0800176static bool ask_to_wipe_data(Device* device) {
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700177 std::vector<std::string> headers{ "Wipe all user data?", " THIS CAN NOT BE UNDONE!" };
178 std::vector<std::string> items{ " Cancel", " Factory data reset" };
179
180 size_t chosen_item = ui->ShowPromptWipeDataConfirmationMenu(
181 headers, items,
182 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
183
184 return (chosen_item == 1);
Paul Crowley08404b42016-12-19 13:04:23 -0800185}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700186
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700187static InstallResult prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700188 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tianjie Xub99e6062018-10-16 15:13:09 -0700189 std::vector<std::string> wipe_data_menu_headers{
Tao Bao2bbc6d62017-08-13 23:48:55 -0700190 "Can't load Android system. Your data may be corrupt. "
191 "If you continue to get this message, you may need to "
192 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700193 "stored on this device.",
Tao Baofc5499f2017-02-23 19:06:53 -0800194 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700195 // clang-format off
Tianjie Xub99e6062018-10-16 15:13:09 -0700196 std::vector<std::string> wipe_data_menu_items {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700197 "Try again",
198 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800199 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700200 // clang-format on
Tao Baofc5499f2017-02-23 19:06:53 -0800201 for (;;) {
Tianjie Xub99e6062018-10-16 15:13:09 -0700202 size_t chosen_item = ui->ShowPromptWipeDataMenu(
203 wipe_data_menu_headers, wipe_data_menu_items,
Tao Bao3aec6962018-04-20 09:24:58 -0700204 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700205 // If ShowMenu() returned RecoveryUI::KeyError::INTERRUPTED, WaitKey() was interrupted.
206 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700207 return INSTALL_KEY_INTERRUPTED;
Jerry Zhangb76af932018-05-22 12:08:35 -0700208 }
Tao Baofc5499f2017-02-23 19:06:53 -0800209 if (chosen_item != 1) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700210 return INSTALL_SUCCESS; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800211 }
Tianjie Xub99e6062018-10-16 15:13:09 -0700212
Tao Baofc5499f2017-02-23 19:06:53 -0800213 if (ask_to_wipe_data(device)) {
xunchang316e9712019-04-12 16:22:15 -0700214 bool convert_fbe = reason && strcmp(reason, "convert_fbe") == 0;
215 if (WipeData(device, convert_fbe)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700216 return INSTALL_SUCCESS;
217 } else {
218 return INSTALL_ERROR;
219 }
Tao Baofc5499f2017-02-23 19:06:53 -0800220 }
221 }
Paul Crowley08404b42016-12-19 13:04:23 -0800222}
223
Tao Bao1b2a98b2017-03-24 10:45:34 -0700224// Secure-wipe a given partition. It uses BLKSECDISCARD, if supported. Otherwise, it goes with
225// BLKDISCARD (if device supports BLKDISCARDZEROES) or BLKZEROOUT.
Tao Bao862a4c12016-06-02 11:16:50 -0700226static bool secure_wipe_partition(const std::string& partition) {
Tao Bao1b2a98b2017-03-24 10:45:34 -0700227 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(partition.c_str(), O_WRONLY)));
228 if (fd == -1) {
229 PLOG(ERROR) << "Failed to open \"" << partition << "\"";
230 return false;
231 }
232
233 uint64_t range[2] = { 0, 0 };
234 if (ioctl(fd, BLKGETSIZE64, &range[1]) == -1 || range[1] == 0) {
235 PLOG(ERROR) << "Failed to get partition size";
236 return false;
237 }
238 LOG(INFO) << "Secure-wiping \"" << partition << "\" from " << range[0] << " to " << range[1];
239
240 LOG(INFO) << " Trying BLKSECDISCARD...";
241 if (ioctl(fd, BLKSECDISCARD, &range) == -1) {
242 PLOG(WARNING) << " Failed";
243
244 // Use BLKDISCARD if it zeroes out blocks, otherwise use BLKZEROOUT.
245 unsigned int zeroes;
246 if (ioctl(fd, BLKDISCARDZEROES, &zeroes) == 0 && zeroes != 0) {
247 LOG(INFO) << " Trying BLKDISCARD...";
248 if (ioctl(fd, BLKDISCARD, &range) == -1) {
249 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700250 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700251 }
252 } else {
253 LOG(INFO) << " Trying BLKZEROOUT...";
254 if (ioctl(fd, BLKZEROOUT, &range) == -1) {
255 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700256 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700257 }
Tao Bao862a4c12016-06-02 11:16:50 -0700258 }
Tao Bao1b2a98b2017-03-24 10:45:34 -0700259 }
Tao Bao862a4c12016-06-02 11:16:50 -0700260
Tao Bao1b2a98b2017-03-24 10:45:34 -0700261 LOG(INFO) << " Done";
262 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700263}
264
xunchang55e3d222019-03-11 11:28:41 -0700265static std::unique_ptr<Package> ReadWipePackage(size_t wipe_package_size) {
xunchange0d991c2019-03-05 14:50:51 -0800266 if (wipe_package_size == 0) {
267 LOG(ERROR) << "wipe_package_size is zero";
xunchang55e3d222019-03-11 11:28:41 -0700268 return nullptr;
xunchange0d991c2019-03-05 14:50:51 -0800269 }
270
271 std::string wipe_package;
272 std::string err_str;
273 if (!read_wipe_package(&wipe_package, wipe_package_size, &err_str)) {
274 PLOG(ERROR) << "Failed to read wipe package" << err_str;
xunchang55e3d222019-03-11 11:28:41 -0700275 return nullptr;
xunchange0d991c2019-03-05 14:50:51 -0800276 }
xunchang55e3d222019-03-11 11:28:41 -0700277
278 return Package::CreateMemoryPackage(
279 std::vector<uint8_t>(wipe_package.begin(), wipe_package.end()), nullptr);
xunchange0d991c2019-03-05 14:50:51 -0800280}
281
282// Checks if the wipe package matches expectation. If the check passes, reads the list of
283// partitions to wipe from the package. Checks include
Yabin Cuifd99a312016-06-09 14:09:39 -0700284// 1. verify the package.
285// 2. check metadata (ota-type, pre-device and serial number if having one).
xunchang55e3d222019-03-11 11:28:41 -0700286static bool CheckWipePackage(Package* wipe_package) {
xunchang24788852019-03-22 16:08:52 -0700287 if (!verify_package(wipe_package, ui)) {
xunchange0d991c2019-03-05 14:50:51 -0800288 LOG(ERROR) << "Failed to verify package";
289 return false;
290 }
Yabin Cuifd99a312016-06-09 14:09:39 -0700291
xunchang55e3d222019-03-11 11:28:41 -0700292 ZipArchiveHandle zip = wipe_package->GetZipArchiveHandle();
293 if (!zip) {
294 LOG(ERROR) << "Failed to get ZipArchiveHandle";
xunchange0d991c2019-03-05 14:50:51 -0800295 return false;
296 }
297
298 std::map<std::string, std::string> metadata;
299 if (!ReadMetadataFromPackage(zip, &metadata)) {
300 LOG(ERROR) << "Failed to parse metadata in the zip file";
301 return false;
302 }
303
xunchang55e3d222019-03-11 11:28:41 -0700304 return CheckPackageMetadata(metadata, OtaType::BRICK) == 0;
xunchange0d991c2019-03-05 14:50:51 -0800305}
306
xunchang55e3d222019-03-11 11:28:41 -0700307std::vector<std::string> GetWipePartitionList(Package* wipe_package) {
308 ZipArchiveHandle zip = wipe_package->GetZipArchiveHandle();
309 if (!zip) {
310 LOG(ERROR) << "Failed to get ZipArchiveHandle";
xunchange0d991c2019-03-05 14:50:51 -0800311 return {};
312 }
313
314 static constexpr const char* RECOVERY_WIPE_ENTRY_NAME = "recovery.wipe";
315
316 std::string partition_list_content;
317 ZipString path(RECOVERY_WIPE_ENTRY_NAME);
318 ZipEntry entry;
319 if (FindEntry(zip, path, &entry) == 0) {
320 uint32_t length = entry.uncompressed_length;
321 partition_list_content = std::string(length, '\0');
322 if (auto err = ExtractToMemory(
323 zip, &entry, reinterpret_cast<uint8_t*>(partition_list_content.data()), length);
324 err != 0) {
325 LOG(ERROR) << "Failed to extract " << RECOVERY_WIPE_ENTRY_NAME << ": "
326 << ErrorCodeString(err);
xunchange0d991c2019-03-05 14:50:51 -0800327 return {};
Yabin Cuifd99a312016-06-09 14:09:39 -0700328 }
xunchange0d991c2019-03-05 14:50:51 -0800329 } else {
330 LOG(INFO) << "Failed to find " << RECOVERY_WIPE_ENTRY_NAME
331 << ", falling back to use the partition list on device.";
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700332
xunchange0d991c2019-03-05 14:50:51 -0800333 static constexpr const char* RECOVERY_WIPE_ON_DEVICE = "/etc/recovery.wipe";
334 if (!android::base::ReadFileToString(RECOVERY_WIPE_ON_DEVICE, &partition_list_content)) {
335 PLOG(ERROR) << "failed to read \"" << RECOVERY_WIPE_ON_DEVICE << "\"";
xunchange0d991c2019-03-05 14:50:51 -0800336 return {};
Yabin Cuifd99a312016-06-09 14:09:39 -0700337 }
xunchange0d991c2019-03-05 14:50:51 -0800338 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700339
xunchange0d991c2019-03-05 14:50:51 -0800340 std::vector<std::string> result;
341 std::vector<std::string> lines = android::base::Split(partition_list_content, "\n");
342 for (const std::string& line : lines) {
343 std::string partition = android::base::Trim(line);
344 // Ignore '#' comment or empty lines.
345 if (android::base::StartsWith(partition, "#") || partition.empty()) {
346 continue;
347 }
348 result.push_back(line);
349 }
Yabin Cuifd99a312016-06-09 14:09:39 -0700350
xunchange0d991c2019-03-05 14:50:51 -0800351 return result;
Yabin Cuifd99a312016-06-09 14:09:39 -0700352}
353
Tao Baoaac9d9f2018-04-29 23:38:59 -0700354// Wipes the current A/B device, with a secure wipe of all the partitions in RECOVERY_WIPE.
Yabin Cuifd99a312016-06-09 14:09:39 -0700355static bool wipe_ab_device(size_t wipe_package_size) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700356 ui->SetBackground(RecoveryUI::ERASING);
357 ui->SetProgressType(RecoveryUI::INDETERMINATE);
Tao Bao862a4c12016-06-02 11:16:50 -0700358
xunchang55e3d222019-03-11 11:28:41 -0700359 auto wipe_package = ReadWipePackage(wipe_package_size);
360 if (!wipe_package) {
361 LOG(ERROR) << "Failed to open wipe package";
xunchange0d991c2019-03-05 14:50:51 -0800362 return false;
363 }
364
xunchang55e3d222019-03-11 11:28:41 -0700365 if (!CheckWipePackage(wipe_package.get())) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700366 LOG(ERROR) << "Failed to verify wipe package";
367 return false;
368 }
xunchange0d991c2019-03-05 14:50:51 -0800369
xunchang55e3d222019-03-11 11:28:41 -0700370 auto partition_list = GetWipePartitionList(wipe_package.get());
xunchange0d991c2019-03-05 14:50:51 -0800371 if (partition_list.empty()) {
372 LOG(ERROR) << "Empty wipe ab partition list";
Tao Baoaac9d9f2018-04-29 23:38:59 -0700373 return false;
374 }
375
xunchange0d991c2019-03-05 14:50:51 -0800376 for (const auto& partition : partition_list) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700377 // Proceed anyway even if it fails to wipe some partition.
378 secure_wipe_partition(partition);
379 }
380 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700381}
382
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700383static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800384 std::vector<std::string> entries;
385 if (has_cache) {
386 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
387 auto add_to_entries = [&](const char* filename) {
388 std::string log_file(filename);
389 if (i > 0) {
390 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700391 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800392
Yifan Hongd81b8e32018-12-17 14:29:06 -0800393 if (ensure_path_mounted(log_file) == 0 && access(log_file.c_str(), R_OK) == 0) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800394 entries.push_back(std::move(log_file));
395 }
396 };
397
398 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
399 add_to_entries(LAST_LOG_FILE);
400
401 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
402 add_to_entries(LAST_KMSG_FILE);
403 }
404 } else {
405 // If cache partition is not found, view /tmp/recovery.log instead.
Tao Bao641fa972018-04-25 18:59:40 -0700406 if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800407 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700408 } else {
Tao Bao641fa972018-04-25 18:59:40 -0700409 entries.push_back(Paths::Get().temporary_log_file());
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700410 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800411 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700412
Tao Bao08fc6be2017-03-07 00:56:27 -0800413 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700414
Tao Bao1fe1afe2018-05-01 15:56:05 -0700415 std::vector<std::string> headers{ "Select file to view" };
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700416
Tao Bao1fe1afe2018-05-01 15:56:05 -0700417 size_t chosen_item = 0;
Tao Bao08fc6be2017-03-07 00:56:27 -0800418 while (true) {
Tao Bao3aec6962018-04-20 09:24:58 -0700419 chosen_item = ui->ShowMenu(
Tao Bao1fe1afe2018-05-01 15:56:05 -0700420 headers, entries, chosen_item, true,
Tao Bao3aec6962018-04-20 09:24:58 -0700421 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700422
423 // Handle WaitKey() interrupt.
424 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
425 break;
426 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800427 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700428
Tao Bao1d156b92018-05-02 12:43:18 -0700429 ui->ShowFile(entries[chosen_item]);
Tao Bao08fc6be2017-03-07 00:56:27 -0800430 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700431}
432
Tao Baodb7e8982017-03-06 23:53:16 -0800433static void run_graphics_test() {
434 // Switch to graphics screen.
435 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700436
Tao Baodb7e8982017-03-06 23:53:16 -0800437 ui->SetProgressType(RecoveryUI::INDETERMINATE);
438 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
439 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700440
Tao Baodb7e8982017-03-06 23:53:16 -0800441 ui->SetBackground(RecoveryUI::ERROR);
442 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700443
Tao Baodb7e8982017-03-06 23:53:16 -0800444 ui->SetBackground(RecoveryUI::NO_COMMAND);
445 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700446
Tao Baodb7e8982017-03-06 23:53:16 -0800447 ui->SetBackground(RecoveryUI::ERASING);
448 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700449
Tao Baodb7e8982017-03-06 23:53:16 -0800450 // Calling SetBackground() after SetStage() to trigger a redraw.
451 ui->SetStage(1, 3);
452 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
453 sleep(1);
454 ui->SetStage(2, 3);
455 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
456 sleep(1);
457 ui->SetStage(3, 3);
458 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
459 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700460
Tao Baodb7e8982017-03-06 23:53:16 -0800461 ui->SetStage(-1, -1);
462 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -0700463
Tao Baodb7e8982017-03-06 23:53:16 -0800464 ui->SetProgressType(RecoveryUI::DETERMINATE);
465 ui->ShowProgress(1.0, 10.0);
466 float fraction = 0.0;
467 for (size_t i = 0; i < 100; ++i) {
468 fraction += .01;
469 ui->SetProgress(fraction);
470 usleep(100000);
471 }
472
473 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -0700474}
475
Tao Bao50dd5322017-03-07 14:57:04 -0800476// Returns REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default,
477// which is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
478static Device::BuiltinAction prompt_and_wait(Device* device, int status) {
479 for (;;) {
Tao Bao551d2c32018-05-09 20:53:13 -0700480 finish_recovery();
Tao Bao50dd5322017-03-07 14:57:04 -0800481 switch (status) {
482 case INSTALL_SUCCESS:
483 case INSTALL_NONE:
484 ui->SetBackground(RecoveryUI::NO_COMMAND);
485 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -0700486
Tao Bao50dd5322017-03-07 14:57:04 -0800487 case INSTALL_ERROR:
488 case INSTALL_CORRUPT:
489 ui->SetBackground(RecoveryUI::ERROR);
490 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800491 }
Tao Bao50dd5322017-03-07 14:57:04 -0800492 ui->SetProgressType(RecoveryUI::EMPTY);
493
Tao Bao1fe1afe2018-05-01 15:56:05 -0700494 size_t chosen_item = ui->ShowMenu(
495 {}, device->GetMenuItems(), 0, false,
Tao Bao3aec6962018-04-20 09:24:58 -0700496 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700497 // Handle Interrupt key
498 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
499 return Device::KEY_INTERRUPTED;
500 }
Tao Bao50dd5322017-03-07 14:57:04 -0800501 // Device-specific code may take some action here. It may return one of the core actions
502 // handled in the switch statement below.
Jerry Zhangb76af932018-05-22 12:08:35 -0700503 Device::BuiltinAction chosen_action =
504 (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::TIMED_OUT))
505 ? Device::REBOOT
506 : device->InvokeMenuItem(chosen_item);
Tao Bao50dd5322017-03-07 14:57:04 -0800507
Tao Bao50dd5322017-03-07 14:57:04 -0800508 switch (chosen_action) {
509 case Device::NO_ACTION:
510 break;
511
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700512 case Device::ENTER_FASTBOOT:
513 case Device::ENTER_RECOVERY:
Tao Baod9cb0142019-04-23 11:46:25 -0700514 case Device::REBOOT:
515 case Device::REBOOT_BOOTLOADER:
516 case Device::REBOOT_FASTBOOT:
517 case Device::REBOOT_RECOVERY:
518 case Device::REBOOT_RESCUE:
519 case Device::SHUTDOWN:
Tao Bao50dd5322017-03-07 14:57:04 -0800520 return chosen_action;
521
522 case Device::WIPE_DATA:
xunchang316e9712019-04-12 16:22:15 -0700523 save_current_log = true;
Tao Bao50dd5322017-03-07 14:57:04 -0800524 if (ui->IsTextVisible()) {
525 if (ask_to_wipe_data(device)) {
xunchang316e9712019-04-12 16:22:15 -0700526 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800527 }
528 } else {
xunchang316e9712019-04-12 16:22:15 -0700529 WipeData(device, false);
Tao Bao50dd5322017-03-07 14:57:04 -0800530 return Device::NO_ACTION;
531 }
532 break;
533
xunchang316e9712019-04-12 16:22:15 -0700534 case Device::WIPE_CACHE: {
535 save_current_log = true;
536 std::function<bool()> confirm_func = [&device]() {
537 return yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!");
538 };
539 WipeCache(ui, ui->IsTextVisible() ? confirm_func : nullptr);
Tao Bao50dd5322017-03-07 14:57:04 -0800540 if (!ui->IsTextVisible()) return Device::NO_ACTION;
541 break;
xunchang316e9712019-04-12 16:22:15 -0700542 }
Tao Bao10f441a2019-04-19 15:22:15 -0700543
Tao Bao50dd5322017-03-07 14:57:04 -0800544 case Device::APPLY_ADB_SIDELOAD:
Tao Baoc6dc3252019-04-16 14:22:25 -0700545 case Device::APPLY_SDCARD:
546 case Device::ENTER_RESCUE: {
xunchang316e9712019-04-12 16:22:15 -0700547 save_current_log = true;
Tao Baoc6dc3252019-04-16 14:22:25 -0700548
549 bool adb = true;
Tao Bao10f441a2019-04-19 15:22:15 -0700550 Device::BuiltinAction reboot_action;
Tao Baoc6dc3252019-04-16 14:22:25 -0700551 if (chosen_action == Device::ENTER_RESCUE) {
552 // Switch to graphics screen.
553 ui->ShowText(false);
xunchangfedeef62019-04-22 12:18:14 -0700554 status = ApplyFromAdb(device, true /* rescue_mode */, &reboot_action);
Tao Baoc6dc3252019-04-16 14:22:25 -0700555 } else if (chosen_action == Device::APPLY_ADB_SIDELOAD) {
xunchangfedeef62019-04-22 12:18:14 -0700556 status = ApplyFromAdb(device, false /* rescue_mode */, &reboot_action);
xunchang3cc23d52019-03-18 15:03:33 -0700557 } else {
Tao Baoc6dc3252019-04-16 14:22:25 -0700558 adb = false;
xunchang316e9712019-04-12 16:22:15 -0700559 status = ApplyFromSdcard(device, ui);
Tao Bao50dd5322017-03-07 14:57:04 -0800560 }
xunchang3cc23d52019-03-18 15:03:33 -0700561
Tao Bao10f441a2019-04-19 15:22:15 -0700562 ui->Print("\nInstall from %s completed with status %d.\n", adb ? "ADB" : "SD card", status);
563 if (status == INSTALL_REBOOT) {
564 return reboot_action;
565 }
566
xunchang3cc23d52019-03-18 15:03:33 -0700567 if (status != INSTALL_SUCCESS) {
568 ui->SetBackground(RecoveryUI::ERROR);
569 ui->Print("Installation aborted.\n");
xunchang316e9712019-04-12 16:22:15 -0700570 copy_logs(save_current_log, has_cache, sehandle);
xunchang3cc23d52019-03-18 15:03:33 -0700571 } else if (!ui->IsTextVisible()) {
572 return Device::NO_ACTION; // reboot if logs aren't visible
xunchang3cc23d52019-03-18 15:03:33 -0700573 }
Tao Bao50dd5322017-03-07 14:57:04 -0800574 break;
xunchang3cc23d52019-03-18 15:03:33 -0700575 }
Tao Bao50dd5322017-03-07 14:57:04 -0800576
577 case Device::VIEW_RECOVERY_LOGS:
578 choose_recovery_file(device);
579 break;
580
581 case Device::RUN_GRAPHICS_TEST:
582 run_graphics_test();
583 break;
584
Tianjie Xu29d55752017-09-20 17:53:46 -0700585 case Device::RUN_LOCALE_TEST: {
586 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
Tao Bao39c49182018-05-07 22:50:33 -0700587 screen_ui->CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700588 break;
589 }
Tao Bao50dd5322017-03-07 14:57:04 -0800590 case Device::MOUNT_SYSTEM:
Jiyong Park8b7af4c2018-06-01 11:58:54 +0900591 // the system partition is mounted at /mnt/system
Yifan Hongd81b8e32018-12-17 14:29:06 -0800592 if (ensure_path_mounted_at(get_system_root(), "/mnt/system") != -1) {
Yifan Hong49327802018-11-26 14:59:09 -0800593 ui->Print("Mounted /system.\n");
Tao Bao50dd5322017-03-07 14:57:04 -0800594 }
595 break;
Jerry Zhangb76af932018-05-22 12:08:35 -0700596
597 case Device::KEY_INTERRUPTED:
598 return Device::KEY_INTERRUPTED;
Tao Bao50dd5322017-03-07 14:57:04 -0800599 }
600 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800601}
602
Tao Bao99f0d9e2016-10-13 12:46:38 -0700603static void print_property(const char* key, const char* name, void* /* cookie */) {
604 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800605}
606
Tao Bao6d90a9d2018-04-26 10:40:36 -0700607static bool is_battery_ok(int* required_battery_level) {
Yifan Honge8e4c402017-11-08 14:56:03 -0800608 using android::hardware::health::V1_0::BatteryStatus;
Yifan Hong056538c2018-07-11 17:04:12 -0700609 using android::hardware::health::V2_0::get_health_service;
610 using android::hardware::health::V2_0::IHealth;
Yifan Honge8e4c402017-11-08 14:56:03 -0800611 using android::hardware::health::V2_0::Result;
612 using android::hardware::health::V2_0::toString;
Yabin Cui99281df2016-02-17 12:21:52 -0800613
Yifan Hong056538c2018-07-11 17:04:12 -0700614 android::sp<IHealth> health = get_health_service();
Yifan Honge8e4c402017-11-08 14:56:03 -0800615
Tao Bao6d90a9d2018-04-26 10:40:36 -0700616 static constexpr int BATTERY_READ_TIMEOUT_IN_SEC = 10;
Yifan Honge8e4c402017-11-08 14:56:03 -0800617 int wait_second = 0;
618 while (true) {
619 auto charge_status = BatteryStatus::UNKNOWN;
Yifan Hong056538c2018-07-11 17:04:12 -0700620
621 if (health == nullptr) {
622 LOG(WARNING) << "no health implementation is found, assuming defaults";
623 } else {
624 health
625 ->getChargeStatus([&charge_status](auto res, auto out_status) {
626 if (res == Result::SUCCESS) {
627 charge_status = out_status;
628 }
629 })
630 .isOk(); // should not have transport error
631 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800632
633 // Treat unknown status as charged.
634 bool charged = (charge_status != BatteryStatus::DISCHARGING &&
635 charge_status != BatteryStatus::NOT_CHARGING);
636
637 Result res = Result::UNKNOWN;
638 int32_t capacity = INT32_MIN;
Yifan Hong056538c2018-07-11 17:04:12 -0700639 if (health != nullptr) {
640 health
641 ->getCapacity([&res, &capacity](auto out_res, auto out_capacity) {
642 res = out_res;
643 capacity = out_capacity;
644 })
645 .isOk(); // should not have transport error
646 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800647
Yifan Hong056538c2018-07-11 17:04:12 -0700648 LOG(INFO) << "charge_status " << toString(charge_status) << ", charged " << charged
649 << ", status " << toString(res) << ", capacity " << capacity;
Yifan Honge8e4c402017-11-08 14:56:03 -0800650 // At startup, the battery drivers in devices like N5X/N6P take some time to load
651 // the battery profile. Before the load finishes, it reports value 50 as a fake
652 // capacity. BATTERY_READ_TIMEOUT_IN_SEC is set that the battery drivers are expected
653 // to finish loading the battery profile earlier than 10 seconds after kernel startup.
654 if (res == Result::SUCCESS && capacity == 50) {
655 if (wait_second < BATTERY_READ_TIMEOUT_IN_SEC) {
656 sleep(1);
657 wait_second++;
658 continue;
659 }
660 }
661 // If we can't read battery percentage, it may be a device without battery. In this
662 // situation, use 100 as a fake battery percentage.
663 if (res != Result::SUCCESS) {
664 capacity = 100;
665 }
Tao Bao6d90a9d2018-04-26 10:40:36 -0700666
667 // GmsCore enters recovery mode to install package when having enough battery percentage.
668 // Normally, the threshold is 40% without charger and 20% with charger. So we should check
669 // battery with a slightly lower limitation.
670 static constexpr int BATTERY_OK_PERCENTAGE = 20;
671 static constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
672 *required_battery_level = charged ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE;
673 return capacity >= *required_battery_level;
674 }
Yabin Cui99281df2016-02-17 12:21:52 -0800675}
676
Tianjie Xu99b73be2017-11-28 17:23:06 -0800677// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -0700678static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
679 std::vector<std::string> options;
680 for (const auto& arg : args) {
681 if (!android::base::StartsWith(arg, "--retry_count")) {
682 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -0800683 }
Tianjie Xu72449c92017-05-16 18:07:31 -0700684 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800685
Tianjie Xu99b73be2017-11-28 17:23:06 -0800686 // Update the retry counter in BCB.
687 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -0700688 std::string err;
689 if (!update_bootloader_message(options, &err)) {
690 LOG(ERROR) << err;
691 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800692}
693
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700694static bool bootreason_in_blacklist() {
Tao Baoefc35592017-01-08 22:45:47 -0800695 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
696 if (!bootreason.empty()) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700697 // More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
698 static const std::vector<std::string> kBootreasonBlacklist{
699 "kernel_panic",
700 "Panic",
701 };
702 for (const auto& str : kBootreasonBlacklist) {
703 if (android::base::EqualsIgnoreCase(str, bootreason)) return true;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700704 }
Tao Baoefc35592017-01-08 22:45:47 -0800705 }
706 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700707}
708
Tao Bao641fa972018-04-25 18:59:40 -0700709static void log_failure_code(ErrorCode code, const std::string& update_package) {
710 std::vector<std::string> log_buffer = {
711 update_package,
712 "0", // install result
713 "error: " + std::to_string(code),
714 };
715 std::string log_content = android::base::Join(log_buffer, "\n");
716 const std::string& install_file = Paths::Get().temporary_install_file();
717 if (!android::base::WriteStringToFile(log_content, install_file)) {
718 PLOG(ERROR) << "Failed to write " << install_file;
719 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700720
Tao Bao641fa972018-04-25 18:59:40 -0700721 // Also write the info into last_log.
722 LOG(INFO) << log_content;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700723}
724
Jerry Zhang6a648042018-05-04 11:24:10 -0700725Device::BuiltinAction start_recovery(Device* device, const std::vector<std::string>& args) {
Tao Baof9f17342018-04-27 10:44:04 -0700726 static constexpr struct option OPTIONS[] = {
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700727 { "fastboot", no_argument, nullptr, 0 },
David Andersonedee8362018-05-16 13:43:22 -0700728 { "fsck_unshare_blocks", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700729 { "just_exit", no_argument, nullptr, 'x' },
730 { "locale", required_argument, nullptr, 0 },
731 { "prompt_and_wipe_data", no_argument, nullptr, 0 },
732 { "reason", required_argument, nullptr, 0 },
Tao Baod9cb0142019-04-23 11:46:25 -0700733 { "rescue", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700734 { "retry_count", required_argument, nullptr, 0 },
735 { "security", no_argument, nullptr, 0 },
736 { "show_text", no_argument, nullptr, 't' },
737 { "shutdown_after", no_argument, nullptr, 0 },
738 { "sideload", no_argument, nullptr, 0 },
739 { "sideload_auto_reboot", no_argument, nullptr, 0 },
740 { "update_package", required_argument, nullptr, 0 },
741 { "wipe_ab", no_argument, nullptr, 0 },
742 { "wipe_cache", no_argument, nullptr, 0 },
743 { "wipe_data", no_argument, nullptr, 0 },
744 { "wipe_package_size", required_argument, nullptr, 0 },
745 { nullptr, 0, nullptr, 0 },
746 };
747
Tianjie Xu99b73be2017-11-28 17:23:06 -0800748 const char* update_package = nullptr;
749 bool should_wipe_data = false;
750 bool should_prompt_and_wipe_data = false;
751 bool should_wipe_cache = false;
752 bool should_wipe_ab = false;
753 size_t wipe_package_size = 0;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800754 bool sideload = false;
755 bool sideload_auto_reboot = false;
Tao Baod9cb0142019-04-23 11:46:25 -0700756 bool rescue = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800757 bool just_exit = false;
758 bool shutdown_after = false;
David Andersonedee8362018-05-16 13:43:22 -0700759 bool fsck_unshare_blocks = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800760 int retry_count = 0;
761 bool security_update = false;
Jerry Zhang2dea53e2018-05-02 17:15:03 -0700762 std::string locale;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800763
Tao Bao1700cc42018-07-16 22:09:59 -0700764 auto args_to_parse = StringVectorToNullTerminatedArray(args);
765
Tianjie Xu99b73be2017-11-28 17:23:06 -0800766 int arg;
767 int option_index;
Tao Bao1700cc42018-07-16 22:09:59 -0700768 // Parse everything before the last element (which must be a nullptr). getopt_long(3) expects a
769 // null-terminated char* array, but without counting null as an arg (i.e. argv[argc] should be
770 // nullptr).
771 while ((arg = getopt_long(args_to_parse.size() - 1, args_to_parse.data(), "", OPTIONS,
Tianjie Xu99b73be2017-11-28 17:23:06 -0800772 &option_index)) != -1) {
773 switch (arg) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800774 case 't':
Jerry Zhang6a648042018-05-04 11:24:10 -0700775 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800776 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800777 case 'x':
778 just_exit = true;
779 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800780 case 0: {
781 std::string option = OPTIONS[option_index].name;
David Andersonedee8362018-05-16 13:43:22 -0700782 if (option == "fsck_unshare_blocks") {
783 fsck_unshare_blocks = true;
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700784 } else if (option == "locale" || option == "fastboot") {
Jerry Zhang6a648042018-05-04 11:24:10 -0700785 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800786 } else if (option == "prompt_and_wipe_data") {
787 should_prompt_and_wipe_data = true;
Tao Baof9f17342018-04-27 10:44:04 -0700788 } else if (option == "reason") {
789 reason = optarg;
Tao Baod9cb0142019-04-23 11:46:25 -0700790 } else if (option == "rescue") {
791 rescue = true;
Tao Baof9f17342018-04-27 10:44:04 -0700792 } else if (option == "retry_count") {
793 android::base::ParseInt(optarg, &retry_count, 0);
794 } else if (option == "security") {
795 security_update = true;
796 } else if (option == "sideload") {
797 sideload = true;
798 } else if (option == "sideload_auto_reboot") {
799 sideload = true;
800 sideload_auto_reboot = true;
801 } else if (option == "shutdown_after") {
802 shutdown_after = true;
803 } else if (option == "update_package") {
804 update_package = optarg;
805 } else if (option == "wipe_ab") {
806 should_wipe_ab = true;
807 } else if (option == "wipe_cache") {
808 should_wipe_cache = true;
809 } else if (option == "wipe_data") {
810 should_wipe_data = true;
811 } else if (option == "wipe_package_size") {
812 android::base::ParseUint(optarg, &wipe_package_size);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800813 }
814 break;
815 }
816 case '?':
817 LOG(ERROR) << "Invalid command argument";
818 continue;
Doug Zongker9270a202012-01-09 15:16:13 -0800819 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800820 }
Jerry Zhang49fd5d22018-05-17 12:54:41 -0700821 optind = 1;
Doug Zongker9270a202012-01-09 15:16:13 -0800822
Tianjie Xu99b73be2017-11-28 17:23:06 -0800823 printf("stage is [%s]\n", stage.c_str());
824 printf("reason is [%s]\n", reason);
Doug Zongker02ec6b82012-08-22 17:26:40 -0700825
Tianjie Xu99b73be2017-11-28 17:23:06 -0800826 // Set background string to "installing security update" for security update,
827 // otherwise set it to "installing system update".
828 ui->SetSystemUpdateText(security_update);
829
830 int st_cur, st_max;
831 if (!stage.empty() && sscanf(stage.c_str(), "%d/%d", &st_cur, &st_max) == 2) {
832 ui->SetStage(st_cur, st_max);
833 }
834
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700835 std::vector<std::string> title_lines =
836 android::base::Split(android::base::GetProperty("ro.bootimage.build.fingerprint", ""), ":");
837 title_lines.insert(std::begin(title_lines), "Android Recovery");
838 ui->SetTitle(title_lines);
839
Jerry Zhangb76af932018-05-22 12:08:35 -0700840 ui->ResetKeyInterruptStatus();
Tianjie Xu99b73be2017-11-28 17:23:06 -0800841 device->StartRecovery();
842
843 printf("Command:");
844 for (const auto& arg : args) {
845 printf(" \"%s\"", arg.c_str());
846 }
847 printf("\n\n");
848
849 property_list(print_property, nullptr);
850 printf("\n");
851
852 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
853
854 int status = INSTALL_SUCCESS;
Tao Bao10f441a2019-04-19 15:22:15 -0700855 // next_action indicates the next target to reboot into upon finishing the install. It could be
856 // overridden to a different reboot target per user request.
857 Device::BuiltinAction next_action = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800858
859 if (update_package != nullptr) {
860 // It's not entirely true that we will modify the flash. But we want
861 // to log the update attempt since update_package is non-NULL.
xunchang316e9712019-04-12 16:22:15 -0700862 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800863
Tao Bao6d90a9d2018-04-26 10:40:36 -0700864 int required_battery_level;
865 if (retry_count == 0 && !is_battery_ok(&required_battery_level)) {
866 ui->Print("battery capacity is not enough for installing package: %d%% needed\n",
867 required_battery_level);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800868 // Log the error code to last_install when installation skips due to
869 // low battery.
870 log_failure_code(kLowBattery, update_package);
871 status = INSTALL_SKIPPED;
Tianjie Xua6f49bd2018-03-26 14:32:11 -0700872 } else if (retry_count == 0 && bootreason_in_blacklist()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800873 // Skip update-on-reboot when bootreason is kernel_panic or similar
874 ui->Print("bootreason is in the blacklist; skip OTA installation\n");
875 log_failure_code(kBootreasonInBlacklist, update_package);
876 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -0700877 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800878 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
879 // identify the interrupted update due to unexpected reboots.
880 if (retry_count == 0) {
881 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -0700882 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800883
xunchang316e9712019-04-12 16:22:15 -0700884 status = install_package(update_package, should_wipe_cache, true, retry_count, ui);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800885 if (status != INSTALL_SUCCESS) {
886 ui->Print("Installation aborted.\n");
Tao Baoaac9d9f2018-04-29 23:38:59 -0700887
888 // When I/O error or bspatch/imgpatch error happens, reboot and retry installation
889 // RETRY_LIMIT times before we abandon this OTA update.
890 static constexpr int RETRY_LIMIT = 4;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800891 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
xunchang316e9712019-04-12 16:22:15 -0700892 copy_logs(save_current_log, has_cache, sehandle);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800893 retry_count += 1;
894 set_retry_bootloader_message(retry_count, args);
895 // Print retry count on screen.
896 ui->Print("Retry attempt %d\n", retry_count);
897
898 // Reboot and retry the update
899 if (!reboot("reboot,recovery")) {
900 ui->Print("Reboot failed\n");
901 } else {
902 while (true) {
903 pause();
904 }
905 }
Tianjie Xud9d16292017-04-20 18:08:21 -0700906 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800907 // If this is an eng or userdebug build, then automatically
908 // turn the text display on if the script fails so the error
909 // message is visible.
910 if (is_ro_debuggable()) {
911 ui->ShowText(true);
Tao Baoc679f932015-03-30 09:43:49 -0700912 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800913 }
Doug Zongker8674a722010-09-15 11:08:23 -0700914 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800915 } else if (should_wipe_data) {
xunchang316e9712019-04-12 16:22:15 -0700916 save_current_log = true;
917 bool convert_fbe = reason && strcmp(reason, "convert_fbe") == 0;
918 if (!WipeData(device, convert_fbe)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800919 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -0700920 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800921 } else if (should_prompt_and_wipe_data) {
Tao Baoa5bbcb92018-09-17 14:32:47 -0700922 // Trigger the logging to capture the cause, even if user chooses to not wipe data.
xunchang316e9712019-04-12 16:22:15 -0700923 save_current_log = true;
Tao Baoa5bbcb92018-09-17 14:32:47 -0700924
Tianjie Xu99b73be2017-11-28 17:23:06 -0800925 ui->ShowText(true);
926 ui->SetBackground(RecoveryUI::ERROR);
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700927 status = prompt_and_wipe_data(device);
928 if (status != INSTALL_KEY_INTERRUPTED) {
929 ui->ShowText(false);
Tao Bao75238632015-05-27 14:46:17 -0700930 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800931 } else if (should_wipe_cache) {
xunchang316e9712019-04-12 16:22:15 -0700932 save_current_log = true;
933 if (!WipeCache(ui, nullptr)) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800934 status = INSTALL_ERROR;
935 }
936 } else if (should_wipe_ab) {
937 if (!wipe_ab_device(wipe_package_size)) {
938 status = INSTALL_ERROR;
939 }
940 } else if (sideload) {
Tao Bao10f441a2019-04-19 15:22:15 -0700941 // 'adb reboot sideload' acts the same as user presses key combinations to enter the sideload
942 // mode. When 'sideload-auto-reboot' is used, text display will NOT be turned on by default. And
943 // it will reboot after sideload finishes even if there are errors. This is to enable automated
Tianjie Xu99b73be2017-11-28 17:23:06 -0800944 // testing.
xunchang316e9712019-04-12 16:22:15 -0700945 save_current_log = true;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800946 if (!sideload_auto_reboot) {
947 ui->ShowText(true);
948 }
xunchangfedeef62019-04-22 12:18:14 -0700949 status = ApplyFromAdb(device, false /* rescue_mode */, &next_action);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800950 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
951 if (sideload_auto_reboot) {
Tao Bao10f441a2019-04-19 15:22:15 -0700952 status = INSTALL_REBOOT;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800953 ui->Print("Rebooting automatically.\n");
954 }
Tao Baod9cb0142019-04-23 11:46:25 -0700955 } else if (rescue) {
956 save_current_log = true;
xunchangfedeef62019-04-22 12:18:14 -0700957 status = ApplyFromAdb(device, true /* rescue_mode */, &next_action);
Tao Baod9cb0142019-04-23 11:46:25 -0700958 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
David Andersonedee8362018-05-16 13:43:22 -0700959 } else if (fsck_unshare_blocks) {
960 if (!do_fsck_unshare_blocks()) {
961 status = INSTALL_ERROR;
962 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800963 } else if (!just_exit) {
964 // If this is an eng or userdebug build, automatically turn on the text display if no command
965 // is specified. Note that this should be called before setting the background to avoid
966 // flickering the background image.
967 if (is_ro_debuggable()) {
968 ui->ShowText(true);
969 }
970 status = INSTALL_NONE; // No command specified
971 ui->SetBackground(RecoveryUI::NO_COMMAND);
972 }
973
974 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
975 ui->SetBackground(RecoveryUI::ERROR);
976 if (!ui->IsTextVisible()) {
977 sleep(5);
978 }
979 }
980
Tao Bao10f441a2019-04-19 15:22:15 -0700981 // Determine the next action.
982 // - If the state is INSTALL_REBOOT, device will reboot into the target as specified in
983 // `next_action`.
984 // - If the recovery menu is visible, prompt and wait for commands.
985 // - If the state is INSTALL_NONE, wait for commands (e.g. in user build, one manually boots
986 // into recovery to sideload a package or to wipe the device).
987 // - In all other cases, reboot the device. Therefore, normal users will observe the device
988 // rebooting a) immediately upon successful finish (INSTALL_SUCCESS); or b) an "error" screen
989 // for 5s followed by an automatic reboot.
990 if (status != INSTALL_REBOOT) {
991 if (status == INSTALL_NONE || ui->IsTextVisible()) {
992 Device::BuiltinAction temp = prompt_and_wait(device, status);
993 if (temp != Device::NO_ACTION) {
994 next_action = temp;
995 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800996 }
997 }
998
999 // Save logs and clean up before rebooting or shutting down.
Tao Bao551d2c32018-05-09 20:53:13 -07001000 finish_recovery();
Tianjie Xu99b73be2017-11-28 17:23:06 -08001001
Tao Bao10f441a2019-04-19 15:22:15 -07001002 return next_action;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001003}