blob: d9c1f22f5f4c902f54a2cfd05517c0739454da46 [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>
Doug Zongker7c3ae452013-05-14 11:03:02 -070027#include <stdarg.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
Doug Zongker23ceeea2010-07-08 17:27:55 -070031#include <sys/stat.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080032#include <sys/types.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080033#include <unistd.h>
34
Tao Baoc4a18ef2017-02-10 00:13:30 -080035#include <algorithm>
Tao Bao3aec6962018-04-20 09:24:58 -070036#include <functional>
Tao Baoc4a18ef2017-02-10 00:13:30 -080037#include <memory>
Tao Bao862a4c12016-06-02 11:16:50 -070038#include <string>
39#include <vector>
Tao Bao04ca4262015-09-10 15:32:24 -070040
Elliott Hughes4b166f02015-12-04 15:30:20 -080041#include <android-base/file.h>
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -070042#include <android-base/logging.h>
Tianjie Xu3c62b672016-02-05 18:25:58 -080043#include <android-base/parseint.h>
Elliott Hughescb220402016-09-23 15:30:55 -070044#include <android-base/properties.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -080045#include <android-base/stringprintf.h>
Tao Bao862a4c12016-06-02 11:16:50 -070046#include <android-base/strings.h>
47#include <android-base/unique_fd.h>
Yabin Cui8b309f62016-06-24 18:22:02 -070048#include <bootloader_message/bootloader_message.h>
Elliott Hughescb220402016-09-23 15:30:55 -070049#include <cutils/properties.h> /* for property_list */
Yifan Hong056538c2018-07-11 17:04:12 -070050#include <healthhalutils/HealthHalUtils.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070051#include <ziparchive/zip_archive.h>
Yabin Cui99281df2016-02-17 12:21:52 -080052
Tao Bao75238632015-05-27 14:46:17 -070053#include "adb_install.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080054#include "common.h"
David Andersonedee8362018-05-16 13:43:22 -070055#include "fsck_unshare_blocks.h"
xunchangea2912f2019-03-17 16:45:12 -070056#include "fuse_sdcard_install.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080057#include "install.h"
Jerry Zhangcadf4ed2018-05-02 16:56:00 -070058#include "logging.h"
Tao Bao17054c02018-05-03 22:41:23 -070059#include "otautil/dirutil.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070060#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070061#include "otautil/paths.h"
Tao Bao2c526392018-05-03 23:01:13 -070062#include "otautil/sysutil.h"
xunchangf07ed2e2019-02-25 14:14:01 -080063#include "package.h"
Tianjie Xub5108c32018-08-20 13:40:47 -070064#include "recovery_ui/screen_ui.h"
65#include "recovery_ui/ui.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080066#include "roots.h"
67
Tao Baoaac9d9f2018-04-29 23:38:59 -070068static constexpr const char* CACHE_LOG_DIR = "/cache/recovery";
69static constexpr const char* COMMAND_FILE = "/cache/recovery/command";
Tao Baoaac9d9f2018-04-29 23:38:59 -070070static constexpr const char* LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
71static constexpr const char* LAST_LOG_FILE = "/cache/recovery/last_log";
72static constexpr const char* LOCALE_FILE = "/cache/recovery/last_locale";
Tianjie Xu06e57ac2016-07-11 14:04:08 -070073
Tao Baoaac9d9f2018-04-29 23:38:59 -070074static constexpr const char* CACHE_ROOT = "/cache";
75static constexpr const char* DATA_ROOT = "/data";
76static constexpr const char* METADATA_ROOT = "/metadata";
Nick Kralevicha9ad0322014-10-22 18:38:48 -070077
Tao Baobd0ddcd2017-05-04 13:03:18 -070078// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
79// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
80static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
81
Tao Baoac9d94d2016-11-03 11:37:15 -070082bool modified_flash = false;
Tao Baoa8d72bc2016-12-25 18:46:50 -080083std::string stage;
Tao Baoac9d94d2016-11-03 11:37:15 -070084const char* reason = nullptr;
Tao Baoac9d94d2016-11-03 11:37:15 -070085
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080086/*
87 * The recovery tool communicates with the main system through /cache files.
88 * /cache/recovery/command - INPUT - command line for tool, one arg per line
89 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080090 *
91 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -070092 * --update_package=path - verify install an OTA package file
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080093 * --wipe_data - erase user data (and cache), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070094 * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user
95 * data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080096 * --wipe_cache - wipe cache (but not user data), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070097 * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519).
Oscar Montemayor05231562009-11-30 08:40:57 -080098 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -070099 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800100 *
101 * After completing, we remove /cache/recovery/command and reboot.
102 * Arguments may also be supplied in the bootloader control block (BCB).
103 * These important scenarios must be safely restartable at any point:
104 *
105 * FACTORY RESET
106 * 1. user selects "factory reset"
107 * 2. main system writes "--wipe_data" to /cache/recovery/command
108 * 3. main system reboots into recovery
109 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
110 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700111 * 5. erase_volume() reformats /data
112 * 6. erase_volume() reformats /cache
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800113 * 7. finish_recovery() erases BCB
114 * -- after this, rebooting will restart the main system --
115 * 8. main() calls reboot() to boot main system
116 *
117 * OTA INSTALL
118 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700119 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800120 * 3. main system reboots into recovery
121 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
122 * -- after this, rebooting will attempt to reinstall the update --
123 * 5. install_package() attempts to install the update
124 * NOTE: the package install must itself be restartable from any point
125 * 6. finish_recovery() erases BCB
126 * -- after this, rebooting will (try to) restart the main system --
127 * 7. ** if install failed **
128 * 7a. prompt_and_wait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800129 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800130 */
131
Elliott Hughesf14af802015-02-10 14:46:14 -0800132bool is_ro_debuggable() {
Elliott Hughescb220402016-09-23 15:30:55 -0700133 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800134}
135
Tao Baoec579032017-07-21 12:13:15 -0700136// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700137// copy our log file to cache as well (for the system to read). This function is
138// idempotent: call it as many times as you like.
Tao Bao551d2c32018-05-09 20:53:13 -0700139static void finish_recovery() {
140 std::string locale = ui->GetLocale();
Tao Baoec579032017-07-21 12:13:15 -0700141 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
142 // (e.g., directly from the bootloader) it will use the last-known locale.
143 if (!locale.empty() && has_cache) {
144 LOG(INFO) << "Saving locale \"" << locale << "\"";
145 if (ensure_path_mounted(LOCALE_FILE) != 0) {
146 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
147 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
148 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700149 }
Tao Baoec579032017-07-21 12:13:15 -0700150 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700151
Jerry Zhangcadf4ed2018-05-02 16:56:00 -0700152 copy_logs(modified_flash, has_cache);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800153
Tao Baoec579032017-07-21 12:13:15 -0700154 // Reset to normal system boot so recovery won't cycle indefinitely.
155 std::string err;
156 if (!clear_bootloader_message(&err)) {
157 LOG(ERROR) << "Failed to clear BCB message: " << err;
158 }
159
160 // Remove the command file, so recovery won't repeat indefinitely.
161 if (has_cache) {
162 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
163 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700164 }
Tao Baoec579032017-07-21 12:13:15 -0700165 ensure_path_unmounted(CACHE_ROOT);
166 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800167
Tao Baoec579032017-07-21 12:13:15 -0700168 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800169}
170
Tao Bao3f5a3822016-12-13 11:14:37 -0800171struct saved_log_file {
172 std::string name;
173 struct stat sb;
174 std::string data;
175};
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700176
Elliott Hughes945548e2015-06-05 17:59:56 -0700177static bool erase_volume(const char* volume) {
Tao Bao3f5a3822016-12-13 11:14:37 -0800178 bool is_cache = (strcmp(volume, CACHE_ROOT) == 0);
179 bool is_data = (strcmp(volume, DATA_ROOT) == 0);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700180
Tao Bao3f5a3822016-12-13 11:14:37 -0800181 ui->SetBackground(RecoveryUI::ERASING);
182 ui->SetProgressType(RecoveryUI::INDETERMINATE);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700183
Tao Bao3f5a3822016-12-13 11:14:37 -0800184 std::vector<saved_log_file> log_files;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700185
Tao Bao3f5a3822016-12-13 11:14:37 -0800186 if (is_cache) {
187 // If we're reformatting /cache, we load any past logs
188 // (i.e. "/cache/recovery/last_*") and the current log
189 // ("/cache/recovery/log") into memory, so we can restore them after
190 // the reformat.
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700191
Tao Bao3f5a3822016-12-13 11:14:37 -0800192 ensure_path_mounted(volume);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700193
Tao Bao3f5a3822016-12-13 11:14:37 -0800194 struct dirent* de;
195 std::unique_ptr<DIR, decltype(&closedir)> d(opendir(CACHE_LOG_DIR), closedir);
196 if (d) {
197 while ((de = readdir(d.get())) != nullptr) {
198 if (strncmp(de->d_name, "last_", 5) == 0 || strcmp(de->d_name, "log") == 0) {
199 std::string path = android::base::StringPrintf("%s/%s", CACHE_LOG_DIR, de->d_name);
200
201 struct stat sb;
202 if (stat(path.c_str(), &sb) == 0) {
203 // truncate files to 512kb
204 if (sb.st_size > (1 << 19)) {
205 sb.st_size = 1 << 19;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700206 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800207
208 std::string data(sb.st_size, '\0');
Tianjie Xude6735e2017-07-10 15:13:33 -0700209 FILE* f = fopen(path.c_str(), "rbe");
Tao Bao3f5a3822016-12-13 11:14:37 -0800210 fread(&data[0], 1, data.size(), f);
211 fclose(f);
212
213 log_files.emplace_back(saved_log_file{ path, sb, data });
214 }
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700215 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800216 }
Paul Lawrenced0db3372015-11-05 13:38:40 -0800217 } else {
Tao Bao3f5a3822016-12-13 11:14:37 -0800218 if (errno != ENOENT) {
219 PLOG(ERROR) << "Failed to opendir " << CACHE_LOG_DIR;
220 }
Paul Lawrenced0db3372015-11-05 13:38:40 -0800221 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800222 }
Doug Zongkerd0181b82011-10-19 10:51:12 -0700223
Tao Bao3f5a3822016-12-13 11:14:37 -0800224 ui->Print("Formatting %s...\n", volume);
225
226 ensure_path_unmounted(volume);
227
228 int result;
Tao Bao3f5a3822016-12-13 11:14:37 -0800229 if (is_data && reason && strcmp(reason, "convert_fbe") == 0) {
Tao Bao406a6ff2018-04-30 10:05:57 -0700230 static constexpr const char* CONVERT_FBE_DIR = "/tmp/convert_fbe";
231 static constexpr const char* CONVERT_FBE_FILE = "/tmp/convert_fbe/convert_fbe";
232 // Create convert_fbe breadcrumb file to signal init to convert to file based encryption, not
233 // full disk encryption.
Tao Bao3f5a3822016-12-13 11:14:37 -0800234 if (mkdir(CONVERT_FBE_DIR, 0700) != 0) {
Tao Bao406a6ff2018-04-30 10:05:57 -0700235 PLOG(ERROR) << "Failed to mkdir " << CONVERT_FBE_DIR;
236 return false;
Tao Bao3f5a3822016-12-13 11:14:37 -0800237 }
Tianjie Xude6735e2017-07-10 15:13:33 -0700238 FILE* f = fopen(CONVERT_FBE_FILE, "wbe");
Tao Bao3f5a3822016-12-13 11:14:37 -0800239 if (!f) {
Tao Bao406a6ff2018-04-30 10:05:57 -0700240 PLOG(ERROR) << "Failed to convert to file encryption";
241 return false;
Tao Bao3f5a3822016-12-13 11:14:37 -0800242 }
243 fclose(f);
244 result = format_volume(volume, CONVERT_FBE_DIR);
245 remove(CONVERT_FBE_FILE);
246 rmdir(CONVERT_FBE_DIR);
247 } else {
248 result = format_volume(volume);
249 }
250
251 if (is_cache) {
252 // Re-create the log dir and write back the log entries.
253 if (ensure_path_mounted(CACHE_LOG_DIR) == 0 &&
Tao Baoac3d1ed2017-07-23 00:01:02 -0700254 mkdir_recursively(CACHE_LOG_DIR, 0777, false, sehandle) == 0) {
Tao Bao3f5a3822016-12-13 11:14:37 -0800255 for (const auto& log : log_files) {
256 if (!android::base::WriteStringToFile(log.data, log.name, log.sb.st_mode, log.sb.st_uid,
257 log.sb.st_gid)) {
258 PLOG(ERROR) << "Failed to write to " << log.name;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700259 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800260 }
261 } else {
262 PLOG(ERROR) << "Failed to mount / create " << CACHE_LOG_DIR;
Doug Zongker2c3539e2010-09-29 13:21:30 -0700263 }
264
Tao Bao3f5a3822016-12-13 11:14:37 -0800265 // Any part of the log we'd copied to cache is now gone.
266 // Reset the pointer so we copy from the beginning of the temp
267 // log.
Jerry Zhangcadf4ed2018-05-02 16:56:00 -0700268 reset_tmplog_offset();
269 copy_logs(modified_flash, has_cache);
Tao Bao3f5a3822016-12-13 11:14:37 -0800270 }
271
272 return (result == 0);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800273}
274
Hridya Valsarajue4ef4532018-08-31 11:57:51 -0700275// Sets the usb config to 'state'
276bool SetUsbConfig(const std::string& state) {
277 android::base::SetProperty("sys.usb.config", state);
278 return android::base::WaitForProperty("sys.usb.state", state);
279}
280
Elliott Hughes30694c92015-03-25 15:16:51 -0700281static bool yes_no(Device* device, const char* question1, const char* question2) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700282 std::vector<std::string> headers{ question1, question2 };
283 std::vector<std::string> items{ " No", " Yes" };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700284
Tao Bao1fe1afe2018-05-01 15:56:05 -0700285 size_t chosen_item = ui->ShowMenu(
Tao Bao3aec6962018-04-20 09:24:58 -0700286 headers, items, 0, true,
287 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
288 return (chosen_item == 1);
Elliott Hughes30694c92015-03-25 15:16:51 -0700289}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800290
Paul Crowley08404b42016-12-19 13:04:23 -0800291static bool ask_to_wipe_data(Device* device) {
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700292 std::vector<std::string> headers{ "Wipe all user data?", " THIS CAN NOT BE UNDONE!" };
293 std::vector<std::string> items{ " Cancel", " Factory data reset" };
294
295 size_t chosen_item = ui->ShowPromptWipeDataConfirmationMenu(
296 headers, items,
297 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
298
299 return (chosen_item == 1);
Paul Crowley08404b42016-12-19 13:04:23 -0800300}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700301
Paul Crowley08404b42016-12-19 13:04:23 -0800302// Return true on success.
303static bool wipe_data(Device* device) {
Tao Bao682c34b2015-04-07 17:16:35 -0700304 modified_flash = true;
305
Doug Zongker211aebc2011-10-28 15:13:10 -0700306 ui->Print("\n-- Wiping data...\n");
Paul Crowley3b4d5162016-06-08 13:51:41 -0700307 bool success = device->PreWipeData();
308 if (success) {
309 success &= erase_volume(DATA_ROOT);
310 if (has_cache) {
311 success &= erase_volume(CACHE_ROOT);
312 }
313 if (volume_for_mount_point(METADATA_ROOT) != nullptr) {
314 success &= erase_volume(METADATA_ROOT);
315 }
316 }
317 if (success) {
318 success &= device->PostWipeData();
319 }
Elliott Hughes945548e2015-06-05 17:59:56 -0700320 ui->Print("Data wipe %s.\n", success ? "complete" : "failed");
321 return success;
Doug Zongkerf93d8162009-09-22 15:16:02 -0700322}
323
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700324static InstallResult prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700325 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tianjie Xub99e6062018-10-16 15:13:09 -0700326 std::vector<std::string> wipe_data_menu_headers{
Tao Bao2bbc6d62017-08-13 23:48:55 -0700327 "Can't load Android system. Your data may be corrupt. "
328 "If you continue to get this message, you may need to "
329 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700330 "stored on this device.",
Tao Baofc5499f2017-02-23 19:06:53 -0800331 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700332 // clang-format off
Tianjie Xub99e6062018-10-16 15:13:09 -0700333 std::vector<std::string> wipe_data_menu_items {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700334 "Try again",
335 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800336 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700337 // clang-format on
Tao Baofc5499f2017-02-23 19:06:53 -0800338 for (;;) {
Tianjie Xub99e6062018-10-16 15:13:09 -0700339 size_t chosen_item = ui->ShowPromptWipeDataMenu(
340 wipe_data_menu_headers, wipe_data_menu_items,
Tao Bao3aec6962018-04-20 09:24:58 -0700341 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700342 // If ShowMenu() returned RecoveryUI::KeyError::INTERRUPTED, WaitKey() was interrupted.
343 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700344 return INSTALL_KEY_INTERRUPTED;
Jerry Zhangb76af932018-05-22 12:08:35 -0700345 }
Tao Baofc5499f2017-02-23 19:06:53 -0800346 if (chosen_item != 1) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700347 return INSTALL_SUCCESS; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800348 }
Tianjie Xub99e6062018-10-16 15:13:09 -0700349
Tao Baofc5499f2017-02-23 19:06:53 -0800350 if (ask_to_wipe_data(device)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700351 if (wipe_data(device)) {
352 return INSTALL_SUCCESS;
353 } else {
354 return INSTALL_ERROR;
355 }
Tao Baofc5499f2017-02-23 19:06:53 -0800356 }
357 }
Paul Crowley08404b42016-12-19 13:04:23 -0800358}
359
Tao Baoe39a9bc2015-03-31 12:19:05 -0700360// Return true on success.
361static bool wipe_cache(bool should_confirm, Device* device) {
Tao Bao26112e52016-02-25 12:29:40 -0800362 if (!has_cache) {
363 ui->Print("No /cache partition found.\n");
364 return false;
365 }
366
Elliott Hughes30694c92015-03-25 15:16:51 -0700367 if (should_confirm && !yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!")) {
Tao Baoe39a9bc2015-03-31 12:19:05 -0700368 return false;
Elliott Hughes30694c92015-03-25 15:16:51 -0700369 }
370
Tao Bao682c34b2015-04-07 17:16:35 -0700371 modified_flash = true;
372
Elliott Hughes30694c92015-03-25 15:16:51 -0700373 ui->Print("\n-- Wiping cache...\n");
Elliott Hughes945548e2015-06-05 17:59:56 -0700374 bool success = erase_volume("/cache");
375 ui->Print("Cache wipe %s.\n", success ? "complete" : "failed");
376 return success;
Elliott Hughes30694c92015-03-25 15:16:51 -0700377}
378
Tao Bao1b2a98b2017-03-24 10:45:34 -0700379// Secure-wipe a given partition. It uses BLKSECDISCARD, if supported. Otherwise, it goes with
380// BLKDISCARD (if device supports BLKDISCARDZEROES) or BLKZEROOUT.
Tao Bao862a4c12016-06-02 11:16:50 -0700381static bool secure_wipe_partition(const std::string& partition) {
Tao Bao1b2a98b2017-03-24 10:45:34 -0700382 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(partition.c_str(), O_WRONLY)));
383 if (fd == -1) {
384 PLOG(ERROR) << "Failed to open \"" << partition << "\"";
385 return false;
386 }
387
388 uint64_t range[2] = { 0, 0 };
389 if (ioctl(fd, BLKGETSIZE64, &range[1]) == -1 || range[1] == 0) {
390 PLOG(ERROR) << "Failed to get partition size";
391 return false;
392 }
393 LOG(INFO) << "Secure-wiping \"" << partition << "\" from " << range[0] << " to " << range[1];
394
395 LOG(INFO) << " Trying BLKSECDISCARD...";
396 if (ioctl(fd, BLKSECDISCARD, &range) == -1) {
397 PLOG(WARNING) << " Failed";
398
399 // Use BLKDISCARD if it zeroes out blocks, otherwise use BLKZEROOUT.
400 unsigned int zeroes;
401 if (ioctl(fd, BLKDISCARDZEROES, &zeroes) == 0 && zeroes != 0) {
402 LOG(INFO) << " Trying BLKDISCARD...";
403 if (ioctl(fd, BLKDISCARD, &range) == -1) {
404 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700405 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700406 }
407 } else {
408 LOG(INFO) << " Trying BLKZEROOUT...";
409 if (ioctl(fd, BLKZEROOUT, &range) == -1) {
410 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700411 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700412 }
Tao Bao862a4c12016-06-02 11:16:50 -0700413 }
Tao Bao1b2a98b2017-03-24 10:45:34 -0700414 }
Tao Bao862a4c12016-06-02 11:16:50 -0700415
Tao Bao1b2a98b2017-03-24 10:45:34 -0700416 LOG(INFO) << " Done";
417 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700418}
419
xunchang55e3d222019-03-11 11:28:41 -0700420static std::unique_ptr<Package> ReadWipePackage(size_t wipe_package_size) {
xunchange0d991c2019-03-05 14:50:51 -0800421 if (wipe_package_size == 0) {
422 LOG(ERROR) << "wipe_package_size is zero";
xunchang55e3d222019-03-11 11:28:41 -0700423 return nullptr;
xunchange0d991c2019-03-05 14:50:51 -0800424 }
425
426 std::string wipe_package;
427 std::string err_str;
428 if (!read_wipe_package(&wipe_package, wipe_package_size, &err_str)) {
429 PLOG(ERROR) << "Failed to read wipe package" << err_str;
xunchang55e3d222019-03-11 11:28:41 -0700430 return nullptr;
xunchange0d991c2019-03-05 14:50:51 -0800431 }
xunchang55e3d222019-03-11 11:28:41 -0700432
433 return Package::CreateMemoryPackage(
434 std::vector<uint8_t>(wipe_package.begin(), wipe_package.end()), nullptr);
xunchange0d991c2019-03-05 14:50:51 -0800435}
436
437// Checks if the wipe package matches expectation. If the check passes, reads the list of
438// partitions to wipe from the package. Checks include
Yabin Cuifd99a312016-06-09 14:09:39 -0700439// 1. verify the package.
440// 2. check metadata (ota-type, pre-device and serial number if having one).
xunchang55e3d222019-03-11 11:28:41 -0700441static bool CheckWipePackage(Package* wipe_package) {
442 if (!verify_package(wipe_package)) {
xunchange0d991c2019-03-05 14:50:51 -0800443 LOG(ERROR) << "Failed to verify package";
444 return false;
445 }
Yabin Cuifd99a312016-06-09 14:09:39 -0700446
xunchang55e3d222019-03-11 11:28:41 -0700447 ZipArchiveHandle zip = wipe_package->GetZipArchiveHandle();
448 if (!zip) {
449 LOG(ERROR) << "Failed to get ZipArchiveHandle";
xunchange0d991c2019-03-05 14:50:51 -0800450 return false;
451 }
452
453 std::map<std::string, std::string> metadata;
454 if (!ReadMetadataFromPackage(zip, &metadata)) {
455 LOG(ERROR) << "Failed to parse metadata in the zip file";
456 return false;
457 }
458
xunchang55e3d222019-03-11 11:28:41 -0700459 return CheckPackageMetadata(metadata, OtaType::BRICK) == 0;
xunchange0d991c2019-03-05 14:50:51 -0800460}
461
xunchang55e3d222019-03-11 11:28:41 -0700462std::vector<std::string> GetWipePartitionList(Package* wipe_package) {
463 ZipArchiveHandle zip = wipe_package->GetZipArchiveHandle();
464 if (!zip) {
465 LOG(ERROR) << "Failed to get ZipArchiveHandle";
xunchange0d991c2019-03-05 14:50:51 -0800466 return {};
467 }
468
469 static constexpr const char* RECOVERY_WIPE_ENTRY_NAME = "recovery.wipe";
470
471 std::string partition_list_content;
472 ZipString path(RECOVERY_WIPE_ENTRY_NAME);
473 ZipEntry entry;
474 if (FindEntry(zip, path, &entry) == 0) {
475 uint32_t length = entry.uncompressed_length;
476 partition_list_content = std::string(length, '\0');
477 if (auto err = ExtractToMemory(
478 zip, &entry, reinterpret_cast<uint8_t*>(partition_list_content.data()), length);
479 err != 0) {
480 LOG(ERROR) << "Failed to extract " << RECOVERY_WIPE_ENTRY_NAME << ": "
481 << ErrorCodeString(err);
xunchange0d991c2019-03-05 14:50:51 -0800482 return {};
Yabin Cuifd99a312016-06-09 14:09:39 -0700483 }
xunchange0d991c2019-03-05 14:50:51 -0800484 } else {
485 LOG(INFO) << "Failed to find " << RECOVERY_WIPE_ENTRY_NAME
486 << ", falling back to use the partition list on device.";
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700487
xunchange0d991c2019-03-05 14:50:51 -0800488 static constexpr const char* RECOVERY_WIPE_ON_DEVICE = "/etc/recovery.wipe";
489 if (!android::base::ReadFileToString(RECOVERY_WIPE_ON_DEVICE, &partition_list_content)) {
490 PLOG(ERROR) << "failed to read \"" << RECOVERY_WIPE_ON_DEVICE << "\"";
xunchange0d991c2019-03-05 14:50:51 -0800491 return {};
Yabin Cuifd99a312016-06-09 14:09:39 -0700492 }
xunchange0d991c2019-03-05 14:50:51 -0800493 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700494
xunchange0d991c2019-03-05 14:50:51 -0800495 std::vector<std::string> result;
496 std::vector<std::string> lines = android::base::Split(partition_list_content, "\n");
497 for (const std::string& line : lines) {
498 std::string partition = android::base::Trim(line);
499 // Ignore '#' comment or empty lines.
500 if (android::base::StartsWith(partition, "#") || partition.empty()) {
501 continue;
502 }
503 result.push_back(line);
504 }
Yabin Cuifd99a312016-06-09 14:09:39 -0700505
xunchange0d991c2019-03-05 14:50:51 -0800506 return result;
Yabin Cuifd99a312016-06-09 14:09:39 -0700507}
508
Tao Baoaac9d9f2018-04-29 23:38:59 -0700509// Wipes the current A/B device, with a secure wipe of all the partitions in RECOVERY_WIPE.
Yabin Cuifd99a312016-06-09 14:09:39 -0700510static bool wipe_ab_device(size_t wipe_package_size) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700511 ui->SetBackground(RecoveryUI::ERASING);
512 ui->SetProgressType(RecoveryUI::INDETERMINATE);
Tao Bao862a4c12016-06-02 11:16:50 -0700513
xunchang55e3d222019-03-11 11:28:41 -0700514 auto wipe_package = ReadWipePackage(wipe_package_size);
515 if (!wipe_package) {
516 LOG(ERROR) << "Failed to open wipe package";
xunchange0d991c2019-03-05 14:50:51 -0800517 return false;
518 }
519
xunchang55e3d222019-03-11 11:28:41 -0700520 if (!CheckWipePackage(wipe_package.get())) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700521 LOG(ERROR) << "Failed to verify wipe package";
522 return false;
523 }
xunchange0d991c2019-03-05 14:50:51 -0800524
xunchang55e3d222019-03-11 11:28:41 -0700525 auto partition_list = GetWipePartitionList(wipe_package.get());
xunchange0d991c2019-03-05 14:50:51 -0800526 if (partition_list.empty()) {
527 LOG(ERROR) << "Empty wipe ab partition list";
Tao Baoaac9d9f2018-04-29 23:38:59 -0700528 return false;
529 }
530
xunchange0d991c2019-03-05 14:50:51 -0800531 for (const auto& partition : partition_list) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700532 // Proceed anyway even if it fails to wipe some partition.
533 secure_wipe_partition(partition);
534 }
535 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700536}
537
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700538static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800539 std::vector<std::string> entries;
540 if (has_cache) {
541 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
542 auto add_to_entries = [&](const char* filename) {
543 std::string log_file(filename);
544 if (i > 0) {
545 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700546 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800547
Yifan Hongd81b8e32018-12-17 14:29:06 -0800548 if (ensure_path_mounted(log_file) == 0 && access(log_file.c_str(), R_OK) == 0) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800549 entries.push_back(std::move(log_file));
550 }
551 };
552
553 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
554 add_to_entries(LAST_LOG_FILE);
555
556 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
557 add_to_entries(LAST_KMSG_FILE);
558 }
559 } else {
560 // If cache partition is not found, view /tmp/recovery.log instead.
Tao Bao641fa972018-04-25 18:59:40 -0700561 if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800562 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700563 } else {
Tao Bao641fa972018-04-25 18:59:40 -0700564 entries.push_back(Paths::Get().temporary_log_file());
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700565 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800566 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700567
Tao Bao08fc6be2017-03-07 00:56:27 -0800568 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700569
Tao Bao1fe1afe2018-05-01 15:56:05 -0700570 std::vector<std::string> headers{ "Select file to view" };
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700571
Tao Bao1fe1afe2018-05-01 15:56:05 -0700572 size_t chosen_item = 0;
Tao Bao08fc6be2017-03-07 00:56:27 -0800573 while (true) {
Tao Bao3aec6962018-04-20 09:24:58 -0700574 chosen_item = ui->ShowMenu(
Tao Bao1fe1afe2018-05-01 15:56:05 -0700575 headers, entries, chosen_item, true,
Tao Bao3aec6962018-04-20 09:24:58 -0700576 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700577
578 // Handle WaitKey() interrupt.
579 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
580 break;
581 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800582 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700583
Tao Bao1d156b92018-05-02 12:43:18 -0700584 ui->ShowFile(entries[chosen_item]);
Tao Bao08fc6be2017-03-07 00:56:27 -0800585 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700586}
587
Tao Baodb7e8982017-03-06 23:53:16 -0800588static void run_graphics_test() {
589 // Switch to graphics screen.
590 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700591
Tao Baodb7e8982017-03-06 23:53:16 -0800592 ui->SetProgressType(RecoveryUI::INDETERMINATE);
593 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
594 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700595
Tao Baodb7e8982017-03-06 23:53:16 -0800596 ui->SetBackground(RecoveryUI::ERROR);
597 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700598
Tao Baodb7e8982017-03-06 23:53:16 -0800599 ui->SetBackground(RecoveryUI::NO_COMMAND);
600 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700601
Tao Baodb7e8982017-03-06 23:53:16 -0800602 ui->SetBackground(RecoveryUI::ERASING);
603 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700604
Tao Baodb7e8982017-03-06 23:53:16 -0800605 // Calling SetBackground() after SetStage() to trigger a redraw.
606 ui->SetStage(1, 3);
607 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
608 sleep(1);
609 ui->SetStage(2, 3);
610 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
611 sleep(1);
612 ui->SetStage(3, 3);
613 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
614 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700615
Tao Baodb7e8982017-03-06 23:53:16 -0800616 ui->SetStage(-1, -1);
617 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -0700618
Tao Baodb7e8982017-03-06 23:53:16 -0800619 ui->SetProgressType(RecoveryUI::DETERMINATE);
620 ui->ShowProgress(1.0, 10.0);
621 float fraction = 0.0;
622 for (size_t i = 0; i < 100; ++i) {
623 fraction += .01;
624 ui->SetProgress(fraction);
625 usleep(100000);
626 }
627
628 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -0700629}
630
Tao Bao50dd5322017-03-07 14:57:04 -0800631// Returns REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default,
632// which is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
633static Device::BuiltinAction prompt_and_wait(Device* device, int status) {
634 for (;;) {
Tao Bao551d2c32018-05-09 20:53:13 -0700635 finish_recovery();
Tao Bao50dd5322017-03-07 14:57:04 -0800636 switch (status) {
637 case INSTALL_SUCCESS:
638 case INSTALL_NONE:
639 ui->SetBackground(RecoveryUI::NO_COMMAND);
640 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -0700641
Tao Bao50dd5322017-03-07 14:57:04 -0800642 case INSTALL_ERROR:
643 case INSTALL_CORRUPT:
644 ui->SetBackground(RecoveryUI::ERROR);
645 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800646 }
Tao Bao50dd5322017-03-07 14:57:04 -0800647 ui->SetProgressType(RecoveryUI::EMPTY);
648
Tao Bao1fe1afe2018-05-01 15:56:05 -0700649 size_t chosen_item = ui->ShowMenu(
650 {}, device->GetMenuItems(), 0, false,
Tao Bao3aec6962018-04-20 09:24:58 -0700651 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700652 // Handle Interrupt key
653 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
654 return Device::KEY_INTERRUPTED;
655 }
Tao Bao50dd5322017-03-07 14:57:04 -0800656 // Device-specific code may take some action here. It may return one of the core actions
657 // handled in the switch statement below.
Jerry Zhangb76af932018-05-22 12:08:35 -0700658 Device::BuiltinAction chosen_action =
659 (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::TIMED_OUT))
660 ? Device::REBOOT
661 : device->InvokeMenuItem(chosen_item);
Tao Bao50dd5322017-03-07 14:57:04 -0800662
663 bool should_wipe_cache = false;
664 switch (chosen_action) {
665 case Device::NO_ACTION:
666 break;
667
668 case Device::REBOOT:
669 case Device::SHUTDOWN:
670 case Device::REBOOT_BOOTLOADER:
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700671 case Device::ENTER_FASTBOOT:
672 case Device::ENTER_RECOVERY:
Tao Bao50dd5322017-03-07 14:57:04 -0800673 return chosen_action;
674
675 case Device::WIPE_DATA:
676 if (ui->IsTextVisible()) {
677 if (ask_to_wipe_data(device)) {
678 wipe_data(device);
679 }
680 } else {
681 wipe_data(device);
682 return Device::NO_ACTION;
683 }
684 break;
685
686 case Device::WIPE_CACHE:
687 wipe_cache(ui->IsTextVisible(), device);
688 if (!ui->IsTextVisible()) return Device::NO_ACTION;
689 break;
690
691 case Device::APPLY_ADB_SIDELOAD:
xunchang3cc23d52019-03-18 15:03:33 -0700692 case Device::APPLY_SDCARD: {
693 modified_flash = true;
694 bool adb = (chosen_action == Device::APPLY_ADB_SIDELOAD);
695 if (adb) {
696 status = apply_from_adb(&should_wipe_cache);
697 } else {
698 status = ApplyFromSdcard(device, &should_wipe_cache, ui);
699 }
Tao Bao50dd5322017-03-07 14:57:04 -0800700
xunchang3cc23d52019-03-18 15:03:33 -0700701 if (status == INSTALL_SUCCESS && should_wipe_cache) {
702 if (!wipe_cache(false, device)) {
703 status = INSTALL_ERROR;
Tao Bao50dd5322017-03-07 14:57:04 -0800704 }
705 }
xunchang3cc23d52019-03-18 15:03:33 -0700706
707 if (status != INSTALL_SUCCESS) {
708 ui->SetBackground(RecoveryUI::ERROR);
709 ui->Print("Installation aborted.\n");
710 copy_logs(modified_flash, has_cache);
711 } else if (!ui->IsTextVisible()) {
712 return Device::NO_ACTION; // reboot if logs aren't visible
713 } else {
714 ui->Print("\nInstall from %s complete.\n", adb ? "ADB" : "SD card");
715 }
Tao Bao50dd5322017-03-07 14:57:04 -0800716 break;
xunchang3cc23d52019-03-18 15:03:33 -0700717 }
Tao Bao50dd5322017-03-07 14:57:04 -0800718
719 case Device::VIEW_RECOVERY_LOGS:
720 choose_recovery_file(device);
721 break;
722
723 case Device::RUN_GRAPHICS_TEST:
724 run_graphics_test();
725 break;
726
Tianjie Xu29d55752017-09-20 17:53:46 -0700727 case Device::RUN_LOCALE_TEST: {
728 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
Tao Bao39c49182018-05-07 22:50:33 -0700729 screen_ui->CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700730 break;
731 }
Tao Bao50dd5322017-03-07 14:57:04 -0800732 case Device::MOUNT_SYSTEM:
Jiyong Park8b7af4c2018-06-01 11:58:54 +0900733 // the system partition is mounted at /mnt/system
Yifan Hongd81b8e32018-12-17 14:29:06 -0800734 if (ensure_path_mounted_at(get_system_root(), "/mnt/system") != -1) {
Yifan Hong49327802018-11-26 14:59:09 -0800735 ui->Print("Mounted /system.\n");
Tao Bao50dd5322017-03-07 14:57:04 -0800736 }
737 break;
Jerry Zhangb76af932018-05-22 12:08:35 -0700738
739 case Device::KEY_INTERRUPTED:
740 return Device::KEY_INTERRUPTED;
Tao Bao50dd5322017-03-07 14:57:04 -0800741 }
742 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800743}
744
Tao Bao99f0d9e2016-10-13 12:46:38 -0700745static void print_property(const char* key, const char* name, void* /* cookie */) {
746 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800747}
748
Tao Baoac9d94d2016-11-03 11:37:15 -0700749void ui_print(const char* format, ...) {
750 std::string buffer;
Doug Zongker7c3ae452013-05-14 11:03:02 -0700751 va_list ap;
752 va_start(ap, format);
Tao Baoac9d94d2016-11-03 11:37:15 -0700753 android::base::StringAppendV(&buffer, format, ap);
Doug Zongker7c3ae452013-05-14 11:03:02 -0700754 va_end(ap);
755
Tao Baoac9d94d2016-11-03 11:37:15 -0700756 if (ui != nullptr) {
757 ui->Print("%s", buffer.c_str());
Doug Zongker7c3ae452013-05-14 11:03:02 -0700758 } else {
Tao Baoac9d94d2016-11-03 11:37:15 -0700759 fputs(buffer.c_str(), stdout);
Doug Zongker7c3ae452013-05-14 11:03:02 -0700760 }
761}
762
Tao Bao6d90a9d2018-04-26 10:40:36 -0700763static bool is_battery_ok(int* required_battery_level) {
Yifan Honge8e4c402017-11-08 14:56:03 -0800764 using android::hardware::health::V1_0::BatteryStatus;
Yifan Hong056538c2018-07-11 17:04:12 -0700765 using android::hardware::health::V2_0::get_health_service;
766 using android::hardware::health::V2_0::IHealth;
Yifan Honge8e4c402017-11-08 14:56:03 -0800767 using android::hardware::health::V2_0::Result;
768 using android::hardware::health::V2_0::toString;
Yabin Cui99281df2016-02-17 12:21:52 -0800769
Yifan Hong056538c2018-07-11 17:04:12 -0700770 android::sp<IHealth> health = get_health_service();
Yifan Honge8e4c402017-11-08 14:56:03 -0800771
Tao Bao6d90a9d2018-04-26 10:40:36 -0700772 static constexpr int BATTERY_READ_TIMEOUT_IN_SEC = 10;
Yifan Honge8e4c402017-11-08 14:56:03 -0800773 int wait_second = 0;
774 while (true) {
775 auto charge_status = BatteryStatus::UNKNOWN;
Yifan Hong056538c2018-07-11 17:04:12 -0700776
777 if (health == nullptr) {
778 LOG(WARNING) << "no health implementation is found, assuming defaults";
779 } else {
780 health
781 ->getChargeStatus([&charge_status](auto res, auto out_status) {
782 if (res == Result::SUCCESS) {
783 charge_status = out_status;
784 }
785 })
786 .isOk(); // should not have transport error
787 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800788
789 // Treat unknown status as charged.
790 bool charged = (charge_status != BatteryStatus::DISCHARGING &&
791 charge_status != BatteryStatus::NOT_CHARGING);
792
793 Result res = Result::UNKNOWN;
794 int32_t capacity = INT32_MIN;
Yifan Hong056538c2018-07-11 17:04:12 -0700795 if (health != nullptr) {
796 health
797 ->getCapacity([&res, &capacity](auto out_res, auto out_capacity) {
798 res = out_res;
799 capacity = out_capacity;
800 })
801 .isOk(); // should not have transport error
802 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800803
Yifan Hong056538c2018-07-11 17:04:12 -0700804 LOG(INFO) << "charge_status " << toString(charge_status) << ", charged " << charged
805 << ", status " << toString(res) << ", capacity " << capacity;
Yifan Honge8e4c402017-11-08 14:56:03 -0800806 // At startup, the battery drivers in devices like N5X/N6P take some time to load
807 // the battery profile. Before the load finishes, it reports value 50 as a fake
808 // capacity. BATTERY_READ_TIMEOUT_IN_SEC is set that the battery drivers are expected
809 // to finish loading the battery profile earlier than 10 seconds after kernel startup.
810 if (res == Result::SUCCESS && capacity == 50) {
811 if (wait_second < BATTERY_READ_TIMEOUT_IN_SEC) {
812 sleep(1);
813 wait_second++;
814 continue;
815 }
816 }
817 // If we can't read battery percentage, it may be a device without battery. In this
818 // situation, use 100 as a fake battery percentage.
819 if (res != Result::SUCCESS) {
820 capacity = 100;
821 }
Tao Bao6d90a9d2018-04-26 10:40:36 -0700822
823 // GmsCore enters recovery mode to install package when having enough battery percentage.
824 // Normally, the threshold is 40% without charger and 20% with charger. So we should check
825 // battery with a slightly lower limitation.
826 static constexpr int BATTERY_OK_PERCENTAGE = 20;
827 static constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
828 *required_battery_level = charged ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE;
829 return capacity >= *required_battery_level;
830 }
Yabin Cui99281df2016-02-17 12:21:52 -0800831}
832
Tianjie Xu99b73be2017-11-28 17:23:06 -0800833// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -0700834static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
835 std::vector<std::string> options;
836 for (const auto& arg : args) {
837 if (!android::base::StartsWith(arg, "--retry_count")) {
838 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -0800839 }
Tianjie Xu72449c92017-05-16 18:07:31 -0700840 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800841
Tianjie Xu99b73be2017-11-28 17:23:06 -0800842 // Update the retry counter in BCB.
843 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -0700844 std::string err;
845 if (!update_bootloader_message(options, &err)) {
846 LOG(ERROR) << err;
847 }
Tianjie Xu3c62b672016-02-05 18:25:58 -0800848}
849
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700850static bool bootreason_in_blacklist() {
Tao Baoefc35592017-01-08 22:45:47 -0800851 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
852 if (!bootreason.empty()) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700853 // More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
854 static const std::vector<std::string> kBootreasonBlacklist{
855 "kernel_panic",
856 "Panic",
857 };
858 for (const auto& str : kBootreasonBlacklist) {
859 if (android::base::EqualsIgnoreCase(str, bootreason)) return true;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700860 }
Tao Baoefc35592017-01-08 22:45:47 -0800861 }
862 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700863}
864
Tao Bao641fa972018-04-25 18:59:40 -0700865static void log_failure_code(ErrorCode code, const std::string& update_package) {
866 std::vector<std::string> log_buffer = {
867 update_package,
868 "0", // install result
869 "error: " + std::to_string(code),
870 };
871 std::string log_content = android::base::Join(log_buffer, "\n");
872 const std::string& install_file = Paths::Get().temporary_install_file();
873 if (!android::base::WriteStringToFile(log_content, install_file)) {
874 PLOG(ERROR) << "Failed to write " << install_file;
875 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700876
Tao Bao641fa972018-04-25 18:59:40 -0700877 // Also write the info into last_log.
878 LOG(INFO) << log_content;
Tianjie Xu06e57ac2016-07-11 14:04:08 -0700879}
880
Jerry Zhang6a648042018-05-04 11:24:10 -0700881Device::BuiltinAction start_recovery(Device* device, const std::vector<std::string>& args) {
Tao Baof9f17342018-04-27 10:44:04 -0700882 static constexpr struct option OPTIONS[] = {
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700883 { "fastboot", no_argument, nullptr, 0 },
David Andersonedee8362018-05-16 13:43:22 -0700884 { "fsck_unshare_blocks", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -0700885 { "just_exit", no_argument, nullptr, 'x' },
886 { "locale", required_argument, nullptr, 0 },
887 { "prompt_and_wipe_data", no_argument, nullptr, 0 },
888 { "reason", required_argument, nullptr, 0 },
889 { "retry_count", required_argument, nullptr, 0 },
890 { "security", no_argument, nullptr, 0 },
891 { "show_text", no_argument, nullptr, 't' },
892 { "shutdown_after", no_argument, nullptr, 0 },
893 { "sideload", no_argument, nullptr, 0 },
894 { "sideload_auto_reboot", no_argument, nullptr, 0 },
895 { "update_package", required_argument, nullptr, 0 },
896 { "wipe_ab", no_argument, nullptr, 0 },
897 { "wipe_cache", no_argument, nullptr, 0 },
898 { "wipe_data", no_argument, nullptr, 0 },
899 { "wipe_package_size", required_argument, nullptr, 0 },
900 { nullptr, 0, nullptr, 0 },
901 };
902
Tianjie Xu99b73be2017-11-28 17:23:06 -0800903 const char* update_package = nullptr;
904 bool should_wipe_data = false;
905 bool should_prompt_and_wipe_data = false;
906 bool should_wipe_cache = false;
907 bool should_wipe_ab = false;
908 size_t wipe_package_size = 0;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800909 bool sideload = false;
910 bool sideload_auto_reboot = false;
911 bool just_exit = false;
912 bool shutdown_after = false;
David Andersonedee8362018-05-16 13:43:22 -0700913 bool fsck_unshare_blocks = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800914 int retry_count = 0;
915 bool security_update = false;
Jerry Zhang2dea53e2018-05-02 17:15:03 -0700916 std::string locale;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800917
Tao Bao1700cc42018-07-16 22:09:59 -0700918 auto args_to_parse = StringVectorToNullTerminatedArray(args);
919
Tianjie Xu99b73be2017-11-28 17:23:06 -0800920 int arg;
921 int option_index;
Tao Bao1700cc42018-07-16 22:09:59 -0700922 // Parse everything before the last element (which must be a nullptr). getopt_long(3) expects a
923 // null-terminated char* array, but without counting null as an arg (i.e. argv[argc] should be
924 // nullptr).
925 while ((arg = getopt_long(args_to_parse.size() - 1, args_to_parse.data(), "", OPTIONS,
Tianjie Xu99b73be2017-11-28 17:23:06 -0800926 &option_index)) != -1) {
927 switch (arg) {
Tianjie Xu99b73be2017-11-28 17:23:06 -0800928 case 't':
Jerry Zhang6a648042018-05-04 11:24:10 -0700929 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800930 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800931 case 'x':
932 just_exit = true;
933 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -0800934 case 0: {
935 std::string option = OPTIONS[option_index].name;
David Andersonedee8362018-05-16 13:43:22 -0700936 if (option == "fsck_unshare_blocks") {
937 fsck_unshare_blocks = true;
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700938 } else if (option == "locale" || option == "fastboot") {
Jerry Zhang6a648042018-05-04 11:24:10 -0700939 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -0800940 } else if (option == "prompt_and_wipe_data") {
941 should_prompt_and_wipe_data = true;
Tao Baof9f17342018-04-27 10:44:04 -0700942 } else if (option == "reason") {
943 reason = optarg;
944 } else if (option == "retry_count") {
945 android::base::ParseInt(optarg, &retry_count, 0);
946 } else if (option == "security") {
947 security_update = true;
948 } else if (option == "sideload") {
949 sideload = true;
950 } else if (option == "sideload_auto_reboot") {
951 sideload = true;
952 sideload_auto_reboot = true;
953 } else if (option == "shutdown_after") {
954 shutdown_after = true;
955 } else if (option == "update_package") {
956 update_package = optarg;
957 } else if (option == "wipe_ab") {
958 should_wipe_ab = true;
959 } else if (option == "wipe_cache") {
960 should_wipe_cache = true;
961 } else if (option == "wipe_data") {
962 should_wipe_data = true;
963 } else if (option == "wipe_package_size") {
964 android::base::ParseUint(optarg, &wipe_package_size);
Tianjie Xu99b73be2017-11-28 17:23:06 -0800965 }
966 break;
967 }
968 case '?':
969 LOG(ERROR) << "Invalid command argument";
970 continue;
Doug Zongker9270a202012-01-09 15:16:13 -0800971 }
Tianjie Xu99b73be2017-11-28 17:23:06 -0800972 }
Jerry Zhang49fd5d22018-05-17 12:54:41 -0700973 optind = 1;
Doug Zongker9270a202012-01-09 15:16:13 -0800974
Tianjie Xu99b73be2017-11-28 17:23:06 -0800975 printf("stage is [%s]\n", stage.c_str());
976 printf("reason is [%s]\n", reason);
Doug Zongker02ec6b82012-08-22 17:26:40 -0700977
Tianjie Xu99b73be2017-11-28 17:23:06 -0800978 // Set background string to "installing security update" for security update,
979 // otherwise set it to "installing system update".
980 ui->SetSystemUpdateText(security_update);
981
982 int st_cur, st_max;
983 if (!stage.empty() && sscanf(stage.c_str(), "%d/%d", &st_cur, &st_max) == 2) {
984 ui->SetStage(st_cur, st_max);
985 }
986
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700987 std::vector<std::string> title_lines =
988 android::base::Split(android::base::GetProperty("ro.bootimage.build.fingerprint", ""), ":");
989 title_lines.insert(std::begin(title_lines), "Android Recovery");
990 ui->SetTitle(title_lines);
991
Jerry Zhangb76af932018-05-22 12:08:35 -0700992 ui->ResetKeyInterruptStatus();
Tianjie Xu99b73be2017-11-28 17:23:06 -0800993 device->StartRecovery();
994
995 printf("Command:");
996 for (const auto& arg : args) {
997 printf(" \"%s\"", arg.c_str());
998 }
999 printf("\n\n");
1000
1001 property_list(print_property, nullptr);
1002 printf("\n");
1003
1004 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
1005
1006 int status = INSTALL_SUCCESS;
1007
1008 if (update_package != nullptr) {
1009 // It's not entirely true that we will modify the flash. But we want
1010 // to log the update attempt since update_package is non-NULL.
1011 modified_flash = true;
1012
Tao Bao6d90a9d2018-04-26 10:40:36 -07001013 int required_battery_level;
1014 if (retry_count == 0 && !is_battery_ok(&required_battery_level)) {
1015 ui->Print("battery capacity is not enough for installing package: %d%% needed\n",
1016 required_battery_level);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001017 // Log the error code to last_install when installation skips due to
1018 // low battery.
1019 log_failure_code(kLowBattery, update_package);
1020 status = INSTALL_SKIPPED;
Tianjie Xua6f49bd2018-03-26 14:32:11 -07001021 } else if (retry_count == 0 && bootreason_in_blacklist()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001022 // Skip update-on-reboot when bootreason is kernel_panic or similar
1023 ui->Print("bootreason is in the blacklist; skip OTA installation\n");
1024 log_failure_code(kBootreasonInBlacklist, update_package);
1025 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -07001026 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001027 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
1028 // identify the interrupted update due to unexpected reboots.
1029 if (retry_count == 0) {
1030 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -07001031 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001032
Tao Bao641fa972018-04-25 18:59:40 -07001033 status = install_package(update_package, &should_wipe_cache, true, retry_count);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001034 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1035 wipe_cache(false, device);
1036 }
1037 if (status != INSTALL_SUCCESS) {
1038 ui->Print("Installation aborted.\n");
Tao Baoaac9d9f2018-04-29 23:38:59 -07001039
1040 // When I/O error or bspatch/imgpatch error happens, reboot and retry installation
1041 // RETRY_LIMIT times before we abandon this OTA update.
1042 static constexpr int RETRY_LIMIT = 4;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001043 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
Jerry Zhangcadf4ed2018-05-02 16:56:00 -07001044 copy_logs(modified_flash, has_cache);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001045 retry_count += 1;
1046 set_retry_bootloader_message(retry_count, args);
1047 // Print retry count on screen.
1048 ui->Print("Retry attempt %d\n", retry_count);
1049
1050 // Reboot and retry the update
1051 if (!reboot("reboot,recovery")) {
1052 ui->Print("Reboot failed\n");
1053 } else {
1054 while (true) {
1055 pause();
1056 }
1057 }
Tianjie Xud9d16292017-04-20 18:08:21 -07001058 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001059 // If this is an eng or userdebug build, then automatically
1060 // turn the text display on if the script fails so the error
1061 // message is visible.
1062 if (is_ro_debuggable()) {
1063 ui->ShowText(true);
Tao Baoc679f932015-03-30 09:43:49 -07001064 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001065 }
Doug Zongker8674a722010-09-15 11:08:23 -07001066 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001067 } else if (should_wipe_data) {
1068 if (!wipe_data(device)) {
1069 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -07001070 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001071 } else if (should_prompt_and_wipe_data) {
Tao Baoa5bbcb92018-09-17 14:32:47 -07001072 // Trigger the logging to capture the cause, even if user chooses to not wipe data.
1073 modified_flash = true;
1074
Tianjie Xu99b73be2017-11-28 17:23:06 -08001075 ui->ShowText(true);
1076 ui->SetBackground(RecoveryUI::ERROR);
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -07001077 status = prompt_and_wipe_data(device);
1078 if (status != INSTALL_KEY_INTERRUPTED) {
1079 ui->ShowText(false);
Tao Bao75238632015-05-27 14:46:17 -07001080 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001081 } else if (should_wipe_cache) {
1082 if (!wipe_cache(false, device)) {
1083 status = INSTALL_ERROR;
1084 }
1085 } else if (should_wipe_ab) {
1086 if (!wipe_ab_device(wipe_package_size)) {
1087 status = INSTALL_ERROR;
1088 }
1089 } else if (sideload) {
1090 // 'adb reboot sideload' acts the same as user presses key combinations
1091 // to enter the sideload mode. When 'sideload-auto-reboot' is used, text
1092 // display will NOT be turned on by default. And it will reboot after
1093 // sideload finishes even if there are errors. Unless one turns on the
1094 // text display during the installation. This is to enable automated
1095 // testing.
1096 if (!sideload_auto_reboot) {
1097 ui->ShowText(true);
1098 }
Tao Bao641fa972018-04-25 18:59:40 -07001099 status = apply_from_adb(&should_wipe_cache);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001100 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1101 if (!wipe_cache(false, device)) {
1102 status = INSTALL_ERROR;
1103 }
1104 }
1105 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
1106 if (sideload_auto_reboot) {
1107 ui->Print("Rebooting automatically.\n");
1108 }
David Andersonedee8362018-05-16 13:43:22 -07001109 } else if (fsck_unshare_blocks) {
1110 if (!do_fsck_unshare_blocks()) {
1111 status = INSTALL_ERROR;
1112 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001113 } else if (!just_exit) {
1114 // If this is an eng or userdebug build, automatically turn on the text display if no command
1115 // is specified. Note that this should be called before setting the background to avoid
1116 // flickering the background image.
1117 if (is_ro_debuggable()) {
1118 ui->ShowText(true);
1119 }
1120 status = INSTALL_NONE; // No command specified
1121 ui->SetBackground(RecoveryUI::NO_COMMAND);
1122 }
1123
1124 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
1125 ui->SetBackground(RecoveryUI::ERROR);
1126 if (!ui->IsTextVisible()) {
1127 sleep(5);
1128 }
1129 }
1130
1131 Device::BuiltinAction after = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
1132 // 1. If the recovery menu is visible, prompt and wait for commands.
1133 // 2. If the state is INSTALL_NONE, wait for commands. (i.e. In user build, manually reboot into
1134 // recovery to sideload a package.)
1135 // 3. sideload_auto_reboot is an option only available in user-debug build, reboot the device
1136 // without waiting.
1137 // 4. In all other cases, reboot the device. Therefore, normal users will observe the device
1138 // reboot after it shows the "error" screen for 5s.
1139 if ((status == INSTALL_NONE && !sideload_auto_reboot) || ui->IsTextVisible()) {
1140 Device::BuiltinAction temp = prompt_and_wait(device, status);
1141 if (temp != Device::NO_ACTION) {
1142 after = temp;
1143 }
1144 }
1145
1146 // Save logs and clean up before rebooting or shutting down.
Tao Bao551d2c32018-05-09 20:53:13 -07001147 finish_recovery();
Tianjie Xu99b73be2017-11-28 17:23:06 -08001148
Jerry Zhang6a648042018-05-04 11:24:10 -07001149 return after;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001150}