1 /*
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>
18 #include <errno.h>
19 #include <fcntl.h>
20 #include <getopt.h>
21 #include <limits.h>
22 #include <linux/input.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <sys/reboot.h>
27 #include <sys/types.h>
28 #include <time.h>
29 #include <unistd.h>
30
31 #include "bootloader.h"
32 #include "common.h"
33 #include "cutils/properties.h"
34 #include "firmware.h"
35 #include "install.h"
36 #include "minui/minui.h"
37 #include "minzip/DirUtil.h"
38 #include "roots.h"
39 #include "recovery_ui.h"
40
41 static const struct option OPTIONS[] = {
42 { "send_intent", required_argument, NULL, 's' },
43 { "update_package", required_argument, NULL, 'u' },
44 { "wipe_data", no_argument, NULL, 'w' },
45 { "wipe_cache", no_argument, NULL, 'c' },
46 { NULL, 0, NULL, 0 },
47 };
48
49 static const char *COMMAND_FILE = "CACHE:recovery/command";
50 static const char *INTENT_FILE = "CACHE:recovery/intent";
51 static const char *LOG_FILE = "CACHE:recovery/log";
52 static const char *SDCARD_PACKAGE_FILE = "SDCARD:update.zip";
53 static const char *TEMPORARY_LOG_FILE = "/tmp/recovery.log";
54
55 /*
56 * The recovery tool communicates with the main system through /cache files.
57 * /cache/recovery/command - INPUT - command line for tool, one arg per line
58 * /cache/recovery/log - OUTPUT - combined log file from recovery run(s)
59 * /cache/recovery/intent - OUTPUT - intent that was passed in
60 *
61 * The arguments which may be supplied in the recovery.command file:
62 * --send_intent=anystring - write the text out to recovery.intent
63 * --update_package=root:path - verify install an OTA package file
64 * --wipe_data - erase user data (and cache), then reboot
65 * --wipe_cache - wipe cache (but not user data), then reboot
66 *
67 * After completing, we remove /cache/recovery/command and reboot.
68 * Arguments may also be supplied in the bootloader control block (BCB).
69 * These important scenarios must be safely restartable at any point:
70 *
71 * FACTORY RESET
72 * 1. user selects "factory reset"
73 * 2. main system writes "--wipe_data" to /cache/recovery/command
74 * 3. main system reboots into recovery
75 * 4. get_args() writes BCB with "boot-recovery" and "--wipe_data"
76 * -- after this, rebooting will restart the erase --
77 * 5. erase_root() reformats /data
78 * 6. erase_root() reformats /cache
79 * 7. finish_recovery() erases BCB
80 * -- after this, rebooting will restart the main system --
81 * 8. main() calls reboot() to boot main system
82 *
83 * OTA INSTALL
84 * 1. main system downloads OTA package to /cache/some-filename.zip
85 * 2. main system writes "--update_package=CACHE:some-filename.zip"
86 * 3. main system reboots into recovery
87 * 4. get_args() writes BCB with "boot-recovery" and "--update_package=..."
88 * -- after this, rebooting will attempt to reinstall the update --
89 * 5. install_package() attempts to install the update
90 * NOTE: the package install must itself be restartable from any point
91 * 6. finish_recovery() erases BCB
92 * -- after this, rebooting will (try to) restart the main system --
93 * 7. ** if install failed **
94 * 7a. prompt_and_wait() shows an error icon and waits for the user
95 * 7b; the user reboots (pulling the battery, etc) into the main system
96 * 8. main() calls maybe_install_firmware_update()
97 * ** if the update contained radio/hboot firmware **:
98 * 8a. m_i_f_u() writes BCB with "boot-recovery" and "--wipe_cache"
99 * -- after this, rebooting will reformat cache & restart main system --
100 * 8b. m_i_f_u() writes firmware image into raw cache partition
101 * 8c. m_i_f_u() writes BCB with "update-radio/hboot" and "--wipe_cache"
102 * -- after this, rebooting will attempt to reinstall firmware --
103 * 8d. bootloader tries to flash firmware
104 * 8e. bootloader writes BCB with "boot-recovery" (keeping "--wipe_cache")
105 * -- after this, rebooting will reformat cache & restart main system --
106 * 8f. erase_root() reformats /cache
107 * 8g. finish_recovery() erases BCB
108 * -- after this, rebooting will (try to) restart the main system --
109 * 9. main() calls reboot() to boot main system
110 */
111
112 static const int MAX_ARG_LENGTH = 4096;
113 static const int MAX_ARGS = 100;
114
115 // open a file given in root:path format, mounting partitions as necessary
116 static FILE*
fopen_root_path(const char * root_path,const char * mode)117 fopen_root_path(const char *root_path, const char *mode) {
118 if (ensure_root_path_mounted(root_path) != 0) {
119 LOGE("Can't mount %s\n", root_path);
120 return NULL;
121 }
122
123 char path[PATH_MAX] = "";
124 if (translate_root_path(root_path, path, sizeof(path)) == NULL) {
125 LOGE("Bad path %s\n", root_path);
126 return NULL;
127 }
128
129 // When writing, try to create the containing directory, if necessary.
130 // Use generous permissions, the system (init.rc) will reset them.
131 if (strchr("wa", mode[0])) dirCreateHierarchy(path, 0777, NULL, 1);
132
133 FILE *fp = fopen(path, mode);
134 if (fp == NULL) LOGE("Can't open %s\n", path);
135 return fp;
136 }
137
138 // close a file, log an error if the error indicator is set
139 static void
check_and_fclose(FILE * fp,const char * name)140 check_and_fclose(FILE *fp, const char *name) {
141 fflush(fp);
142 if (ferror(fp)) LOGE("Error in %s\n(%s)\n", name, strerror(errno));
143 fclose(fp);
144 }
145
146 // command line args come from, in decreasing precedence:
147 // - the actual command line
148 // - the bootloader control block (one per line, after "recovery")
149 // - the contents of COMMAND_FILE (one per line)
150 static void
get_args(int * argc,char *** argv)151 get_args(int *argc, char ***argv) {
152 struct bootloader_message boot;
153 memset(&boot, 0, sizeof(boot));
154 get_bootloader_message(&boot); // this may fail, leaving a zeroed structure
155
156 if (boot.command[0] != 0 && boot.command[0] != 255) {
157 LOGI("Boot command: %.*s\n", sizeof(boot.command), boot.command);
158 }
159
160 if (boot.status[0] != 0 && boot.status[0] != 255) {
161 LOGI("Boot status: %.*s\n", sizeof(boot.status), boot.status);
162 }
163
164 // --- if arguments weren't supplied, look in the bootloader control block
165 if (*argc <= 1) {
166 boot.recovery[sizeof(boot.recovery) - 1] = '\0'; // Ensure termination
167 const char *arg = strtok(boot.recovery, "\n");
168 if (arg != NULL && !strcmp(arg, "recovery")) {
169 *argv = (char **) malloc(sizeof(char *) * MAX_ARGS);
170 (*argv)[0] = strdup(arg);
171 for (*argc = 1; *argc < MAX_ARGS; ++*argc) {
172 if ((arg = strtok(NULL, "\n")) == NULL) break;
173 (*argv)[*argc] = strdup(arg);
174 }
175 LOGI("Got arguments from boot message\n");
176 } else if (boot.recovery[0] != 0 && boot.recovery[0] != 255) {
177 LOGE("Bad boot message\n\"%.20s\"\n", boot.recovery);
178 }
179 }
180
181 // --- if that doesn't work, try the command file
182 if (*argc <= 1) {
183 FILE *fp = fopen_root_path(COMMAND_FILE, "r");
184 if (fp != NULL) {
185 char *argv0 = (*argv)[0];
186 *argv = (char **) malloc(sizeof(char *) * MAX_ARGS);
187 (*argv)[0] = argv0; // use the same program name
188
189 char buf[MAX_ARG_LENGTH];
190 for (*argc = 1; *argc < MAX_ARGS; ++*argc) {
191 if (!fgets(buf, sizeof(buf), fp)) break;
192 (*argv)[*argc] = strdup(strtok(buf, "\r\n")); // Strip newline.
193 }
194
195 check_and_fclose(fp, COMMAND_FILE);
196 LOGI("Got arguments from %s\n", COMMAND_FILE);
197 }
198 }
199
200 // --> write the arguments we have back into the bootloader control block
201 // always boot into recovery after this (until finish_recovery() is called)
202 strlcpy(boot.command, "boot-recovery", sizeof(boot.command));
203 strlcpy(boot.recovery, "recovery\n", sizeof(boot.recovery));
204 int i;
205 for (i = 1; i < *argc; ++i) {
206 strlcat(boot.recovery, (*argv)[i], sizeof(boot.recovery));
207 strlcat(boot.recovery, "\n", sizeof(boot.recovery));
208 }
209 set_bootloader_message(&boot);
210 }
211
212 static void
set_sdcard_update_bootloader_message()213 set_sdcard_update_bootloader_message()
214 {
215 struct bootloader_message boot;
216 memset(&boot, 0, sizeof(boot));
217 strlcpy(boot.command, "boot-recovery", sizeof(boot.command));
218 strlcpy(boot.recovery, "recovery\n", sizeof(boot.recovery));
219 set_bootloader_message(&boot);
220 }
221
222 // clear the recovery command and prepare to boot a (hopefully working) system,
223 // copy our log file to cache as well (for the system to read), and
224 // record any intent we were asked to communicate back to the system.
225 // this function is idempotent: call it as many times as you like.
226 static void
finish_recovery(const char * send_intent)227 finish_recovery(const char *send_intent)
228 {
229 // By this point, we're ready to return to the main system...
230 if (send_intent != NULL) {
231 FILE *fp = fopen_root_path(INTENT_FILE, "w");
232 if (fp != NULL) {
233 fputs(send_intent, fp);
234 check_and_fclose(fp, INTENT_FILE);
235 }
236 }
237
238 // Copy logs to cache so the system can find out what happened.
239 FILE *log = fopen_root_path(LOG_FILE, "a");
240 if (log != NULL) {
241 FILE *tmplog = fopen(TEMPORARY_LOG_FILE, "r");
242 if (tmplog == NULL) {
243 LOGE("Can't open %s\n", TEMPORARY_LOG_FILE);
244 } else {
245 static long tmplog_offset = 0;
246 fseek(tmplog, tmplog_offset, SEEK_SET); // Since last write
247 char buf[4096];
248 while (fgets(buf, sizeof(buf), tmplog)) fputs(buf, log);
249 tmplog_offset = ftell(tmplog);
250 check_and_fclose(tmplog, TEMPORARY_LOG_FILE);
251 }
252 check_and_fclose(log, LOG_FILE);
253 }
254
255 // Reset the bootloader message to revert to a normal main system boot.
256 struct bootloader_message boot;
257 memset(&boot, 0, sizeof(boot));
258 set_bootloader_message(&boot);
259
260 // Remove the command file, so recovery won't repeat indefinitely.
261 char path[PATH_MAX] = "";
262 if (ensure_root_path_mounted(COMMAND_FILE) != 0 ||
263 translate_root_path(COMMAND_FILE, path, sizeof(path)) == NULL ||
264 (unlink(path) && errno != ENOENT)) {
265 LOGW("Can't unlink %s\n", COMMAND_FILE);
266 }
267
268 sync(); // For good measure.
269 }
270
271 static int
erase_root(const char * root)272 erase_root(const char *root)
273 {
274 ui_set_background(BACKGROUND_ICON_INSTALLING);
275 ui_show_indeterminate_progress();
276 ui_print("Formatting %s...\n", root);
277 return format_root_device(root);
278 }
279
280 static char**
prepend_title(char ** headers)281 prepend_title(char** headers) {
282 char* title[] = { "Android system recovery <"
283 EXPAND(RECOVERY_API_VERSION) "e>",
284 "",
285 NULL };
286
287 // count the number of lines in our title, plus the
288 // caller-provided headers.
289 int count = 0;
290 char** p;
291 for (p = title; *p; ++p, ++count);
292 for (p = headers; *p; ++p, ++count);
293
294 char** new_headers = malloc((count+1) * sizeof(char*));
295 char** h = new_headers;
296 for (p = title; *p; ++p, ++h) *h = *p;
297 for (p = headers; *p; ++p, ++h) *h = *p;
298 *h = NULL;
299
300 return new_headers;
301 }
302
303 static int
get_menu_selection(char ** headers,char ** items,int menu_only)304 get_menu_selection(char** headers, char** items, int menu_only) {
305 // throw away keys pressed previously, so user doesn't
306 // accidentally trigger menu items.
307 ui_clear_key_queue();
308
309 ui_start_menu(headers, items);
310 int selected = 0;
311 int chosen_item = -1;
312
313 while (chosen_item < 0) {
314 int key = ui_wait_key();
315 int visible = ui_text_visible();
316
317 int action = device_handle_key(key, visible);
318
319 if (action < 0) {
320 switch (action) {
321 case HIGHLIGHT_UP:
322 --selected;
323 selected = ui_menu_select(selected);
324 break;
325 case HIGHLIGHT_DOWN:
326 ++selected;
327 selected = ui_menu_select(selected);
328 break;
329 case SELECT_ITEM:
330 chosen_item = selected;
331 break;
332 case NO_ACTION:
333 break;
334 }
335 } else if (!menu_only) {
336 chosen_item = action;
337 }
338 }
339
340 ui_end_menu();
341 return chosen_item;
342 }
343
344 static void
wipe_data(int confirm)345 wipe_data(int confirm) {
346 if (confirm) {
347 static char** title_headers = NULL;
348
349 if (title_headers == NULL) {
350 char* headers[] = { "Confirm wipe of all user data?",
351 " THIS CAN NOT BE UNDONE.",
352 "",
353 NULL };
354 title_headers = prepend_title(headers);
355 }
356
357 char* items[] = { " No",
358 " No",
359 " No",
360 " No",
361 " No",
362 " No",
363 " No",
364 " Yes -- delete all user data", // [7]
365 " No",
366 " No",
367 " No",
368 NULL };
369
370 int chosen_item = get_menu_selection(title_headers, items, 1);
371 if (chosen_item != 7) {
372 return;
373 }
374 }
375
376 ui_print("\n-- Wiping data...\n");
377 device_wipe_data();
378 erase_root("DATA:");
379 erase_root("CACHE:");
380 ui_print("Data wipe complete.\n");
381 }
382
383 static void
prompt_and_wait()384 prompt_and_wait()
385 {
386 char** headers = prepend_title(MENU_HEADERS);
387
388 for (;;) {
389 finish_recovery(NULL);
390 ui_reset_progress();
391
392 int chosen_item = get_menu_selection(headers, MENU_ITEMS, 0);
393
394 // device-specific code may take some action here. It may
395 // return one of the core actions handled in the switch
396 // statement below.
397 chosen_item = device_perform_action(chosen_item);
398
399 switch (chosen_item) {
400 case ITEM_REBOOT:
401 return;
402
403 case ITEM_WIPE_DATA:
404 wipe_data(ui_text_visible());
405 if (!ui_text_visible()) return;
406 break;
407
408 case ITEM_WIPE_CACHE:
409 ui_print("\n-- Wiping cache...\n");
410 erase_root("CACHE:");
411 ui_print("Cache wipe complete.\n");
412 if (!ui_text_visible()) return;
413 break;
414
415 case ITEM_APPLY_SDCARD:
416 ui_print("\n-- Install from sdcard...\n");
417 set_sdcard_update_bootloader_message();
418 int status = install_package(SDCARD_PACKAGE_FILE);
419 if (status != INSTALL_SUCCESS) {
420 ui_set_background(BACKGROUND_ICON_ERROR);
421 ui_print("Installation aborted.\n");
422 } else if (!ui_text_visible()) {
423 return; // reboot if logs aren't visible
424 } else {
425 if (firmware_update_pending()) {
426 ui_print("\nReboot via menu to complete\n"
427 "installation.\n");
428 } else {
429 ui_print("\nInstall from sdcard complete.\n");
430 }
431 }
432 break;
433 }
434 }
435 }
436
437 static void
print_property(const char * key,const char * name,void * cookie)438 print_property(const char *key, const char *name, void *cookie)
439 {
440 fprintf(stderr, "%s=%s\n", key, name);
441 }
442
443 int
main(int argc,char ** argv)444 main(int argc, char **argv)
445 {
446 time_t start = time(NULL);
447
448 // If these fail, there's not really anywhere to complain...
449 freopen(TEMPORARY_LOG_FILE, "a", stdout); setbuf(stdout, NULL);
450 freopen(TEMPORARY_LOG_FILE, "a", stderr); setbuf(stderr, NULL);
451 fprintf(stderr, "Starting recovery on %s", ctime(&start));
452
453 ui_init();
454 get_args(&argc, &argv);
455
456 int previous_runs = 0;
457 const char *send_intent = NULL;
458 const char *update_package = NULL;
459 int wipe_data = 0, wipe_cache = 0;
460
461 int arg;
462 while ((arg = getopt_long(argc, argv, "", OPTIONS, NULL)) != -1) {
463 switch (arg) {
464 case 'p': previous_runs = atoi(optarg); break;
465 case 's': send_intent = optarg; break;
466 case 'u': update_package = optarg; break;
467 case 'w': wipe_data = wipe_cache = 1; break;
468 case 'c': wipe_cache = 1; break;
469 case '?':
470 LOGE("Invalid command argument\n");
471 continue;
472 }
473 }
474
475 fprintf(stderr, "Command:");
476 for (arg = 0; arg < argc; arg++) {
477 fprintf(stderr, " \"%s\"", argv[arg]);
478 }
479 fprintf(stderr, "\n\n");
480
481 property_list(print_property, NULL);
482 fprintf(stderr, "\n");
483
484 int status = INSTALL_SUCCESS;
485
486 if (update_package != NULL) {
487 status = install_package(update_package);
488 if (status != INSTALL_SUCCESS) ui_print("Installation aborted.\n");
489 } else if (wipe_data) {
490 if (device_wipe_data()) status = INSTALL_ERROR;
491 if (erase_root("DATA:")) status = INSTALL_ERROR;
492 if (wipe_cache && erase_root("CACHE:")) status = INSTALL_ERROR;
493 if (status != INSTALL_SUCCESS) ui_print("Data wipe failed.\n");
494 } else if (wipe_cache) {
495 if (wipe_cache && erase_root("CACHE:")) status = INSTALL_ERROR;
496 if (status != INSTALL_SUCCESS) ui_print("Cache wipe failed.\n");
497 } else {
498 status = INSTALL_ERROR; // No command specified
499 }
500
501 if (status != INSTALL_SUCCESS) ui_set_background(BACKGROUND_ICON_ERROR);
502 if (status != INSTALL_SUCCESS || ui_text_visible()) prompt_and_wait();
503
504 // If there is a radio image pending, reboot now to install it.
505 maybe_install_firmware_update(send_intent);
506
507 // Otherwise, get ready to boot the main system...
508 finish_recovery(send_intent);
509 ui_print("Rebooting...\n");
510 sync();
511 reboot(RB_AUTOBOOT);
512 return EXIT_SUCCESS;
513 }
514