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