blob: 07ec5cfb6598a252f3d1f4865e93c3bf61118ea8 [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
17#include <ctype.h>
Doug Zongker7c3ae452013-05-14 11:03:02 -070018#include <dirent.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080019#include <errno.h>
20#include <fcntl.h>
21#include <getopt.h>
Tao Bao862a4c12016-06-02 11:16:50 -070022#include <inttypes.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080023#include <limits.h>
Tao Bao862a4c12016-06-02 11:16:50 -070024#include <linux/fs.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080025#include <linux/input.h>
Doug Zongker7c3ae452013-05-14 11:03:02 -070026#include <stdarg.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080027#include <stdio.h>
28#include <stdlib.h>
29#include <string.h>
Patrick Tjincd055ee2014-12-09 11:26:40 -080030#include <sys/klog.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>
Tao Baocdcf28f2016-01-13 15:05:20 -080033#include <sys/wait.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080034#include <time.h>
35#include <unistd.h>
36
Tao Baoc4a18ef2017-02-10 00:13:30 -080037#include <algorithm>
Tao Bao04ca4262015-09-10 15:32:24 -070038#include <chrono>
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>
Tao Bao75238632015-05-27 14:46:17 -070051#include <cutils/android_reboot.h>
Elliott Hughescb220402016-09-23 15:30:55 -070052#include <cutils/properties.h> /* for property_list */
Yifan Honge8e4c402017-11-08 14:56:03 -080053#include <health2/Health.h>
54#include <private/android_filesystem_config.h> /* for AID_SYSTEM */
55#include <private/android_logger.h> /* private pmsg functions */
Jeff Vander Stoepe35926e2017-06-14 15:30:39 -070056#include <selinux/android.h>
Elliott Hughes4bbd5bf2016-04-01 18:24:39 -070057#include <selinux/label.h>
58#include <selinux/selinux.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070059#include <ziparchive/zip_archive.h>
Yabin Cui99281df2016-02-17 12:21:52 -080060
Tao Bao75238632015-05-27 14:46:17 -070061#include "adb_install.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080062#include "common.h"
Tao Bao75238632015-05-27 14:46:17 -070063#include "device.h"
64#include "fuse_sdcard_provider.h"
65#include "fuse_sideload.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080066#include "install.h"
Josh Gaoacb2a2f2016-08-26 18:24:34 -070067#include "minadbd/minadbd.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080068#include "minui/minui.h"
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070069#include "otautil/DirUtil.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070070#include "otautil/error_code.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080071#include "roots.h"
Tianjie Xue113e4d2016-10-21 17:46:13 -070072#include "rotate_logs.h"
Doug Zongker211aebc2011-10-28 15:13:10 -070073#include "screen_ui.h"
Sen Jiangd5304492016-12-09 16:20:49 -080074#include "stub_ui.h"
Tianjie Xue113e4d2016-10-21 17:46:13 -070075#include "ui.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080076
77static const struct option OPTIONS[] = {
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080078 { "update_package", required_argument, NULL, 'u' },
Tianjie Xu3c62b672016-02-05 18:25:58 -080079 { "retry_count", required_argument, NULL, 'n' },
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080080 { "wipe_data", no_argument, NULL, 'w' },
81 { "wipe_cache", no_argument, NULL, 'c' },
Doug Zongker4bc98062010-09-03 11:00:13 -070082 { "show_text", no_argument, NULL, 't' },
Tao Baoc679f932015-03-30 09:43:49 -070083 { "sideload", no_argument, NULL, 's' },
84 { "sideload_auto_reboot", no_argument, NULL, 'a' },
Doug Zongkere5d5ac72012-04-12 11:01:22 -070085 { "just_exit", no_argument, NULL, 'x' },
Doug Zongker02ec6b82012-08-22 17:26:40 -070086 { "locale", required_argument, NULL, 'l' },
Doug Zongkerb1d12632014-03-18 10:32:12 -070087 { "shutdown_after", no_argument, NULL, 'p' },
Jeff Sharkeya6e13ae2014-09-24 11:46:17 -070088 { "reason", required_argument, NULL, 'r' },
Tianjie Xu35926c42016-04-28 18:06:26 -070089 { "security", no_argument, NULL, 'e'},
Yabin Cui8b309f62016-06-24 18:22:02 -070090 { "wipe_ab", no_argument, NULL, 0 },
Yabin Cuifd99a312016-06-09 14:09:39 -070091 { "wipe_package_size", required_argument, NULL, 0 },
Paul Crowley08404b42016-12-19 13:04:23 -080092 { "prompt_and_wipe_data", no_argument, NULL, 0 },
Doug Zongker988500b2009-10-06 14:41:38 -070093 { NULL, 0, NULL, 0 },
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080094};
95
Tianjie Xu06e57ac2016-07-11 14:04:08 -070096// More bootreasons can be found in "system/core/bootstat/bootstat.cpp".
97static const std::vector<std::string> bootreason_blacklist {
98 "kernel_panic",
99 "Panic",
100};
101
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700102static const char *CACHE_LOG_DIR = "/cache/recovery";
Doug Zongkerd4208f92010-09-20 12:16:13 -0700103static const char *COMMAND_FILE = "/cache/recovery/command";
Doug Zongkerd4208f92010-09-20 12:16:13 -0700104static const char *LOG_FILE = "/cache/recovery/log";
Doug Zongkerd0181b82011-10-19 10:51:12 -0700105static const char *LAST_INSTALL_FILE = "/cache/recovery/last_install";
Doug Zongker8b240cc2012-08-29 15:19:29 -0700106static const char *LOCALE_FILE = "/cache/recovery/last_locale";
Paul Lawrence661f8a62016-02-25 12:42:19 -0800107static const char *CONVERT_FBE_DIR = "/tmp/convert_fbe";
108static const char *CONVERT_FBE_FILE = "/tmp/convert_fbe/convert_fbe";
Michael Ward9d2629c2011-06-23 22:14:24 -0700109static const char *CACHE_ROOT = "/cache";
Paul Lawrenced0db3372015-11-05 13:38:40 -0800110static const char *DATA_ROOT = "/data";
Paul Crowley723056a2016-06-08 13:51:41 -0700111static const char* METADATA_ROOT = "/metadata";
Doug Zongkerd4208f92010-09-20 12:16:13 -0700112static const char *SDCARD_ROOT = "/sdcard";
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800113static const char *TEMPORARY_LOG_FILE = "/tmp/recovery.log";
Doug Zongkerd0181b82011-10-19 10:51:12 -0700114static const char *TEMPORARY_INSTALL_FILE = "/tmp/last_install";
Tao Baof0124322015-04-11 02:04:11 +0000115static const char *LAST_KMSG_FILE = "/cache/recovery/last_kmsg";
Tao Baobef39712015-05-04 18:50:27 -0700116static const char *LAST_LOG_FILE = "/cache/recovery/last_log";
Tianjie Xu69575552017-05-16 15:51:46 -0700117// We will try to apply the update package 5 times at most in case of an I/O error or
118// bspatch | imgpatch error.
119static const int RETRY_LIMIT = 4;
Yabin Cui99281df2016-02-17 12:21:52 -0800120static const int BATTERY_READ_TIMEOUT_IN_SEC = 10;
121// GmsCore enters recovery mode to install package when having enough battery
122// percentage. Normally, the threshold is 40% without charger and 20% with charger.
123// So we should check battery with a slightly lower limitation.
124static const int BATTERY_OK_PERCENTAGE = 20;
125static const int BATTERY_WITH_CHARGER_OK_PERCENTAGE = 15;
Tao Baoac9d94d2016-11-03 11:37:15 -0700126static constexpr const char* RECOVERY_WIPE = "/etc/recovery.wipe";
Tianjie Xu2078b222017-03-22 12:27:26 -0700127static constexpr const char* DEFAULT_LOCALE = "en-US";
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700128
Tao Baobd0ddcd2017-05-04 13:03:18 -0700129// We define RECOVERY_API_VERSION in Android.mk, which will be picked up by build system and packed
130// into target_files.zip. Assert the version defined in code and in Android.mk are consistent.
131static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
132
Tao Baoac9d94d2016-11-03 11:37:15 -0700133static std::string locale;
Dan Albert8584fcf2016-10-27 03:08:08 +0000134static bool has_cache = false;
Tao Baoc0319b62016-10-13 15:17:04 -0700135
Tao Baoac9d94d2016-11-03 11:37:15 -0700136RecoveryUI* ui = nullptr;
137bool modified_flash = false;
Tao Baoa8d72bc2016-12-25 18:46:50 -0800138std::string stage;
Tao Baoac9d94d2016-11-03 11:37:15 -0700139const char* reason = nullptr;
140struct selabel_handle* sehandle;
141
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800142/*
143 * The recovery tool communicates with the main system through /cache files.
144 * /cache/recovery/command - INPUT - command line for tool, one arg per line
145 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800146 *
147 * The arguments which may be supplied in the recovery.command file:
Doug Zongkerd4208f92010-09-20 12:16:13 -0700148 * --update_package=path - verify install an OTA package file
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800149 * --wipe_data - erase user data (and cache), then reboot
Paul Crowley08404b42016-12-19 13:04:23 -0800150 * --prompt_and_wipe_data - prompt the user that data is corrupt,
151 * with their consent erase user data (and cache), then reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800152 * --wipe_cache - wipe cache (but not user data), then reboot
Oscar Montemayor05231562009-11-30 08:40:57 -0800153 * --set_encrypted_filesystem=on|off - enables / diasables encrypted fs
Doug Zongkere5d5ac72012-04-12 11:01:22 -0700154 * --just_exit - do nothing; exit and reboot
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800155 *
156 * After completing, we remove /cache/recovery/command and reboot.
157 * Arguments may also be supplied in the bootloader control block (BCB).
158 * These important scenarios must be safely restartable at any point:
159 *
160 * FACTORY RESET
161 * 1. user selects "factory reset"
162 * 2. main system writes "--wipe_data" to /cache/recovery/command
163 * 3. main system reboots into recovery
164 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
165 * -- after this, rebooting will restart the erase --
Doug Zongkerd4208f92010-09-20 12:16:13 -0700166 * 5. erase_volume() reformats /data
167 * 6. erase_volume() reformats /cache
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800168 * 7. finish_recovery() erases BCB
169 * -- after this, rebooting will restart the main system --
170 * 8. main() calls reboot() to boot main system
171 *
172 * OTA INSTALL
173 * 1. main system downloads OTA package to /cache/some-filename.zip
Doug Zongker9b125b02010-09-22 12:01:37 -0700174 * 2. main system writes "--update_package=/cache/some-filename.zip"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800175 * 3. main system reboots into recovery
176 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
177 * -- after this, rebooting will attempt to reinstall the update --
178 * 5. install_package() attempts to install the update
179 * NOTE: the package install must itself be restartable from any point
180 * 6. finish_recovery() erases BCB
181 * -- after this, rebooting will (try to) restart the main system --
182 * 7. ** if install failed **
183 * 7a. prompt_and_wait() shows an error icon and waits for the user
Tao Baoc0336392016-12-13 22:29:49 -0800184 * 7b. the user reboots (pulling the battery, etc) into the main system
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800185 */
186
Tao Baoac3d1ed2017-07-23 00:01:02 -0700187// Open a given path, mounting partitions as necessary.
188FILE* fopen_path(const char* path, const char* mode) {
189 if (ensure_path_mounted(path) != 0) {
190 LOG(ERROR) << "Can't mount " << path;
191 return nullptr;
192 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800193
Tao Baoac3d1ed2017-07-23 00:01:02 -0700194 // When writing, try to create the containing directory, if necessary. Use generous permissions,
195 // the system (init.rc) will reset them.
196 if (strchr("wa", mode[0])) {
197 mkdir_recursively(path, 0777, true, sehandle);
198 }
199 return fopen(path, mode);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800200}
201
Tao Bao04ca4262015-09-10 15:32:24 -0700202// close a file, log an error if the error indicator is set
203static void check_and_fclose(FILE *fp, const char *name) {
204 fflush(fp);
Tao Baoac9d94d2016-11-03 11:37:15 -0700205 if (fsync(fileno(fp)) == -1) {
206 PLOG(ERROR) << "Failed to fsync " << name;
207 }
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700208 if (ferror(fp)) {
209 PLOG(ERROR) << "Error in " << name;
210 }
Tao Bao04ca4262015-09-10 15:32:24 -0700211 fclose(fp);
212}
213
Elliott Hughesf14af802015-02-10 14:46:14 -0800214bool is_ro_debuggable() {
Elliott Hughescb220402016-09-23 15:30:55 -0700215 return android::base::GetBoolProperty("ro.debuggable", false);
Elliott Hughesf14af802015-02-10 14:46:14 -0800216}
217
Dmitri Plotnikov8706a982017-04-18 08:28:26 -0700218bool reboot(const std::string& command) {
219 std::string cmd = command;
220 if (android::base::GetBoolProperty("ro.boot.quiescent", false)) {
221 cmd += ",quiescent";
222 }
223 return android::base::SetProperty(ANDROID_RB_PROPERTY, cmd);
224}
225
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700226static void redirect_stdio(const char* filename) {
Tao Bao04ca4262015-09-10 15:32:24 -0700227 int pipefd[2];
228 if (pipe(pipefd) == -1) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700229 PLOG(ERROR) << "pipe failed";
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700230
Tao Bao04ca4262015-09-10 15:32:24 -0700231 // Fall back to traditional logging mode without timestamps.
232 // If these fail, there's not really anywhere to complain...
233 freopen(filename, "a", stdout); setbuf(stdout, NULL);
234 freopen(filename, "a", stderr); setbuf(stderr, NULL);
235
236 return;
237 }
238
239 pid_t pid = fork();
240 if (pid == -1) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700241 PLOG(ERROR) << "fork failed";
Tao Bao04ca4262015-09-10 15:32:24 -0700242
243 // Fall back to traditional logging mode without timestamps.
244 // If these fail, there's not really anywhere to complain...
245 freopen(filename, "a", stdout); setbuf(stdout, NULL);
246 freopen(filename, "a", stderr); setbuf(stderr, NULL);
247
248 return;
249 }
250
251 if (pid == 0) {
252 /// Close the unused write end.
253 close(pipefd[1]);
254
255 auto start = std::chrono::steady_clock::now();
256
257 // Child logger to actually write to the log file.
Tianjie Xude6735e2017-07-10 15:13:33 -0700258 FILE* log_fp = fopen(filename, "ae");
Tao Bao04ca4262015-09-10 15:32:24 -0700259 if (log_fp == nullptr) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700260 PLOG(ERROR) << "fopen \"" << filename << "\" failed";
Tao Bao04ca4262015-09-10 15:32:24 -0700261 close(pipefd[0]);
Tao Bao3da88012017-02-03 13:09:23 -0800262 _exit(EXIT_FAILURE);
Tao Bao04ca4262015-09-10 15:32:24 -0700263 }
264
265 FILE* pipe_fp = fdopen(pipefd[0], "r");
266 if (pipe_fp == nullptr) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700267 PLOG(ERROR) << "fdopen failed";
Tao Bao04ca4262015-09-10 15:32:24 -0700268 check_and_fclose(log_fp, filename);
269 close(pipefd[0]);
Tao Bao3da88012017-02-03 13:09:23 -0800270 _exit(EXIT_FAILURE);
Tao Bao04ca4262015-09-10 15:32:24 -0700271 }
272
273 char* line = nullptr;
274 size_t len = 0;
275 while (getline(&line, &len, pipe_fp) != -1) {
276 auto now = std::chrono::steady_clock::now();
277 double duration = std::chrono::duration_cast<std::chrono::duration<double>>(
278 now - start).count();
279 if (line[0] == '\n') {
280 fprintf(log_fp, "[%12.6lf]\n", duration);
281 } else {
282 fprintf(log_fp, "[%12.6lf] %s", duration, line);
283 }
284 fflush(log_fp);
285 }
286
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700287 PLOG(ERROR) << "getline failed";
Tao Bao04ca4262015-09-10 15:32:24 -0700288
289 free(line);
290 check_and_fclose(log_fp, filename);
291 close(pipefd[0]);
Tao Bao3da88012017-02-03 13:09:23 -0800292 _exit(EXIT_FAILURE);
Tao Bao04ca4262015-09-10 15:32:24 -0700293 } else {
294 // Redirect stdout/stderr to the logger process.
295 // Close the unused read end.
296 close(pipefd[0]);
297
298 setbuf(stdout, nullptr);
299 setbuf(stderr, nullptr);
300
301 if (dup2(pipefd[1], STDOUT_FILENO) == -1) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700302 PLOG(ERROR) << "dup2 stdout failed";
Tao Bao04ca4262015-09-10 15:32:24 -0700303 }
304 if (dup2(pipefd[1], STDERR_FILENO) == -1) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700305 PLOG(ERROR) << "dup2 stderr failed";
Tao Bao04ca4262015-09-10 15:32:24 -0700306 }
307
308 close(pipefd[1]);
309 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800310}
311
312// command line args come from, in decreasing precedence:
313// - the actual command line
314// - the bootloader control block (one per line, after "recovery")
315// - the contents of COMMAND_FILE (one per line)
Tao Baof0ed1592016-12-02 11:32:19 -0800316static std::vector<std::string> get_args(const int argc, char** const argv) {
317 CHECK_GT(argc, 0);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800318
Tao Baof0ed1592016-12-02 11:32:19 -0800319 bootloader_message boot = {};
320 std::string err;
321 if (!read_bootloader_message(&boot, &err)) {
322 LOG(ERROR) << err;
323 // If fails, leave a zeroed bootloader_message.
324 boot = {};
325 }
Tao Baoa8d72bc2016-12-25 18:46:50 -0800326 stage = std::string(boot.stage);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800327
Tao Baof0ed1592016-12-02 11:32:19 -0800328 if (boot.command[0] != 0) {
329 std::string boot_command = std::string(boot.command, sizeof(boot.command));
330 LOG(INFO) << "Boot command: " << boot_command;
331 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800332
Tao Baof0ed1592016-12-02 11:32:19 -0800333 if (boot.status[0] != 0) {
334 std::string boot_status = std::string(boot.status, sizeof(boot.status));
335 LOG(INFO) << "Boot status: " << boot_status;
336 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800337
Tao Baof0ed1592016-12-02 11:32:19 -0800338 std::vector<std::string> args(argv, argv + argc);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800339
Tao Baof0ed1592016-12-02 11:32:19 -0800340 // --- if arguments weren't supplied, look in the bootloader control block
Tao Bao570af9d2017-01-09 10:29:59 -0800341 if (args.size() == 1) {
Tao Baof0ed1592016-12-02 11:32:19 -0800342 boot.recovery[sizeof(boot.recovery) - 1] = '\0'; // Ensure termination
343 std::string boot_recovery(boot.recovery);
344 std::vector<std::string> tokens = android::base::Split(boot_recovery, "\n");
345 if (!tokens.empty() && tokens[0] == "recovery") {
346 for (auto it = tokens.begin() + 1; it != tokens.end(); it++) {
347 // Skip empty and '\0'-filled tokens.
348 if (!it->empty() && (*it)[0] != '\0') args.push_back(std::move(*it));
349 }
350 LOG(INFO) << "Got " << args.size() << " arguments from boot message";
351 } else if (boot.recovery[0] != 0) {
352 LOG(ERROR) << "Bad boot message: \"" << boot_recovery << "\"";
353 }
354 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800355
Tao Baof0ed1592016-12-02 11:32:19 -0800356 // --- if that doesn't work, try the command file (if we have /cache).
Tao Bao570af9d2017-01-09 10:29:59 -0800357 if (args.size() == 1 && has_cache) {
Tao Baof0ed1592016-12-02 11:32:19 -0800358 std::string content;
Tao Bao7d34fa12016-12-08 18:10:48 -0800359 if (ensure_path_mounted(COMMAND_FILE) == 0 &&
360 android::base::ReadFileToString(COMMAND_FILE, &content)) {
Tao Baof0ed1592016-12-02 11:32:19 -0800361 std::vector<std::string> tokens = android::base::Split(content, "\n");
Tao Bao7d34fa12016-12-08 18:10:48 -0800362 // All the arguments in COMMAND_FILE are needed (unlike the BCB message,
363 // COMMAND_FILE doesn't use filename as the first argument).
364 for (auto it = tokens.begin(); it != tokens.end(); it++) {
Tao Baof0ed1592016-12-02 11:32:19 -0800365 // Skip empty and '\0'-filled tokens.
366 if (!it->empty() && (*it)[0] != '\0') args.push_back(std::move(*it));
367 }
368 LOG(INFO) << "Got " << args.size() << " arguments from " << COMMAND_FILE;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800369 }
Tao Baof0ed1592016-12-02 11:32:19 -0800370 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800371
Tao Baof0ed1592016-12-02 11:32:19 -0800372 // Write the arguments (excluding the filename in args[0]) back into the
373 // bootloader control block. So the device will always boot into recovery to
374 // finish the pending work, until finish_recovery() is called.
375 std::vector<std::string> options(args.cbegin() + 1, args.cend());
Tao Bao2292db82016-12-13 21:53:31 -0800376 if (!update_bootloader_message(options, &err)) {
377 LOG(ERROR) << "Failed to set BCB message: " << err;
Tao Baof0ed1592016-12-02 11:32:19 -0800378 }
379
380 return args;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800381}
382
Tao Bao2292db82016-12-13 21:53:31 -0800383// Set the BCB to reboot back into recovery (it won't resume the install from
384// sdcard though).
385static void set_sdcard_update_bootloader_message() {
386 std::vector<std::string> options;
387 std::string err;
388 if (!update_bootloader_message(options, &err)) {
389 LOG(ERROR) << "Failed to set BCB message: " << err;
390 }
Doug Zongker34c98df2009-08-18 12:05:45 -0700391}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800392
Tao Baobef39712015-05-04 18:50:27 -0700393// Read from kernel log into buffer and write out to file.
394static void save_kernel_log(const char* destination) {
395 int klog_buf_len = klogctl(KLOG_SIZE_BUFFER, 0, 0);
Patrick Tjincd055ee2014-12-09 11:26:40 -0800396 if (klog_buf_len <= 0) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700397 PLOG(ERROR) << "Error getting klog size";
Patrick Tjincd055ee2014-12-09 11:26:40 -0800398 return;
399 }
400
Tao Baobef39712015-05-04 18:50:27 -0700401 std::string buffer(klog_buf_len, 0);
402 int n = klogctl(KLOG_READ_ALL, &buffer[0], klog_buf_len);
403 if (n == -1) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -0700404 PLOG(ERROR) << "Error in reading klog";
Patrick Tjincd055ee2014-12-09 11:26:40 -0800405 return;
406 }
Tao Baobef39712015-05-04 18:50:27 -0700407 buffer.resize(n);
408 android::base::WriteStringToFile(buffer, destination);
Patrick Tjincd055ee2014-12-09 11:26:40 -0800409}
410
Mark Salyzyna4f701a2016-03-09 14:58:16 -0800411// write content to the current pmsg session.
412static ssize_t __pmsg_write(const char *filename, const char *buf, size_t len) {
413 return __android_log_pmsg_file_write(LOG_ID_SYSTEM, ANDROID_LOG_INFO,
414 filename, buf, len);
415}
416
417static void copy_log_file_to_pmsg(const char* source, const char* destination) {
418 std::string content;
419 android::base::ReadFileToString(source, &content);
420 __pmsg_write(destination, content.c_str(), content.length());
421}
422
Tao Baof0124322015-04-11 02:04:11 +0000423// How much of the temp log we have copied to the copy in cache.
Chih-Hung Hsieh54a27472016-04-18 11:30:55 -0700424static off_t tmplog_offset = 0;
Tao Baof0124322015-04-11 02:04:11 +0000425
Tao Baobef39712015-05-04 18:50:27 -0700426static void copy_log_file(const char* source, const char* destination, bool append) {
Tianjie Xude6735e2017-07-10 15:13:33 -0700427 FILE* dest_fp = fopen_path(destination, append ? "ae" : "we");
428 if (dest_fp == nullptr) {
429 PLOG(ERROR) << "Can't open " << destination;
430 } else {
431 FILE* source_fp = fopen(source, "re");
432 if (source_fp != nullptr) {
433 if (append) {
434 fseeko(source_fp, tmplog_offset, SEEK_SET); // Since last write
435 }
436 char buf[4096];
437 size_t bytes;
438 while ((bytes = fread(buf, 1, sizeof(buf), source_fp)) != 0) {
439 fwrite(buf, 1, bytes, dest_fp);
440 }
441 if (append) {
442 tmplog_offset = ftello(source_fp);
443 }
444 check_and_fclose(source_fp, source);
Doug Zongker2c3539e2010-09-29 13:21:30 -0700445 }
Tianjie Xude6735e2017-07-10 15:13:33 -0700446 check_and_fclose(dest_fp, destination);
447 }
Doug Zongker2c3539e2010-09-29 13:21:30 -0700448}
449
Tao Bao682c34b2015-04-07 17:16:35 -0700450static void copy_logs() {
451 // We only rotate and record the log of the current session if there are
452 // actual attempts to modify the flash, such as wipes, installs from BCB
453 // or menu selections. This is to avoid unnecessary rotation (and
454 // possible deletion) of log files, if it does not do anything loggable.
455 if (!modified_flash) {
456 return;
457 }
458
Mark Salyzyna4f701a2016-03-09 14:58:16 -0800459 // Always write to pmsg, this allows the OTA logs to be caught in logcat -L
460 copy_log_file_to_pmsg(TEMPORARY_LOG_FILE, LAST_LOG_FILE);
461 copy_log_file_to_pmsg(TEMPORARY_INSTALL_FILE, LAST_INSTALL_FILE);
462
463 // We can do nothing for now if there's no /cache partition.
464 if (!has_cache) {
465 return;
466 }
467
Tianjie Xue113e4d2016-10-21 17:46:13 -0700468 ensure_path_mounted(LAST_LOG_FILE);
469 ensure_path_mounted(LAST_KMSG_FILE);
470 rotate_logs(LAST_LOG_FILE, LAST_KMSG_FILE);
Tao Bao682c34b2015-04-07 17:16:35 -0700471
Doug Zongkerf24fd7e2013-07-02 11:43:25 -0700472 // Copy logs to cache so the system can find out what happened.
Tao Baof0124322015-04-11 02:04:11 +0000473 copy_log_file(TEMPORARY_LOG_FILE, LOG_FILE, true);
474 copy_log_file(TEMPORARY_LOG_FILE, LAST_LOG_FILE, false);
475 copy_log_file(TEMPORARY_INSTALL_FILE, LAST_INSTALL_FILE, false);
476 save_kernel_log(LAST_KMSG_FILE);
Doug Zongkerf24fd7e2013-07-02 11:43:25 -0700477 chmod(LOG_FILE, 0600);
Tao Baoe1905ad2017-03-22 14:57:04 -0700478 chown(LOG_FILE, AID_SYSTEM, AID_SYSTEM);
Tao Baof0124322015-04-11 02:04:11 +0000479 chmod(LAST_KMSG_FILE, 0600);
Tao Baoe1905ad2017-03-22 14:57:04 -0700480 chown(LAST_KMSG_FILE, AID_SYSTEM, AID_SYSTEM);
Doug Zongkerf24fd7e2013-07-02 11:43:25 -0700481 chmod(LAST_LOG_FILE, 0640);
482 chmod(LAST_INSTALL_FILE, 0644);
483 sync();
484}
485
Tao Baoec579032017-07-21 12:13:15 -0700486// Clear the recovery command and prepare to boot a (hopefully working) system,
Tianjie Xuc14d95d2016-03-24 11:50:34 -0700487// copy our log file to cache as well (for the system to read). This function is
488// idempotent: call it as many times as you like.
Tao Baoac9d94d2016-11-03 11:37:15 -0700489static void finish_recovery() {
Tao Baoec579032017-07-21 12:13:15 -0700490 // Save the locale to cache, so if recovery is next started up without a '--locale' argument
491 // (e.g., directly from the bootloader) it will use the last-known locale.
492 if (!locale.empty() && has_cache) {
493 LOG(INFO) << "Saving locale \"" << locale << "\"";
494 if (ensure_path_mounted(LOCALE_FILE) != 0) {
495 LOG(ERROR) << "Failed to mount " << LOCALE_FILE;
496 } else if (!android::base::WriteStringToFile(locale, LOCALE_FILE)) {
497 PLOG(ERROR) << "Failed to save locale to " << LOCALE_FILE;
Doug Zongker4f33e552012-08-23 13:16:12 -0700498 }
Tao Baoec579032017-07-21 12:13:15 -0700499 }
Doug Zongker4f33e552012-08-23 13:16:12 -0700500
Tao Baoec579032017-07-21 12:13:15 -0700501 copy_logs();
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800502
Tao Baoec579032017-07-21 12:13:15 -0700503 // Reset to normal system boot so recovery won't cycle indefinitely.
504 std::string err;
505 if (!clear_bootloader_message(&err)) {
506 LOG(ERROR) << "Failed to clear BCB message: " << err;
507 }
508
509 // Remove the command file, so recovery won't repeat indefinitely.
510 if (has_cache) {
511 if (ensure_path_mounted(COMMAND_FILE) != 0 || (unlink(COMMAND_FILE) && errno != ENOENT)) {
512 LOG(WARNING) << "Can't unlink " << COMMAND_FILE;
Yabin Cui8b309f62016-06-24 18:22:02 -0700513 }
Tao Baoec579032017-07-21 12:13:15 -0700514 ensure_path_unmounted(CACHE_ROOT);
515 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800516
Tao Baoec579032017-07-21 12:13:15 -0700517 sync(); // For good measure.
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800518}
519
Tao Bao3f5a3822016-12-13 11:14:37 -0800520struct saved_log_file {
521 std::string name;
522 struct stat sb;
523 std::string data;
524};
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700525
Elliott Hughes945548e2015-06-05 17:59:56 -0700526static bool erase_volume(const char* volume) {
Tao Bao3f5a3822016-12-13 11:14:37 -0800527 bool is_cache = (strcmp(volume, CACHE_ROOT) == 0);
528 bool is_data = (strcmp(volume, DATA_ROOT) == 0);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700529
Tao Bao3f5a3822016-12-13 11:14:37 -0800530 ui->SetBackground(RecoveryUI::ERASING);
531 ui->SetProgressType(RecoveryUI::INDETERMINATE);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700532
Tao Bao3f5a3822016-12-13 11:14:37 -0800533 std::vector<saved_log_file> log_files;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700534
Tao Bao3f5a3822016-12-13 11:14:37 -0800535 if (is_cache) {
536 // If we're reformatting /cache, we load any past logs
537 // (i.e. "/cache/recovery/last_*") and the current log
538 // ("/cache/recovery/log") into memory, so we can restore them after
539 // the reformat.
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700540
Tao Bao3f5a3822016-12-13 11:14:37 -0800541 ensure_path_mounted(volume);
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700542
Tao Bao3f5a3822016-12-13 11:14:37 -0800543 struct dirent* de;
544 std::unique_ptr<DIR, decltype(&closedir)> d(opendir(CACHE_LOG_DIR), closedir);
545 if (d) {
546 while ((de = readdir(d.get())) != nullptr) {
547 if (strncmp(de->d_name, "last_", 5) == 0 || strcmp(de->d_name, "log") == 0) {
548 std::string path = android::base::StringPrintf("%s/%s", CACHE_LOG_DIR, de->d_name);
549
550 struct stat sb;
551 if (stat(path.c_str(), &sb) == 0) {
552 // truncate files to 512kb
553 if (sb.st_size > (1 << 19)) {
554 sb.st_size = 1 << 19;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700555 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800556
557 std::string data(sb.st_size, '\0');
Tianjie Xude6735e2017-07-10 15:13:33 -0700558 FILE* f = fopen(path.c_str(), "rbe");
Tao Bao3f5a3822016-12-13 11:14:37 -0800559 fread(&data[0], 1, data.size(), f);
560 fclose(f);
561
562 log_files.emplace_back(saved_log_file{ path, sb, data });
563 }
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700564 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800565 }
Paul Lawrenced0db3372015-11-05 13:38:40 -0800566 } else {
Tao Bao3f5a3822016-12-13 11:14:37 -0800567 if (errno != ENOENT) {
568 PLOG(ERROR) << "Failed to opendir " << CACHE_LOG_DIR;
569 }
Paul Lawrenced0db3372015-11-05 13:38:40 -0800570 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800571 }
Doug Zongkerd0181b82011-10-19 10:51:12 -0700572
Tao Bao3f5a3822016-12-13 11:14:37 -0800573 ui->Print("Formatting %s...\n", volume);
574
575 ensure_path_unmounted(volume);
576
577 int result;
578
579 if (is_data && reason && strcmp(reason, "convert_fbe") == 0) {
580 // Create convert_fbe breadcrumb file to signal to init
581 // to convert to file based encryption, not full disk encryption
582 if (mkdir(CONVERT_FBE_DIR, 0700) != 0) {
583 ui->Print("Failed to make convert_fbe dir %s\n", strerror(errno));
584 return true;
585 }
Tianjie Xude6735e2017-07-10 15:13:33 -0700586 FILE* f = fopen(CONVERT_FBE_FILE, "wbe");
Tao Bao3f5a3822016-12-13 11:14:37 -0800587 if (!f) {
588 ui->Print("Failed to convert to file encryption %s\n", strerror(errno));
589 return true;
590 }
591 fclose(f);
592 result = format_volume(volume, CONVERT_FBE_DIR);
593 remove(CONVERT_FBE_FILE);
594 rmdir(CONVERT_FBE_DIR);
595 } else {
596 result = format_volume(volume);
597 }
598
599 if (is_cache) {
600 // Re-create the log dir and write back the log entries.
601 if (ensure_path_mounted(CACHE_LOG_DIR) == 0 &&
Tao Baoac3d1ed2017-07-23 00:01:02 -0700602 mkdir_recursively(CACHE_LOG_DIR, 0777, false, sehandle) == 0) {
Tao Bao3f5a3822016-12-13 11:14:37 -0800603 for (const auto& log : log_files) {
604 if (!android::base::WriteStringToFile(log.data, log.name, log.sb.st_mode, log.sb.st_uid,
605 log.sb.st_gid)) {
606 PLOG(ERROR) << "Failed to write to " << log.name;
Doug Zongker6d0d7ac2013-07-09 13:34:55 -0700607 }
Tao Bao3f5a3822016-12-13 11:14:37 -0800608 }
609 } else {
610 PLOG(ERROR) << "Failed to mount / create " << CACHE_LOG_DIR;
Doug Zongker2c3539e2010-09-29 13:21:30 -0700611 }
612
Tao Bao3f5a3822016-12-13 11:14:37 -0800613 // Any part of the log we'd copied to cache is now gone.
614 // Reset the pointer so we copy from the beginning of the temp
615 // log.
616 tmplog_offset = 0;
617 copy_logs();
618 }
619
620 return (result == 0);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800621}
622
Tao Baofc5499f2017-02-23 19:06:53 -0800623// Display a menu with the specified 'headers' and 'items'. Device specific HandleMenuKey() may
624// return a positive number beyond the given range. Caller sets 'menu_only' to true to ensure only
Tao Bao50dd5322017-03-07 14:57:04 -0800625// a menu item gets selected. 'initial_selection' controls the initial cursor location. Returns the
626// (non-negative) chosen item number, or -1 if timed out waiting for input.
Tao Baofc5499f2017-02-23 19:06:53 -0800627static int get_menu_selection(const char* const* headers, const char* const* items, bool menu_only,
628 int initial_selection, Device* device) {
629 // Throw away keys pressed previously, so user doesn't accidentally trigger menu items.
630 ui->FlushKeys();
Doug Zongkerf93d8162009-09-22 15:16:02 -0700631
Tao Baofc5499f2017-02-23 19:06:53 -0800632 ui->StartMenu(headers, items, initial_selection);
Tao Bao50dd5322017-03-07 14:57:04 -0800633
Tao Baofc5499f2017-02-23 19:06:53 -0800634 int selected = initial_selection;
635 int chosen_item = -1;
Tao Baofc5499f2017-02-23 19:06:53 -0800636 while (chosen_item < 0) {
637 int key = ui->WaitKey();
Tao Bao50dd5322017-03-07 14:57:04 -0800638 if (key == -1) { // WaitKey() timed out.
Tao Baofc5499f2017-02-23 19:06:53 -0800639 if (ui->WasTextEverVisible()) {
640 continue;
641 } else {
Tao Bao50dd5322017-03-07 14:57:04 -0800642 LOG(INFO) << "Timed out waiting for key input; rebooting.";
Tao Baofc5499f2017-02-23 19:06:53 -0800643 ui->EndMenu();
Tao Bao50dd5322017-03-07 14:57:04 -0800644 return -1;
Tao Baofc5499f2017-02-23 19:06:53 -0800645 }
Doug Zongkerf93d8162009-09-22 15:16:02 -0700646 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800647
Tao Baofc5499f2017-02-23 19:06:53 -0800648 bool visible = ui->IsTextVisible();
649 int action = device->HandleMenuKey(key, visible);
650
651 if (action < 0) {
652 switch (action) {
653 case Device::kHighlightUp:
654 selected = ui->SelectMenu(--selected);
655 break;
656 case Device::kHighlightDown:
657 selected = ui->SelectMenu(++selected);
658 break;
659 case Device::kInvokeItem:
660 chosen_item = selected;
661 break;
662 case Device::kNoAction:
663 break;
664 }
665 } else if (!menu_only) {
666 chosen_item = action;
667 }
668 }
669
670 ui->EndMenu();
671 return chosen_item;
Doug Zongkerf93d8162009-09-22 15:16:02 -0700672}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800673
Tao Baoc4a18ef2017-02-10 00:13:30 -0800674// Returns the selected filename, or an empty string.
675static std::string browse_directory(const std::string& path, Device* device) {
676 ensure_path_mounted(path.c_str());
Doug Zongker8674a722010-09-15 11:08:23 -0700677
Tao Baoc4a18ef2017-02-10 00:13:30 -0800678 std::unique_ptr<DIR, decltype(&closedir)> d(opendir(path.c_str()), closedir);
679 if (!d) {
680 PLOG(ERROR) << "error opening " << path;
681 return "";
682 }
Doug Zongkerc18eeb82010-09-21 16:49:26 -0700683
Tao Baoc4a18ef2017-02-10 00:13:30 -0800684 std::vector<std::string> dirs;
685 std::vector<std::string> zips = { "../" }; // "../" is always the first entry.
686
687 dirent* de;
688 while ((de = readdir(d.get())) != nullptr) {
689 std::string name(de->d_name);
690
691 if (de->d_type == DT_DIR) {
692 // Skip "." and ".." entries.
693 if (name == "." || name == "..") continue;
694 dirs.push_back(name + "/");
695 } else if (de->d_type == DT_REG && android::base::EndsWithIgnoreCase(name, ".zip")) {
696 zips.push_back(name);
697 }
698 }
699
700 std::sort(dirs.begin(), dirs.end());
701 std::sort(zips.begin(), zips.end());
702
703 // Append dirs to the zips list.
704 zips.insert(zips.end(), dirs.begin(), dirs.end());
705
706 const char* entries[zips.size() + 1];
707 entries[zips.size()] = nullptr;
708 for (size_t i = 0; i < zips.size(); i++) {
709 entries[i] = zips[i].c_str();
710 }
711
712 const char* headers[] = { "Choose a package to install:", path.c_str(), nullptr };
713
714 int chosen_item = 0;
715 while (true) {
Tao Baofc5499f2017-02-23 19:06:53 -0800716 chosen_item = get_menu_selection(headers, entries, true, chosen_item, device);
Tao Baoc4a18ef2017-02-10 00:13:30 -0800717
718 const std::string& item = zips[chosen_item];
719 if (chosen_item == 0) {
720 // Go up but continue browsing (if the caller is browse_directory).
721 return "";
Doug Zongker8674a722010-09-15 11:08:23 -0700722 }
723
Tao Baoc4a18ef2017-02-10 00:13:30 -0800724 std::string new_path = path + "/" + item;
725 if (new_path.back() == '/') {
726 // Recurse down into a subdirectory.
727 new_path.pop_back();
728 std::string result = browse_directory(new_path, device);
729 if (!result.empty()) return result;
730 } else {
731 // Selected a zip file: return the path to the caller.
732 return new_path;
Doug Zongker8674a722010-09-15 11:08:23 -0700733 }
Tao Baoc4a18ef2017-02-10 00:13:30 -0800734 }
Doug Zongker8674a722010-09-15 11:08:23 -0700735
Tao Baoc4a18ef2017-02-10 00:13:30 -0800736 // Unreachable.
Doug Zongker8674a722010-09-15 11:08:23 -0700737}
738
Elliott Hughes30694c92015-03-25 15:16:51 -0700739static bool yes_no(Device* device, const char* question1, const char* question2) {
Elliott Hughes8fd86d72015-04-13 14:36:02 -0700740 const char* headers[] = { question1, question2, NULL };
Elliott Hughes30694c92015-03-25 15:16:51 -0700741 const char* items[] = { " No", " Yes", NULL };
Doug Zongkerddd6a282009-06-09 12:22:33 -0700742
Tao Baofc5499f2017-02-23 19:06:53 -0800743 int chosen_item = get_menu_selection(headers, items, true, 0, device);
Elliott Hughes30694c92015-03-25 15:16:51 -0700744 return (chosen_item == 1);
745}
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800746
Paul Crowley08404b42016-12-19 13:04:23 -0800747static bool ask_to_wipe_data(Device* device) {
748 return yes_no(device, "Wipe all user data?", " THIS CAN NOT BE UNDONE!");
749}
Doug Zongker1066d2c2009-04-01 13:57:40 -0700750
Paul Crowley08404b42016-12-19 13:04:23 -0800751// Return true on success.
752static bool wipe_data(Device* device) {
Tao Bao682c34b2015-04-07 17:16:35 -0700753 modified_flash = true;
754
Doug Zongker211aebc2011-10-28 15:13:10 -0700755 ui->Print("\n-- Wiping data...\n");
Paul Crowley723056a2016-06-08 13:51:41 -0700756 bool success = device->PreWipeData();
757 if (success) {
758 success &= erase_volume(DATA_ROOT);
759 if (has_cache) {
760 success &= erase_volume(CACHE_ROOT);
761 }
762 if (volume_for_mount_point(METADATA_ROOT) != nullptr) {
763 success &= erase_volume(METADATA_ROOT);
764 }
765 }
766 if (success) {
767 success &= device->PostWipeData();
768 }
Elliott Hughes945548e2015-06-05 17:59:56 -0700769 ui->Print("Data wipe %s.\n", success ? "complete" : "failed");
770 return success;
Doug Zongkerf93d8162009-09-22 15:16:02 -0700771}
772
Paul Crowley08404b42016-12-19 13:04:23 -0800773static bool prompt_and_wipe_data(Device* device) {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700774 // Use a single string and let ScreenRecoveryUI handles the wrapping.
Tao Baofc5499f2017-02-23 19:06:53 -0800775 const char* const headers[] = {
Tao Bao2bbc6d62017-08-13 23:48:55 -0700776 "Can't load Android system. Your data may be corrupt. "
777 "If you continue to get this message, you may need to "
778 "perform a factory data reset and erase all user data "
Paul Crowley31ac0c62017-03-23 12:32:40 -0700779 "stored on this device.",
Tao Bao2bbc6d62017-08-13 23:48:55 -0700780 nullptr
Tao Baofc5499f2017-02-23 19:06:53 -0800781 };
782 const char* const items[] = {
Paul Crowley31ac0c62017-03-23 12:32:40 -0700783 "Try again",
784 "Factory data reset",
Tao Baofc5499f2017-02-23 19:06:53 -0800785 NULL
786 };
787 for (;;) {
788 int chosen_item = get_menu_selection(headers, items, true, 0, device);
789 if (chosen_item != 1) {
790 return true; // Just reboot, no wipe; not a failure, user asked for it
Paul Crowley08404b42016-12-19 13:04:23 -0800791 }
Tao Baofc5499f2017-02-23 19:06:53 -0800792 if (ask_to_wipe_data(device)) {
793 return wipe_data(device);
794 }
795 }
Paul Crowley08404b42016-12-19 13:04:23 -0800796}
797
Tao Baoe39a9bc2015-03-31 12:19:05 -0700798// Return true on success.
799static bool wipe_cache(bool should_confirm, Device* device) {
Tao Bao26112e52016-02-25 12:29:40 -0800800 if (!has_cache) {
801 ui->Print("No /cache partition found.\n");
802 return false;
803 }
804
Elliott Hughes30694c92015-03-25 15:16:51 -0700805 if (should_confirm && !yes_no(device, "Wipe cache?", " THIS CAN NOT BE UNDONE!")) {
Tao Baoe39a9bc2015-03-31 12:19:05 -0700806 return false;
Elliott Hughes30694c92015-03-25 15:16:51 -0700807 }
808
Tao Bao682c34b2015-04-07 17:16:35 -0700809 modified_flash = true;
810
Elliott Hughes30694c92015-03-25 15:16:51 -0700811 ui->Print("\n-- Wiping cache...\n");
Elliott Hughes945548e2015-06-05 17:59:56 -0700812 bool success = erase_volume("/cache");
813 ui->Print("Cache wipe %s.\n", success ? "complete" : "failed");
814 return success;
Elliott Hughes30694c92015-03-25 15:16:51 -0700815}
816
Tao Bao1b2a98b2017-03-24 10:45:34 -0700817// Secure-wipe a given partition. It uses BLKSECDISCARD, if supported. Otherwise, it goes with
818// BLKDISCARD (if device supports BLKDISCARDZEROES) or BLKZEROOUT.
Tao Bao862a4c12016-06-02 11:16:50 -0700819static bool secure_wipe_partition(const std::string& partition) {
Tao Bao1b2a98b2017-03-24 10:45:34 -0700820 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(partition.c_str(), O_WRONLY)));
821 if (fd == -1) {
822 PLOG(ERROR) << "Failed to open \"" << partition << "\"";
823 return false;
824 }
825
826 uint64_t range[2] = { 0, 0 };
827 if (ioctl(fd, BLKGETSIZE64, &range[1]) == -1 || range[1] == 0) {
828 PLOG(ERROR) << "Failed to get partition size";
829 return false;
830 }
831 LOG(INFO) << "Secure-wiping \"" << partition << "\" from " << range[0] << " to " << range[1];
832
833 LOG(INFO) << " Trying BLKSECDISCARD...";
834 if (ioctl(fd, BLKSECDISCARD, &range) == -1) {
835 PLOG(WARNING) << " Failed";
836
837 // Use BLKDISCARD if it zeroes out blocks, otherwise use BLKZEROOUT.
838 unsigned int zeroes;
839 if (ioctl(fd, BLKDISCARDZEROES, &zeroes) == 0 && zeroes != 0) {
840 LOG(INFO) << " Trying BLKDISCARD...";
841 if (ioctl(fd, BLKDISCARD, &range) == -1) {
842 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700843 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700844 }
845 } else {
846 LOG(INFO) << " Trying BLKZEROOUT...";
847 if (ioctl(fd, BLKZEROOUT, &range) == -1) {
848 PLOG(ERROR) << " Failed";
Tao Bao862a4c12016-06-02 11:16:50 -0700849 return false;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700850 }
Tao Bao862a4c12016-06-02 11:16:50 -0700851 }
Tao Bao1b2a98b2017-03-24 10:45:34 -0700852 }
Tao Bao862a4c12016-06-02 11:16:50 -0700853
Tao Bao1b2a98b2017-03-24 10:45:34 -0700854 LOG(INFO) << " Done";
855 return true;
Tao Bao862a4c12016-06-02 11:16:50 -0700856}
857
Yabin Cuifd99a312016-06-09 14:09:39 -0700858// Check if the wipe package matches expectation:
859// 1. verify the package.
860// 2. check metadata (ota-type, pre-device and serial number if having one).
861static bool check_wipe_package(size_t wipe_package_size) {
862 if (wipe_package_size == 0) {
863 LOG(ERROR) << "wipe_package_size is zero";
864 return false;
865 }
866 std::string wipe_package;
867 std::string err_str;
868 if (!read_wipe_package(&wipe_package, wipe_package_size, &err_str)) {
869 PLOG(ERROR) << "Failed to read wipe package";
870 return false;
871 }
872 if (!verify_package(reinterpret_cast<const unsigned char*>(wipe_package.data()),
873 wipe_package.size())) {
874 LOG(ERROR) << "Failed to verify package";
875 return false;
876 }
877
878 // Extract metadata
879 ZipArchiveHandle zip;
Tao Baoefc35592017-01-08 22:45:47 -0800880 int err = OpenArchiveFromMemory(static_cast<void*>(&wipe_package[0]), wipe_package.size(),
881 "wipe_package", &zip);
Yabin Cuifd99a312016-06-09 14:09:39 -0700882 if (err != 0) {
883 LOG(ERROR) << "Can't open wipe package : " << ErrorCodeString(err);
884 return false;
885 }
886 std::string metadata;
Tao Bao1b2a98b2017-03-24 10:45:34 -0700887 if (!read_metadata_from_package(zip, &metadata)) {
Yabin Cuifd99a312016-06-09 14:09:39 -0700888 CloseArchive(zip);
889 return false;
890 }
891 CloseArchive(zip);
892
893 // Check metadata
894 std::vector<std::string> lines = android::base::Split(metadata, "\n");
895 bool ota_type_matched = false;
896 bool device_type_matched = false;
897 bool has_serial_number = false;
898 bool serial_number_matched = false;
899 for (const auto& line : lines) {
900 if (line == "ota-type=BRICK") {
901 ota_type_matched = true;
902 } else if (android::base::StartsWith(line, "pre-device=")) {
903 std::string device_type = line.substr(strlen("pre-device="));
Tao Baoefc35592017-01-08 22:45:47 -0800904 std::string real_device_type = android::base::GetProperty("ro.build.product", "");
Yabin Cuifd99a312016-06-09 14:09:39 -0700905 device_type_matched = (device_type == real_device_type);
906 } else if (android::base::StartsWith(line, "serialno=")) {
907 std::string serial_no = line.substr(strlen("serialno="));
Tao Baoefc35592017-01-08 22:45:47 -0800908 std::string real_serial_no = android::base::GetProperty("ro.serialno", "");
Yabin Cuifd99a312016-06-09 14:09:39 -0700909 has_serial_number = true;
910 serial_number_matched = (serial_no == real_serial_no);
911 }
912 }
913 return ota_type_matched && device_type_matched && (!has_serial_number || serial_number_matched);
914}
915
Yabin Cui8b309f62016-06-24 18:22:02 -0700916// Wipe the current A/B device, with a secure wipe of all the partitions in
917// RECOVERY_WIPE.
Yabin Cuifd99a312016-06-09 14:09:39 -0700918static bool wipe_ab_device(size_t wipe_package_size) {
Tao Bao862a4c12016-06-02 11:16:50 -0700919 ui->SetBackground(RecoveryUI::ERASING);
920 ui->SetProgressType(RecoveryUI::INDETERMINATE);
921
Yabin Cuifd99a312016-06-09 14:09:39 -0700922 if (!check_wipe_package(wipe_package_size)) {
923 LOG(ERROR) << "Failed to verify wipe package";
924 return false;
925 }
Tao Bao862a4c12016-06-02 11:16:50 -0700926 std::string partition_list;
Yabin Cui8b309f62016-06-24 18:22:02 -0700927 if (!android::base::ReadFileToString(RECOVERY_WIPE, &partition_list)) {
928 LOG(ERROR) << "failed to read \"" << RECOVERY_WIPE << "\"";
Tao Bao862a4c12016-06-02 11:16:50 -0700929 return false;
930 }
931
932 std::vector<std::string> lines = android::base::Split(partition_list, "\n");
933 for (const std::string& line : lines) {
934 std::string partition = android::base::Trim(line);
935 // Ignore '#' comment or empty lines.
936 if (android::base::StartsWith(partition, "#") || partition.empty()) {
937 continue;
938 }
939
940 // Proceed anyway even if it fails to wipe some partition.
941 secure_wipe_partition(partition);
942 }
943 return true;
944}
945
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700946static void choose_recovery_file(Device* device) {
Tao Bao08fc6be2017-03-07 00:56:27 -0800947 std::vector<std::string> entries;
948 if (has_cache) {
949 for (int i = 0; i < KEEP_LOG_COUNT; i++) {
950 auto add_to_entries = [&](const char* filename) {
951 std::string log_file(filename);
952 if (i > 0) {
953 log_file += "." + std::to_string(i);
Tao Baobef39712015-05-04 18:50:27 -0700954 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800955
956 if (ensure_path_mounted(log_file.c_str()) == 0 && access(log_file.c_str(), R_OK) == 0) {
957 entries.push_back(std::move(log_file));
958 }
959 };
960
961 // Add LAST_LOG_FILE + LAST_LOG_FILE.x
962 add_to_entries(LAST_LOG_FILE);
963
964 // Add LAST_KMSG_FILE + LAST_KMSG_FILE.x
965 add_to_entries(LAST_KMSG_FILE);
966 }
967 } else {
968 // If cache partition is not found, view /tmp/recovery.log instead.
969 if (access(TEMPORARY_LOG_FILE, R_OK) == -1) {
970 return;
Tianjie Xua54f75e2016-08-17 12:02:46 -0700971 } else {
Tao Bao08fc6be2017-03-07 00:56:27 -0800972 entries.push_back(TEMPORARY_LOG_FILE);
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700973 }
Tao Bao08fc6be2017-03-07 00:56:27 -0800974 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700975
Tao Bao08fc6be2017-03-07 00:56:27 -0800976 entries.push_back("Back");
Elliott Hughesc0491632015-05-06 12:40:05 -0700977
Tao Bao08fc6be2017-03-07 00:56:27 -0800978 std::vector<const char*> menu_entries(entries.size());
979 std::transform(entries.cbegin(), entries.cend(), menu_entries.begin(),
980 [](const std::string& entry) { return entry.c_str(); });
981 menu_entries.push_back(nullptr);
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700982
Tao Bao08fc6be2017-03-07 00:56:27 -0800983 const char* headers[] = { "Select file to view", nullptr };
Elliott Hughes8de52072015-04-08 20:06:50 -0700984
Tao Bao08fc6be2017-03-07 00:56:27 -0800985 int chosen_item = 0;
986 while (true) {
Tao Baofc5499f2017-02-23 19:06:53 -0800987 chosen_item = get_menu_selection(headers, menu_entries.data(), true, chosen_item, device);
Tao Bao08fc6be2017-03-07 00:56:27 -0800988 if (entries[chosen_item] == "Back") break;
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700989
Tao Bao08fc6be2017-03-07 00:56:27 -0800990 ui->ShowFile(entries[chosen_item].c_str());
991 }
Nick Kralevicha9ad0322014-10-22 18:38:48 -0700992}
993
Tao Baodb7e8982017-03-06 23:53:16 -0800994static void run_graphics_test() {
995 // Switch to graphics screen.
996 ui->ShowText(false);
Elliott Hughes498cda62016-04-14 16:49:04 -0700997
Tao Baodb7e8982017-03-06 23:53:16 -0800998 ui->SetProgressType(RecoveryUI::INDETERMINATE);
999 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
1000 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -07001001
Tao Baodb7e8982017-03-06 23:53:16 -08001002 ui->SetBackground(RecoveryUI::ERROR);
1003 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -07001004
Tao Baodb7e8982017-03-06 23:53:16 -08001005 ui->SetBackground(RecoveryUI::NO_COMMAND);
1006 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -07001007
Tao Baodb7e8982017-03-06 23:53:16 -08001008 ui->SetBackground(RecoveryUI::ERASING);
1009 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -07001010
Tao Baodb7e8982017-03-06 23:53:16 -08001011 // Calling SetBackground() after SetStage() to trigger a redraw.
1012 ui->SetStage(1, 3);
1013 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
1014 sleep(1);
1015 ui->SetStage(2, 3);
1016 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
1017 sleep(1);
1018 ui->SetStage(3, 3);
1019 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
1020 sleep(1);
Elliott Hughes498cda62016-04-14 16:49:04 -07001021
Tao Baodb7e8982017-03-06 23:53:16 -08001022 ui->SetStage(-1, -1);
1023 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
Elliott Hughes498cda62016-04-14 16:49:04 -07001024
Tao Baodb7e8982017-03-06 23:53:16 -08001025 ui->SetProgressType(RecoveryUI::DETERMINATE);
1026 ui->ShowProgress(1.0, 10.0);
1027 float fraction = 0.0;
1028 for (size_t i = 0; i < 100; ++i) {
1029 fraction += .01;
1030 ui->SetProgress(fraction);
1031 usleep(100000);
1032 }
1033
1034 ui->ShowText(true);
Elliott Hughes498cda62016-04-14 16:49:04 -07001035}
1036
Tao Baocdcf28f2016-01-13 15:05:20 -08001037// How long (in seconds) we wait for the fuse-provided package file to
1038// appear, before timing out.
1039#define SDCARD_INSTALL_TIMEOUT 10
1040
Tao Bao145d8612015-03-25 15:51:15 -07001041static int apply_from_sdcard(Device* device, bool* wipe_cache) {
Tao Bao682c34b2015-04-07 17:16:35 -07001042 modified_flash = true;
1043
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001044 if (ensure_path_mounted(SDCARD_ROOT) != 0) {
1045 ui->Print("\n-- Couldn't mount %s.\n", SDCARD_ROOT);
1046 return INSTALL_ERROR;
1047 }
1048
Tao Baoc4a18ef2017-02-10 00:13:30 -08001049 std::string path = browse_directory(SDCARD_ROOT, device);
1050 if (path.empty()) {
Elliott Hughes018ed312015-04-08 16:51:36 -07001051 ui->Print("\n-- No package file selected.\n");
caozhiyuanb4effb92015-06-10 16:46:38 +08001052 ensure_path_unmounted(SDCARD_ROOT);
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001053 return INSTALL_ERROR;
1054 }
1055
Tao Baoc4a18ef2017-02-10 00:13:30 -08001056 ui->Print("\n-- Install %s ...\n", path.c_str());
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001057 set_sdcard_update_bootloader_message();
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001058
Tao Baocdcf28f2016-01-13 15:05:20 -08001059 // We used to use fuse in a thread as opposed to a process. Since accessing
1060 // through fuse involves going from kernel to userspace to kernel, it leads
1061 // to deadlock when a page fault occurs. (Bug: 26313124)
1062 pid_t child;
1063 if ((child = fork()) == 0) {
Tao Baoc4a18ef2017-02-10 00:13:30 -08001064 bool status = start_sdcard_fuse(path.c_str());
Tao Baocdcf28f2016-01-13 15:05:20 -08001065
1066 _exit(status ? EXIT_SUCCESS : EXIT_FAILURE);
1067 }
1068
1069 // FUSE_SIDELOAD_HOST_PATHNAME will start to exist once the fuse in child
1070 // process is ready.
1071 int result = INSTALL_ERROR;
1072 int status;
1073 bool waited = false;
1074 for (int i = 0; i < SDCARD_INSTALL_TIMEOUT; ++i) {
1075 if (waitpid(child, &status, WNOHANG) == -1) {
1076 result = INSTALL_ERROR;
1077 waited = true;
1078 break;
1079 }
1080
1081 struct stat sb;
1082 if (stat(FUSE_SIDELOAD_HOST_PATHNAME, &sb) == -1) {
1083 if (errno == ENOENT && i < SDCARD_INSTALL_TIMEOUT-1) {
1084 sleep(1);
1085 continue;
1086 } else {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -07001087 LOG(ERROR) << "Timed out waiting for the fuse-provided package.";
Tao Baocdcf28f2016-01-13 15:05:20 -08001088 result = INSTALL_ERROR;
1089 kill(child, SIGKILL);
1090 break;
1091 }
1092 }
1093
1094 result = install_package(FUSE_SIDELOAD_HOST_PATHNAME, wipe_cache,
Tianjie Xu16255832016-04-30 11:49:59 -07001095 TEMPORARY_INSTALL_FILE, false, 0/*retry_count*/);
Tao Baocdcf28f2016-01-13 15:05:20 -08001096 break;
1097 }
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001098
Tao Baocdcf28f2016-01-13 15:05:20 -08001099 if (!waited) {
1100 // Calling stat() on this magic filename signals the fuse
1101 // filesystem to shut down.
1102 struct stat sb;
1103 stat(FUSE_SIDELOAD_HOST_EXIT_PATHNAME, &sb);
1104
1105 waitpid(child, &status, 0);
1106 }
1107
1108 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -07001109 LOG(ERROR) << "Error exit from the fuse process: " << WEXITSTATUS(status);
Tao Baocdcf28f2016-01-13 15:05:20 -08001110 }
1111
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001112 ensure_path_unmounted(SDCARD_ROOT);
Tao Baocdcf28f2016-01-13 15:05:20 -08001113 return result;
Christian Poetzsch4ec58a42015-02-19 10:42:39 +00001114}
1115
Tao Bao50dd5322017-03-07 14:57:04 -08001116// Returns REBOOT, SHUTDOWN, or REBOOT_BOOTLOADER. Returning NO_ACTION means to take the default,
1117// which is to reboot or shutdown depending on if the --shutdown_after flag was passed to recovery.
1118static Device::BuiltinAction prompt_and_wait(Device* device, int status) {
1119 for (;;) {
1120 finish_recovery();
1121 switch (status) {
1122 case INSTALL_SUCCESS:
1123 case INSTALL_NONE:
1124 ui->SetBackground(RecoveryUI::NO_COMMAND);
1125 break;
Doug Zongker6c8553d2012-09-24 10:40:47 -07001126
Tao Bao50dd5322017-03-07 14:57:04 -08001127 case INSTALL_ERROR:
1128 case INSTALL_CORRUPT:
1129 ui->SetBackground(RecoveryUI::ERROR);
1130 break;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001131 }
Tao Bao50dd5322017-03-07 14:57:04 -08001132 ui->SetProgressType(RecoveryUI::EMPTY);
1133
1134 int chosen_item = get_menu_selection(nullptr, device->GetMenuItems(), false, 0, device);
1135
1136 // Device-specific code may take some action here. It may return one of the core actions
1137 // handled in the switch statement below.
1138 Device::BuiltinAction chosen_action =
1139 (chosen_item == -1) ? Device::REBOOT : device->InvokeMenuItem(chosen_item);
1140
1141 bool should_wipe_cache = false;
1142 switch (chosen_action) {
1143 case Device::NO_ACTION:
1144 break;
1145
1146 case Device::REBOOT:
1147 case Device::SHUTDOWN:
1148 case Device::REBOOT_BOOTLOADER:
1149 return chosen_action;
1150
1151 case Device::WIPE_DATA:
1152 if (ui->IsTextVisible()) {
1153 if (ask_to_wipe_data(device)) {
1154 wipe_data(device);
1155 }
1156 } else {
1157 wipe_data(device);
1158 return Device::NO_ACTION;
1159 }
1160 break;
1161
1162 case Device::WIPE_CACHE:
1163 wipe_cache(ui->IsTextVisible(), device);
1164 if (!ui->IsTextVisible()) return Device::NO_ACTION;
1165 break;
1166
1167 case Device::APPLY_ADB_SIDELOAD:
1168 case Device::APPLY_SDCARD:
1169 {
1170 bool adb = (chosen_action == Device::APPLY_ADB_SIDELOAD);
1171 if (adb) {
Tao Bao0150d012017-05-01 11:31:28 -07001172 status = apply_from_adb(&should_wipe_cache, TEMPORARY_INSTALL_FILE);
Tao Bao50dd5322017-03-07 14:57:04 -08001173 } else {
1174 status = apply_from_sdcard(device, &should_wipe_cache);
1175 }
1176
1177 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1178 if (!wipe_cache(false, device)) {
1179 status = INSTALL_ERROR;
1180 }
1181 }
1182
1183 if (status != INSTALL_SUCCESS) {
1184 ui->SetBackground(RecoveryUI::ERROR);
1185 ui->Print("Installation aborted.\n");
1186 copy_logs();
1187 } else if (!ui->IsTextVisible()) {
1188 return Device::NO_ACTION; // reboot if logs aren't visible
1189 } else {
1190 ui->Print("\nInstall from %s complete.\n", adb ? "ADB" : "SD card");
1191 }
1192 }
1193 break;
1194
1195 case Device::VIEW_RECOVERY_LOGS:
1196 choose_recovery_file(device);
1197 break;
1198
1199 case Device::RUN_GRAPHICS_TEST:
1200 run_graphics_test();
1201 break;
1202
Tianjie Xu29d55752017-09-20 17:53:46 -07001203 case Device::RUN_LOCALE_TEST: {
1204 ScreenRecoveryUI* screen_ui = static_cast<ScreenRecoveryUI*>(ui);
1205 screen_ui->CheckBackgroundTextImages(locale);
1206 break;
1207 }
Tao Bao50dd5322017-03-07 14:57:04 -08001208 case Device::MOUNT_SYSTEM:
1209 // For a system image built with the root directory (i.e. system_root_image == "true"), we
1210 // mount it to /system_root, and symlink /system to /system_root/system to make adb shell
1211 // work (the symlink is created through the build system). (Bug: 22855115)
1212 if (android::base::GetBoolProperty("ro.build.system_root_image", false)) {
1213 if (ensure_path_mounted_at("/", "/system_root") != -1) {
1214 ui->Print("Mounted /system.\n");
1215 }
1216 } else {
1217 if (ensure_path_mounted("/system") != -1) {
1218 ui->Print("Mounted /system.\n");
1219 }
1220 }
1221 break;
1222 }
1223 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001224}
1225
Tao Bao99f0d9e2016-10-13 12:46:38 -07001226static void print_property(const char* key, const char* name, void* /* cookie */) {
1227 printf("%s=%s\n", key, name);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001228}
1229
Tao Baoac9d94d2016-11-03 11:37:15 -07001230static std::string load_locale_from_cache() {
1231 if (ensure_path_mounted(LOCALE_FILE) != 0) {
1232 LOG(ERROR) << "Can't mount " << LOCALE_FILE;
1233 return "";
Doug Zongker02ec6b82012-08-22 17:26:40 -07001234 }
Tao Baoac9d94d2016-11-03 11:37:15 -07001235
1236 std::string content;
1237 if (!android::base::ReadFileToString(LOCALE_FILE, &content)) {
1238 PLOG(ERROR) << "Can't read " << LOCALE_FILE;
1239 return "";
1240 }
1241
1242 return android::base::Trim(content);
Doug Zongker02ec6b82012-08-22 17:26:40 -07001243}
1244
Tao Baoac9d94d2016-11-03 11:37:15 -07001245void ui_print(const char* format, ...) {
1246 std::string buffer;
Doug Zongker7c3ae452013-05-14 11:03:02 -07001247 va_list ap;
1248 va_start(ap, format);
Tao Baoac9d94d2016-11-03 11:37:15 -07001249 android::base::StringAppendV(&buffer, format, ap);
Doug Zongker7c3ae452013-05-14 11:03:02 -07001250 va_end(ap);
1251
Tao Baoac9d94d2016-11-03 11:37:15 -07001252 if (ui != nullptr) {
1253 ui->Print("%s", buffer.c_str());
Doug Zongker7c3ae452013-05-14 11:03:02 -07001254 } else {
Tao Baoac9d94d2016-11-03 11:37:15 -07001255 fputs(buffer.c_str(), stdout);
Doug Zongker7c3ae452013-05-14 11:03:02 -07001256 }
1257}
1258
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -07001259static constexpr char log_characters[] = "VDIWEF";
1260
Tao Bao99f0d9e2016-10-13 12:46:38 -07001261void UiLogger(android::base::LogId /* id */, android::base::LogSeverity severity,
1262 const char* /* tag */, const char* /* file */, unsigned int /* line */,
1263 const char* message) {
1264 if (severity >= android::base::ERROR && ui != nullptr) {
1265 ui->Print("E:%s\n", message);
1266 } else {
1267 fprintf(stdout, "%c:%s\n", log_characters[severity], message);
1268 }
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -07001269}
1270
Yabin Cui99281df2016-02-17 12:21:52 -08001271static bool is_battery_ok() {
Yifan Honge8e4c402017-11-08 14:56:03 -08001272 using android::hardware::health::V1_0::BatteryStatus;
1273 using android::hardware::health::V2_0::Result;
1274 using android::hardware::health::V2_0::toString;
1275 using android::hardware::health::V2_0::implementation::Health;
Yabin Cui99281df2016-02-17 12:21:52 -08001276
Yifan Honge8e4c402017-11-08 14:56:03 -08001277 struct healthd_config healthd_config = {
1278 .batteryStatusPath = android::String8(android::String8::kEmptyString),
1279 .batteryHealthPath = android::String8(android::String8::kEmptyString),
1280 .batteryPresentPath = android::String8(android::String8::kEmptyString),
1281 .batteryCapacityPath = android::String8(android::String8::kEmptyString),
1282 .batteryVoltagePath = android::String8(android::String8::kEmptyString),
1283 .batteryTemperaturePath = android::String8(android::String8::kEmptyString),
1284 .batteryTechnologyPath = android::String8(android::String8::kEmptyString),
1285 .batteryCurrentNowPath = android::String8(android::String8::kEmptyString),
1286 .batteryCurrentAvgPath = android::String8(android::String8::kEmptyString),
1287 .batteryChargeCounterPath = android::String8(android::String8::kEmptyString),
1288 .batteryFullChargePath = android::String8(android::String8::kEmptyString),
1289 .batteryCycleCountPath = android::String8(android::String8::kEmptyString),
1290 .energyCounter = NULL,
1291 .boot_min_cap = 0,
1292 .screen_on = NULL
1293 };
Yabin Cui99281df2016-02-17 12:21:52 -08001294
Yifan Honge8e4c402017-11-08 14:56:03 -08001295 auto health =
1296 android::hardware::health::V2_0::implementation::Health::initInstance(&healthd_config);
1297
1298 int wait_second = 0;
1299 while (true) {
1300 auto charge_status = BatteryStatus::UNKNOWN;
1301 health
1302 ->getChargeStatus([&charge_status](auto res, auto out_status) {
1303 if (res == Result::SUCCESS) {
1304 charge_status = out_status;
1305 }
1306 })
1307 .isOk(); // should not have transport error
1308
1309 // Treat unknown status as charged.
1310 bool charged = (charge_status != BatteryStatus::DISCHARGING &&
1311 charge_status != BatteryStatus::NOT_CHARGING);
1312
1313 Result res = Result::UNKNOWN;
1314 int32_t capacity = INT32_MIN;
1315 health
1316 ->getCapacity([&res, &capacity](auto out_res, auto out_capacity) {
1317 res = out_res;
1318 capacity = out_capacity;
1319 })
1320 .isOk(); // should not have transport error
1321
1322 ui_print("charge_status %d, charged %d, status %s, capacity %" PRId32 "\n", charge_status,
1323 charged, toString(res).c_str(), capacity);
1324 // At startup, the battery drivers in devices like N5X/N6P take some time to load
1325 // the battery profile. Before the load finishes, it reports value 50 as a fake
1326 // capacity. BATTERY_READ_TIMEOUT_IN_SEC is set that the battery drivers are expected
1327 // to finish loading the battery profile earlier than 10 seconds after kernel startup.
1328 if (res == Result::SUCCESS && capacity == 50) {
1329 if (wait_second < BATTERY_READ_TIMEOUT_IN_SEC) {
1330 sleep(1);
1331 wait_second++;
1332 continue;
1333 }
1334 }
1335 // If we can't read battery percentage, it may be a device without battery. In this
1336 // situation, use 100 as a fake battery percentage.
1337 if (res != Result::SUCCESS) {
1338 capacity = 100;
1339 }
1340 return (charged && capacity >= BATTERY_WITH_CHARGER_OK_PERCENTAGE) ||
1341 (!charged && capacity >= BATTERY_OK_PERCENTAGE);
Yabin Cui99281df2016-02-17 12:21:52 -08001342 }
1343}
1344
Tianjie Xu99b73be2017-11-28 17:23:06 -08001345// Set the retry count to |retry_count| in BCB.
Tianjie Xu72449c92017-05-16 18:07:31 -07001346static void set_retry_bootloader_message(int retry_count, const std::vector<std::string>& args) {
1347 std::vector<std::string> options;
1348 for (const auto& arg : args) {
1349 if (!android::base::StartsWith(arg, "--retry_count")) {
1350 options.push_back(arg);
Tianjie Xu3c62b672016-02-05 18:25:58 -08001351 }
Tianjie Xu72449c92017-05-16 18:07:31 -07001352 }
Tianjie Xu3c62b672016-02-05 18:25:58 -08001353
Tianjie Xu99b73be2017-11-28 17:23:06 -08001354 // Update the retry counter in BCB.
1355 options.push_back(android::base::StringPrintf("--retry_count=%d", retry_count));
Tianjie Xu72449c92017-05-16 18:07:31 -07001356 std::string err;
1357 if (!update_bootloader_message(options, &err)) {
1358 LOG(ERROR) << err;
1359 }
Tianjie Xu3c62b672016-02-05 18:25:58 -08001360}
1361
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001362static bool bootreason_in_blacklist() {
Tao Baoefc35592017-01-08 22:45:47 -08001363 std::string bootreason = android::base::GetProperty("ro.boot.bootreason", "");
1364 if (!bootreason.empty()) {
1365 for (const auto& str : bootreason_blacklist) {
1366 if (strcasecmp(str.c_str(), bootreason.c_str()) == 0) {
1367 return true;
1368 }
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001369 }
Tao Baoefc35592017-01-08 22:45:47 -08001370 }
1371 return false;
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001372}
1373
1374static void log_failure_code(ErrorCode code, const char *update_package) {
1375 std::vector<std::string> log_buffer = {
1376 update_package,
1377 "0", // install result
1378 "error: " + std::to_string(code),
1379 };
1380 std::string log_content = android::base::Join(log_buffer, "\n");
1381 if (!android::base::WriteStringToFile(log_content, TEMPORARY_INSTALL_FILE)) {
Tao Baoac9d94d2016-11-03 11:37:15 -07001382 PLOG(ERROR) << "failed to write " << TEMPORARY_INSTALL_FILE;
Tianjie Xu06e57ac2016-07-11 14:04:08 -07001383 }
1384
1385 // Also write the info into last_log.
1386 LOG(INFO) << log_content;
1387}
1388
Yabin Cui99281df2016-02-17 12:21:52 -08001389int main(int argc, char **argv) {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001390 // We don't have logcat yet under recovery; so we'll print error on screen and
1391 // log to stdout (which is redirected to recovery.log) as we used to do.
1392 android::base::InitLogging(argv, &UiLogger);
Tianjie Xu7b0ad9c2016-08-05 18:00:04 -07001393
Tianjie Xu99b73be2017-11-28 17:23:06 -08001394 // Take last pmsg contents and rewrite it to the current pmsg session.
1395 static const char filter[] = "recovery/";
1396 // Do we need to rotate?
1397 bool doRotate = false;
Tianjie Xue113e4d2016-10-21 17:46:13 -07001398
Tianjie Xu99b73be2017-11-28 17:23:06 -08001399 __android_log_pmsg_file_read(LOG_ID_SYSTEM, ANDROID_LOG_INFO, filter, logbasename, &doRotate);
1400 // Take action to refresh pmsg contents
1401 __android_log_pmsg_file_read(LOG_ID_SYSTEM, ANDROID_LOG_INFO, filter, logrotate, &doRotate);
Mark Salyzyna4f701a2016-03-09 14:58:16 -08001402
Tianjie Xu99b73be2017-11-28 17:23:06 -08001403 // If this binary is started with the single argument "--adbd",
1404 // instead of being the normal recovery binary, it turns into kind
1405 // of a stripped-down version of adbd that only supports the
1406 // 'sideload' command. Note this must be a real argument, not
1407 // anything in the command file or bootloader control block; the
1408 // only way recovery should be run with this argument is when it
1409 // starts a copy of itself from the apply_from_adb() function.
1410 if (argc == 2 && strcmp(argv[1], "--adbd") == 0) {
1411 minadbd_main();
1412 return 0;
1413 }
1414
1415 time_t start = time(nullptr);
1416
1417 // redirect_stdio should be called only in non-sideload mode. Otherwise
1418 // we may have two logger instances with different timestamps.
1419 redirect_stdio(TEMPORARY_LOG_FILE);
1420
1421 printf("Starting recovery (pid %d) on %s", getpid(), ctime(&start));
1422
1423 load_volume_table();
1424 has_cache = volume_for_mount_point(CACHE_ROOT) != nullptr;
1425
1426 std::vector<std::string> args = get_args(argc, argv);
1427 std::vector<char*> args_to_parse(args.size());
1428 std::transform(args.cbegin(), args.cend(), args_to_parse.begin(),
1429 [](const std::string& arg) { return const_cast<char*>(arg.c_str()); });
1430
1431 const char* update_package = nullptr;
1432 bool should_wipe_data = false;
1433 bool should_prompt_and_wipe_data = false;
1434 bool should_wipe_cache = false;
1435 bool should_wipe_ab = false;
1436 size_t wipe_package_size = 0;
1437 bool show_text = false;
1438 bool sideload = false;
1439 bool sideload_auto_reboot = false;
1440 bool just_exit = false;
1441 bool shutdown_after = false;
1442 int retry_count = 0;
1443 bool security_update = false;
1444
1445 int arg;
1446 int option_index;
1447 while ((arg = getopt_long(args_to_parse.size(), args_to_parse.data(), "", OPTIONS,
1448 &option_index)) != -1) {
1449 switch (arg) {
1450 case 'n':
1451 android::base::ParseInt(optarg, &retry_count, 0);
1452 break;
1453 case 'u':
1454 update_package = optarg;
1455 break;
1456 case 'w':
1457 should_wipe_data = true;
1458 break;
1459 case 'c':
1460 should_wipe_cache = true;
1461 break;
1462 case 't':
1463 show_text = true;
1464 break;
1465 case 's':
1466 sideload = true;
1467 break;
1468 case 'a':
1469 sideload = true;
1470 sideload_auto_reboot = true;
1471 break;
1472 case 'x':
1473 just_exit = true;
1474 break;
1475 case 'l':
1476 locale = optarg;
1477 break;
1478 case 'p':
1479 shutdown_after = true;
1480 break;
1481 case 'r':
1482 reason = optarg;
1483 break;
1484 case 'e':
1485 security_update = true;
1486 break;
1487 case 0: {
1488 std::string option = OPTIONS[option_index].name;
1489 if (option == "wipe_ab") {
1490 should_wipe_ab = true;
1491 } else if (option == "wipe_package_size") {
1492 android::base::ParseUint(optarg, &wipe_package_size);
1493 } else if (option == "prompt_and_wipe_data") {
1494 should_prompt_and_wipe_data = true;
1495 }
1496 break;
1497 }
1498 case '?':
1499 LOG(ERROR) << "Invalid command argument";
1500 continue;
Doug Zongker9270a202012-01-09 15:16:13 -08001501 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001502 }
Doug Zongker9270a202012-01-09 15:16:13 -08001503
Tianjie Xu99b73be2017-11-28 17:23:06 -08001504 if (locale.empty()) {
1505 if (has_cache) {
1506 locale = load_locale_from_cache();
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001507 }
1508
Tao Baoac9d94d2016-11-03 11:37:15 -07001509 if (locale.empty()) {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001510 locale = DEFAULT_LOCALE;
Doug Zongker02ec6b82012-08-22 17:26:40 -07001511 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001512 }
Tao Baoac9d94d2016-11-03 11:37:15 -07001513
Tianjie Xu99b73be2017-11-28 17:23:06 -08001514 printf("locale is [%s]\n", locale.c_str());
1515 printf("stage is [%s]\n", stage.c_str());
1516 printf("reason is [%s]\n", reason);
Doug Zongker02ec6b82012-08-22 17:26:40 -07001517
Tianjie Xu99b73be2017-11-28 17:23:06 -08001518 Device* device = make_device();
1519 if (android::base::GetBoolProperty("ro.boot.quiescent", false)) {
1520 printf("Quiescent recovery mode.\n");
1521 ui = new StubRecoveryUI();
1522 } else {
1523 ui = device->GetUI();
1524
1525 if (!ui->Init(locale)) {
1526 printf("Failed to initialize UI, use stub UI instead.\n");
1527 ui = new StubRecoveryUI();
1528 }
1529 }
1530
1531 // Set background string to "installing security update" for security update,
1532 // otherwise set it to "installing system update".
1533 ui->SetSystemUpdateText(security_update);
1534
1535 int st_cur, st_max;
1536 if (!stage.empty() && sscanf(stage.c_str(), "%d/%d", &st_cur, &st_max) == 2) {
1537 ui->SetStage(st_cur, st_max);
1538 }
1539
1540 ui->SetBackground(RecoveryUI::NONE);
1541 if (show_text) ui->ShowText(true);
1542
1543 sehandle = selinux_android_file_context_handle();
1544 selinux_android_set_sehandle(sehandle);
1545 if (!sehandle) {
1546 ui->Print("Warning: No file_contexts\n");
1547 }
1548
1549 device->StartRecovery();
1550
1551 printf("Command:");
1552 for (const auto& arg : args) {
1553 printf(" \"%s\"", arg.c_str());
1554 }
1555 printf("\n\n");
1556
1557 property_list(print_property, nullptr);
1558 printf("\n");
1559
1560 ui->Print("Supported API: %d\n", kRecoveryApiVersion);
1561
1562 int status = INSTALL_SUCCESS;
1563
1564 if (update_package != nullptr) {
1565 // It's not entirely true that we will modify the flash. But we want
1566 // to log the update attempt since update_package is non-NULL.
1567 modified_flash = true;
1568
1569 if (!is_battery_ok()) {
1570 ui->Print("battery capacity is not enough for installing package, needed is %d%%\n",
1571 BATTERY_OK_PERCENTAGE);
1572 // Log the error code to last_install when installation skips due to
1573 // low battery.
1574 log_failure_code(kLowBattery, update_package);
1575 status = INSTALL_SKIPPED;
1576 } else if (bootreason_in_blacklist()) {
1577 // Skip update-on-reboot when bootreason is kernel_panic or similar
1578 ui->Print("bootreason is in the blacklist; skip OTA installation\n");
1579 log_failure_code(kBootreasonInBlacklist, update_package);
1580 status = INSTALL_SKIPPED;
Dmitri Plotnikov8706a982017-04-18 08:28:26 -07001581 } else {
Tianjie Xu99b73be2017-11-28 17:23:06 -08001582 // It's a fresh update. Initialize the retry_count in the BCB to 1; therefore we can later
1583 // identify the interrupted update due to unexpected reboots.
1584 if (retry_count == 0) {
1585 set_retry_bootloader_message(retry_count + 1, args);
Tao Bao7022f332017-07-25 09:52:36 -07001586 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001587
Tianjie Xu99b73be2017-11-28 17:23:06 -08001588 status = install_package(update_package, &should_wipe_cache, TEMPORARY_INSTALL_FILE, true,
1589 retry_count);
1590 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1591 wipe_cache(false, device);
1592 }
1593 if (status != INSTALL_SUCCESS) {
1594 ui->Print("Installation aborted.\n");
1595 // When I/O error happens, reboot and retry installation RETRY_LIMIT
1596 // times before we abandon this OTA update.
1597 if (status == INSTALL_RETRY && retry_count < RETRY_LIMIT) {
1598 copy_logs();
1599 retry_count += 1;
1600 set_retry_bootloader_message(retry_count, args);
1601 // Print retry count on screen.
1602 ui->Print("Retry attempt %d\n", retry_count);
1603
1604 // Reboot and retry the update
1605 if (!reboot("reboot,recovery")) {
1606 ui->Print("Reboot failed\n");
1607 } else {
1608 while (true) {
1609 pause();
1610 }
1611 }
Tianjie Xud9d16292017-04-20 18:08:21 -07001612 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001613 // If this is an eng or userdebug build, then automatically
1614 // turn the text display on if the script fails so the error
1615 // message is visible.
1616 if (is_ro_debuggable()) {
1617 ui->ShowText(true);
Tao Baoc679f932015-03-30 09:43:49 -07001618 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001619 }
Doug Zongker8674a722010-09-15 11:08:23 -07001620 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001621 } else if (should_wipe_data) {
1622 if (!wipe_data(device)) {
1623 status = INSTALL_ERROR;
Doug Zongkerb1d12632014-03-18 10:32:12 -07001624 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001625 } else if (should_prompt_and_wipe_data) {
1626 ui->ShowText(true);
1627 ui->SetBackground(RecoveryUI::ERROR);
1628 if (!prompt_and_wipe_data(device)) {
1629 status = INSTALL_ERROR;
Tao Bao75238632015-05-27 14:46:17 -07001630 }
Tianjie Xu99b73be2017-11-28 17:23:06 -08001631 ui->ShowText(false);
1632 } else if (should_wipe_cache) {
1633 if (!wipe_cache(false, device)) {
1634 status = INSTALL_ERROR;
1635 }
1636 } else if (should_wipe_ab) {
1637 if (!wipe_ab_device(wipe_package_size)) {
1638 status = INSTALL_ERROR;
1639 }
1640 } else if (sideload) {
1641 // 'adb reboot sideload' acts the same as user presses key combinations
1642 // to enter the sideload mode. When 'sideload-auto-reboot' is used, text
1643 // display will NOT be turned on by default. And it will reboot after
1644 // sideload finishes even if there are errors. Unless one turns on the
1645 // text display during the installation. This is to enable automated
1646 // testing.
1647 if (!sideload_auto_reboot) {
1648 ui->ShowText(true);
1649 }
1650 status = apply_from_adb(&should_wipe_cache, TEMPORARY_INSTALL_FILE);
1651 if (status == INSTALL_SUCCESS && should_wipe_cache) {
1652 if (!wipe_cache(false, device)) {
1653 status = INSTALL_ERROR;
1654 }
1655 }
1656 ui->Print("\nInstall from ADB complete (status: %d).\n", status);
1657 if (sideload_auto_reboot) {
1658 ui->Print("Rebooting automatically.\n");
1659 }
1660 } else if (!just_exit) {
1661 // If this is an eng or userdebug build, automatically turn on the text display if no command
1662 // is specified. Note that this should be called before setting the background to avoid
1663 // flickering the background image.
1664 if (is_ro_debuggable()) {
1665 ui->ShowText(true);
1666 }
1667 status = INSTALL_NONE; // No command specified
1668 ui->SetBackground(RecoveryUI::NO_COMMAND);
1669 }
1670
1671 if (status == INSTALL_ERROR || status == INSTALL_CORRUPT) {
1672 ui->SetBackground(RecoveryUI::ERROR);
1673 if (!ui->IsTextVisible()) {
1674 sleep(5);
1675 }
1676 }
1677
1678 Device::BuiltinAction after = shutdown_after ? Device::SHUTDOWN : Device::REBOOT;
1679 // 1. If the recovery menu is visible, prompt and wait for commands.
1680 // 2. If the state is INSTALL_NONE, wait for commands. (i.e. In user build, manually reboot into
1681 // recovery to sideload a package.)
1682 // 3. sideload_auto_reboot is an option only available in user-debug build, reboot the device
1683 // without waiting.
1684 // 4. In all other cases, reboot the device. Therefore, normal users will observe the device
1685 // reboot after it shows the "error" screen for 5s.
1686 if ((status == INSTALL_NONE && !sideload_auto_reboot) || ui->IsTextVisible()) {
1687 Device::BuiltinAction temp = prompt_and_wait(device, status);
1688 if (temp != Device::NO_ACTION) {
1689 after = temp;
1690 }
1691 }
1692
1693 // Save logs and clean up before rebooting or shutting down.
1694 finish_recovery();
1695
1696 switch (after) {
1697 case Device::SHUTDOWN:
1698 ui->Print("Shutting down...\n");
1699 android::base::SetProperty(ANDROID_RB_PROPERTY, "shutdown,");
1700 break;
1701
1702 case Device::REBOOT_BOOTLOADER:
1703 ui->Print("Rebooting to bootloader...\n");
1704 android::base::SetProperty(ANDROID_RB_PROPERTY, "reboot,bootloader");
1705 break;
1706
1707 default:
1708 ui->Print("Rebooting...\n");
1709 reboot("reboot,");
1710 break;
1711 }
1712 while (true) {
1713 pause();
1714 }
1715 // Should be unreachable.
1716 return EXIT_SUCCESS;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001717}