1 /*
2 * Copyright (C) 2008 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #include "fastboot.h"
30
31 #include <ctype.h>
32 #include <errno.h>
33 #include <fcntl.h>
34 #include <getopt.h>
35 #include <inttypes.h>
36 #include <limits.h>
37 #include <stdint.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <sys/stat.h>
42 #include <sys/time.h>
43 #include <sys/types.h>
44 #include <unistd.h>
45
46 #include <chrono>
47 #include <functional>
48 #include <regex>
49 #include <string>
50 #include <thread>
51 #include <utility>
52 #include <vector>
53
54 #include <android-base/endian.h>
55 #include <android-base/file.h>
56 #include <android-base/macros.h>
57 #include <android-base/parseint.h>
58 #include <android-base/parsenetaddress.h>
59 #include <android-base/stringprintf.h>
60 #include <android-base/strings.h>
61 #include <android-base/unique_fd.h>
62 #include <build/version.h>
63 #include <libavb/libavb.h>
64 #include <liblp/liblp.h>
65 #include <platform_tools_version.h>
66 #include <sparse/sparse.h>
67 #include <ziparchive/zip_archive.h>
68
69 #include "bootimg_utils.h"
70 #include "constants.h"
71 #include "diagnose_usb.h"
72 #include "fastboot_driver.h"
73 #include "fs.h"
74 #include "tcp.h"
75 #include "transport.h"
76 #include "udp.h"
77 #include "usb.h"
78 #include "util.h"
79 #include "vendor_boot_img_utils.h"
80
81 using android::base::borrowed_fd;
82 using android::base::ReadFully;
83 using android::base::Split;
84 using android::base::Trim;
85 using android::base::unique_fd;
86 using namespace std::string_literals;
87 using namespace std::placeholders;
88
89 static const char* serial = nullptr;
90
91 static bool g_long_listing = false;
92 // Don't resparse files in too-big chunks.
93 // libsparse will support INT_MAX, but this results in large allocations, so
94 // let's keep it at 1GB to avoid memory pressure on the host.
95 static constexpr int64_t RESPARSE_LIMIT = 1 * 1024 * 1024 * 1024;
96 static uint64_t sparse_limit = 0;
97 static int64_t target_sparse_limit = -1;
98
99 static unsigned g_base_addr = 0x10000000;
100 static boot_img_hdr_v2 g_boot_img_hdr = {};
101 static std::string g_cmdline;
102 static std::string g_dtb_path;
103
104 static bool g_disable_verity = false;
105 static bool g_disable_verification = false;
106
107 fastboot::FastBootDriver* fb = nullptr;
108
109 enum fb_buffer_type {
110 FB_BUFFER_FD,
111 FB_BUFFER_SPARSE,
112 };
113
114 struct fastboot_buffer {
115 enum fb_buffer_type type;
116 void* data;
117 int64_t sz;
118 unique_fd fd;
119 int64_t image_size;
120 };
121
122 enum class ImageType {
123 // Must be flashed for device to boot into the kernel.
124 BootCritical,
125 // Normal partition to be flashed during "flashall".
126 Normal,
127 // Partition that is never flashed during "flashall".
128 Extra
129 };
130
131 struct Image {
132 const char* nickname;
133 const char* img_name;
134 const char* sig_name;
135 const char* part_name;
136 bool optional_if_no_image;
137 ImageType type;
IsSecondaryImage138 bool IsSecondary() const { return nickname == nullptr; }
139 };
140
141 static Image images[] = {
142 // clang-format off
143 { "boot", "boot.img", "boot.sig", "boot", false, ImageType::BootCritical },
144 { "init_boot",
145 "init_boot.img", "init_boot.sig",
146 "init_boot",
147 true, ImageType::BootCritical },
148 { nullptr, "boot_other.img", "boot.sig", "boot", true, ImageType::Normal },
149 { "cache", "cache.img", "cache.sig", "cache", true, ImageType::Extra },
150 { "dtbo", "dtbo.img", "dtbo.sig", "dtbo", true, ImageType::BootCritical },
151 { "dts", "dt.img", "dt.sig", "dts", true, ImageType::BootCritical },
152 { "odm", "odm.img", "odm.sig", "odm", true, ImageType::Normal },
153 { "odm_dlkm", "odm_dlkm.img", "odm_dlkm.sig", "odm_dlkm", true, ImageType::Normal },
154 { "product", "product.img", "product.sig", "product", true, ImageType::Normal },
155 { "pvmfw", "pvmfw.img", "pvmfw.sig", "pvmfw", true, ImageType::BootCritical },
156 { "recovery", "recovery.img", "recovery.sig", "recovery", true, ImageType::BootCritical },
157 { "super", "super.img", "super.sig", "super", true, ImageType::Extra },
158 { "system", "system.img", "system.sig", "system", false, ImageType::Normal },
159 { "system_dlkm",
160 "system_dlkm.img", "system_dlkm.sig",
161 "system_dlkm",
162 true, ImageType::Normal },
163 { "system_ext",
164 "system_ext.img", "system_ext.sig",
165 "system_ext",
166 true, ImageType::Normal },
167 { nullptr, "system_other.img", "system.sig", "system", true, ImageType::Normal },
168 { "userdata", "userdata.img", "userdata.sig", "userdata", true, ImageType::Extra },
169 { "vbmeta", "vbmeta.img", "vbmeta.sig", "vbmeta", true, ImageType::BootCritical },
170 { "vbmeta_system",
171 "vbmeta_system.img",
172 "vbmeta_system.sig",
173 "vbmeta_system",
174 true, ImageType::BootCritical },
175 { "vbmeta_vendor",
176 "vbmeta_vendor.img",
177 "vbmeta_vendor.sig",
178 "vbmeta_vendor",
179 true, ImageType::BootCritical },
180 { "vendor", "vendor.img", "vendor.sig", "vendor", true, ImageType::Normal },
181 { "vendor_boot",
182 "vendor_boot.img", "vendor_boot.sig",
183 "vendor_boot",
184 true, ImageType::BootCritical },
185 { "vendor_dlkm",
186 "vendor_dlkm.img", "vendor_dlkm.sig",
187 "vendor_dlkm",
188 true, ImageType::Normal },
189 { "vendor_kernel_boot",
190 "vendor_kernel_boot.img",
191 "vendor_kernel_boot.sig",
192 "vendor_kernel_boot",
193 true, ImageType::BootCritical },
194 { nullptr, "vendor_other.img", "vendor.sig", "vendor", true, ImageType::Normal },
195 // clang-format on
196 };
197
get_android_product_out()198 static char* get_android_product_out() {
199 char* dir = getenv("ANDROID_PRODUCT_OUT");
200 if (dir == nullptr || dir[0] == '\0') {
201 return nullptr;
202 }
203 return dir;
204 }
205
find_item_given_name(const std::string & img_name)206 static std::string find_item_given_name(const std::string& img_name) {
207 char* dir = get_android_product_out();
208 if (!dir) {
209 die("ANDROID_PRODUCT_OUT not set");
210 }
211 return std::string(dir) + "/" + img_name;
212 }
213
find_item(const std::string & item)214 static std::string find_item(const std::string& item) {
215 for (size_t i = 0; i < arraysize(images); ++i) {
216 if (images[i].nickname && item == images[i].nickname) {
217 return find_item_given_name(images[i].img_name);
218 }
219 }
220
221 fprintf(stderr, "unknown partition '%s'\n", item.c_str());
222 return "";
223 }
224
225 double last_start_time;
226
Status(const std::string & message)227 static void Status(const std::string& message) {
228 if (!message.empty()) {
229 static constexpr char kStatusFormat[] = "%-50s ";
230 fprintf(stderr, kStatusFormat, message.c_str());
231 }
232 last_start_time = now();
233 }
234
Epilog(int status)235 static void Epilog(int status) {
236 if (status) {
237 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
238 die("Command failed");
239 } else {
240 double split = now();
241 fprintf(stderr, "OKAY [%7.3fs]\n", (split - last_start_time));
242 }
243 }
244
InfoMessage(const std::string & info)245 static void InfoMessage(const std::string& info) {
246 fprintf(stderr, "(bootloader) %s\n", info.c_str());
247 }
248
get_file_size(borrowed_fd fd)249 static int64_t get_file_size(borrowed_fd fd) {
250 struct stat sb;
251 if (fstat(fd.get(), &sb) == -1) {
252 die("could not get file size");
253 }
254 return sb.st_size;
255 }
256
ReadFileToVector(const std::string & file,std::vector<char> * out)257 bool ReadFileToVector(const std::string& file, std::vector<char>* out) {
258 out->clear();
259
260 unique_fd fd(TEMP_FAILURE_RETRY(open(file.c_str(), O_RDONLY | O_CLOEXEC | O_BINARY)));
261 if (fd == -1) {
262 return false;
263 }
264
265 out->resize(get_file_size(fd));
266 return ReadFully(fd, out->data(), out->size());
267 }
268
match_fastboot_with_serial(usb_ifc_info * info,const char * local_serial)269 static int match_fastboot_with_serial(usb_ifc_info* info, const char* local_serial) {
270 if (info->ifc_class != 0xff || info->ifc_subclass != 0x42 || info->ifc_protocol != 0x03) {
271 return -1;
272 }
273
274 // require matching serial number or device path if requested
275 // at the command line with the -s option.
276 if (local_serial && (strcmp(local_serial, info->serial_number) != 0 &&
277 strcmp(local_serial, info->device_path) != 0)) return -1;
278 return 0;
279 }
280
match_fastboot(usb_ifc_info * info)281 static int match_fastboot(usb_ifc_info* info) {
282 return match_fastboot_with_serial(info, serial);
283 }
284
list_devices_callback(usb_ifc_info * info)285 static int list_devices_callback(usb_ifc_info* info) {
286 if (match_fastboot_with_serial(info, nullptr) == 0) {
287 std::string serial = info->serial_number;
288 std::string interface = info->interface;
289 if (interface.empty()) {
290 interface = "fastboot";
291 }
292 if (!info->writable) {
293 serial = UsbNoPermissionsShortHelpText();
294 }
295 if (!serial[0]) {
296 serial = "????????????";
297 }
298 // output compatible with "adb devices"
299 if (!g_long_listing) {
300 printf("%s\t%s", serial.c_str(), interface.c_str());
301 } else {
302 printf("%-22s %s", serial.c_str(), interface.c_str());
303 if (strlen(info->device_path) > 0) printf(" %s", info->device_path);
304 }
305 putchar('\n');
306 }
307
308 return -1;
309 }
310
311 // Opens a new Transport connected to a device. If |serial| is non-null it will be used to identify
312 // a specific device, otherwise the first USB device found will be used.
313 //
314 // If |serial| is non-null but invalid, this exits.
315 // Otherwise it blocks until the target is available.
316 //
317 // The returned Transport is a singleton, so multiple calls to this function will return the same
318 // object, and the caller should not attempt to delete the returned Transport.
open_device()319 static Transport* open_device() {
320 bool announce = true;
321
322 Socket::Protocol protocol = Socket::Protocol::kTcp;
323 std::string host;
324 int port = 0;
325 if (serial != nullptr) {
326 const char* net_address = nullptr;
327
328 if (android::base::StartsWith(serial, "tcp:")) {
329 protocol = Socket::Protocol::kTcp;
330 port = tcp::kDefaultPort;
331 net_address = serial + strlen("tcp:");
332 } else if (android::base::StartsWith(serial, "udp:")) {
333 protocol = Socket::Protocol::kUdp;
334 port = udp::kDefaultPort;
335 net_address = serial + strlen("udp:");
336 }
337
338 if (net_address != nullptr) {
339 std::string error;
340 if (!android::base::ParseNetAddress(net_address, &host, &port, nullptr, &error)) {
341 die("invalid network address '%s': %s\n", net_address, error.c_str());
342 }
343 }
344 }
345
346 Transport* transport = nullptr;
347 while (true) {
348 if (!host.empty()) {
349 std::string error;
350 if (protocol == Socket::Protocol::kTcp) {
351 transport = tcp::Connect(host, port, &error).release();
352 } else if (protocol == Socket::Protocol::kUdp) {
353 transport = udp::Connect(host, port, &error).release();
354 }
355
356 if (transport == nullptr && announce) {
357 fprintf(stderr, "error: %s\n", error.c_str());
358 }
359 } else {
360 transport = usb_open(match_fastboot);
361 }
362
363 if (transport != nullptr) {
364 return transport;
365 }
366
367 if (announce) {
368 announce = false;
369 fprintf(stderr, "< waiting for %s >\n", serial ? serial : "any device");
370 }
371 std::this_thread::sleep_for(std::chrono::milliseconds(1));
372 }
373 }
374
list_devices()375 static void list_devices() {
376 // We don't actually open a USB device here,
377 // just getting our callback called so we can
378 // list all the connected devices.
379 usb_open(list_devices_callback);
380 }
381
syntax_error(const char * fmt,...)382 static void syntax_error(const char* fmt, ...) {
383 fprintf(stderr, "fastboot: usage: ");
384
385 va_list ap;
386 va_start(ap, fmt);
387 vfprintf(stderr, fmt, ap);
388 va_end(ap);
389
390 fprintf(stderr, "\n");
391 exit(1);
392 }
393
show_help()394 static int show_help() {
395 // clang-format off
396 fprintf(stdout,
397 // 1 2 3 4 5 6 7 8
398 // 12345678901234567890123456789012345678901234567890123456789012345678901234567890
399 "usage: fastboot [OPTION...] COMMAND...\n"
400 "\n"
401 "flashing:\n"
402 " update ZIP Flash all partitions from an update.zip package.\n"
403 " flashall Flash all partitions from $ANDROID_PRODUCT_OUT.\n"
404 " On A/B devices, flashed slot is set as active.\n"
405 " Secondary images may be flashed to inactive slot.\n"
406 " flash PARTITION [FILENAME] Flash given partition, using the image from\n"
407 " $ANDROID_PRODUCT_OUT if no filename is given.\n"
408 "\n"
409 "basics:\n"
410 " devices [-l] List devices in bootloader (-l: with device paths).\n"
411 " getvar NAME Display given bootloader variable.\n"
412 " reboot [bootloader] Reboot device.\n"
413 "\n"
414 "locking/unlocking:\n"
415 " flashing lock|unlock Lock/unlock partitions for flashing\n"
416 " flashing lock_critical|unlock_critical\n"
417 " Lock/unlock 'critical' bootloader partitions.\n"
418 " flashing get_unlock_ability\n"
419 " Check whether unlocking is allowed (1) or not(0).\n"
420 "\n"
421 "advanced:\n"
422 " erase PARTITION Erase a flash partition.\n"
423 " format[:FS_TYPE[:SIZE]] PARTITION\n"
424 " Format a flash partition.\n"
425 " set_active SLOT Set the active slot.\n"
426 " oem [COMMAND...] Execute OEM-specific command.\n"
427 " gsi wipe|disable Wipe or disable a GSI installation (fastbootd only).\n"
428 " wipe-super [SUPER_EMPTY] Wipe the super partition. This will reset it to\n"
429 " contain an empty set of default dynamic partitions.\n"
430 " create-logical-partition NAME SIZE\n"
431 " Create a logical partition with the given name and\n"
432 " size, in the super partition.\n"
433 " delete-logical-partition NAME\n"
434 " Delete a logical partition with the given name.\n"
435 " resize-logical-partition NAME SIZE\n"
436 " Change the size of the named logical partition.\n"
437 " snapshot-update cancel On devices that support snapshot-based updates, cancel\n"
438 " an in-progress update. This may make the device\n"
439 " unbootable until it is reflashed.\n"
440 " snapshot-update merge On devices that support snapshot-based updates, finish\n"
441 " an in-progress update if it is in the \"merging\"\n"
442 " phase.\n"
443 " fetch PARTITION OUT_FILE Fetch a partition image from the device."
444 "\n"
445 "boot image:\n"
446 " boot KERNEL [RAMDISK [SECOND]]\n"
447 " Download and boot kernel from RAM.\n"
448 " flash:raw PARTITION KERNEL [RAMDISK [SECOND]]\n"
449 " Create boot image and flash it.\n"
450 " --dtb DTB Specify path to DTB for boot image header version 2.\n"
451 " --cmdline CMDLINE Override kernel command line.\n"
452 " --base ADDRESS Set kernel base address (default: 0x10000000).\n"
453 " --kernel-offset Set kernel offset (default: 0x00008000).\n"
454 " --ramdisk-offset Set ramdisk offset (default: 0x01000000).\n"
455 " --tags-offset Set tags offset (default: 0x00000100).\n"
456 " --dtb-offset Set dtb offset (default: 0x01100000).\n"
457 " --page-size BYTES Set flash page size (default: 2048).\n"
458 " --header-version VERSION Set boot image header version.\n"
459 " --os-version MAJOR[.MINOR[.PATCH]]\n"
460 " Set boot image OS version (default: 0.0.0).\n"
461 " --os-patch-level YYYY-MM-DD\n"
462 " Set boot image OS security patch level.\n"
463 // TODO: still missing: `second_addr`, `name`, `id`, `recovery_dtbo_*`.
464 "\n"
465 // TODO: what device(s) used this? is there any documentation?
466 //" continue Continue with autoboot.\n"
467 //"\n"
468 "Android Things:\n"
469 " stage IN_FILE Sends given file to stage for the next command.\n"
470 " get_staged OUT_FILE Writes data staged by the last command to a file.\n"
471 "\n"
472 "options:\n"
473 " -w Wipe userdata.\n"
474 " -s SERIAL Specify a USB device.\n"
475 " -s tcp|udp:HOST[:PORT] Specify a network device.\n"
476 " -S SIZE[K|M|G] Break into sparse files no larger than SIZE.\n"
477 " --force Force a flash operation that may be unsafe.\n"
478 " --slot SLOT Use SLOT; 'all' for both slots, 'other' for\n"
479 " non-current slot (default: current active slot).\n"
480 " --set-active[=SLOT] Sets the active slot before rebooting.\n"
481 " --skip-secondary Don't flash secondary slots in flashall/update.\n"
482 " --skip-reboot Don't reboot device after flashing.\n"
483 " --disable-verity Sets disable-verity when flashing vbmeta.\n"
484 " --disable-verification Sets disable-verification when flashing vbmeta.\n"
485 " --fs-options=OPTION[,OPTION]\n"
486 " Enable filesystem features. OPTION supports casefold, projid, compress\n"
487 // TODO: remove --unbuffered?
488 " --unbuffered Don't buffer input or output.\n"
489 " --verbose, -v Verbose output.\n"
490 " --version Display version.\n"
491 " --help, -h Show this message.\n"
492 );
493 // clang-format on
494 return 0;
495 }
496
LoadBootableImage(const std::string & kernel,const std::string & ramdisk,const std::string & second_stage)497 static std::vector<char> LoadBootableImage(const std::string& kernel, const std::string& ramdisk,
498 const std::string& second_stage) {
499 std::vector<char> kernel_data;
500 if (!ReadFileToVector(kernel, &kernel_data)) {
501 die("cannot load '%s': %s", kernel.c_str(), strerror(errno));
502 }
503
504 // Is this actually a boot image?
505 if (kernel_data.size() < sizeof(boot_img_hdr_v3)) {
506 die("cannot load '%s': too short", kernel.c_str());
507 }
508 if (!memcmp(kernel_data.data(), BOOT_MAGIC, BOOT_MAGIC_SIZE)) {
509 if (!g_cmdline.empty()) {
510 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(kernel_data.data()), g_cmdline);
511 }
512
513 if (!ramdisk.empty()) die("cannot boot a boot.img *and* ramdisk");
514
515 return kernel_data;
516 }
517
518 std::vector<char> ramdisk_data;
519 if (!ramdisk.empty()) {
520 if (!ReadFileToVector(ramdisk, &ramdisk_data)) {
521 die("cannot load '%s': %s", ramdisk.c_str(), strerror(errno));
522 }
523 }
524
525 std::vector<char> second_stage_data;
526 if (!second_stage.empty()) {
527 if (!ReadFileToVector(second_stage, &second_stage_data)) {
528 die("cannot load '%s': %s", second_stage.c_str(), strerror(errno));
529 }
530 }
531
532 std::vector<char> dtb_data;
533 if (!g_dtb_path.empty()) {
534 if (g_boot_img_hdr.header_version != 2) {
535 die("Argument dtb not supported for boot image header version %d\n",
536 g_boot_img_hdr.header_version);
537 }
538 if (!ReadFileToVector(g_dtb_path, &dtb_data)) {
539 die("cannot load '%s': %s", g_dtb_path.c_str(), strerror(errno));
540 }
541 }
542
543 fprintf(stderr,"creating boot image...\n");
544
545 std::vector<char> out;
546 mkbootimg(kernel_data, ramdisk_data, second_stage_data, dtb_data, g_base_addr, g_boot_img_hdr,
547 &out);
548
549 if (!g_cmdline.empty()) {
550 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(out.data()), g_cmdline);
551 }
552 fprintf(stderr, "creating boot image - %zu bytes\n", out.size());
553 return out;
554 }
555
UnzipToMemory(ZipArchiveHandle zip,const std::string & entry_name,std::vector<char> * out)556 static bool UnzipToMemory(ZipArchiveHandle zip, const std::string& entry_name,
557 std::vector<char>* out) {
558 ZipEntry64 zip_entry;
559 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
560 fprintf(stderr, "archive does not contain '%s'\n", entry_name.c_str());
561 return false;
562 }
563
564 if (zip_entry.uncompressed_length > std::numeric_limits<size_t>::max()) {
565 die("entry '%s' is too large: %" PRIu64, entry_name.c_str(), zip_entry.uncompressed_length);
566 }
567 out->resize(zip_entry.uncompressed_length);
568
569 fprintf(stderr, "extracting %s (%zu MB) to RAM...\n", entry_name.c_str(),
570 out->size() / 1024 / 1024);
571
572 int error = ExtractToMemory(zip, &zip_entry, reinterpret_cast<uint8_t*>(out->data()),
573 out->size());
574 if (error != 0) die("failed to extract '%s': %s", entry_name.c_str(), ErrorCodeString(error));
575
576 return true;
577 }
578
579 #if defined(_WIN32)
580
581 // TODO: move this to somewhere it can be shared.
582
583 #include <windows.h>
584
585 // Windows' tmpfile(3) requires administrator rights because
586 // it creates temporary files in the root directory.
win32_tmpfile()587 static FILE* win32_tmpfile() {
588 char temp_path[PATH_MAX];
589 DWORD nchars = GetTempPath(sizeof(temp_path), temp_path);
590 if (nchars == 0 || nchars >= sizeof(temp_path)) {
591 die("GetTempPath failed, error %ld", GetLastError());
592 }
593
594 char filename[PATH_MAX];
595 if (GetTempFileName(temp_path, "fastboot", 0, filename) == 0) {
596 die("GetTempFileName failed, error %ld", GetLastError());
597 }
598
599 return fopen(filename, "w+bTD");
600 }
601
602 #define tmpfile win32_tmpfile
603
make_temporary_fd(const char *)604 static int make_temporary_fd(const char* /*what*/) {
605 // TODO: reimplement to avoid leaking a FILE*.
606 return fileno(tmpfile());
607 }
608
609 #else
610
make_temporary_template()611 static std::string make_temporary_template() {
612 const char* tmpdir = getenv("TMPDIR");
613 if (tmpdir == nullptr) tmpdir = P_tmpdir;
614 return std::string(tmpdir) + "/fastboot_userdata_XXXXXX";
615 }
616
make_temporary_fd(const char * what)617 static int make_temporary_fd(const char* what) {
618 std::string path_template(make_temporary_template());
619 int fd = mkstemp(&path_template[0]);
620 if (fd == -1) {
621 die("failed to create temporary file for %s with template %s: %s\n",
622 path_template.c_str(), what, strerror(errno));
623 }
624 unlink(path_template.c_str());
625 return fd;
626 }
627
628 #endif
629
unzip_to_file(ZipArchiveHandle zip,const char * entry_name)630 static unique_fd unzip_to_file(ZipArchiveHandle zip, const char* entry_name) {
631 unique_fd fd(make_temporary_fd(entry_name));
632
633 ZipEntry64 zip_entry;
634 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
635 fprintf(stderr, "archive does not contain '%s'\n", entry_name);
636 errno = ENOENT;
637 return unique_fd();
638 }
639
640 fprintf(stderr, "extracting %s (%" PRIu64 " MB) to disk...", entry_name,
641 zip_entry.uncompressed_length / 1024 / 1024);
642 double start = now();
643 int error = ExtractEntryToFile(zip, &zip_entry, fd.get());
644 if (error != 0) {
645 die("\nfailed to extract '%s': %s", entry_name, ErrorCodeString(error));
646 }
647
648 if (lseek(fd.get(), 0, SEEK_SET) != 0) {
649 die("\nlseek on extracted file '%s' failed: %s", entry_name, strerror(errno));
650 }
651
652 fprintf(stderr, " took %.3fs\n", now() - start);
653
654 return fd;
655 }
656
CheckRequirement(const std::string & cur_product,const std::string & var,const std::string & product,bool invert,const std::vector<std::string> & options)657 static bool CheckRequirement(const std::string& cur_product, const std::string& var,
658 const std::string& product, bool invert,
659 const std::vector<std::string>& options) {
660 Status("Checking '" + var + "'");
661
662 double start = now();
663
664 if (!product.empty()) {
665 if (product != cur_product) {
666 double split = now();
667 fprintf(stderr, "IGNORE, product is %s required only for %s [%7.3fs]\n",
668 cur_product.c_str(), product.c_str(), (split - start));
669 return true;
670 }
671 }
672
673 std::string var_value;
674 if (fb->GetVar(var, &var_value) != fastboot::SUCCESS) {
675 fprintf(stderr, "FAILED\n\n");
676 fprintf(stderr, "Could not getvar for '%s' (%s)\n\n", var.c_str(),
677 fb->Error().c_str());
678 return false;
679 }
680
681 bool match = false;
682 for (const auto& option : options) {
683 if (option == var_value || (option.back() == '*' &&
684 !var_value.compare(0, option.length() - 1, option, 0,
685 option.length() - 1))) {
686 match = true;
687 break;
688 }
689 }
690
691 if (invert) {
692 match = !match;
693 }
694
695 if (match) {
696 double split = now();
697 fprintf(stderr, "OKAY [%7.3fs]\n", (split - start));
698 return true;
699 }
700
701 fprintf(stderr, "FAILED\n\n");
702 fprintf(stderr, "Device %s is '%s'.\n", var.c_str(), var_value.c_str());
703 fprintf(stderr, "Update %s '%s'", invert ? "rejects" : "requires", options[0].c_str());
704 for (auto it = std::next(options.begin()); it != options.end(); ++it) {
705 fprintf(stderr, " or '%s'", it->c_str());
706 }
707 fprintf(stderr, ".\n\n");
708 return false;
709 }
710
ParseRequirementLine(const std::string & line,std::string * name,std::string * product,bool * invert,std::vector<std::string> * options)711 bool ParseRequirementLine(const std::string& line, std::string* name, std::string* product,
712 bool* invert, std::vector<std::string>* options) {
713 // "require product=alpha|beta|gamma"
714 // "require version-bootloader=1234"
715 // "require-for-product:gamma version-bootloader=istanbul|constantinople"
716 // "require partition-exists=vendor"
717 *product = "";
718 *invert = false;
719
720 auto require_reject_regex = std::regex{"(require\\s+|reject\\s+)?\\s*(\\S+)\\s*=\\s*(.*)"};
721 auto require_product_regex =
722 std::regex{"require-for-product:\\s*(\\S+)\\s+(\\S+)\\s*=\\s*(.*)"};
723 std::smatch match_results;
724
725 if (std::regex_match(line, match_results, require_reject_regex)) {
726 *invert = Trim(match_results[1]) == "reject";
727 } else if (std::regex_match(line, match_results, require_product_regex)) {
728 *product = match_results[1];
729 } else {
730 return false;
731 }
732
733 *name = match_results[2];
734 // Work around an unfortunate name mismatch.
735 if (*name == "board") {
736 *name = "product";
737 }
738
739 auto raw_options = Split(match_results[3], "|");
740 for (const auto& option : raw_options) {
741 auto trimmed_option = Trim(option);
742 options->emplace_back(trimmed_option);
743 }
744
745 return true;
746 }
747
748 // "require partition-exists=x" is a special case, added because of the trouble we had when
749 // Pixel 2 shipped with new partitions and users used old versions of fastboot to flash them,
750 // missing out new partitions. A device with new partitions can use "partition-exists" to
751 // override the fields `optional_if_no_image` in the `images` array.
HandlePartitionExists(const std::vector<std::string> & options)752 static void HandlePartitionExists(const std::vector<std::string>& options) {
753 const std::string& partition_name = options[0];
754 std::string has_slot;
755 if (fb->GetVar("has-slot:" + partition_name, &has_slot) != fastboot::SUCCESS ||
756 (has_slot != "yes" && has_slot != "no")) {
757 die("device doesn't have required partition %s!", partition_name.c_str());
758 }
759 bool known_partition = false;
760 for (size_t i = 0; i < arraysize(images); ++i) {
761 if (images[i].nickname && images[i].nickname == partition_name) {
762 images[i].optional_if_no_image = false;
763 known_partition = true;
764 }
765 }
766 if (!known_partition) {
767 die("device requires partition %s which is not known to this version of fastboot",
768 partition_name.c_str());
769 }
770 }
771
CheckRequirements(const std::string & data,bool force_flash)772 static void CheckRequirements(const std::string& data, bool force_flash) {
773 std::string cur_product;
774 if (fb->GetVar("product", &cur_product) != fastboot::SUCCESS) {
775 fprintf(stderr, "getvar:product FAILED (%s)\n", fb->Error().c_str());
776 }
777
778 auto lines = Split(data, "\n");
779 for (const auto& line : lines) {
780 if (line.empty()) {
781 continue;
782 }
783
784 std::string name;
785 std::string product;
786 bool invert;
787 std::vector<std::string> options;
788
789 if (!ParseRequirementLine(line, &name, &product, &invert, &options)) {
790 fprintf(stderr, "android-info.txt syntax error: %s\n", line.c_str());
791 continue;
792 }
793 if (name == "partition-exists") {
794 HandlePartitionExists(options);
795 } else {
796 bool met = CheckRequirement(cur_product, name, product, invert, options);
797 if (!met) {
798 if (!force_flash) {
799 die("requirements not met!");
800 } else {
801 fprintf(stderr, "requirements not met! but proceeding due to --force\n");
802 }
803 }
804 }
805 }
806 }
807
DisplayVarOrError(const std::string & label,const std::string & var)808 static void DisplayVarOrError(const std::string& label, const std::string& var) {
809 std::string value;
810
811 if (fb->GetVar(var, &value) != fastboot::SUCCESS) {
812 Status("getvar:" + var);
813 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
814 return;
815 }
816 fprintf(stderr, "%s: %s\n", label.c_str(), value.c_str());
817 }
818
DumpInfo()819 static void DumpInfo() {
820 fprintf(stderr, "--------------------------------------------\n");
821 DisplayVarOrError("Bootloader Version...", "version-bootloader");
822 DisplayVarOrError("Baseband Version.....", "version-baseband");
823 DisplayVarOrError("Serial Number........", "serialno");
824 fprintf(stderr, "--------------------------------------------\n");
825
826 }
827
load_sparse_files(int fd,int64_t max_size)828 static struct sparse_file** load_sparse_files(int fd, int64_t max_size) {
829 struct sparse_file* s = sparse_file_import_auto(fd, false, true);
830 if (!s) die("cannot sparse read file");
831
832 if (max_size <= 0 || max_size > std::numeric_limits<uint32_t>::max()) {
833 die("invalid max size %" PRId64, max_size);
834 }
835
836 int files = sparse_file_resparse(s, max_size, nullptr, 0);
837 if (files < 0) die("Failed to resparse");
838
839 sparse_file** out_s = reinterpret_cast<sparse_file**>(calloc(sizeof(struct sparse_file *), files + 1));
840 if (!out_s) die("Failed to allocate sparse file array");
841
842 files = sparse_file_resparse(s, max_size, out_s, files);
843 if (files < 0) die("Failed to resparse");
844
845 return out_s;
846 }
847
get_uint_var(const char * var_name)848 static uint64_t get_uint_var(const char* var_name) {
849 std::string value_str;
850 if (fb->GetVar(var_name, &value_str) != fastboot::SUCCESS || value_str.empty()) {
851 verbose("target didn't report %s", var_name);
852 return 0;
853 }
854
855 // Some bootloaders (angler, for example) send spurious whitespace too.
856 value_str = android::base::Trim(value_str);
857
858 uint64_t value;
859 if (!android::base::ParseUint(value_str, &value)) {
860 fprintf(stderr, "couldn't parse %s '%s'\n", var_name, value_str.c_str());
861 return 0;
862 }
863 if (value > 0) verbose("target reported %s of %" PRId64 " bytes", var_name, value);
864 return value;
865 }
866
get_sparse_limit(int64_t size)867 static int64_t get_sparse_limit(int64_t size) {
868 int64_t limit = sparse_limit;
869 if (limit == 0) {
870 // Unlimited, so see what the target device's limit is.
871 // TODO: shouldn't we apply this limit even if you've used -S?
872 if (target_sparse_limit == -1) {
873 target_sparse_limit = static_cast<int64_t>(get_uint_var("max-download-size"));
874 }
875 if (target_sparse_limit > 0) {
876 limit = target_sparse_limit;
877 } else {
878 return 0;
879 }
880 }
881
882 if (size > limit) {
883 return std::min(limit, RESPARSE_LIMIT);
884 }
885
886 return 0;
887 }
888
load_buf_fd(unique_fd fd,struct fastboot_buffer * buf)889 static bool load_buf_fd(unique_fd fd, struct fastboot_buffer* buf) {
890 int64_t sz = get_file_size(fd);
891 if (sz == -1) {
892 return false;
893 }
894
895 if (sparse_file* s = sparse_file_import(fd.get(), false, false)) {
896 buf->image_size = sparse_file_len(s, false, false);
897 sparse_file_destroy(s);
898 } else {
899 buf->image_size = sz;
900 }
901
902 lseek(fd.get(), 0, SEEK_SET);
903 int64_t limit = get_sparse_limit(sz);
904 buf->fd = std::move(fd);
905 if (limit) {
906 sparse_file** s = load_sparse_files(buf->fd.get(), limit);
907 if (s == nullptr) {
908 return false;
909 }
910 buf->type = FB_BUFFER_SPARSE;
911 buf->data = s;
912 } else {
913 buf->type = FB_BUFFER_FD;
914 buf->data = nullptr;
915 buf->sz = sz;
916 }
917
918 return true;
919 }
920
load_buf(const char * fname,struct fastboot_buffer * buf)921 static bool load_buf(const char* fname, struct fastboot_buffer* buf) {
922 unique_fd fd(TEMP_FAILURE_RETRY(open(fname, O_RDONLY | O_BINARY)));
923
924 if (fd == -1) {
925 return false;
926 }
927
928 struct stat s;
929 if (fstat(fd.get(), &s)) {
930 return false;
931 }
932 if (!S_ISREG(s.st_mode)) {
933 errno = S_ISDIR(s.st_mode) ? EISDIR : EINVAL;
934 return false;
935 }
936
937 return load_buf_fd(std::move(fd), buf);
938 }
939
rewrite_vbmeta_buffer(struct fastboot_buffer * buf,bool vbmeta_in_boot)940 static void rewrite_vbmeta_buffer(struct fastboot_buffer* buf, bool vbmeta_in_boot) {
941 // Buffer needs to be at least the size of the VBMeta struct which
942 // is 256 bytes.
943 if (buf->sz < 256) {
944 return;
945 }
946
947 std::string data;
948 if (!android::base::ReadFdToString(buf->fd, &data)) {
949 die("Failed reading from vbmeta");
950 }
951
952 uint64_t vbmeta_offset = 0;
953 if (vbmeta_in_boot) {
954 // Tries to locate top-level vbmeta from boot.img footer.
955 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
956 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
957 die("Failed to find AVB_FOOTER at offset: %" PRId64 ", is BOARD_AVB_ENABLE true?",
958 footer_offset);
959 }
960 const AvbFooter* footer = reinterpret_cast<const AvbFooter*>(data.c_str() + footer_offset);
961 vbmeta_offset = be64toh(footer->vbmeta_offset);
962 }
963 // Ensures there is AVB_MAGIC at vbmeta_offset.
964 if (0 != data.compare(vbmeta_offset, AVB_MAGIC_LEN, AVB_MAGIC)) {
965 die("Failed to find AVB_MAGIC at offset: %" PRId64, vbmeta_offset);
966 }
967
968 fprintf(stderr, "Rewriting vbmeta struct at offset: %" PRId64 "\n", vbmeta_offset);
969
970 // There's a 32-bit big endian |flags| field at offset 120 where
971 // bit 0 corresponds to disable-verity and bit 1 corresponds to
972 // disable-verification.
973 //
974 // See external/avb/libavb/avb_vbmeta_image.h for the layout of
975 // the VBMeta struct.
976 uint64_t flags_offset = 123 + vbmeta_offset;
977 if (g_disable_verity) {
978 data[flags_offset] |= 0x01;
979 }
980 if (g_disable_verification) {
981 data[flags_offset] |= 0x02;
982 }
983
984 unique_fd fd(make_temporary_fd("vbmeta rewriting"));
985 if (!android::base::WriteStringToFd(data, fd)) {
986 die("Failed writing to modified vbmeta");
987 }
988 buf->fd = std::move(fd);
989 lseek(buf->fd.get(), 0, SEEK_SET);
990 }
991
has_vbmeta_partition()992 static bool has_vbmeta_partition() {
993 std::string partition_type;
994 return fb->GetVar("partition-type:vbmeta", &partition_type) == fastboot::SUCCESS ||
995 fb->GetVar("partition-type:vbmeta_a", &partition_type) == fastboot::SUCCESS ||
996 fb->GetVar("partition-type:vbmeta_b", &partition_type) == fastboot::SUCCESS;
997 }
998
is_logical(const std::string & partition)999 static bool is_logical(const std::string& partition) {
1000 std::string value;
1001 return fb->GetVar("is-logical:" + partition, &value) == fastboot::SUCCESS && value == "yes";
1002 }
1003
fb_fix_numeric_var(std::string var)1004 static std::string fb_fix_numeric_var(std::string var) {
1005 // Some bootloaders (angler, for example), send spurious leading whitespace.
1006 var = android::base::Trim(var);
1007 // Some bootloaders (hammerhead, for example) use implicit hex.
1008 // This code used to use strtol with base 16.
1009 if (!android::base::StartsWith(var, "0x")) var = "0x" + var;
1010 return var;
1011 }
1012
get_partition_size(const std::string & partition)1013 static uint64_t get_partition_size(const std::string& partition) {
1014 std::string partition_size_str;
1015 if (fb->GetVar("partition-size:" + partition, &partition_size_str) != fastboot::SUCCESS) {
1016 if (!is_logical(partition)) {
1017 return 0;
1018 }
1019 die("cannot get partition size for %s", partition.c_str());
1020 }
1021
1022 partition_size_str = fb_fix_numeric_var(partition_size_str);
1023 uint64_t partition_size;
1024 if (!android::base::ParseUint(partition_size_str, &partition_size)) {
1025 if (!is_logical(partition)) {
1026 return 0;
1027 }
1028 die("Couldn't parse partition size '%s'.", partition_size_str.c_str());
1029 }
1030 return partition_size;
1031 }
1032
copy_avb_footer(const std::string & partition,struct fastboot_buffer * buf)1033 static void copy_avb_footer(const std::string& partition, struct fastboot_buffer* buf) {
1034 if (buf->sz < AVB_FOOTER_SIZE) {
1035 return;
1036 }
1037
1038 // If overflows and negative, it should be < buf->sz.
1039 int64_t partition_size = static_cast<int64_t>(get_partition_size(partition));
1040
1041 if (partition_size == buf->sz) {
1042 return;
1043 }
1044 // Some device bootloaders might not implement `fastboot getvar partition-size:boot[_a|_b]`.
1045 // In this case, partition_size will be zero.
1046 if (partition_size < buf->sz) {
1047 fprintf(stderr,
1048 "Warning: skip copying %s image avb footer"
1049 " (%s partition size: %" PRId64 ", %s image size: %" PRId64 ").\n",
1050 partition.c_str(), partition.c_str(), partition_size, partition.c_str(), buf->sz);
1051 return;
1052 }
1053
1054 // IMPORTANT: after the following read, we need to reset buf->fd before return (if not die).
1055 // Because buf->fd will still be used afterwards.
1056 std::string data;
1057 if (!android::base::ReadFdToString(buf->fd, &data)) {
1058 die("Failed reading from %s", partition.c_str());
1059 }
1060
1061 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1062 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
1063 lseek(buf->fd.get(), 0, SEEK_SET); // IMPORTANT: resets buf->fd before return.
1064 return;
1065 }
1066
1067 const std::string tmp_fd_template = partition + " rewriting";
1068 unique_fd fd(make_temporary_fd(tmp_fd_template.c_str()));
1069 if (!android::base::WriteStringToFd(data, fd)) {
1070 die("Failed writing to modified %s", partition.c_str());
1071 }
1072 lseek(fd.get(), partition_size - AVB_FOOTER_SIZE, SEEK_SET);
1073 if (!android::base::WriteStringToFd(data.substr(footer_offset), fd)) {
1074 die("Failed copying AVB footer in %s", partition.c_str());
1075 }
1076 buf->fd = std::move(fd);
1077 buf->sz = partition_size;
1078 lseek(buf->fd.get(), 0, SEEK_SET);
1079 }
1080
flash_buf(const std::string & partition,struct fastboot_buffer * buf)1081 static void flash_buf(const std::string& partition, struct fastboot_buffer *buf)
1082 {
1083 sparse_file** s;
1084
1085 if (partition == "boot" || partition == "boot_a" || partition == "boot_b" ||
1086 partition == "init_boot" || partition == "init_boot_a" || partition == "init_boot_b") {
1087 copy_avb_footer(partition, buf);
1088 }
1089
1090 // Rewrite vbmeta if that's what we're flashing and modification has been requested.
1091 if (g_disable_verity || g_disable_verification) {
1092 // The vbmeta partition might have additional prefix if running in virtual machine
1093 // e.g., guest_vbmeta_a.
1094 if (android::base::EndsWith(partition, "vbmeta") ||
1095 android::base::EndsWith(partition, "vbmeta_a") ||
1096 android::base::EndsWith(partition, "vbmeta_b")) {
1097 rewrite_vbmeta_buffer(buf, false /* vbmeta_in_boot */);
1098 } else if (!has_vbmeta_partition() &&
1099 (partition == "boot" || partition == "boot_a" || partition == "boot_b")) {
1100 rewrite_vbmeta_buffer(buf, true /* vbmeta_in_boot */ );
1101 }
1102 }
1103
1104 switch (buf->type) {
1105 case FB_BUFFER_SPARSE: {
1106 std::vector<std::pair<sparse_file*, int64_t>> sparse_files;
1107 s = reinterpret_cast<sparse_file**>(buf->data);
1108 while (*s) {
1109 int64_t sz = sparse_file_len(*s, true, false);
1110 sparse_files.emplace_back(*s, sz);
1111 ++s;
1112 }
1113
1114 for (size_t i = 0; i < sparse_files.size(); ++i) {
1115 const auto& pair = sparse_files[i];
1116 fb->FlashPartition(partition, pair.first, pair.second, i + 1, sparse_files.size());
1117 }
1118 break;
1119 }
1120 case FB_BUFFER_FD:
1121 fb->FlashPartition(partition, buf->fd, buf->sz);
1122 break;
1123 default:
1124 die("unknown buffer type: %d", buf->type);
1125 }
1126 }
1127
get_current_slot()1128 static std::string get_current_slot() {
1129 std::string current_slot;
1130 if (fb->GetVar("current-slot", ¤t_slot) != fastboot::SUCCESS) return "";
1131 if (current_slot[0] == '_') current_slot.erase(0, 1);
1132 return current_slot;
1133 }
1134
get_slot_count()1135 static int get_slot_count() {
1136 std::string var;
1137 int count = 0;
1138 if (fb->GetVar("slot-count", &var) != fastboot::SUCCESS ||
1139 !android::base::ParseInt(var, &count)) {
1140 return 0;
1141 }
1142 return count;
1143 }
1144
supports_AB()1145 static bool supports_AB() {
1146 return get_slot_count() >= 2;
1147 }
1148
1149 // Given a current slot, this returns what the 'other' slot is.
get_other_slot(const std::string & current_slot,int count)1150 static std::string get_other_slot(const std::string& current_slot, int count) {
1151 if (count == 0) return "";
1152
1153 char next = (current_slot[0] - 'a' + 1)%count + 'a';
1154 return std::string(1, next);
1155 }
1156
get_other_slot(const std::string & current_slot)1157 static std::string get_other_slot(const std::string& current_slot) {
1158 return get_other_slot(current_slot, get_slot_count());
1159 }
1160
get_other_slot(int count)1161 static std::string get_other_slot(int count) {
1162 return get_other_slot(get_current_slot(), count);
1163 }
1164
get_other_slot()1165 static std::string get_other_slot() {
1166 return get_other_slot(get_current_slot(), get_slot_count());
1167 }
1168
verify_slot(const std::string & slot_name,bool allow_all)1169 static std::string verify_slot(const std::string& slot_name, bool allow_all) {
1170 std::string slot = slot_name;
1171 if (slot == "all") {
1172 if (allow_all) {
1173 return "all";
1174 } else {
1175 int count = get_slot_count();
1176 if (count > 0) {
1177 return "a";
1178 } else {
1179 die("No known slots");
1180 }
1181 }
1182 }
1183
1184 int count = get_slot_count();
1185 if (count == 0) die("Device does not support slots");
1186
1187 if (slot == "other") {
1188 std::string other = get_other_slot( count);
1189 if (other == "") {
1190 die("No known slots");
1191 }
1192 return other;
1193 }
1194
1195 if (slot.size() == 1 && (slot[0]-'a' >= 0 && slot[0]-'a' < count)) return slot;
1196
1197 fprintf(stderr, "Slot %s does not exist. supported slots are:\n", slot.c_str());
1198 for (int i=0; i<count; i++) {
1199 fprintf(stderr, "%c\n", (char)(i + 'a'));
1200 }
1201
1202 exit(1);
1203 }
1204
verify_slot(const std::string & slot)1205 static std::string verify_slot(const std::string& slot) {
1206 return verify_slot(slot, true);
1207 }
1208
do_for_partition(const std::string & part,const std::string & slot,const std::function<void (const std::string &)> & func,bool force_slot)1209 static void do_for_partition(const std::string& part, const std::string& slot,
1210 const std::function<void(const std::string&)>& func, bool force_slot) {
1211 std::string has_slot;
1212 std::string current_slot;
1213 // |part| can be vendor_boot:default. Append slot to the first token.
1214 auto part_tokens = android::base::Split(part, ":");
1215
1216 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1217 /* If has-slot is not supported, the answer is no. */
1218 has_slot = "no";
1219 }
1220 if (has_slot == "yes") {
1221 if (slot == "") {
1222 current_slot = get_current_slot();
1223 if (current_slot == "") {
1224 die("Failed to identify current slot");
1225 }
1226 part_tokens[0] += "_" + current_slot;
1227 } else {
1228 part_tokens[0] += "_" + slot;
1229 }
1230 func(android::base::Join(part_tokens, ":"));
1231 } else {
1232 if (force_slot && slot != "") {
1233 fprintf(stderr, "Warning: %s does not support slots, and slot %s was requested.\n",
1234 part_tokens[0].c_str(), slot.c_str());
1235 }
1236 func(part);
1237 }
1238 }
1239
1240 /* This function will find the real partition name given a base name, and a slot. If slot is NULL or
1241 * empty, it will use the current slot. If slot is "all", it will return a list of all possible
1242 * partition names. If force_slot is true, it will fail if a slot is specified, and the given
1243 * partition does not support slots.
1244 */
do_for_partitions(const std::string & part,const std::string & slot,const std::function<void (const std::string &)> & func,bool force_slot)1245 static void do_for_partitions(const std::string& part, const std::string& slot,
1246 const std::function<void(const std::string&)>& func, bool force_slot) {
1247 std::string has_slot;
1248 // |part| can be vendor_boot:default. Query has-slot on the first token only.
1249 auto part_tokens = android::base::Split(part, ":");
1250
1251 if (slot == "all") {
1252 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1253 die("Could not check if partition %s has slot %s", part_tokens[0].c_str(),
1254 slot.c_str());
1255 }
1256 if (has_slot == "yes") {
1257 for (int i=0; i < get_slot_count(); i++) {
1258 do_for_partition(part, std::string(1, (char)(i + 'a')), func, force_slot);
1259 }
1260 } else {
1261 do_for_partition(part, "", func, force_slot);
1262 }
1263 } else {
1264 do_for_partition(part, slot, func, force_slot);
1265 }
1266 }
1267
is_retrofit_device()1268 static bool is_retrofit_device() {
1269 std::string value;
1270 if (fb->GetVar("super-partition-name", &value) != fastboot::SUCCESS) {
1271 return false;
1272 }
1273 return android::base::StartsWith(value, "system_");
1274 }
1275
1276 // Fetch a partition from the device to a given fd. This is a wrapper over FetchToFd to fetch
1277 // the full image.
fetch_partition(const std::string & partition,borrowed_fd fd)1278 static uint64_t fetch_partition(const std::string& partition, borrowed_fd fd) {
1279 uint64_t fetch_size = get_uint_var(FB_VAR_MAX_FETCH_SIZE);
1280 if (fetch_size == 0) {
1281 die("Unable to get %s. Device does not support fetch command.", FB_VAR_MAX_FETCH_SIZE);
1282 }
1283 uint64_t partition_size = get_partition_size(partition);
1284 if (partition_size <= 0) {
1285 die("Invalid partition size for partition %s: %" PRId64, partition.c_str(), partition_size);
1286 }
1287
1288 uint64_t offset = 0;
1289 while (offset < partition_size) {
1290 uint64_t chunk_size = std::min(fetch_size, partition_size - offset);
1291 if (fb->FetchToFd(partition, fd, offset, chunk_size) != fastboot::RetCode::SUCCESS) {
1292 die("Unable to fetch %s (offset=%" PRIx64 ", size=%" PRIx64 ")", partition.c_str(),
1293 offset, chunk_size);
1294 }
1295 offset += chunk_size;
1296 }
1297 return partition_size;
1298 }
1299
do_fetch(const std::string & partition,const std::string & slot_override,const std::string & outfile)1300 static void do_fetch(const std::string& partition, const std::string& slot_override,
1301 const std::string& outfile) {
1302 unique_fd fd(TEMP_FAILURE_RETRY(
1303 open(outfile.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0644)));
1304 auto fetch = std::bind(fetch_partition, _1, borrowed_fd(fd));
1305 do_for_partitions(partition, slot_override, fetch, false /* force slot */);
1306 }
1307
1308 // Return immediately if not flashing a vendor boot image. If flashing a vendor boot image,
1309 // repack vendor_boot image with an updated ramdisk. After execution, buf is set
1310 // to the new image to flash, and return value is the real partition name to flash.
repack_ramdisk(const char * pname,struct fastboot_buffer * buf)1311 static std::string repack_ramdisk(const char* pname, struct fastboot_buffer* buf) {
1312 std::string_view pname_sv{pname};
1313
1314 if (!android::base::StartsWith(pname_sv, "vendor_boot:") &&
1315 !android::base::StartsWith(pname_sv, "vendor_boot_a:") &&
1316 !android::base::StartsWith(pname_sv, "vendor_boot_b:")) {
1317 return std::string(pname_sv);
1318 }
1319 if (buf->type != FB_BUFFER_FD) {
1320 die("Flashing sparse vendor ramdisk image is not supported.");
1321 }
1322 if (buf->sz <= 0) {
1323 die("repack_ramdisk() sees negative size: %" PRId64, buf->sz);
1324 }
1325 std::string partition(pname_sv.substr(0, pname_sv.find(':')));
1326 std::string ramdisk(pname_sv.substr(pname_sv.find(':') + 1));
1327
1328 unique_fd vendor_boot(make_temporary_fd("vendor boot repack"));
1329 uint64_t vendor_boot_size = fetch_partition(partition, vendor_boot);
1330 auto repack_res = replace_vendor_ramdisk(vendor_boot, vendor_boot_size, ramdisk, buf->fd,
1331 static_cast<uint64_t>(buf->sz));
1332 if (!repack_res.ok()) {
1333 die("%s", repack_res.error().message().c_str());
1334 }
1335
1336 buf->fd = std::move(vendor_boot);
1337 buf->sz = vendor_boot_size;
1338 buf->image_size = vendor_boot_size;
1339 return partition;
1340 }
1341
do_flash(const char * pname,const char * fname)1342 static void do_flash(const char* pname, const char* fname) {
1343 verbose("Do flash %s %s", pname, fname);
1344 struct fastboot_buffer buf;
1345
1346 if (!load_buf(fname, &buf)) {
1347 die("cannot load '%s': %s", fname, strerror(errno));
1348 }
1349 if (is_logical(pname)) {
1350 fb->ResizePartition(pname, std::to_string(buf.image_size));
1351 }
1352 std::string flash_pname = repack_ramdisk(pname, &buf);
1353 flash_buf(flash_pname, &buf);
1354 }
1355
1356 // Sets slot_override as the active slot. If slot_override is blank,
1357 // set current slot as active instead. This clears slot-unbootable.
set_active(const std::string & slot_override)1358 static void set_active(const std::string& slot_override) {
1359 if (!supports_AB()) return;
1360
1361 if (slot_override != "") {
1362 fb->SetActive(slot_override);
1363 } else {
1364 std::string current_slot = get_current_slot();
1365 if (current_slot != "") {
1366 fb->SetActive(current_slot);
1367 }
1368 }
1369 }
1370
is_userspace_fastboot()1371 static bool is_userspace_fastboot() {
1372 std::string value;
1373 return fb->GetVar("is-userspace", &value) == fastboot::SUCCESS && value == "yes";
1374 }
1375
reboot_to_userspace_fastboot()1376 static void reboot_to_userspace_fastboot() {
1377 fb->RebootTo("fastboot");
1378
1379 auto* old_transport = fb->set_transport(nullptr);
1380 delete old_transport;
1381
1382 // Give the current connection time to close.
1383 std::this_thread::sleep_for(std::chrono::milliseconds(1000));
1384
1385 fb->set_transport(open_device());
1386
1387 if (!is_userspace_fastboot()) {
1388 die("Failed to boot into userspace fastboot; one or more components might be unbootable.");
1389 }
1390
1391 // Reset target_sparse_limit after reboot to userspace fastboot. Max
1392 // download sizes may differ in bootloader and fastbootd.
1393 target_sparse_limit = -1;
1394 }
1395
CancelSnapshotIfNeeded()1396 static void CancelSnapshotIfNeeded() {
1397 std::string merge_status = "none";
1398 if (fb->GetVar(FB_VAR_SNAPSHOT_UPDATE_STATUS, &merge_status) == fastboot::SUCCESS &&
1399 !merge_status.empty() && merge_status != "none") {
1400 fb->SnapshotUpdateCommand("cancel");
1401 }
1402 }
1403
1404 class ImageSource {
1405 public:
~ImageSource()1406 virtual ~ImageSource() {};
1407 virtual bool ReadFile(const std::string& name, std::vector<char>* out) const = 0;
1408 virtual unique_fd OpenFile(const std::string& name) const = 0;
1409 };
1410
1411 class FlashAllTool {
1412 public:
1413 FlashAllTool(const ImageSource& source, const std::string& slot_override, bool skip_secondary,
1414 bool wipe, bool force_flash);
1415
1416 void Flash();
1417
1418 private:
1419 void CheckRequirements();
1420 void DetermineSecondarySlot();
1421 void CollectImages();
1422 void FlashImages(const std::vector<std::pair<const Image*, std::string>>& images);
1423 void FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf);
1424 void UpdateSuperPartition();
1425
1426 const ImageSource& source_;
1427 std::string slot_override_;
1428 bool skip_secondary_;
1429 bool wipe_;
1430 bool force_flash_;
1431 std::string secondary_slot_;
1432 std::vector<std::pair<const Image*, std::string>> boot_images_;
1433 std::vector<std::pair<const Image*, std::string>> os_images_;
1434 };
1435
FlashAllTool(const ImageSource & source,const std::string & slot_override,bool skip_secondary,bool wipe,bool force_flash)1436 FlashAllTool::FlashAllTool(const ImageSource& source, const std::string& slot_override,
1437 bool skip_secondary, bool wipe, bool force_flash)
1438 : source_(source),
1439 slot_override_(slot_override),
1440 skip_secondary_(skip_secondary),
1441 wipe_(wipe),
1442 force_flash_(force_flash)
1443 {
1444 }
1445
Flash()1446 void FlashAllTool::Flash() {
1447 DumpInfo();
1448 CheckRequirements();
1449
1450 // Change the slot first, so we boot into the correct recovery image when
1451 // using fastbootd.
1452 if (slot_override_ == "all") {
1453 set_active("a");
1454 } else {
1455 set_active(slot_override_);
1456 }
1457
1458 DetermineSecondarySlot();
1459 CollectImages();
1460
1461 CancelSnapshotIfNeeded();
1462
1463 // First flash boot partitions. We allow this to happen either in userspace
1464 // or in bootloader fastboot.
1465 FlashImages(boot_images_);
1466
1467 // Sync the super partition. This will reboot to userspace fastboot if needed.
1468 UpdateSuperPartition();
1469
1470 // Resize any logical partition to 0, so each partition is reset to 0
1471 // extents, and will achieve more optimal allocation.
1472 for (const auto& [image, slot] : os_images_) {
1473 auto resize_partition = [](const std::string& partition) -> void {
1474 if (is_logical(partition)) {
1475 fb->ResizePartition(partition, "0");
1476 }
1477 };
1478 do_for_partitions(image->part_name, slot, resize_partition, false);
1479 }
1480
1481 // Flash OS images, resizing logical partitions as needed.
1482 FlashImages(os_images_);
1483 }
1484
CheckRequirements()1485 void FlashAllTool::CheckRequirements() {
1486 std::vector<char> contents;
1487 if (!source_.ReadFile("android-info.txt", &contents)) {
1488 die("could not read android-info.txt");
1489 }
1490 ::CheckRequirements({contents.data(), contents.size()}, force_flash_);
1491 }
1492
DetermineSecondarySlot()1493 void FlashAllTool::DetermineSecondarySlot() {
1494 if (skip_secondary_) {
1495 return;
1496 }
1497 if (slot_override_ != "" && slot_override_ != "all") {
1498 secondary_slot_ = get_other_slot(slot_override_);
1499 } else {
1500 secondary_slot_ = get_other_slot();
1501 }
1502 if (secondary_slot_ == "") {
1503 if (supports_AB()) {
1504 fprintf(stderr, "Warning: Could not determine slot for secondary images. Ignoring.\n");
1505 }
1506 skip_secondary_ = true;
1507 }
1508 }
1509
CollectImages()1510 void FlashAllTool::CollectImages() {
1511 for (size_t i = 0; i < arraysize(images); ++i) {
1512 std::string slot = slot_override_;
1513 if (images[i].IsSecondary()) {
1514 if (skip_secondary_) {
1515 continue;
1516 }
1517 slot = secondary_slot_;
1518 }
1519 if (images[i].type == ImageType::BootCritical) {
1520 boot_images_.emplace_back(&images[i], slot);
1521 } else if (images[i].type == ImageType::Normal) {
1522 os_images_.emplace_back(&images[i], slot);
1523 }
1524 }
1525 }
1526
FlashImages(const std::vector<std::pair<const Image *,std::string>> & images)1527 void FlashAllTool::FlashImages(const std::vector<std::pair<const Image*, std::string>>& images) {
1528 for (const auto& [image, slot] : images) {
1529 fastboot_buffer buf;
1530 unique_fd fd = source_.OpenFile(image->img_name);
1531 if (fd < 0 || !load_buf_fd(std::move(fd), &buf)) {
1532 if (image->optional_if_no_image) {
1533 continue;
1534 }
1535 die("could not load '%s': %s", image->img_name, strerror(errno));
1536 }
1537 FlashImage(*image, slot, &buf);
1538 }
1539 }
1540
FlashImage(const Image & image,const std::string & slot,fastboot_buffer * buf)1541 void FlashAllTool::FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf) {
1542 auto flash = [&, this](const std::string& partition_name) {
1543 std::vector<char> signature_data;
1544 if (source_.ReadFile(image.sig_name, &signature_data)) {
1545 fb->Download("signature", signature_data);
1546 fb->RawCommand("signature", "installing signature");
1547 }
1548
1549 if (is_logical(partition_name)) {
1550 fb->ResizePartition(partition_name, std::to_string(buf->image_size));
1551 }
1552 flash_buf(partition_name.c_str(), buf);
1553 };
1554 do_for_partitions(image.part_name, slot, flash, false);
1555 }
1556
UpdateSuperPartition()1557 void FlashAllTool::UpdateSuperPartition() {
1558 unique_fd fd = source_.OpenFile("super_empty.img");
1559 if (fd < 0) {
1560 return;
1561 }
1562 if (!is_userspace_fastboot()) {
1563 reboot_to_userspace_fastboot();
1564 }
1565
1566 std::string super_name;
1567 if (fb->GetVar("super-partition-name", &super_name) != fastboot::RetCode::SUCCESS) {
1568 super_name = "super";
1569 }
1570 fb->Download(super_name, fd, get_file_size(fd));
1571
1572 std::string command = "update-super:" + super_name;
1573 if (wipe_) {
1574 command += ":wipe";
1575 }
1576 fb->RawCommand(command, "Updating super partition");
1577
1578 // Retrofit devices have two super partitions, named super_a and super_b.
1579 // On these devices, secondary slots must be flashed as physical
1580 // partitions (otherwise they would not mount on first boot). To enforce
1581 // this, we delete any logical partitions for the "other" slot.
1582 if (is_retrofit_device()) {
1583 for (const auto& [image, slot] : os_images_) {
1584 std::string partition_name = image->part_name + "_"s + slot;
1585 if (image->IsSecondary() && is_logical(partition_name)) {
1586 fb->DeletePartition(partition_name);
1587 }
1588 }
1589 }
1590 }
1591
1592 class ZipImageSource final : public ImageSource {
1593 public:
ZipImageSource(ZipArchiveHandle zip)1594 explicit ZipImageSource(ZipArchiveHandle zip) : zip_(zip) {}
1595 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
1596 unique_fd OpenFile(const std::string& name) const override;
1597
1598 private:
1599 ZipArchiveHandle zip_;
1600 };
1601
ReadFile(const std::string & name,std::vector<char> * out) const1602 bool ZipImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1603 return UnzipToMemory(zip_, name, out);
1604 }
1605
OpenFile(const std::string & name) const1606 unique_fd ZipImageSource::OpenFile(const std::string& name) const {
1607 return unzip_to_file(zip_, name.c_str());
1608 }
1609
do_update(const char * filename,const std::string & slot_override,bool skip_secondary,bool force_flash)1610 static void do_update(const char* filename, const std::string& slot_override, bool skip_secondary,
1611 bool force_flash) {
1612 ZipArchiveHandle zip;
1613 int error = OpenArchive(filename, &zip);
1614 if (error != 0) {
1615 die("failed to open zip file '%s': %s", filename, ErrorCodeString(error));
1616 }
1617
1618 FlashAllTool tool(ZipImageSource(zip), slot_override, skip_secondary, false, force_flash);
1619 tool.Flash();
1620
1621 CloseArchive(zip);
1622 }
1623
1624 class LocalImageSource final : public ImageSource {
1625 public:
1626 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
1627 unique_fd OpenFile(const std::string& name) const override;
1628 };
1629
ReadFile(const std::string & name,std::vector<char> * out) const1630 bool LocalImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1631 auto path = find_item_given_name(name);
1632 if (path.empty()) {
1633 return false;
1634 }
1635 return ReadFileToVector(path, out);
1636 }
1637
OpenFile(const std::string & name) const1638 unique_fd LocalImageSource::OpenFile(const std::string& name) const {
1639 auto path = find_item_given_name(name);
1640 return unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
1641 }
1642
do_flashall(const std::string & slot_override,bool skip_secondary,bool wipe,bool force_flash)1643 static void do_flashall(const std::string& slot_override, bool skip_secondary, bool wipe,
1644 bool force_flash) {
1645 FlashAllTool tool(LocalImageSource(), slot_override, skip_secondary, wipe, force_flash);
1646 tool.Flash();
1647 }
1648
next_arg(std::vector<std::string> * args)1649 static std::string next_arg(std::vector<std::string>* args) {
1650 if (args->empty()) syntax_error("expected argument");
1651 std::string result = args->front();
1652 args->erase(args->begin());
1653 return result;
1654 }
1655
do_oem_command(const std::string & cmd,std::vector<std::string> * args)1656 static void do_oem_command(const std::string& cmd, std::vector<std::string>* args) {
1657 if (args->empty()) syntax_error("empty oem command");
1658
1659 std::string command(cmd);
1660 while (!args->empty()) {
1661 command += " " + next_arg(args);
1662 }
1663 fb->RawCommand(command, "");
1664 }
1665
fb_get_flash_block_size(std::string name)1666 static unsigned fb_get_flash_block_size(std::string name) {
1667 std::string sizeString;
1668 if (fb->GetVar(name, &sizeString) != fastboot::SUCCESS || sizeString.empty()) {
1669 // This device does not report flash block sizes, so return 0.
1670 return 0;
1671 }
1672 sizeString = fb_fix_numeric_var(sizeString);
1673
1674 unsigned size;
1675 if (!android::base::ParseUint(sizeString, &size)) {
1676 fprintf(stderr, "Couldn't parse %s '%s'.\n", name.c_str(), sizeString.c_str());
1677 return 0;
1678 }
1679 if ((size & (size - 1)) != 0) {
1680 fprintf(stderr, "Invalid %s %u: must be a power of 2.\n", name.c_str(), size);
1681 return 0;
1682 }
1683 return size;
1684 }
1685
fb_perform_format(const std::string & partition,int skip_if_not_supported,const std::string & type_override,const std::string & size_override,const std::string & initial_dir,const unsigned fs_options)1686 static void fb_perform_format(
1687 const std::string& partition, int skip_if_not_supported,
1688 const std::string& type_override, const std::string& size_override,
1689 const std::string& initial_dir, const unsigned fs_options) {
1690 std::string partition_type, partition_size;
1691
1692 struct fastboot_buffer buf;
1693 const char* errMsg = nullptr;
1694 const struct fs_generator* gen = nullptr;
1695 TemporaryFile output;
1696 unique_fd fd;
1697
1698 unsigned int limit = INT_MAX;
1699 if (target_sparse_limit > 0 && target_sparse_limit < limit) {
1700 limit = target_sparse_limit;
1701 }
1702 if (sparse_limit > 0 && sparse_limit < limit) {
1703 limit = sparse_limit;
1704 }
1705
1706 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
1707 errMsg = "Can't determine partition type.\n";
1708 goto failed;
1709 }
1710 if (!type_override.empty()) {
1711 if (partition_type != type_override) {
1712 fprintf(stderr, "Warning: %s type is %s, but %s was requested for formatting.\n",
1713 partition.c_str(), partition_type.c_str(), type_override.c_str());
1714 }
1715 partition_type = type_override;
1716 }
1717
1718 if (fb->GetVar("partition-size:" + partition, &partition_size) != fastboot::SUCCESS) {
1719 errMsg = "Unable to get partition size\n";
1720 goto failed;
1721 }
1722 if (!size_override.empty()) {
1723 if (partition_size != size_override) {
1724 fprintf(stderr, "Warning: %s size is %s, but %s was requested for formatting.\n",
1725 partition.c_str(), partition_size.c_str(), size_override.c_str());
1726 }
1727 partition_size = size_override;
1728 }
1729 partition_size = fb_fix_numeric_var(partition_size);
1730
1731 gen = fs_get_generator(partition_type);
1732 if (!gen) {
1733 if (skip_if_not_supported) {
1734 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
1735 fprintf(stderr, "File system type %s not supported.\n", partition_type.c_str());
1736 return;
1737 }
1738 die("Formatting is not supported for file system with type '%s'.",
1739 partition_type.c_str());
1740 }
1741
1742 int64_t size;
1743 if (!android::base::ParseInt(partition_size, &size)) {
1744 die("Couldn't parse partition size '%s'.", partition_size.c_str());
1745 }
1746
1747 unsigned eraseBlkSize, logicalBlkSize;
1748 eraseBlkSize = fb_get_flash_block_size("erase-block-size");
1749 logicalBlkSize = fb_get_flash_block_size("logical-block-size");
1750
1751 if (fs_generator_generate(gen, output.path, size, initial_dir,
1752 eraseBlkSize, logicalBlkSize, fs_options)) {
1753 die("Cannot generate image for %s", partition.c_str());
1754 }
1755
1756 fd.reset(open(output.path, O_RDONLY));
1757 if (fd == -1) {
1758 die("Cannot open generated image: %s", strerror(errno));
1759 }
1760 if (!load_buf_fd(std::move(fd), &buf)) {
1761 die("Cannot read image: %s", strerror(errno));
1762 }
1763 flash_buf(partition, &buf);
1764 return;
1765
1766 failed:
1767 if (skip_if_not_supported) {
1768 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
1769 if (errMsg) fprintf(stderr, "%s", errMsg);
1770 }
1771 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
1772 if (!skip_if_not_supported) {
1773 die("Command failed");
1774 }
1775 }
1776
should_flash_in_userspace(const std::string & partition_name)1777 static bool should_flash_in_userspace(const std::string& partition_name) {
1778 if (!get_android_product_out()) {
1779 return false;
1780 }
1781 auto path = find_item_given_name("super_empty.img");
1782 if (path.empty() || access(path.c_str(), R_OK)) {
1783 return false;
1784 }
1785 auto metadata = android::fs_mgr::ReadFromImageFile(path);
1786 if (!metadata) {
1787 return false;
1788 }
1789 for (const auto& partition : metadata->partitions) {
1790 auto candidate = android::fs_mgr::GetPartitionName(partition);
1791 if (partition.attributes & LP_PARTITION_ATTR_SLOT_SUFFIXED) {
1792 // On retrofit devices, we don't know if, or whether, the A or B
1793 // slot has been flashed for dynamic partitions. Instead we add
1794 // both names to the list as a conservative guess.
1795 if (candidate + "_a" == partition_name || candidate + "_b" == partition_name) {
1796 return true;
1797 }
1798 } else if (candidate == partition_name) {
1799 return true;
1800 }
1801 }
1802 return false;
1803 }
1804
wipe_super(const android::fs_mgr::LpMetadata & metadata,const std::string & slot,std::string * message)1805 static bool wipe_super(const android::fs_mgr::LpMetadata& metadata, const std::string& slot,
1806 std::string* message) {
1807 auto super_device = GetMetadataSuperBlockDevice(metadata);
1808 auto block_size = metadata.geometry.logical_block_size;
1809 auto super_bdev_name = android::fs_mgr::GetBlockDevicePartitionName(*super_device);
1810
1811 if (super_bdev_name != "super") {
1812 // retrofit devices do not allow flashing to the retrofit partitions,
1813 // so enable it if we can.
1814 fb->RawCommand("oem allow-flash-super");
1815 }
1816
1817 // Note: do not use die() in here, since we want TemporaryDir's destructor
1818 // to be called.
1819 TemporaryDir temp_dir;
1820
1821 bool ok;
1822 if (metadata.block_devices.size() > 1) {
1823 ok = WriteSplitImageFiles(temp_dir.path, metadata, block_size, {}, true);
1824 } else {
1825 auto image_path = temp_dir.path + "/"s + super_bdev_name + ".img";
1826 ok = WriteToImageFile(image_path, metadata, block_size, {}, true);
1827 }
1828 if (!ok) {
1829 *message = "Could not generate a flashable super image file";
1830 return false;
1831 }
1832
1833 for (const auto& block_device : metadata.block_devices) {
1834 auto partition = android::fs_mgr::GetBlockDevicePartitionName(block_device);
1835 bool force_slot = !!(block_device.flags & LP_BLOCK_DEVICE_SLOT_SUFFIXED);
1836
1837 std::string image_name;
1838 if (metadata.block_devices.size() > 1) {
1839 image_name = "super_" + partition + ".img";
1840 } else {
1841 image_name = partition + ".img";
1842 }
1843
1844 auto image_path = temp_dir.path + "/"s + image_name;
1845 auto flash = [&](const std::string& partition_name) {
1846 do_flash(partition_name.c_str(), image_path.c_str());
1847 };
1848 do_for_partitions(partition, slot, flash, force_slot);
1849
1850 unlink(image_path.c_str());
1851 }
1852 return true;
1853 }
1854
do_wipe_super(const std::string & image,const std::string & slot_override)1855 static void do_wipe_super(const std::string& image, const std::string& slot_override) {
1856 if (access(image.c_str(), R_OK) != 0) {
1857 die("Could not read image: %s", image.c_str());
1858 }
1859 auto metadata = android::fs_mgr::ReadFromImageFile(image);
1860 if (!metadata) {
1861 die("Could not parse image: %s", image.c_str());
1862 }
1863
1864 auto slot = slot_override;
1865 if (slot.empty()) {
1866 slot = get_current_slot();
1867 }
1868
1869 std::string message;
1870 if (!wipe_super(*metadata.get(), slot, &message)) {
1871 die(message);
1872 }
1873 }
1874
Main(int argc,char * argv[])1875 int FastBootTool::Main(int argc, char* argv[]) {
1876 bool wants_wipe = false;
1877 bool wants_reboot = false;
1878 bool wants_reboot_bootloader = false;
1879 bool wants_reboot_recovery = false;
1880 bool wants_reboot_fastboot = false;
1881 bool skip_reboot = false;
1882 bool wants_set_active = false;
1883 bool skip_secondary = false;
1884 bool force_flash = false;
1885 unsigned fs_options = 0;
1886 int longindex;
1887 std::string slot_override;
1888 std::string next_active;
1889
1890 g_boot_img_hdr.kernel_addr = 0x00008000;
1891 g_boot_img_hdr.ramdisk_addr = 0x01000000;
1892 g_boot_img_hdr.second_addr = 0x00f00000;
1893 g_boot_img_hdr.tags_addr = 0x00000100;
1894 g_boot_img_hdr.page_size = 2048;
1895 g_boot_img_hdr.dtb_addr = 0x01100000;
1896
1897 const struct option longopts[] = {
1898 {"base", required_argument, 0, 0},
1899 {"cmdline", required_argument, 0, 0},
1900 {"disable-verification", no_argument, 0, 0},
1901 {"disable-verity", no_argument, 0, 0},
1902 {"force", no_argument, 0, 0},
1903 {"fs-options", required_argument, 0, 0},
1904 {"header-version", required_argument, 0, 0},
1905 {"help", no_argument, 0, 'h'},
1906 {"kernel-offset", required_argument, 0, 0},
1907 {"os-patch-level", required_argument, 0, 0},
1908 {"os-version", required_argument, 0, 0},
1909 {"page-size", required_argument, 0, 0},
1910 {"ramdisk-offset", required_argument, 0, 0},
1911 {"set-active", optional_argument, 0, 'a'},
1912 {"skip-reboot", no_argument, 0, 0},
1913 {"skip-secondary", no_argument, 0, 0},
1914 {"slot", required_argument, 0, 0},
1915 {"tags-offset", required_argument, 0, 0},
1916 {"dtb", required_argument, 0, 0},
1917 {"dtb-offset", required_argument, 0, 0},
1918 {"unbuffered", no_argument, 0, 0},
1919 {"verbose", no_argument, 0, 'v'},
1920 {"version", no_argument, 0, 0},
1921 {0, 0, 0, 0}
1922 };
1923
1924 serial = getenv("ANDROID_SERIAL");
1925
1926 int c;
1927 while ((c = getopt_long(argc, argv, "a::hls:S:vw", longopts, &longindex)) != -1) {
1928 if (c == 0) {
1929 std::string name{longopts[longindex].name};
1930 if (name == "base") {
1931 g_base_addr = strtoul(optarg, 0, 16);
1932 } else if (name == "cmdline") {
1933 g_cmdline = optarg;
1934 } else if (name == "disable-verification") {
1935 g_disable_verification = true;
1936 } else if (name == "disable-verity") {
1937 g_disable_verity = true;
1938 } else if (name == "force") {
1939 force_flash = true;
1940 } else if (name == "fs-options") {
1941 fs_options = ParseFsOption(optarg);
1942 } else if (name == "header-version") {
1943 g_boot_img_hdr.header_version = strtoul(optarg, nullptr, 0);
1944 } else if (name == "dtb") {
1945 g_dtb_path = optarg;
1946 } else if (name == "kernel-offset") {
1947 g_boot_img_hdr.kernel_addr = strtoul(optarg, 0, 16);
1948 } else if (name == "os-patch-level") {
1949 ParseOsPatchLevel(&g_boot_img_hdr, optarg);
1950 } else if (name == "os-version") {
1951 ParseOsVersion(&g_boot_img_hdr, optarg);
1952 } else if (name == "page-size") {
1953 g_boot_img_hdr.page_size = strtoul(optarg, nullptr, 0);
1954 if (g_boot_img_hdr.page_size == 0) die("invalid page size");
1955 } else if (name == "ramdisk-offset") {
1956 g_boot_img_hdr.ramdisk_addr = strtoul(optarg, 0, 16);
1957 } else if (name == "skip-reboot") {
1958 skip_reboot = true;
1959 } else if (name == "skip-secondary") {
1960 skip_secondary = true;
1961 } else if (name == "slot") {
1962 slot_override = optarg;
1963 } else if (name == "dtb-offset") {
1964 g_boot_img_hdr.dtb_addr = strtoul(optarg, 0, 16);
1965 } else if (name == "tags-offset") {
1966 g_boot_img_hdr.tags_addr = strtoul(optarg, 0, 16);
1967 } else if (name == "unbuffered") {
1968 setvbuf(stdout, nullptr, _IONBF, 0);
1969 setvbuf(stderr, nullptr, _IONBF, 0);
1970 } else if (name == "version") {
1971 fprintf(stdout, "fastboot version %s-%s\n", PLATFORM_TOOLS_VERSION, android::build::GetBuildNumber().c_str());
1972 fprintf(stdout, "Installed as %s\n", android::base::GetExecutablePath().c_str());
1973 return 0;
1974 } else {
1975 die("unknown option %s", longopts[longindex].name);
1976 }
1977 } else {
1978 switch (c) {
1979 case 'a':
1980 wants_set_active = true;
1981 if (optarg) next_active = optarg;
1982 break;
1983 case 'h':
1984 return show_help();
1985 case 'l':
1986 g_long_listing = true;
1987 break;
1988 case 's':
1989 serial = optarg;
1990 break;
1991 case 'S':
1992 if (!android::base::ParseByteCount(optarg, &sparse_limit)) {
1993 die("invalid sparse limit %s", optarg);
1994 }
1995 break;
1996 case 'v':
1997 set_verbose();
1998 break;
1999 case 'w':
2000 wants_wipe = true;
2001 break;
2002 case '?':
2003 return 1;
2004 default:
2005 abort();
2006 }
2007 }
2008 }
2009
2010 argc -= optind;
2011 argv += optind;
2012
2013 if (argc == 0 && !wants_wipe && !wants_set_active) syntax_error("no command");
2014
2015 if (argc > 0 && !strcmp(*argv, "devices")) {
2016 list_devices();
2017 return 0;
2018 }
2019
2020 if (argc > 0 && !strcmp(*argv, "help")) {
2021 return show_help();
2022 }
2023
2024 Transport* transport = open_device();
2025 if (transport == nullptr) {
2026 return 1;
2027 }
2028 fastboot::DriverCallbacks driver_callbacks = {
2029 .prolog = Status,
2030 .epilog = Epilog,
2031 .info = InfoMessage,
2032 };
2033 fastboot::FastBootDriver fastboot_driver(transport, driver_callbacks, false);
2034 fb = &fastboot_driver;
2035
2036 const double start = now();
2037
2038 if (slot_override != "") slot_override = verify_slot(slot_override);
2039 if (next_active != "") next_active = verify_slot(next_active, false);
2040
2041 if (wants_set_active) {
2042 if (next_active == "") {
2043 if (slot_override == "") {
2044 std::string current_slot;
2045 if (fb->GetVar("current-slot", ¤t_slot) == fastboot::SUCCESS) {
2046 if (current_slot[0] == '_') current_slot.erase(0, 1);
2047 next_active = verify_slot(current_slot, false);
2048 } else {
2049 wants_set_active = false;
2050 }
2051 } else {
2052 next_active = verify_slot(slot_override, false);
2053 }
2054 }
2055 }
2056
2057 std::vector<std::string> args(argv, argv + argc);
2058 while (!args.empty()) {
2059 std::string command = next_arg(&args);
2060
2061 if (command == FB_CMD_GETVAR) {
2062 std::string variable = next_arg(&args);
2063 DisplayVarOrError(variable, variable);
2064 } else if (command == FB_CMD_ERASE) {
2065 std::string partition = next_arg(&args);
2066 auto erase = [&](const std::string& partition) {
2067 std::string partition_type;
2068 if (fb->GetVar("partition-type:" + partition, &partition_type) == fastboot::SUCCESS &&
2069 fs_get_generator(partition_type) != nullptr) {
2070 fprintf(stderr, "******** Did you mean to fastboot format this %s partition?\n",
2071 partition_type.c_str());
2072 }
2073
2074 fb->Erase(partition);
2075 };
2076 do_for_partitions(partition, slot_override, erase, true);
2077 } else if (android::base::StartsWith(command, "format")) {
2078 // Parsing for: "format[:[type][:[size]]]"
2079 // Some valid things:
2080 // - select only the size, and leave default fs type:
2081 // format::0x4000000 userdata
2082 // - default fs type and size:
2083 // format userdata
2084 // format:: userdata
2085 std::vector<std::string> pieces = android::base::Split(command, ":");
2086 std::string type_override;
2087 if (pieces.size() > 1) type_override = pieces[1].c_str();
2088 std::string size_override;
2089 if (pieces.size() > 2) size_override = pieces[2].c_str();
2090
2091 std::string partition = next_arg(&args);
2092
2093 auto format = [&](const std::string& partition) {
2094 fb_perform_format(partition, 0, type_override, size_override, "", fs_options);
2095 };
2096 do_for_partitions(partition, slot_override, format, true);
2097 } else if (command == "signature") {
2098 std::string filename = next_arg(&args);
2099 std::vector<char> data;
2100 if (!ReadFileToVector(filename, &data)) {
2101 die("could not load '%s': %s", filename.c_str(), strerror(errno));
2102 }
2103 if (data.size() != 256) die("signature must be 256 bytes (got %zu)", data.size());
2104 fb->Download("signature", data);
2105 fb->RawCommand("signature", "installing signature");
2106 } else if (command == FB_CMD_REBOOT) {
2107 wants_reboot = true;
2108
2109 if (args.size() == 1) {
2110 std::string what = next_arg(&args);
2111 if (what == "bootloader") {
2112 wants_reboot = false;
2113 wants_reboot_bootloader = true;
2114 } else if (what == "recovery") {
2115 wants_reboot = false;
2116 wants_reboot_recovery = true;
2117 } else if (what == "fastboot") {
2118 wants_reboot = false;
2119 wants_reboot_fastboot = true;
2120 } else {
2121 syntax_error("unknown reboot target %s", what.c_str());
2122 }
2123
2124 }
2125 if (!args.empty()) syntax_error("junk after reboot command");
2126 } else if (command == FB_CMD_REBOOT_BOOTLOADER) {
2127 wants_reboot_bootloader = true;
2128 } else if (command == FB_CMD_REBOOT_RECOVERY) {
2129 wants_reboot_recovery = true;
2130 } else if (command == FB_CMD_REBOOT_FASTBOOT) {
2131 wants_reboot_fastboot = true;
2132 } else if (command == FB_CMD_CONTINUE) {
2133 fb->Continue();
2134 } else if (command == FB_CMD_BOOT) {
2135 std::string kernel = next_arg(&args);
2136 std::string ramdisk;
2137 if (!args.empty()) ramdisk = next_arg(&args);
2138 std::string second_stage;
2139 if (!args.empty()) second_stage = next_arg(&args);
2140 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2141 fb->Download("boot.img", data);
2142 fb->Boot();
2143 } else if (command == FB_CMD_FLASH) {
2144 std::string pname = next_arg(&args);
2145
2146 std::string fname;
2147 if (!args.empty()) {
2148 fname = next_arg(&args);
2149 } else {
2150 fname = find_item(pname);
2151 }
2152 if (fname.empty()) die("cannot determine image filename for '%s'", pname.c_str());
2153
2154 auto flash = [&](const std::string &partition) {
2155 if (should_flash_in_userspace(partition) && !is_userspace_fastboot() &&
2156 !force_flash) {
2157 die("The partition you are trying to flash is dynamic, and "
2158 "should be flashed via fastbootd. Please run:\n"
2159 "\n"
2160 " fastboot reboot fastboot\n"
2161 "\n"
2162 "And try again. If you are intentionally trying to "
2163 "overwrite a fixed partition, use --force.");
2164 }
2165 do_flash(partition.c_str(), fname.c_str());
2166 };
2167 do_for_partitions(pname, slot_override, flash, true);
2168 } else if (command == "flash:raw") {
2169 std::string partition = next_arg(&args);
2170 std::string kernel = next_arg(&args);
2171 std::string ramdisk;
2172 if (!args.empty()) ramdisk = next_arg(&args);
2173 std::string second_stage;
2174 if (!args.empty()) second_stage = next_arg(&args);
2175
2176 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2177 auto flashraw = [&data](const std::string& partition) {
2178 fb->FlashPartition(partition, data);
2179 };
2180 do_for_partitions(partition, slot_override, flashraw, true);
2181 } else if (command == "flashall") {
2182 if (slot_override == "all") {
2183 fprintf(stderr, "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
2184 do_flashall(slot_override, true, wants_wipe, force_flash);
2185 } else {
2186 do_flashall(slot_override, skip_secondary, wants_wipe, force_flash);
2187 }
2188 wants_reboot = true;
2189 } else if (command == "update") {
2190 bool slot_all = (slot_override == "all");
2191 if (slot_all) {
2192 fprintf(stderr, "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
2193 }
2194 std::string filename = "update.zip";
2195 if (!args.empty()) {
2196 filename = next_arg(&args);
2197 }
2198 do_update(filename.c_str(), slot_override, skip_secondary || slot_all, force_flash);
2199 wants_reboot = true;
2200 } else if (command == FB_CMD_SET_ACTIVE) {
2201 std::string slot = verify_slot(next_arg(&args), false);
2202 fb->SetActive(slot);
2203 } else if (command == "stage") {
2204 std::string filename = next_arg(&args);
2205
2206 struct fastboot_buffer buf;
2207 if (!load_buf(filename.c_str(), &buf) || buf.type != FB_BUFFER_FD) {
2208 die("cannot load '%s'", filename.c_str());
2209 }
2210 fb->Download(filename, buf.fd.get(), buf.sz);
2211 } else if (command == "get_staged") {
2212 std::string filename = next_arg(&args);
2213 fb->Upload(filename);
2214 } else if (command == FB_CMD_OEM) {
2215 do_oem_command(FB_CMD_OEM, &args);
2216 } else if (command == "flashing") {
2217 if (args.empty()) {
2218 syntax_error("missing 'flashing' command");
2219 } else if (args.size() == 1 && (args[0] == "unlock" || args[0] == "lock" ||
2220 args[0] == "unlock_critical" ||
2221 args[0] == "lock_critical" ||
2222 args[0] == "get_unlock_ability")) {
2223 do_oem_command("flashing", &args);
2224 } else {
2225 syntax_error("unknown 'flashing' command %s", args[0].c_str());
2226 }
2227 } else if (command == FB_CMD_CREATE_PARTITION) {
2228 std::string partition = next_arg(&args);
2229 std::string size = next_arg(&args);
2230 fb->CreatePartition(partition, size);
2231 } else if (command == FB_CMD_DELETE_PARTITION) {
2232 std::string partition = next_arg(&args);
2233 fb->DeletePartition(partition);
2234 } else if (command == FB_CMD_RESIZE_PARTITION) {
2235 std::string partition = next_arg(&args);
2236 std::string size = next_arg(&args);
2237 fb->ResizePartition(partition, size);
2238 } else if (command == "gsi") {
2239 std::string arg = next_arg(&args);
2240 if (arg == "wipe") {
2241 fb->RawCommand("gsi:wipe", "wiping GSI");
2242 } else if (arg == "disable") {
2243 fb->RawCommand("gsi:disable", "disabling GSI");
2244 } else {
2245 syntax_error("expected 'wipe' or 'disable'");
2246 }
2247 } else if (command == "wipe-super") {
2248 std::string image;
2249 if (args.empty()) {
2250 image = find_item_given_name("super_empty.img");
2251 } else {
2252 image = next_arg(&args);
2253 }
2254 do_wipe_super(image, slot_override);
2255 } else if (command == "snapshot-update") {
2256 std::string arg;
2257 if (!args.empty()) {
2258 arg = next_arg(&args);
2259 }
2260 if (!arg.empty() && (arg != "cancel" && arg != "merge")) {
2261 syntax_error("expected: snapshot-update [cancel|merge]");
2262 }
2263 fb->SnapshotUpdateCommand(arg);
2264 } else if (command == FB_CMD_FETCH) {
2265 std::string partition = next_arg(&args);
2266 std::string outfile = next_arg(&args);
2267 do_fetch(partition, slot_override, outfile);
2268 } else {
2269 syntax_error("unknown command %s", command.c_str());
2270 }
2271 }
2272
2273 if (wants_wipe) {
2274 if (force_flash) {
2275 CancelSnapshotIfNeeded();
2276 }
2277 std::vector<std::string> partitions = { "userdata", "cache", "metadata" };
2278 for (const auto& partition : partitions) {
2279 std::string partition_type;
2280 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
2281 continue;
2282 }
2283 if (partition_type.empty()) continue;
2284 fb->Erase(partition);
2285 fb_perform_format(partition, 1, partition_type, "", "", fs_options);
2286 }
2287 }
2288 if (wants_set_active) {
2289 fb->SetActive(next_active);
2290 }
2291 if (wants_reboot && !skip_reboot) {
2292 fb->Reboot();
2293 fb->WaitForDisconnect();
2294 } else if (wants_reboot_bootloader) {
2295 fb->RebootTo("bootloader");
2296 fb->WaitForDisconnect();
2297 } else if (wants_reboot_recovery) {
2298 fb->RebootTo("recovery");
2299 fb->WaitForDisconnect();
2300 } else if (wants_reboot_fastboot) {
2301 reboot_to_userspace_fastboot();
2302 }
2303
2304 fprintf(stderr, "Finished. Total time: %.3fs\n", (now() - start));
2305
2306 auto* old_transport = fb->set_transport(nullptr);
2307 delete old_transport;
2308
2309 return 0;
2310 }
2311
ParseOsPatchLevel(boot_img_hdr_v1 * hdr,const char * arg)2312 void FastBootTool::ParseOsPatchLevel(boot_img_hdr_v1* hdr, const char* arg) {
2313 unsigned year, month, day;
2314 if (sscanf(arg, "%u-%u-%u", &year, &month, &day) != 3) {
2315 syntax_error("OS patch level should be YYYY-MM-DD: %s", arg);
2316 }
2317 if (year < 2000 || year >= 2128) syntax_error("year out of range: %d", year);
2318 if (month < 1 || month > 12) syntax_error("month out of range: %d", month);
2319 hdr->SetOsPatchLevel(year, month);
2320 }
2321
ParseOsVersion(boot_img_hdr_v1 * hdr,const char * arg)2322 void FastBootTool::ParseOsVersion(boot_img_hdr_v1* hdr, const char* arg) {
2323 unsigned major = 0, minor = 0, patch = 0;
2324 std::vector<std::string> versions = android::base::Split(arg, ".");
2325 if (versions.size() < 1 || versions.size() > 3 ||
2326 (versions.size() >= 1 && !android::base::ParseUint(versions[0], &major)) ||
2327 (versions.size() >= 2 && !android::base::ParseUint(versions[1], &minor)) ||
2328 (versions.size() == 3 && !android::base::ParseUint(versions[2], &patch)) ||
2329 (major > 0x7f || minor > 0x7f || patch > 0x7f)) {
2330 syntax_error("bad OS version: %s", arg);
2331 }
2332 hdr->SetOsVersion(major, minor, patch);
2333 }
2334
ParseFsOption(const char * arg)2335 unsigned FastBootTool::ParseFsOption(const char* arg) {
2336 unsigned fsOptions = 0;
2337
2338 std::vector<std::string> options = android::base::Split(arg, ",");
2339 if (options.size() < 1)
2340 syntax_error("bad options: %s", arg);
2341
2342 for (size_t i = 0; i < options.size(); ++i) {
2343 if (options[i] == "casefold")
2344 fsOptions |= (1 << FS_OPT_CASEFOLD);
2345 else if (options[i] == "projid")
2346 fsOptions |= (1 << FS_OPT_PROJID);
2347 else if (options[i] == "compress")
2348 fsOptions |= (1 << FS_OPT_COMPRESS);
2349 else
2350 syntax_error("unsupported options: %s", options[i].c_str());
2351 }
2352 return fsOptions;
2353 }
2354