blob: 90c84878b2b5f0a1568ce5c99c96263fc9460166 [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>
Doug Zongker7c3ae452013-05-14 11:03:02 -070020#include <dirent.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080021#include <errno.h>
22#include <fcntl.h>
23#include <getopt.h>
Tao Bao862a4c12016-06-02 11:16:50 -070024#include <inttypes.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080025#include <limits.h>
Tao Bao862a4c12016-06-02 11:16:50 -070026#include <linux/fs.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080027#include <linux/input.h>
Doug Zongker7c3ae452013-05-14 11:03:02 -070028#include <stdarg.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080029#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
Doug Zongker23ceeea2010-07-08 17:27:55 -070032#include <sys/stat.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080033#include <sys/types.h>
Tao Baocdcf28f2016-01-13 15:05:20 -080034#include <sys/wait.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080035#include <unistd.h>
36
Tao Baoc4a18ef2017-02-10 00:13:30 -080037#include <algorithm>
Tao Bao3aec6962018-04-20 09:24:58 -070038#include <functional>
Tao Baoc4a18ef2017-02-10 00:13:30 -080039#include <memory>
Tao Bao862a4c12016-06-02 11:16:50 -070040#include <string>
41#include <vector>
Tao Bao04ca4262015-09-10 15:32:24 -070042
Elliott Hughes4b166f02015-12-04 15:30:20 -080043#include <android-base/file.h>
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -070044#include <android-base/logging.h>
Tianjie Xu3c62b672016-02-05 18:25:58 -080045#include <android-base/parseint.h>
Elliott Hughescb220402016-09-23 15:30:55 -070046#include <android-base/properties.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -080047#include <android-base/stringprintf.h>
Tao Bao862a4c12016-06-02 11:16:50 -070048#include <android-base/strings.h>
49#include <android-base/unique_fd.h>
Yabin Cui8b309f62016-06-24 18:22:02 -070050#include <bootloader_message/bootloader_message.h>
Elliott Hughescb220402016-09-23 15:30:55 -070051#include <cutils/properties.h> /* for property_list */
Yifan Hong056538c2018-07-11 17:04:12 -070052#include <healthhalutils/HealthHalUtils.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070053#include <ziparchive/zip_archive.h>
Yabin Cui99281df2016-02-17 12:21:52 -080054
Tao Bao75238632015-05-27 14:46:17 -070055#include "adb_install.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080056#include "common.h"
Tao Bao75238632015-05-27 14:46:17 -070057#include "device.h"
David Andersonedee8362018-05-16 13:43:22 -070058#include "fsck_unshare_blocks.h"
Tao Bao75238632015-05-27 14:46:17 -070059#include "fuse_sdcard_provider.h"
60#include "fuse_sideload.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080061#include "install.h"
Jerry Zhangcadf4ed2018-05-02 16:56:00 -070062#include "logging.h"
Tao Bao17054c02018-05-03 22:41:23 -070063#include "otautil/dirutil.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070064#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070065#include "otautil/paths.h"
Tao Bao2c526392018-05-03 23:01:13 -070066#include "otautil/sysutil.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080067#include "roots.h"
Doug Zongker211aebc2011-10-28 15:13:10 -070068#include "screen_ui.h"
Tianjie Xue113e4d2016-10-21 17:46:13 -070069#include "ui.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080070
Tao Baoaac9d9f2018-04-29 23:38:59 -070071static constexpr const char* CACHE_LOG_DIR = "/cache/recovery";
72static constexpr const char* COMMAND_FILE = "/cache/recovery/command";
Tao Baoaac9d9f2018-04-29 23:38:59 -070073static constexpr const char* LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
74static constexpr const char* LAST_LOG_FILE = "/cache/recovery/last_log";
75static constexpr const char* LOCALE_FILE = "/cache/recovery/last_locale";
Tianjie Xu06e57ac2016-07-11 14:04:08 -070076
Tao Baoaac9d9f2018-04-29 23:38:59 -070077static constexpr const char* CACHE_ROOT = "/cache";
78static constexpr const char* DATA_ROOT = "/data";
79static constexpr const char* METADATA_ROOT = "/metadata";
80static constexpr const char* SDCARD_ROOT = "/sdcard";
Nick Kralevicha9ad0322014-10-22 18:38:48 -070081
Tao Baobd0ddcd2017-05-04 13:03:18 -070082// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
83// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
84static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
85
Tao Baoac9d94d2016-11-03 11:37:15 -070086bool modified_flash = false;
Tao Baoa8d72bc2016-12-25 18:46:50 -080087std::string stage;
Tao Baoac9d94d2016-11-03 11:37:15 -070088const char* reason = nullptr;
Tao Baoac9d94d2016-11-03 11:37:15 -070089
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080090/*
91 * The recovery tool communicates with the main system through /cache files.
92 * /cache/recovery/command - INPUT - command line for tool, one arg per line
93 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080094 *
95 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -070096 * --update_package=path - verify install an OTA package file
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080097 * --wipe_data - erase user data (and cache), then reboot
Tao Baof9f17342018-04-27 10:44:04 -070098 * --prompt_and_wipe_data - prompt the user that data is corrupt, with their consent erase user
99 * data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800100 * --wipe_cache - wipe cache (but not user data), then reboot
Tao Baof9f17342018-04-27 10:44:04 -0700101 * --show_text - show the recovery text menu, used by some bootloader (e.g. http://b/36872519).
Oscar Montemayor05231562009-11-30 08:40:57 -0800102 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -0700103 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800104 *
105 * After completing, we remove /cache/recovery/command and reboot.
106 * Arguments may also be supplied in the bootloader control block (BCB).
107 * These important scenarios must be safely restartable at any point:
108 *
109 * FACTORY RESET
110 * 1. user selects "factory reset"
111 * 2. main system writes "--wipe_data" to /cache/recovery/command
112 * 3. main system reboots into recovery
113 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
114 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700115 * 5. erase_volume() reformats /data
116 * 6. erase_volume() reformats /cache
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800117 * 7. finish_recovery() erases BCB
118 * -- after this, rebooting will restart the main system --
119 * 8. main() calls reboot() to boot main system
120 *
121 * OTA INSTALL
122 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700123 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800124 * 3. main system reboots into recovery
125 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
126 * -- after this, rebooting will attempt to reinstall the update --
127 * 5. install_package() attempts to install the update
128 * NOTE: the package install must itself be restartable from any point
129 * 6. finish_recovery() erases BCB
130 * -- after this, rebooting will (try to) restart the main system --
131 * 7. ** if install failed **
132 * 7a. prompt_and_wait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800133 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800134 */
135
Elliott Hughesf14af802015-02-10 14:46:14 -0800136bool is_ro_debuggable() {
Elliott Hughescb220402016-09-23 15:30:55 -0700137 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800138}
139
Tao Bao2292db82016-12-13 21:53:31 -0800140// Set the BCB to reboot back into recovery (it won't resume the install from
141// sdcard though).
142static void set_sdcard_update_bootloader_message() {
143 std::vector<std::string> options;
144 std::string err;
145 if (!update_bootloader_message(options, &err)) {
146 LOG(ERROR) << "Failed to set BCB message: " << err;
147 }
Doug Zongker34c98df2009-08-18 12:05:45 -0700148}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800149
Tao Baoec579032017-07-21 12:13:15 -0700150// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700151// copy our log file to cache as well (for the system to read). This function is
152// idempotent: call it as many times as you like.
Tao Bao551d2c32018-05-09 20:53:13 -0700153static void finish_recovery() {
154 std::string locale = ui->GetLocale();
Tao Baoec579032017-07-21 12:13:15 -0700155 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
156 // (e.g., directly from the bootloader) it will use the last-known locale.
157 if (!locale.empty() && has_cache) {
158 LOG(INFO) << "Saving locale \"" << locale << "\"";
159 if (ensure_path_mounted(LOCALE_FILE) != 0) {
160 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
161 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
162 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700163 }
Tao Baoec579032017-07-21 12:13:15 -0700164 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700165
Jerry Zhangcadf4ed2018-05-02 16:56:00 -0700166 copy_logs(modified_flash, has_cache);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800167
Tao Baoec579032017-07-21 12:13:15 -0700168 // Reset to normal system boot so recovery won't cycle indefinitely.
169 std::string err;
170 if (!clear_bootloader_message(&err)) {
171 LOG(ERROR) << "Failed to clear BCB message: " << err;
172 }
173
174 // Remove the command file, so recovery won't repeat indefinitely.
175 if (has_cache) {
176 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
177 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700178 }
Tao Baoec579032017-07-21 12:13:15 -0700179 ensure_path_unmounted(CACHE_ROOT);
180 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800181
Tao Baoec579032017-07-21 12:13:15 -0700182 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800183}
184
Tao Bao3f5a3822016-12-13 11:14:37 -0800185struct saved_log_file {
186 std::string name;
187 struct stat sb;
188 std::string data;
189};
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700190
Elliott Hughes945548e2015-06-05 17:59:56 -0700191static bool erase_volume(const char* volume) {
Tao Bao3f5a3822016-12-13 11:14:37 -0800192 bool is_cache = (strcmp(volume, CACHE_ROOT) == 0);
193 bool is_data = (strcmp(volume, DATA_ROOT) == 0);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700194
Tao Bao3f5a3822016-12-13 11:14:37 -0800195 ui->SetBackground(RecoveryUI::ERASING);
196 ui->SetProgressType(RecoveryUI::INDETERMINATE);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700197
Tao Bao3f5a3822016-12-13 11:14:37 -0800198 std::vector<saved_log_file> log_files;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700199
Tao Bao3f5a3822016-12-13 11:14:37 -0800200 if (is_cache) {
201 // If we're reformatting /cache, we load any past logs
202 // (i.e. "/cache/recovery/last_*") and the current log
203 // ("/cache/recovery/log") into memory, so we can restore them after
204 // the reformat.
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700205
Tao Bao3f5a3822016-12-13 11:14:37 -0800206 ensure_path_mounted(volume);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700207
Tao Bao3f5a3822016-12-13 11:14:37 -0800208 struct dirent* de;
209 std::unique_ptr<DIR, decltype(&closedir)> d(opendir(CACHE_LOG_DIR), closedir);
210 if (d) {
211 while ((de = readdir(d.get())) != nullptr) {
212 if (strncmp(de->d_name, "last_", 5) == 0 || strcmp(de->d_name, "log") == 0) {
213 std::string path = android::base::StringPrintf("%s/%s", CACHE_LOG_DIR, de->d_name);
214
215 struct stat sb;
216 if (stat(path.c_str(), &sb) == 0) {
217 // truncate files to 512kb
218 if (sb.st_size > (1 << 19)) {
219 sb.st_size = 1 << 19;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700220 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800221
222 std::string data(sb.st_size, '\0');
Tianjie Xude6735e2017-07-10 15:13:33 -0700223 FILE* f = fopen(path.c_str(), "rbe");
Tao Bao3f5a3822016-12-13 11:14:37 -0800224 fread(&data[0], 1, data.size(), f);
225 fclose(f);
226
227 log_files.emplace_back(saved_log_file{ path, sb, data });
228 }
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700229 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800230 }
Paul Lawrenced0db3372015-11-05 13:38:40 -0800231 } else {
Tao Bao3f5a3822016-12-13 11:14:37 -0800232 if (errno != ENOENT) {
233 PLOG(ERROR) << "Failed to opendir " << CACHE_LOG_DIR;
234 }
Paul Lawrenced0db3372015-11-05 13:38:40 -0800235 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800236 }
Doug Zongkerd0181b82011-10-19 10:51:12 -0700237
Tao Bao3f5a3822016-12-13 11:14:37 -0800238 ui->Print("Formatting %s...\n", volume);
239
240 ensure_path_unmounted(volume);
241
242 int result;
Tao Bao3f5a3822016-12-13 11:14:37 -0800243 if (is_data && reason && strcmp(reason, "convert_fbe") == 0) {
Tao Bao406a6ff2018-04-30 10:05:57 -0700244 static constexpr const char* CONVERT_FBE_DIR = "/tmp/convert_fbe";
245 static constexpr const char* CONVERT_FBE_FILE = "/tmp/convert_fbe/convert_fbe";
246 // Create convert_fbe breadcrumb file to signal init to convert to file based encryption, not
247 // full disk encryption.
Tao Bao3f5a3822016-12-13 11:14:37 -0800248 if (mkdir(CONVERT_FBE_DIR, 0700) != 0) {
Tao Bao406a6ff2018-04-30 10:05:57 -0700249 PLOG(ERROR) << "Failed to mkdir " << CONVERT_FBE_DIR;
250 return false;
Tao Bao3f5a3822016-12-13 11:14:37 -0800251 }
Tianjie Xude6735e2017-07-10 15:13:33 -0700252 FILE* f = fopen(CONVERT_FBE_FILE, "wbe");
Tao Bao3f5a3822016-12-13 11:14:37 -0800253 if (!f) {
Tao Bao406a6ff2018-04-30 10:05:57 -0700254 PLOG(ERROR) << "Failed to convert to file encryption";
255 return false;
Tao Bao3f5a3822016-12-13 11:14:37 -0800256 }
257 fclose(f);
258 result = format_volume(volume, CONVERT_FBE_DIR);
259 remove(CONVERT_FBE_FILE);
260 rmdir(CONVERT_FBE_DIR);
261 } else {
262 result = format_volume(volume);
263 }
264
265 if (is_cache) {
266 // Re-create the log dir and write back the log entries.
267 if (ensure_path_mounted(CACHE_LOG_DIR) == 0 &&
Tao Baoac3d1ed2017-07-23 00:01:02 -0700268 mkdir_recursively(CACHE_LOG_DIR, 0777, false, sehandle) == 0) {
Tao Bao3f5a3822016-12-13 11:14:37 -0800269 for (const auto& log : log_files) {
270 if (!android::base::WriteStringToFile(log.data, log.name, log.sb.st_mode, log.sb.st_uid,
271 log.sb.st_gid)) {
272 PLOG(ERROR) << "Failed to write to " << log.name;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700273 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800274 }
275 } else {
276 PLOG(ERROR) << "Failed to mount / create " << CACHE_LOG_DIR;
Doug Zongker2c3539e2010-09-29 13:21:30 -0700277 }
278
Tao Bao3f5a3822016-12-13 11:14:37 -0800279 // Any part of the log we'd copied to cache is now gone.
280 // Reset the pointer so we copy from the beginning of the temp
281 // log.
Jerry Zhangcadf4ed2018-05-02 16:56:00 -0700282 reset_tmplog_offset();
283 copy_logs(modified_flash, has_cache);
Tao Bao3f5a3822016-12-13 11:14:37 -0800284 }
285
286 return (result == 0);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800287}
288
Hridya Valsarajue4ef4532018-08-31 11:57:51 -0700289// Sets the usb config to 'state'
290bool SetUsbConfig(const std::string& state) {
291 android::base::SetProperty("sys.usb.config", state);
292 return android::base::WaitForProperty("sys.usb.state", state);
293}
294
Tao Baoc4a18ef2017-02-10 00:13:30 -0800295// Returns the selected filename, or an empty string.
296static std::string browse_directory(const std::string& path, Device* device) {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800297 ensure_path_mounted(path);
Doug Zongker8674a722010-09-15 11:08:23 -0700298
Tao Baoc4a18ef2017-02-10 00:13:30 -0800299 std::unique_ptr<DIR, decltype(&closedir)> d(opendir(path.c_str()), closedir);
300 if (!d) {
301 PLOG(ERROR) << "error opening " << path;
302 return "";
303 }
Doug Zongkerc18eeb82010-09-21 16:49:26 -0700304
Tao Baoc4a18ef2017-02-10 00:13:30 -0800305 std::vector<std::string> dirs;
Tao Bao1fe1afe2018-05-01 15:56:05 -0700306 std::vector<std::string> entries{ "../" }; // "../" is always the first entry.
Tao Baoc4a18ef2017-02-10 00:13:30 -0800307
308 dirent* de;
309 while ((de = readdir(d.get())) != nullptr) {
310 std::string name(de->d_name);
311
312 if (de->d_type == DT_DIR) {
313 // Skip "." and ".." entries.
314 if (name == "." || name == "..") continue;
315 dirs.push_back(name + "/");
316 } else if (de->d_type == DT_REG && android::base::EndsWithIgnoreCase(name, ".zip")) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700317 entries.push_back(name);
Tao Baoc4a18ef2017-02-10 00:13:30 -0800318 }
319 }
320
321 std::sort(dirs.begin(), dirs.end());
Tao Bao1fe1afe2018-05-01 15:56:05 -0700322 std::sort(entries.begin(), entries.end());
Tao Baoc4a18ef2017-02-10 00:13:30 -0800323
Tao Bao1fe1afe2018-05-01 15:56:05 -0700324 // Append dirs to the entries list.
325 entries.insert(entries.end(), dirs.begin(), dirs.end());
Tao Baoc4a18ef2017-02-10 00:13:30 -0800326
Tao Bao1fe1afe2018-05-01 15:56:05 -0700327 std::vector<std::string> headers{ "Choose a package to install:", path };
Tao Baoc4a18ef2017-02-10 00:13:30 -0800328
Tao Bao1fe1afe2018-05-01 15:56:05 -0700329 size_t chosen_item = 0;
Tao Baoc4a18ef2017-02-10 00:13:30 -0800330 while (true) {
Tao Bao3aec6962018-04-20 09:24:58 -0700331 chosen_item = ui->ShowMenu(
332 headers, entries, chosen_item, true,
333 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Tao Baoc4a18ef2017-02-10 00:13:30 -0800334
Jerry Zhangb76af932018-05-22 12:08:35 -0700335 // Return if WaitKey() was interrupted.
336 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
337 return "";
338 }
339
Tao Bao1fe1afe2018-05-01 15:56:05 -0700340 const std::string& item = entries[chosen_item];
Tao Baoc4a18ef2017-02-10 00:13:30 -0800341 if (chosen_item == 0) {
342 // Go up but continue browsing (if the caller is browse_directory).
343 return "";
Doug Zongker8674a722010-09-15 11:08:23 -0700344 }
345
Tao Baoc4a18ef2017-02-10 00:13:30 -0800346 std::string new_path = path + "/" + item;
347 if (new_path.back() == '/') {
348 // Recurse down into a subdirectory.
349 new_path.pop_back();
350 std::string result = browse_directory(new_path, device);
351 if (!result.empty()) return result;
352 } else {
353 // Selected a zip file: return the path to the caller.
354 return new_path;
Doug Zongker8674a722010-09-15 11:08:23 -0700355 }
Tao Baoc4a18ef2017-02-10 00:13:30 -0800356 }
Doug Zongker8674a722010-09-15 11:08:23 -0700357
Tao Baoc4a18ef2017-02-10 00:13:30 -0800358 // Unreachable.
Doug Zongker8674a722010-09-15 11:08:23 -0700359}
360
Elliott Hughes30694c92015-03-25 15:16:51 -0700361static bool yes_no(Device* device, const char* question1, const char* question2) {
Tao Bao1fe1afe2018-05-01 15:56:05 -0700362 std::vector<std::string> headers{ question1, question2 };
363 std::vector<std::string> items{ " No", " Yes" };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700364
Tao Bao1fe1afe2018-05-01 15:56:05 -0700365 size_t chosen_item = ui->ShowMenu(
Tao Bao3aec6962018-04-20 09:24:58 -0700366 headers, items, 0, true,
367 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
368 return (chosen_item == 1);
Elliott Hughes30694c92015-03-25 15:16:51 -0700369}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800370
Paul Crowley08404b42016-12-19 13:04:23 -0800371static bool ask_to_wipe_data(Device* device) {
Tianjie Xu1a0a30a2018-10-25 15:22:07 -0700372 std::vector<std::string> headers{ "Wipe all user data?", " THIS CAN NOT BE UNDONE!" };
373 std::vector<std::string> items{ " Cancel", " Factory data reset" };
374
375 size_t chosen_item = ui->ShowPromptWipeDataConfirmationMenu(
376 headers, items,
377 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
378
379 return (chosen_item == 1);
Paul Crowley08404b42016-12-19 13:04:23 -0800380}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700381
Paul Crowley08404b42016-12-19 13:04:23 -0800382// Return true on success.
383static bool wipe_data(Device* device) {
Tao Bao682c34b2015-04-07 17:16:35 -0700384 modified_flash = true;
385
Doug Zongker211aebc2011-10-28 15:13:10 -0700386 ui->Print("\n-- Wiping data...\n");
Paul Crowley3b4d5162016-06-08 13:51:41 -0700387 bool success = device->PreWipeData();
388 if (success) {
389 success &= erase_volume(DATA_ROOT);
390 if (has_cache) {
391 success &= erase_volume(CACHE_ROOT);
392 }
393 if (volume_for_mount_point(METADATA_ROOT) != nullptr) {
394 success &= erase_volume(METADATA_ROOT);
395 }
396 }
397 if (success) {
398 success &= device->PostWipeData();
399 }
Elliott Hughes945548e2015-06-05 17:59:56 -0700400 ui->Print("Data wipe %s.\n", success ? "complete" : "failed");
401 return success;
Doug Zongkerf93d8162009-09-22 15:16:02 -0700402}
403
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700404static InstallResult prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700405 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tianjie Xub99e6062018-10-16 15:13:09 -0700406 std::vector<std::string> wipe_data_menu_headers{
Tao Bao2bbc6d62017-08-13 23:48:55 -0700407 "Can't load Android system. Your data may be corrupt. "
408 "If you continue to get this message, you may need to "
409 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700410 "stored on this device.",
Tao Baofc5499f2017-02-23 19:06:53 -0800411 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700412 // clang-format off
Tianjie Xub99e6062018-10-16 15:13:09 -0700413 std::vector<std::string> wipe_data_menu_items {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700414 "Try again",
415 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800416 };
Tao Bao1fe1afe2018-05-01 15:56:05 -0700417 // clang-format on
Tao Baofc5499f2017-02-23 19:06:53 -0800418 for (;;) {
Tianjie Xub99e6062018-10-16 15:13:09 -0700419 size_t chosen_item = ui->ShowPromptWipeDataMenu(
420 wipe_data_menu_headers, wipe_data_menu_items,
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 // If ShowMenu() returned RecoveryUI::KeyError::INTERRUPTED, WaitKey() was interrupted.
423 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700424 return INSTALL_KEY_INTERRUPTED;
Jerry Zhangb76af932018-05-22 12:08:35 -0700425 }
Tao Baofc5499f2017-02-23 19:06:53 -0800426 if (chosen_item != 1) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700427 return INSTALL_SUCCESS; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800428 }
Tianjie Xub99e6062018-10-16 15:13:09 -0700429
Tao Baofc5499f2017-02-23 19:06:53 -0800430 if (ask_to_wipe_data(device)) {
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -0700431 if (wipe_data(device)) {
432 return INSTALL_SUCCESS;
433 } else {
434 return INSTALL_ERROR;
435 }
Tao Baofc5499f2017-02-23 19:06:53 -0800436 }
437 }
Paul Crowley08404b42016-12-19 13:04:23 -0800438}
439
Tao Baoe39a9bc2015-03-31 12:19:05 -0700440// Return true on success.
441static bool wipe_cache(bool should_confirm, Device* device) {
Tao Bao26112e52016-02-25 12:29:40 -0800442 if (!has_cache) {
443 ui->Print("No /cache partition found.\n");
444 return false;
445 }
446
Elliott Hughes30694c92015-03-25 15:16:51 -0700447 if (should_confirm && !yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!")) {
Tao Baoe39a9bc2015-03-31 12:19:05 -0700448 return false;
Elliott Hughes30694c92015-03-25 15:16:51 -0700449 }
450
Tao Bao682c34b2015-04-07 17:16:35 -0700451 modified_flash = true;
452
Elliott Hughes30694c92015-03-25 15:16:51 -0700453 ui->Print("\n-- Wiping cache...\n");
Elliott Hughes945548e2015-06-05 17:59:56 -0700454 bool success = erase_volume("/cache");
455 ui->Print("Cache wipe %s.\n", success ? "complete" : "failed");
456 return success;
Elliott Hughes30694c92015-03-25 15:16:51 -0700457}
458
Tao Bao1b2a98b2017-03-24 10:45:34 -0700459// Secure-wipe a given partition. It uses BLKSECDISCARD, if supported. Otherwise, it goes with
460// BLKDISCARD (if device supports BLKDISCARDZEROES) or BLKZEROOUT.
Tao Bao862a4c12016-06-02 11:16:50 -0700461static bool secure_wipe_partition(const std::string& partition) {
Tao Bao1b2a98b2017-03-24 10:45:34 -0700462 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(partition.c_str(), O_WRONLY)));
463 if (fd == -1) {
464 PLOG(ERROR) << "Failed to open \"" << partition << "\"";
465 return false;
466 }
467
468 uint64_t range[2] = { 0, 0 };
469 if (ioctl(fd, BLKGETSIZE64, &range[1]) == -1 || range[1] == 0) {
470 PLOG(ERROR) << "Failed to get partition size";
471 return false;
472 }
473 LOG(INFO) << "Secure-wiping \"" << partition << "\" from " << range[0] << " to " << range[1];
474
475 LOG(INFO) << " Trying BLKSECDISCARD...";
476 if (ioctl(fd, BLKSECDISCARD, &range) == -1) {
477 PLOG(WARNING) << " Failed";
478
479 // Use BLKDISCARD if it zeroes out blocks, otherwise use BLKZEROOUT.
480 unsigned int zeroes;
481 if (ioctl(fd, BLKDISCARDZEROES, &zeroes) == 0 && zeroes != 0) {
482 LOG(INFO) << " Trying BLKDISCARD...";
483 if (ioctl(fd, BLKDISCARD, &range) == -1) {
484 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700485 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700486 }
487 } else {
488 LOG(INFO) << " Trying BLKZEROOUT...";
489 if (ioctl(fd, BLKZEROOUT, &range) == -1) {
490 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700491 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700492 }
Tao Bao862a4c12016-06-02 11:16:50 -0700493 }
Tao Bao1b2a98b2017-03-24 10:45:34 -0700494 }
Tao Bao862a4c12016-06-02 11:16:50 -0700495
Tao Bao1b2a98b2017-03-24 10:45:34 -0700496 LOG(INFO) << " Done";
497 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700498}
499
xunchange0d991c2019-03-05 14:50:51 -0800500static std::string ReadWipePackage(size_t wipe_package_size) {
501 if (wipe_package_size == 0) {
502 LOG(ERROR) << "wipe_package_size is zero";
503 return "";
504 }
505
506 std::string wipe_package;
507 std::string err_str;
508 if (!read_wipe_package(&wipe_package, wipe_package_size, &err_str)) {
509 PLOG(ERROR) << "Failed to read wipe package" << err_str;
510 return "";
511 }
512 return wipe_package;
513}
514
515// Checks if the wipe package matches expectation. If the check passes, reads the list of
516// partitions to wipe from the package. Checks include
Yabin Cuifd99a312016-06-09 14:09:39 -0700517// 1. verify the package.
518// 2. check metadata (ota-type, pre-device and serial number if having one).
xunchange0d991c2019-03-05 14:50:51 -0800519static bool CheckWipePackage(const std::string& wipe_package) {
520 if (!verify_package(reinterpret_cast<const unsigned char*>(wipe_package.data()),
521 wipe_package.size())) {
522 LOG(ERROR) << "Failed to verify package";
523 return false;
524 }
Yabin Cuifd99a312016-06-09 14:09:39 -0700525
xunchange0d991c2019-03-05 14:50:51 -0800526 // Extract metadata
527 ZipArchiveHandle zip;
528 if (auto err =
529 OpenArchiveFromMemory(const_cast<void*>(static_cast<const void*>(&wipe_package[0])),
530 wipe_package.size(), "wipe_package", &zip);
531 err != 0) {
532 LOG(ERROR) << "Can't open wipe package : " << ErrorCodeString(err);
533 return false;
534 }
535
536 std::map<std::string, std::string> metadata;
537 if (!ReadMetadataFromPackage(zip, &metadata)) {
538 LOG(ERROR) << "Failed to parse metadata in the zip file";
539 return false;
540 }
541
542 int result = CheckPackageMetadata(metadata, OtaType::BRICK);
543 CloseArchive(zip);
544
545 return result == 0;
546}
547
548std::vector<std::string> GetWipePartitionList(const std::string& wipe_package) {
549 ZipArchiveHandle zip;
550 if (auto err =
551 OpenArchiveFromMemory(const_cast<void*>(static_cast<const void*>(&wipe_package[0])),
552 wipe_package.size(), "wipe_package", &zip);
553 err != 0) {
554 LOG(ERROR) << "Can't open wipe package : " << ErrorCodeString(err);
555 return {};
556 }
557
558 static constexpr const char* RECOVERY_WIPE_ENTRY_NAME = "recovery.wipe";
559
560 std::string partition_list_content;
561 ZipString path(RECOVERY_WIPE_ENTRY_NAME);
562 ZipEntry entry;
563 if (FindEntry(zip, path, &entry) == 0) {
564 uint32_t length = entry.uncompressed_length;
565 partition_list_content = std::string(length, '\0');
566 if (auto err = ExtractToMemory(
567 zip, &entry, reinterpret_cast<uint8_t*>(partition_list_content.data()), length);
568 err != 0) {
569 LOG(ERROR) << "Failed to extract " << RECOVERY_WIPE_ENTRY_NAME << ": "
570 << ErrorCodeString(err);
571 CloseArchive(zip);
572 return {};
Yabin Cuifd99a312016-06-09 14:09:39 -0700573 }
xunchange0d991c2019-03-05 14:50:51 -0800574 } else {
575 LOG(INFO) << "Failed to find " << RECOVERY_WIPE_ENTRY_NAME
576 << ", falling back to use the partition list on device.";
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700577
xunchange0d991c2019-03-05 14:50:51 -0800578 static constexpr const char* RECOVERY_WIPE_ON_DEVICE = "/etc/recovery.wipe";
579 if (!android::base::ReadFileToString(RECOVERY_WIPE_ON_DEVICE, &partition_list_content)) {
580 PLOG(ERROR) << "failed to read \"" << RECOVERY_WIPE_ON_DEVICE << "\"";
581 CloseArchive(zip);
582 return {};
Yabin Cuifd99a312016-06-09 14:09:39 -0700583 }
xunchange0d991c2019-03-05 14:50:51 -0800584 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700585
xunchange0d991c2019-03-05 14:50:51 -0800586 std::vector<std::string> result;
587 std::vector<std::string> lines = android::base::Split(partition_list_content, "\n");
588 for (const std::string& line : lines) {
589 std::string partition = android::base::Trim(line);
590 // Ignore '#' comment or empty lines.
591 if (android::base::StartsWith(partition, "#") || partition.empty()) {
592 continue;
593 }
594 result.push_back(line);
595 }
Yabin Cuifd99a312016-06-09 14:09:39 -0700596
xunchange0d991c2019-03-05 14:50:51 -0800597 CloseArchive(zip);
598 return result;
Yabin Cuifd99a312016-06-09 14:09:39 -0700599}
600
Tao Baoaac9d9f2018-04-29 23:38:59 -0700601// Wipes the current A/B device, with a secure wipe of all the partitions in RECOVERY_WIPE.
Yabin Cuifd99a312016-06-09 14:09:39 -0700602static bool wipe_ab_device(size_t wipe_package_size) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700603 ui->SetBackground(RecoveryUI::ERASING);
604 ui->SetProgressType(RecoveryUI::INDETERMINATE);
Tao Bao862a4c12016-06-02 11:16:50 -0700605
xunchange0d991c2019-03-05 14:50:51 -0800606 std::string wipe_package = ReadWipePackage(wipe_package_size);
607 if (wipe_package.empty()) {
608 return false;
609 }
610
611 if (!CheckWipePackage(wipe_package)) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700612 LOG(ERROR) << "Failed to verify wipe package";
613 return false;
614 }
xunchange0d991c2019-03-05 14:50:51 -0800615
616 std::vector<std::string> partition_list = GetWipePartitionList(wipe_package);
617 if (partition_list.empty()) {
618 LOG(ERROR) << "Empty wipe ab partition list";
Tao Baoaac9d9f2018-04-29 23:38:59 -0700619 return false;
620 }
621
xunchange0d991c2019-03-05 14:50:51 -0800622 for (const auto& partition : partition_list) {
Tao Baoaac9d9f2018-04-29 23:38:59 -0700623 // Proceed anyway even if it fails to wipe some partition.
624 secure_wipe_partition(partition);
625 }
626 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700627}
628
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700629static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800630 std::vector<std::string> entries;
631 if (has_cache) {
632 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
633 auto add_to_entries = [&](const char* filename) {
634 std::string log_file(filename);
635 if (i > 0) {
636 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700637 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800638
Yifan Hongd81b8e32018-12-17 14:29:06 -0800639 if (ensure_path_mounted(log_file) == 0 && access(log_file.c_str(), R_OK) == 0) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800640 entries.push_back(std::move(log_file));
641 }
642 };
643
644 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
645 add_to_entries(LAST_LOG_FILE);
646
647 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
648 add_to_entries(LAST_KMSG_FILE);
649 }
650 } else {
651 // If cache partition is not found, view /tmp/recovery.log instead.
Tao Bao641fa972018-04-25 18:59:40 -0700652 if (access(Paths::Get().temporary_log_file().c_str(), R_OK) == -1) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800653 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700654 } else {
Tao Bao641fa972018-04-25 18:59:40 -0700655 entries.push_back(Paths::Get().temporary_log_file());
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700656 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800657 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700658
Tao Bao08fc6be2017-03-07 00:56:27 -0800659 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700660
Tao Bao1fe1afe2018-05-01 15:56:05 -0700661 std::vector<std::string> headers{ "Select file to view" };
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700662
Tao Bao1fe1afe2018-05-01 15:56:05 -0700663 size_t chosen_item = 0;
Tao Bao08fc6be2017-03-07 00:56:27 -0800664 while (true) {
Tao Bao3aec6962018-04-20 09:24:58 -0700665 chosen_item = ui->ShowMenu(
Tao Bao1fe1afe2018-05-01 15:56:05 -0700666 headers, entries, chosen_item, true,
Tao Bao3aec6962018-04-20 09:24:58 -0700667 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700668
669 // Handle WaitKey() interrupt.
670 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
671 break;
672 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800673 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700674
Tao Bao1d156b92018-05-02 12:43:18 -0700675 ui->ShowFile(entries[chosen_item]);
Tao Bao08fc6be2017-03-07 00:56:27 -0800676 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700677}
678
Tao Baodb7e8982017-03-06 23:53:16 -0800679static void run_graphics_test() {
680 // Switch to graphics screen.
681 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700682
Tao Baodb7e8982017-03-06 23:53:16 -0800683 ui->SetProgressType(RecoveryUI::INDETERMINATE);
684 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
685 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700686
Tao Baodb7e8982017-03-06 23:53:16 -0800687 ui->SetBackground(RecoveryUI::ERROR);
688 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700689
Tao Baodb7e8982017-03-06 23:53:16 -0800690 ui->SetBackground(RecoveryUI::NO_COMMAND);
691 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700692
Tao Baodb7e8982017-03-06 23:53:16 -0800693 ui->SetBackground(RecoveryUI::ERASING);
694 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700695
Tao Baodb7e8982017-03-06 23:53:16 -0800696 // Calling SetBackground() after SetStage() to trigger a redraw.
697 ui->SetStage(1, 3);
698 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
699 sleep(1);
700 ui->SetStage(2, 3);
701 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
702 sleep(1);
703 ui->SetStage(3, 3);
704 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
705 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -0700706
Tao Baodb7e8982017-03-06 23:53:16 -0800707 ui->SetStage(-1, -1);
708 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -0700709
Tao Baodb7e8982017-03-06 23:53:16 -0800710 ui->SetProgressType(RecoveryUI::DETERMINATE);
711 ui->ShowProgress(1.0, 10.0);
712 float fraction = 0.0;
713 for (size_t i = 0; i < 100; ++i) {
714 fraction += .01;
715 ui->SetProgress(fraction);
716 usleep(100000);
717 }
718
719 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -0700720}
721
Tao Baocdcf28f2016-01-13 15:05:20 -0800722// How long (in seconds) we wait for the fuse-provided package file to
723// appear, before timing out.
724#define SDCARD_INSTALL_TIMEOUT 10
725
Tao Bao145d8612015-03-25 15:51:15 -0700726static int apply_from_sdcard(Device* device, bool* wipe_cache) {
Tao Bao682c34b2015-04-07 17:16:35 -0700727 modified_flash = true;
728
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000729 if (ensure_path_mounted(SDCARD_ROOT) != 0) {
730 ui->Print("\n-- Couldn't mount %s.\n", SDCARD_ROOT);
731 return INSTALL_ERROR;
732 }
733
Tao Baoc4a18ef2017-02-10 00:13:30 -0800734 std::string path = browse_directory(SDCARD_ROOT, device);
735 if (path.empty()) {
Elliott Hughes018ed312015-04-08 16:51:36 -0700736 ui->Print("\n-- No package file selected.\n");
caozhiyuanb4effb92015-06-10 16:46:38 +0800737 ensure_path_unmounted(SDCARD_ROOT);
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000738 return INSTALL_ERROR;
739 }
740
Tao Baoc4a18ef2017-02-10 00:13:30 -0800741 ui->Print("\n-- Install %s ...\n", path.c_str());
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000742 set_sdcard_update_bootloader_message();
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000743
Tao Baocdcf28f2016-01-13 15:05:20 -0800744 // We used to use fuse in a thread as opposed to a process. Since accessing
745 // through fuse involves going from kernel to userspace to kernel, it leads
746 // to deadlock when a page fault occurs. (Bug: 26313124)
747 pid_t child;
748 if ((child = fork()) == 0) {
Tao Baoc4a18ef2017-02-10 00:13:30 -0800749 bool status = start_sdcard_fuse(path.c_str());
Tao Baocdcf28f2016-01-13 15:05:20 -0800750
751 _exit(status ? EXIT_SUCCESS : EXIT_FAILURE);
752 }
753
754 // FUSE_SIDELOAD_HOST_PATHNAME will start to exist once the fuse in child
755 // process is ready.
756 int result = INSTALL_ERROR;
757 int status;
758 bool waited = false;
759 for (int i = 0; i < SDCARD_INSTALL_TIMEOUT; ++i) {
760 if (waitpid(child, &status, WNOHANG) == -1) {
761 result = INSTALL_ERROR;
762 waited = true;
763 break;
764 }
765
766 struct stat sb;
767 if (stat(FUSE_SIDELOAD_HOST_PATHNAME, &sb) == -1) {
768 if (errno == ENOENT && i < SDCARD_INSTALL_TIMEOUT-1) {
769 sleep(1);
770 continue;
771 } else {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700772 LOG(ERROR) << "Timed out waiting for the fuse-provided package.";
Tao Baocdcf28f2016-01-13 15:05:20 -0800773 result = INSTALL_ERROR;
774 kill(child, SIGKILL);
775 break;
776 }
777 }
778
Tao Bao641fa972018-04-25 18:59:40 -0700779 result = install_package(FUSE_SIDELOAD_HOST_PATHNAME, wipe_cache, false, 0 /*retry_count*/);
Tao Baocdcf28f2016-01-13 15:05:20 -0800780 break;
781 }
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000782
Tao Baocdcf28f2016-01-13 15:05:20 -0800783 if (!waited) {
784 // Calling stat() on this magic filename signals the fuse
785 // filesystem to shut down.
786 struct stat sb;
787 stat(FUSE_SIDELOAD_HOST_EXIT_PATHNAME, &sb);
788
789 waitpid(child, &status, 0);
790 }
791
792 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700793 LOG(ERROR) << "Error exit from the fuse process: " << WEXITSTATUS(status);
Tao Baocdcf28f2016-01-13 15:05:20 -0800794 }
795
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000796 ensure_path_unmounted(SDCARD_ROOT);
Tao Baocdcf28f2016-01-13 15:05:20 -0800797 return result;
Christian Poetzsch4ec58a42015-02-19 10:42:39 +0000798}
799
Tao Bao50dd5322017-03-07 14:57:04 -0800800// Returns REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default,
801// which is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
802static Device::BuiltinAction prompt_and_wait(Device* device, int status) {
803 for (;;) {
Tao Bao551d2c32018-05-09 20:53:13 -0700804 finish_recovery();
Tao Bao50dd5322017-03-07 14:57:04 -0800805 switch (status) {
806 case INSTALL_SUCCESS:
807 case INSTALL_NONE:
808 ui->SetBackground(RecoveryUI::NO_COMMAND);
809 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -0700810
Tao Bao50dd5322017-03-07 14:57:04 -0800811 case INSTALL_ERROR:
812 case INSTALL_CORRUPT:
813 ui->SetBackground(RecoveryUI::ERROR);
814 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800815 }
Tao Bao50dd5322017-03-07 14:57:04 -0800816 ui->SetProgressType(RecoveryUI::EMPTY);
817
Tao Bao1fe1afe2018-05-01 15:56:05 -0700818 size_t chosen_item = ui->ShowMenu(
819 {}, device->GetMenuItems(), 0, false,
Tao Bao3aec6962018-04-20 09:24:58 -0700820 std::bind(&Device::HandleMenuKey, device, std::placeholders::_1, std::placeholders::_2));
Jerry Zhangb76af932018-05-22 12:08:35 -0700821 // Handle Interrupt key
822 if (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::INTERRUPTED)) {
823 return Device::KEY_INTERRUPTED;
824 }
Tao Bao50dd5322017-03-07 14:57:04 -0800825 // Device-specific code may take some action here. It may return one of the core actions
826 // handled in the switch statement below.
Jerry Zhangb76af932018-05-22 12:08:35 -0700827 Device::BuiltinAction chosen_action =
828 (chosen_item == static_cast<size_t>(RecoveryUI::KeyError::TIMED_OUT))
829 ? Device::REBOOT
830 : device->InvokeMenuItem(chosen_item);
Tao Bao50dd5322017-03-07 14:57:04 -0800831
832 bool should_wipe_cache = false;
833 switch (chosen_action) {
834 case Device::NO_ACTION:
835 break;
836
837 case Device::REBOOT:
838 case Device::SHUTDOWN:
839 case Device::REBOOT_BOOTLOADER:
Hridya Valsaraju20c81b32018-07-27 22:09:12 -0700840 case Device::ENTER_FASTBOOT:
841 case Device::ENTER_RECOVERY:
Tao Bao50dd5322017-03-07 14:57:04 -0800842 return chosen_action;
843
844 case Device::WIPE_DATA:
845 if (ui->IsTextVisible()) {
846 if (ask_to_wipe_data(device)) {
847 wipe_data(device);
848 }
849 } else {
850 wipe_data(device);
851 return Device::NO_ACTION;
852 }
853 break;
854
855 case Device::WIPE_CACHE:
856 wipe_cache(ui->IsTextVisible(), device);
857 if (!ui->IsTextVisible()) return Device::NO_ACTION;
858 break;
859
860 case Device::APPLY_ADB_SIDELOAD:
861 case Device::APPLY_SDCARD:
862 {
863 bool adb = (chosen_action == Device::APPLY_ADB_SIDELOAD);
864 if (adb) {
Tao Bao641fa972018-04-25 18:59:40 -0700865 status = apply_from_adb(&should_wipe_cache);
Tao Bao50dd5322017-03-07 14:57:04 -0800866 } else {
867 status = apply_from_sdcard(device, &should_wipe_cache);
868 }
869
870 if (status == INSTALL_SUCCESS && should_wipe_cache) {
871 if (!wipe_cache(false, device)) {
872 status = INSTALL_ERROR;
873 }
874 }
875
876 if (status != INSTALL_SUCCESS) {
877 ui->SetBackground(RecoveryUI::ERROR);
878 ui->Print("Installation aborted.\n");
Jerry Zhangcadf4ed2018-05-02 16:56:00 -0700879 copy_logs(modified_flash, has_cache);
Tao Bao50dd5322017-03-07 14:57:04 -0800880 } else if (!ui->IsTextVisible()) {
881 return Device::NO_ACTION; // reboot if logs aren't visible
882 } else {
883 ui->Print("\nInstall from %s complete.\n", adb ? "ADB" : "SD card");
884 }
885 }
886 break;
887
888 case Device::VIEW_RECOVERY_LOGS:
889 choose_recovery_file(device);
890 break;
891
892 case Device::RUN_GRAPHICS_TEST:
893 run_graphics_test();
894 break;
895
Tianjie Xu29d55752017-09-20 17:53:46 -0700896 case Device::RUN_LOCALE_TEST: {
897 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
Tao Bao39c49182018-05-07 22:50:33 -0700898 screen_ui->CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700899 break;
900 }
Tao Bao50dd5322017-03-07 14:57:04 -0800901 case Device::MOUNT_SYSTEM:
Jiyong Park8b7af4c2018-06-01 11:58:54 +0900902 // the system partition is mounted at /mnt/system
Yifan Hongd81b8e32018-12-17 14:29:06 -0800903 if (ensure_path_mounted_at(get_system_root(), "/mnt/system") != -1) {
Yifan Hong49327802018-11-26 14:59:09 -0800904 ui->Print("Mounted /system.\n");
Tao Bao50dd5322017-03-07 14:57:04 -0800905 }
906 break;
Jerry Zhangb76af932018-05-22 12:08:35 -0700907
908 case Device::KEY_INTERRUPTED:
909 return Device::KEY_INTERRUPTED;
Tao Bao50dd5322017-03-07 14:57:04 -0800910 }
911 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800912}
913
Tao Bao99f0d9e2016-10-13 12:46:38 -0700914static void print_property(const char* key, const char* name, void* /* cookie */) {
915 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800916}
917
Tao Baoac9d94d2016-11-03 11:37:15 -0700918void ui_print(const char* format, ...) {
919 std::string buffer;
Doug Zongker7c3ae452013-05-14 11:03:02 -0700920 va_list ap;
921 va_start(ap, format);
Tao Baoac9d94d2016-11-03 11:37:15 -0700922 android::base::StringAppendV(&buffer, format, ap);
Doug Zongker7c3ae452013-05-14 11:03:02 -0700923 va_end(ap);
924
Tao Baoac9d94d2016-11-03 11:37:15 -0700925 if (ui != nullptr) {
926 ui->Print("%s", buffer.c_str());
Doug Zongker7c3ae452013-05-14 11:03:02 -0700927 } else {
Tao Baoac9d94d2016-11-03 11:37:15 -0700928 fputs(buffer.c_str(), stdout);
Doug Zongker7c3ae452013-05-14 11:03:02 -0700929 }
930}
931
Tao Bao6d90a9d2018-04-26 10:40:36 -0700932static bool is_battery_ok(int* required_battery_level) {
Yifan Honge8e4c402017-11-08 14:56:03 -0800933 using android::hardware::health::V1_0::BatteryStatus;
Yifan Hong056538c2018-07-11 17:04:12 -0700934 using android::hardware::health::V2_0::get_health_service;
935 using android::hardware::health::V2_0::IHealth;
Yifan Honge8e4c402017-11-08 14:56:03 -0800936 using android::hardware::health::V2_0::Result;
937 using android::hardware::health::V2_0::toString;
Yabin Cui99281df2016-02-17 12:21:52 -0800938
Yifan Hong056538c2018-07-11 17:04:12 -0700939 android::sp<IHealth> health = get_health_service();
Yifan Honge8e4c402017-11-08 14:56:03 -0800940
Tao Bao6d90a9d2018-04-26 10:40:36 -0700941 static constexpr int BATTERY_READ_TIMEOUT_IN_SEC = 10;
Yifan Honge8e4c402017-11-08 14:56:03 -0800942 int wait_second = 0;
943 while (true) {
944 auto charge_status = BatteryStatus::UNKNOWN;
Yifan Hong056538c2018-07-11 17:04:12 -0700945
946 if (health == nullptr) {
947 LOG(WARNING) << "no health implementation is found, assuming defaults";
948 } else {
949 health
950 ->getChargeStatus([&charge_status](auto res, auto out_status) {
951 if (res == Result::SUCCESS) {
952 charge_status = out_status;
953 }
954 })
955 .isOk(); // should not have transport error
956 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800957
958 // Treat unknown status as charged.
959 bool charged = (charge_status != BatteryStatus::DISCHARGING &&
960 charge_status != BatteryStatus::NOT_CHARGING);
961
962 Result res = Result::UNKNOWN;
963 int32_t capacity = INT32_MIN;
Yifan Hong056538c2018-07-11 17:04:12 -0700964 if (health != nullptr) {
965 health
966 ->getCapacity([&res, &capacity](auto out_res, auto out_capacity) {
967 res = out_res;
968 capacity = out_capacity;
969 })
970 .isOk(); // should not have transport error
971 }
Yifan Honge8e4c402017-11-08 14:56:03 -0800972
Yifan Hong056538c2018-07-11 17:04:12 -0700973 LOG(INFO) << "charge_status " << toString(charge_status) << ", charged " << charged
974 << ", status " << toString(res) << ", capacity " << capacity;
Yifan Honge8e4c402017-11-08 14:56:03 -0800975 // At startup, the battery drivers in devices like N5X/N6P take some time to load
976 // the battery profile. Before the load finishes, it reports value 50 as a fake
977 // capacity. BATTERY_READ_TIMEOUT_IN_SEC is set that the battery drivers are expected
978 // to finish loading the battery profile earlier than 10 seconds after kernel startup.
979 if (res == Result::SUCCESS && capacity == 50) {
980 if (wait_second < BATTERY_READ_TIMEOUT_IN_SEC) {
981 sleep(1);
982 wait_second++;
983 continue;
984 }
985 }
986 // If we can't read battery percentage, it may be a device without battery. In this
987 // situation, use 100 as a fake battery percentage.
988 if (res != Result::SUCCESS) {
989 capacity = 100;
990 }
Tao Bao6d90a9d2018-04-26 10:40:36 -0700991
992 // GmsCore enters recovery mode to install package when having enough battery percentage.
993 // Normally, the threshold is 40% without charger and 20% with charger. So we should check
994 // battery with a slightly lower limitation.
995 static constexpr int BATTERY_OK_PERCENTAGE = 20;
996 static constexpr int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
997 *required_battery_level = charged ? BATTERY_WITH_CHARGER_OK_PERCENTAGE : BATTERY_OK_PERCENTAGE;
998 return capacity >= *required_battery_level;
999 }
Yabin Cui99281df2016-02-17 12:21:52 -08001000}
1001
Tianjie Xu99b73be2017-11-28 17:23:06 -08001002// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -07001003static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
1004 std::vector<std::string> options;
1005 for (const auto& arg : args) {
1006 if (!android::base::StartsWith(arg, "--retry_count")) {
1007 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -08001008 }
Tianjie Xu72449c92017-05-16 18:07:31 -07001009 }
Tianjie Xu3c62b672016-02-05 18:25:58 -08001010
Tianjie Xu99b73be2017-11-28 17:23:06 -08001011 // Update the retry counter in BCB.
1012 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -07001013 std::string err;
1014 if (!update_bootloader_message(options, &err)) {
1015 LOG(ERROR) << err;
1016 }
Tianjie Xu3c62b672016-02-05 18:25:58 -08001017}
1018
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001019static bool bootreason_in_blacklist() {
Tao Baoefc35592017-01-08 22:45:47 -08001020 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
1021 if (!bootreason.empty()) {
Tao Baoaac9d9f2018-04-29 23:38:59 -07001022 // More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
1023 static const std::vector<std::string> kBootreasonBlacklist{
1024 "kernel_panic",
1025 "Panic",
1026 };
1027 for (const auto& str : kBootreasonBlacklist) {
1028 if (android::base::EqualsIgnoreCase(str, bootreason)) return true;
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001029 }
Tao Baoefc35592017-01-08 22:45:47 -08001030 }
1031 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001032}
1033
Tao Bao641fa972018-04-25 18:59:40 -07001034static void log_failure_code(ErrorCode code, const std::string& update_package) {
1035 std::vector<std::string> log_buffer = {
1036 update_package,
1037 "0", // install result
1038 "error: " + std::to_string(code),
1039 };
1040 std::string log_content = android::base::Join(log_buffer, "\n");
1041 const std::string& install_file = Paths::Get().temporary_install_file();
1042 if (!android::base::WriteStringToFile(log_content, install_file)) {
1043 PLOG(ERROR) << "Failed to write " << install_file;
1044 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001045
Tao Bao641fa972018-04-25 18:59:40 -07001046 // Also write the info into last_log.
1047 LOG(INFO) << log_content;
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001048}
1049
Jerry Zhang6a648042018-05-04 11:24:10 -07001050Device::BuiltinAction start_recovery(Device* device, const std::vector<std::string>& args) {
Tao Baof9f17342018-04-27 10:44:04 -07001051 static constexpr struct option OPTIONS[] = {
Hridya Valsaraju20c81b32018-07-27 22:09:12 -07001052 { "fastboot", no_argument, nullptr, 0 },
David Andersonedee8362018-05-16 13:43:22 -07001053 { "fsck_unshare_blocks", no_argument, nullptr, 0 },
Tao Baof9f17342018-04-27 10:44:04 -07001054 { "just_exit", no_argument, nullptr, 'x' },
1055 { "locale", required_argument, nullptr, 0 },
1056 { "prompt_and_wipe_data", no_argument, nullptr, 0 },
1057 { "reason", required_argument, nullptr, 0 },
1058 { "retry_count", required_argument, nullptr, 0 },
1059 { "security", no_argument, nullptr, 0 },
1060 { "show_text", no_argument, nullptr, 't' },
1061 { "shutdown_after", no_argument, nullptr, 0 },
1062 { "sideload", no_argument, nullptr, 0 },
1063 { "sideload_auto_reboot", no_argument, nullptr, 0 },
1064 { "update_package", required_argument, nullptr, 0 },
1065 { "wipe_ab", no_argument, nullptr, 0 },
1066 { "wipe_cache", no_argument, nullptr, 0 },
1067 { "wipe_data", no_argument, nullptr, 0 },
1068 { "wipe_package_size", required_argument, nullptr, 0 },
1069 { nullptr, 0, nullptr, 0 },
1070 };
1071
Tianjie Xu99b73be2017-11-28 17:23:06 -08001072 const char* update_package = nullptr;
1073 bool should_wipe_data = false;
1074 bool should_prompt_and_wipe_data = false;
1075 bool should_wipe_cache = false;
1076 bool should_wipe_ab = false;
1077 size_t wipe_package_size = 0;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001078 bool sideload = false;
1079 bool sideload_auto_reboot = false;
1080 bool just_exit = false;
1081 bool shutdown_after = false;
David Andersonedee8362018-05-16 13:43:22 -07001082 bool fsck_unshare_blocks = false;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001083 int retry_count = 0;
1084 bool security_update = false;
Jerry Zhang2dea53e2018-05-02 17:15:03 -07001085 std::string locale;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001086
Tao Bao1700cc42018-07-16 22:09:59 -07001087 auto args_to_parse = StringVectorToNullTerminatedArray(args);
1088
Tianjie Xu99b73be2017-11-28 17:23:06 -08001089 int arg;
1090 int option_index;
Tao Bao1700cc42018-07-16 22:09:59 -07001091 // Parse everything before the last element (which must be a nullptr). getopt_long(3) expects a
1092 // null-terminated char* array, but without counting null as an arg (i.e. argv[argc] should be
1093 // nullptr).
1094 while ((arg = getopt_long(args_to_parse.size() - 1, args_to_parse.data(), "", OPTIONS,
Tianjie Xu99b73be2017-11-28 17:23:06 -08001095 &option_index)) != -1) {
1096 switch (arg) {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001097 case 't':
Jerry Zhang6a648042018-05-04 11:24:10 -07001098 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -08001099 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001100 case 'x':
1101 just_exit = true;
1102 break;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001103 case 0: {
1104 std::string option = OPTIONS[option_index].name;
David Andersonedee8362018-05-16 13:43:22 -07001105 if (option == "fsck_unshare_blocks") {
1106 fsck_unshare_blocks = true;
Hridya Valsaraju20c81b32018-07-27 22:09:12 -07001107 } else if (option == "locale" || option == "fastboot") {
Jerry Zhang6a648042018-05-04 11:24:10 -07001108 // Handled in recovery_main.cpp
Tianjie Xu99b73be2017-11-28 17:23:06 -08001109 } else if (option == "prompt_and_wipe_data") {
1110 should_prompt_and_wipe_data = true;
Tao Baof9f17342018-04-27 10:44:04 -07001111 } else if (option == "reason") {
1112 reason = optarg;
1113 } else if (option == "retry_count") {
1114 android::base::ParseInt(optarg, &retry_count, 0);
1115 } else if (option == "security") {
1116 security_update = true;
1117 } else if (option == "sideload") {
1118 sideload = true;
1119 } else if (option == "sideload_auto_reboot") {
1120 sideload = true;
1121 sideload_auto_reboot = true;
1122 } else if (option == "shutdown_after") {
1123 shutdown_after = true;
1124 } else if (option == "update_package") {
1125 update_package = optarg;
1126 } else if (option == "wipe_ab") {
1127 should_wipe_ab = true;
1128 } else if (option == "wipe_cache") {
1129 should_wipe_cache = true;
1130 } else if (option == "wipe_data") {
1131 should_wipe_data = true;
1132 } else if (option == "wipe_package_size") {
1133 android::base::ParseUint(optarg, &wipe_package_size);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001134 }
1135 break;
1136 }
1137 case '?':
1138 LOG(ERROR) << "Invalid command argument";
1139 continue;
Doug Zongker9270a202012-01-09 15:16:13 -08001140 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001141 }
Jerry Zhang49fd5d22018-05-17 12:54:41 -07001142 optind = 1;
Doug Zongker9270a202012-01-09 15:16:13 -08001143
Tianjie Xu99b73be2017-11-28 17:23:06 -08001144 printf("stage is [%s]\n", stage.c_str());
1145 printf("reason is [%s]\n", reason);
Doug Zongker02ec6b82012-08-22 17:26:40 -07001146
Tianjie Xu99b73be2017-11-28 17:23:06 -08001147 // Set background string to "installing security update" for security update,
1148 // otherwise set it to "installing system update".
1149 ui->SetSystemUpdateText(security_update);
1150
1151 int st_cur, st_max;
1152 if (!stage.empty() && sscanf(stage.c_str(), "%d/%d", &st_cur, &st_max) == 2) {
1153 ui->SetStage(st_cur, st_max);
1154 }
1155
Jerry Zhang0e577ee2018-05-07 11:21:10 -07001156 std::vector<std::string> title_lines =
1157 android::base::Split(android::base::GetProperty("ro.bootimage.build.fingerprint", ""), ":");
1158 title_lines.insert(std::begin(title_lines), "Android Recovery");
1159 ui->SetTitle(title_lines);
1160
Jerry Zhangb76af932018-05-22 12:08:35 -07001161 ui->ResetKeyInterruptStatus();
Tianjie Xu99b73be2017-11-28 17:23:06 -08001162 device->StartRecovery();
1163
1164 printf("Command:");
1165 for (const auto& arg : args) {
1166 printf(" \"%s\"", arg.c_str());
1167 }
1168 printf("\n\n");
1169
1170 property_list(print_property, nullptr);
1171 printf("\n");
1172
1173 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
1174
1175 int status = INSTALL_SUCCESS;
1176
1177 if (update_package != nullptr) {
1178 // It's not entirely true that we will modify the flash. But we want
1179 // to log the update attempt since update_package is non-NULL.
1180 modified_flash = true;
1181
Tao Bao6d90a9d2018-04-26 10:40:36 -07001182 int required_battery_level;
1183 if (retry_count == 0 && !is_battery_ok(&required_battery_level)) {
1184 ui->Print("battery capacity is not enough for installing package: %d%% needed\n",
1185 required_battery_level);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001186 // Log the error code to last_install when installation skips due to
1187 // low battery.
1188 log_failure_code(kLowBattery, update_package);
1189 status = INSTALL_SKIPPED;
Tianjie Xua6f49bd2018-03-26 14:32:11 -07001190 } else if (retry_count == 0 && bootreason_in_blacklist()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001191 // Skip update-on-reboot when bootreason is kernel_panic or similar
1192 ui->Print("bootreason is in the blacklist; skip OTA installation\n");
1193 log_failure_code(kBootreasonInBlacklist, update_package);
1194 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -07001195 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001196 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
1197 // identify the interrupted update due to unexpected reboots.
1198 if (retry_count == 0) {
1199 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -07001200 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001201
Tao Bao641fa972018-04-25 18:59:40 -07001202 status = install_package(update_package, &should_wipe_cache, true, retry_count);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001203 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1204 wipe_cache(false, device);
1205 }
1206 if (status != INSTALL_SUCCESS) {
1207 ui->Print("Installation aborted.\n");
Tao Baoaac9d9f2018-04-29 23:38:59 -07001208
1209 // When I/O error or bspatch/imgpatch error happens, reboot and retry installation
1210 // RETRY_LIMIT times before we abandon this OTA update.
1211 static constexpr int RETRY_LIMIT = 4;
Tianjie Xu99b73be2017-11-28 17:23:06 -08001212 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
Jerry Zhangcadf4ed2018-05-02 16:56:00 -07001213 copy_logs(modified_flash, has_cache);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001214 retry_count += 1;
1215 set_retry_bootloader_message(retry_count, args);
1216 // Print retry count on screen.
1217 ui->Print("Retry attempt %d\n", retry_count);
1218
1219 // Reboot and retry the update
1220 if (!reboot("reboot,recovery")) {
1221 ui->Print("Reboot failed\n");
1222 } else {
1223 while (true) {
1224 pause();
1225 }
1226 }
Tianjie Xud9d16292017-04-20 18:08:21 -07001227 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001228 // If this is an eng or userdebug build, then automatically
1229 // turn the text display on if the script fails so the error
1230 // message is visible.
1231 if (is_ro_debuggable()) {
1232 ui->ShowText(true);
Tao Baoc679f932015-03-30 09:43:49 -07001233 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001234 }
Doug Zongker8674a722010-09-15 11:08:23 -07001235 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001236 } else if (should_wipe_data) {
1237 if (!wipe_data(device)) {
1238 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -07001239 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001240 } else if (should_prompt_and_wipe_data) {
Tao Baoa5bbcb92018-09-17 14:32:47 -07001241 // Trigger the logging to capture the cause, even if user chooses to not wipe data.
1242 modified_flash = true;
1243
Tianjie Xu99b73be2017-11-28 17:23:06 -08001244 ui->ShowText(true);
1245 ui->SetBackground(RecoveryUI::ERROR);
Hridya Valsarajueb6f13a2018-09-12 10:25:01 -07001246 status = prompt_and_wipe_data(device);
1247 if (status != INSTALL_KEY_INTERRUPTED) {
1248 ui->ShowText(false);
Tao Bao75238632015-05-27 14:46:17 -07001249 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001250 } else if (should_wipe_cache) {
1251 if (!wipe_cache(false, device)) {
1252 status = INSTALL_ERROR;
1253 }
1254 } else if (should_wipe_ab) {
1255 if (!wipe_ab_device(wipe_package_size)) {
1256 status = INSTALL_ERROR;
1257 }
1258 } else if (sideload) {
1259 // 'adb reboot sideload' acts the same as user presses key combinations
1260 // to enter the sideload mode. When 'sideload-auto-reboot' is used, text
1261 // display will NOT be turned on by default. And it will reboot after
1262 // sideload finishes even if there are errors. Unless one turns on the
1263 // text display during the installation. This is to enable automated
1264 // testing.
1265 if (!sideload_auto_reboot) {
1266 ui->ShowText(true);
1267 }
Tao Bao641fa972018-04-25 18:59:40 -07001268 status = apply_from_adb(&should_wipe_cache);
Tianjie Xu99b73be2017-11-28 17:23:06 -08001269 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1270 if (!wipe_cache(false, device)) {
1271 status = INSTALL_ERROR;
1272 }
1273 }
1274 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
1275 if (sideload_auto_reboot) {
1276 ui->Print("Rebooting automatically.\n");
1277 }
David Andersonedee8362018-05-16 13:43:22 -07001278 } else if (fsck_unshare_blocks) {
1279 if (!do_fsck_unshare_blocks()) {
1280 status = INSTALL_ERROR;
1281 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001282 } else if (!just_exit) {
1283 // If this is an eng or userdebug build, automatically turn on the text display if no command
1284 // is specified. Note that this should be called before setting the background to avoid
1285 // flickering the background image.
1286 if (is_ro_debuggable()) {
1287 ui->ShowText(true);
1288 }
1289 status = INSTALL_NONE; // No command specified
1290 ui->SetBackground(RecoveryUI::NO_COMMAND);
1291 }
1292
1293 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
1294 ui->SetBackground(RecoveryUI::ERROR);
1295 if (!ui->IsTextVisible()) {
1296 sleep(5);
1297 }
1298 }
1299
1300 Device::BuiltinAction after = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
1301 // 1. If the recovery menu is visible, prompt and wait for commands.
1302 // 2. If the state is INSTALL_NONE, wait for commands. (i.e. In user build, manually reboot into
1303 // recovery to sideload a package.)
1304 // 3. sideload_auto_reboot is an option only available in user-debug build, reboot the device
1305 // without waiting.
1306 // 4. In all other cases, reboot the device. Therefore, normal users will observe the device
1307 // reboot after it shows the "error" screen for 5s.
1308 if ((status == INSTALL_NONE && !sideload_auto_reboot) || ui->IsTextVisible()) {
1309 Device::BuiltinAction temp = prompt_and_wait(device, status);
1310 if (temp != Device::NO_ACTION) {
1311 after = temp;
1312 }
1313 }
1314
1315 // Save logs and clean up before rebooting or shutting down.
Tao Bao551d2c32018-05-09 20:53:13 -07001316 finish_recovery();
Tianjie Xu99b73be2017-11-28 17:23:06 -08001317
Jerry Zhang6a648042018-05-04 11:24:10 -07001318 return after;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001319}