blob: a30b10cd63e8b6dab72440398ca7fd82e628d7f4 [file] [log] [blame]
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001/*
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
Tsu Chiang Chuangee520552011-02-25 18:38:53 -080012 * the documentation and/or other materials provided with the
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080013 * 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
Tsu Chiang Chuangee520552011-02-25 18:38:53 -080022 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080023 * 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
Tom Cherry9027af02018-09-24 15:48:09 -070029#include "fastboot.h"
30
Mark Salyzyn5957c1f2014-04-30 14:05:28 -070031#include <ctype.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080032#include <errno.h>
33#include <fcntl.h>
Colin Cross8879f982012-05-22 17:53:34 -070034#include <getopt.h>
Ying Wangcf86e2f2014-05-15 20:06:40 -070035#include <inttypes.h>
Mark Salyzyn5957c1f2014-04-30 14:05:28 -070036#include <limits.h>
Mark Salyzyn5957c1f2014-04-30 14:05:28 -070037#include <stdint.h>
38#include <stdio.h>
39#include <stdlib.h>
40#include <string.h>
41#include <sys/stat.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080042#include <sys/time.h>
Colin Crossf8387882012-05-24 17:18:41 -070043#include <sys/types.h>
Mark Salyzyn5957c1f2014-04-30 14:05:28 -070044#include <unistd.h>
David Pursell2ec418a2016-01-20 08:32:08 -080045
Elliott Hughes290a2282016-11-14 17:08:47 -080046#include <chrono>
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -070047#include <functional>
Tom Cherry4aa60b32018-09-05 15:11:44 -070048#include <regex>
David Anderson0c732342018-11-28 17:10:42 -080049#include <string>
Elliott Hughes290a2282016-11-14 17:08:47 -080050#include <thread>
Josh Gao9da9ac52016-01-19 14:50:18 -080051#include <utility>
52#include <vector>
Colin Crossf8387882012-05-24 17:18:41 -070053
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +080054#include <android-base/endian.h>
Elliott Hughes82ff3152016-08-31 15:07:18 -070055#include <android-base/file.h>
David Andersona67fc322023-01-27 16:15:52 -080056#include <android-base/logging.h>
Elliott Hughes749ae2d2016-06-28 14:48:45 -070057#include <android-base/macros.h>
Elliott Hughes4f713192015-12-04 22:00:26 -080058#include <android-base/parseint.h>
David Pursell2ec418a2016-01-20 08:32:08 -080059#include <android-base/parsenetaddress.h>
Elliott Hughes2810d002016-04-25 14:31:18 -070060#include <android-base/stringprintf.h>
Elliott Hughes4f713192015-12-04 22:00:26 -080061#include <android-base/strings.h>
Chris Fries0ea946c2017-04-12 10:25:57 -050062#include <android-base/unique_fd.h>
Dan Willemsenab971b52018-08-29 14:58:02 -070063#include <build/version.h>
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +080064#include <libavb/libavb.h>
David Anderson89569642018-11-16 15:53:35 -080065#include <liblp/liblp.h>
David Anderson667b1ef2023-01-27 21:11:11 -080066#include <liblp/super_layout_builder.h>
Dan Willemsenab971b52018-08-29 14:58:02 -070067#include <platform_tools_version.h>
Colin Crossf8387882012-05-24 17:18:41 -070068#include <sparse/sparse.h>
Elliott Hughesd30ad8a2015-03-18 23:12:44 -070069#include <ziparchive/zip_archive.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080070
Elliott Hughes253c18d2015-03-18 22:47:09 -070071#include "bootimg_utils.h"
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -070072#include "constants.h"
Elliott Hughes1b708d32015-12-11 19:07:01 -080073#include "diagnose_usb.h"
Tom Cherry9027af02018-09-24 15:48:09 -070074#include "fastboot_driver.h"
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -070075#include "fs.h"
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +000076#include "storage.h"
David Anderson667b1ef2023-01-27 21:11:11 -080077#include "super_flash_helper.h"
Daniel Zheng1a01a1c2023-01-30 23:29:50 +000078#include "task.h"
David Pursell2ec418a2016-01-20 08:32:08 -080079#include "tcp.h"
David Pursell0b156632015-10-30 11:22:01 -070080#include "transport.h"
David Pursell4601c972016-02-05 15:35:09 -080081#include "udp.h"
David Pursell0b156632015-10-30 11:22:01 -070082#include "usb.h"
Tom Cherry9027af02018-09-24 15:48:09 -070083#include "util.h"
Yifan Honge71fe242021-02-22 15:00:15 -080084#include "vendor_boot_img_utils.h"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080085
Yifan Hongbcd27702021-02-16 19:37:32 -080086using android::base::borrowed_fd;
Tom Cherrydfd85df2018-09-20 14:45:05 -070087using android::base::ReadFully;
Tom Cherry4aa60b32018-09-05 15:11:44 -070088using android::base::Split;
89using android::base::Trim;
Chris Fries0ea946c2017-04-12 10:25:57 -050090using android::base::unique_fd;
David Anderson0c732342018-11-28 17:10:42 -080091using namespace std::string_literals;
Yifan Hongbcd27702021-02-16 19:37:32 -080092using namespace std::placeholders;
Chris Fries0ea946c2017-04-12 10:25:57 -050093
David Pursell2ec418a2016-01-20 08:32:08 -080094static const char* serial = nullptr;
Elliott Hughes577e8b42018-04-05 16:12:47 -070095
Elliott Hughes577e8b42018-04-05 16:12:47 -070096static bool g_long_listing = false;
Chris Fries6a999712017-04-04 09:52:47 -050097// Don't resparse files in too-big chunks.
98// libsparse will support INT_MAX, but this results in large allocations, so
99// let's keep it at 1GB to avoid memory pressure on the host.
100static constexpr int64_t RESPARSE_LIMIT = 1 * 1024 * 1024 * 1024;
Elliott Hughes542370d2018-04-19 19:49:44 -0700101static uint64_t sparse_limit = 0;
Colin Crossf8387882012-05-24 17:18:41 -0700102static int64_t target_sparse_limit = -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800103
Elliott Hughes577e8b42018-04-05 16:12:47 -0700104static unsigned g_base_addr = 0x10000000;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800105static boot_img_hdr_v2 g_boot_img_hdr = {};
Elliott Hughes577e8b42018-04-05 16:12:47 -0700106static std::string g_cmdline;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800107static std::string g_dtb_path;
JP Abgrall7b8970c2013-03-07 17:06:41 -0800108
David Zeuthenb6ea4352017-08-07 14:29:26 -0400109static bool g_disable_verity = false;
110static bool g_disable_verification = false;
111
Tom Cherry9027af02018-09-24 15:48:09 -0700112fastboot::FastBootDriver* fb = nullptr;
113
Rom Lemarchand622810c2013-06-28 09:54:59 -0700114enum fb_buffer_type {
Chris Fries0ea946c2017-04-12 10:25:57 -0500115 FB_BUFFER_FD,
Rom Lemarchand622810c2013-06-28 09:54:59 -0700116 FB_BUFFER_SPARSE,
117};
118
119struct fastboot_buffer {
120 enum fb_buffer_type type;
David Andersona1c983e2023-01-27 11:57:27 -0800121 std::vector<SparsePtr> files;
Elliott Hughesfc797672015-04-07 20:12:50 -0700122 int64_t sz;
Yifan Hongb10d0672021-02-22 15:06:27 -0800123 unique_fd fd;
David Anderson32e376f2018-08-16 13:43:11 -0700124 int64_t image_size;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700125};
126
David Anderson0debda02018-08-28 13:54:03 -0700127enum class ImageType {
128 // Must be flashed for device to boot into the kernel.
129 BootCritical,
130 // Normal partition to be flashed during "flashall".
131 Normal,
132 // Partition that is never flashed during "flashall".
133 Extra
134};
135
David Anderson32e376f2018-08-16 13:43:11 -0700136struct Image {
Daniel Zheng65452d02022-11-30 02:25:31 +0000137 std::string nickname;
138 std::string img_name;
139 std::string sig_name;
140 std::string part_name;
Hridya Valsarajuf1f0a9c2018-08-02 10:46:21 -0700141 bool optional_if_no_image;
David Anderson0debda02018-08-28 13:54:03 -0700142 ImageType type;
Daniel Zheng65452d02022-11-30 02:25:31 +0000143 bool IsSecondary() const { return nickname.empty(); }
David Anderson32e376f2018-08-16 13:43:11 -0700144};
145
Daniel Zheng65452d02022-11-30 02:25:31 +0000146static std::vector<Image> images = {
Dario Frenic7ea1af2018-05-25 16:07:19 +0100147 // clang-format off
David Anderson0debda02018-08-28 13:54:03 -0700148 { "boot", "boot.img", "boot.sig", "boot", false, ImageType::BootCritical },
Devin Mooredd1eb872022-01-05 00:20:15 +0000149 { "init_boot",
150 "init_boot.img", "init_boot.sig",
151 "init_boot",
Devin Moore60bd33f2022-01-11 02:01:26 +0000152 true, ImageType::BootCritical },
Daniel Zheng65452d02022-11-30 02:25:31 +0000153 { "", "boot_other.img", "boot.sig", "boot", true, ImageType::Normal },
David Anderson0debda02018-08-28 13:54:03 -0700154 { "cache", "cache.img", "cache.sig", "cache", true, ImageType::Extra },
155 { "dtbo", "dtbo.img", "dtbo.sig", "dtbo", true, ImageType::BootCritical },
156 { "dts", "dt.img", "dt.sig", "dts", true, ImageType::BootCritical },
157 { "odm", "odm.img", "odm.sig", "odm", true, ImageType::Normal },
Yifan Hongbe78bb62020-07-15 17:07:11 -0700158 { "odm_dlkm", "odm_dlkm.img", "odm_dlkm.sig", "odm_dlkm", true, ImageType::Normal },
David Anderson0debda02018-08-28 13:54:03 -0700159 { "product", "product.img", "product.sig", "product", true, ImageType::Normal },
Andrew Scullbe823d72021-01-15 14:37:15 +0000160 { "pvmfw", "pvmfw.img", "pvmfw.sig", "pvmfw", true, ImageType::BootCritical },
David Anderson0debda02018-08-28 13:54:03 -0700161 { "recovery", "recovery.img", "recovery.sig", "recovery", true, ImageType::BootCritical },
162 { "super", "super.img", "super.sig", "super", true, ImageType::Extra },
163 { "system", "system.img", "system.sig", "system", false, ImageType::Normal },
Ramji Jiyanib3ddb532021-12-06 02:28:28 +0000164 { "system_dlkm",
165 "system_dlkm.img", "system_dlkm.sig",
166 "system_dlkm",
167 true, ImageType::Normal },
Justin Yun5d0ac622019-06-26 09:18:03 +0900168 { "system_ext",
169 "system_ext.img", "system_ext.sig",
170 "system_ext",
171 true, ImageType::Normal },
Daniel Zheng65452d02022-11-30 02:25:31 +0000172 { "", "system_other.img", "system.sig", "system", true, ImageType::Normal },
David Anderson0debda02018-08-28 13:54:03 -0700173 { "userdata", "userdata.img", "userdata.sig", "userdata", true, ImageType::Extra },
174 { "vbmeta", "vbmeta.img", "vbmeta.sig", "vbmeta", true, ImageType::BootCritical },
David Anderson166bfef2018-10-15 14:46:59 -0700175 { "vbmeta_system",
176 "vbmeta_system.img",
177 "vbmeta_system.sig",
178 "vbmeta_system",
David Anderson1109c922018-09-17 17:32:54 -0700179 true, ImageType::BootCritical },
Bowgo Tsaia48a7832021-06-03 14:39:34 +0800180 { "vbmeta_vendor",
181 "vbmeta_vendor.img",
182 "vbmeta_vendor.sig",
183 "vbmeta_vendor",
184 true, ImageType::BootCritical },
David Anderson0debda02018-08-28 13:54:03 -0700185 { "vendor", "vendor.img", "vendor.sig", "vendor", true, ImageType::Normal },
Steve Muckle36112432019-08-21 11:16:14 -0700186 { "vendor_boot",
187 "vendor_boot.img", "vendor_boot.sig",
188 "vendor_boot",
189 true, ImageType::BootCritical },
Yifan Hong6b1c15c2020-05-12 10:38:53 -0700190 { "vendor_dlkm",
191 "vendor_dlkm.img", "vendor_dlkm.sig",
192 "vendor_dlkm",
193 true, ImageType::Normal },
Lucas Weif0fb5dd2022-03-28 21:57:58 +0800194 { "vendor_kernel_boot",
195 "vendor_kernel_boot.img",
196 "vendor_kernel_boot.sig",
197 "vendor_kernel_boot",
198 true, ImageType::BootCritical },
Daniel Zheng65452d02022-11-30 02:25:31 +0000199 { "", "vendor_other.img", "vendor.sig", "vendor", true, ImageType::Normal },
Dario Frenic7ea1af2018-05-25 16:07:19 +0100200 // clang-format on
Rom Lemarchand622810c2013-06-28 09:54:59 -0700201};
Brian Swetland2a63bb72009-04-28 16:05:07 -0700202
David Andersone0e693c2018-11-27 20:19:26 -0800203static char* get_android_product_out() {
Elliott Hughes45964a82017-05-03 22:43:23 -0700204 char* dir = getenv("ANDROID_PRODUCT_OUT");
Alex Lightbb9b8a52016-06-29 09:26:44 -0700205 if (dir == nullptr || dir[0] == '\0') {
David Andersone0e693c2018-11-27 20:19:26 -0800206 return nullptr;
207 }
208 return dir;
209}
210
211static std::string find_item_given_name(const std::string& img_name) {
212 char* dir = get_android_product_out();
213 if (!dir) {
Elliott Hughes45964a82017-05-03 22:43:23 -0700214 die("ANDROID_PRODUCT_OUT not set");
Alex Lightbb9b8a52016-06-29 09:26:44 -0700215 }
David Anderson0debda02018-08-28 13:54:03 -0700216 return std::string(dir) + "/" + img_name;
Alex Lightbb9b8a52016-06-29 09:26:44 -0700217}
218
Elliott Hughes29d5d7d2017-05-11 15:05:13 -0700219static std::string find_item(const std::string& item) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000220 for (size_t i = 0; i < images.size(); ++i) {
221 if (!images[i].nickname.empty() && item == images[i].nickname) {
Elliott Hughes45964a82017-05-03 22:43:23 -0700222 return find_item_given_name(images[i].img_name);
223 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800224 }
225
Elliott Hughesd6365a72017-05-08 18:04:49 -0700226 fprintf(stderr, "unknown partition '%s'\n", item.c_str());
Elliott Hughes45964a82017-05-03 22:43:23 -0700227 return "";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800228}
229
Tom Cherry9027af02018-09-24 15:48:09 -0700230double last_start_time;
231
232static void Status(const std::string& message) {
Tom Cherry2217c502020-06-10 09:29:25 -0700233 if (!message.empty()) {
234 static constexpr char kStatusFormat[] = "%-50s ";
235 fprintf(stderr, kStatusFormat, message.c_str());
236 }
Tom Cherry9027af02018-09-24 15:48:09 -0700237 last_start_time = now();
238}
239
240static void Epilog(int status) {
241 if (status) {
242 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
243 die("Command failed");
244 } else {
245 double split = now();
246 fprintf(stderr, "OKAY [%7.3fs]\n", (split - last_start_time));
247 }
248}
249
250static void InfoMessage(const std::string& info) {
251 fprintf(stderr, "(bootloader) %s\n", info.c_str());
252}
253
Raphael Herouart99097cc2022-12-30 11:51:54 +0000254static void TextMessage(const std::string& text) {
255 fprintf(stderr, "%s", text.c_str());
256}
257
Tom Cherrydfd85df2018-09-20 14:45:05 -0700258bool ReadFileToVector(const std::string& file, std::vector<char>* out) {
259 out->clear();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800260
Tom Cherrydfd85df2018-09-20 14:45:05 -0700261 unique_fd fd(TEMP_FAILURE_RETRY(open(file.c_str(), O_RDONLY | O_CLOEXEC | O_BINARY)));
262 if (fd == -1) {
263 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700264 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800265
Tom Cherrydfd85df2018-09-20 14:45:05 -0700266 out->resize(get_file_size(fd));
267 return ReadFully(fd, out->data(), out->size());
Rom Lemarchand622810c2013-06-28 09:54:59 -0700268}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800269
Elliott Hughesfc797672015-04-07 20:12:50 -0700270static int match_fastboot_with_serial(usb_ifc_info* info, const char* local_serial) {
Elliott Hughese1746fd2015-08-10 15:30:54 -0700271 if (info->ifc_class != 0xff || info->ifc_subclass != 0x42 || info->ifc_protocol != 0x03) {
272 return -1;
273 }
274
Scott Anderson13081c62012-04-06 12:39:30 -0700275 // require matching serial number or device path if requested
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800276 // at the command line with the -s option.
JP Abgralla032ded2012-06-06 11:53:33 -0700277 if (local_serial && (strcmp(local_serial, info->serial_number) != 0 &&
Daniel Zheng65452d02022-11-30 02:25:31 +0000278 strcmp(local_serial, info->device_path) != 0))
279 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800280 return 0;
281}
282
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000283static ifc_match_func match_fastboot(const char* local_serial = serial) {
284 return [local_serial](usb_ifc_info* info) -> int {
285 return match_fastboot_with_serial(info, local_serial);
286 };
287}
288
289// output compatible with "adb devices"
290static void PrintDevice(const char* local_serial, const char* status = nullptr,
291 const char* details = nullptr) {
292 if (local_serial == nullptr || strlen(local_serial) == 0) {
293 return;
294 }
295
296 if (g_long_listing) {
297 printf("%-22s", local_serial);
298 } else {
299 printf("%s\t", local_serial);
300 }
301
302 if (status != nullptr && strlen(status) > 0) {
303 printf(" %s", status);
304 }
305
306 if (g_long_listing) {
307 if (details != nullptr && strlen(details) > 0) {
308 printf(" %s", details);
309 }
310 }
311
312 putchar('\n');
JP Abgrall7b8970c2013-03-07 17:06:41 -0800313}
314
Elliott Hughesfc797672015-04-07 20:12:50 -0700315static int list_devices_callback(usb_ifc_info* info) {
316 if (match_fastboot_with_serial(info, nullptr) == 0) {
Elliott Hughes1b708d32015-12-11 19:07:01 -0800317 std::string serial = info->serial_number;
David Anderson4e058ca2020-05-28 04:39:37 +0000318 std::string interface = info->interface;
319 if (interface.empty()) {
320 interface = "fastboot";
321 }
Elliott Hughesb4add9b2009-10-06 18:07:49 -0700322 if (!info->writable) {
Elliott Hughes1b708d32015-12-11 19:07:01 -0800323 serial = UsbNoPermissionsShortHelpText();
Elliott Hughesb4add9b2009-10-06 18:07:49 -0700324 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800325 if (!serial[0]) {
326 serial = "????????????";
327 }
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000328
329 PrintDevice(serial.c_str(), interface.c_str(), info->device_path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800330 }
331
332 return -1;
333}
334
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000335struct NetworkSerial {
336 Socket::Protocol protocol;
337 std::string address;
338 int port;
339};
340
341static Result<NetworkSerial> ParseNetworkSerial(const std::string& serial) {
342 const auto serial_parsed = android::base::Tokenize(serial, ":");
343 const auto parsed_segments_count = serial_parsed.size();
344 if (parsed_segments_count != 2 && parsed_segments_count != 3) {
345 return Error() << "invalid network address: " << serial << ". Expected format:\n"
346 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
347 }
348
349 Socket::Protocol protocol;
350 if (serial_parsed[0] == "tcp") {
351 protocol = Socket::Protocol::kTcp;
352 } else if (serial_parsed[0] == "udp") {
353 protocol = Socket::Protocol::kUdp;
354 } else {
355 return Error() << "invalid network address: " << serial << ". Expected format:\n"
356 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
357 }
358
359 int port = 5554;
360 if (parsed_segments_count == 3) {
361 android::base::ParseInt(serial_parsed[2], &port, 5554);
362 }
363
364 return NetworkSerial{protocol, serial_parsed[1], port};
365}
366
367// Opens a new Transport connected to the particular device.
368// arguments:
David Pursell2ec418a2016-01-20 08:32:08 -0800369//
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000370// local_serial - device to connect (can be a network or usb serial name)
371// wait_for_device - flag indicates whether we need to wait for device
372// announce - flag indicates whether we need to print error to stdout in case
373// we cannot connect to the device
David Pursell2ec418a2016-01-20 08:32:08 -0800374//
375// The returned Transport is a singleton, so multiple calls to this function will return the same
376// object, and the caller should not attempt to delete the returned Transport.
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000377static Transport* open_device(const char* local_serial, bool wait_for_device = true,
378 bool announce = true) {
379 const Result<NetworkSerial> network_serial = ParseNetworkSerial(local_serial);
David Pursell2ec418a2016-01-20 08:32:08 -0800380
David Anderson1d887432018-08-27 16:47:32 -0700381 Transport* transport = nullptr;
David Pursell2ec418a2016-01-20 08:32:08 -0800382 while (true) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000383 if (network_serial.ok()) {
David Pursell2ec418a2016-01-20 08:32:08 -0800384 std::string error;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000385 if (network_serial->protocol == Socket::Protocol::kTcp) {
386 transport = tcp::Connect(network_serial->address, network_serial->port, &error)
387 .release();
388 } else if (network_serial->protocol == Socket::Protocol::kUdp) {
389 transport = udp::Connect(network_serial->address, network_serial->port, &error)
390 .release();
David Pursell4601c972016-02-05 15:35:09 -0800391 }
392
David Pursell2ec418a2016-01-20 08:32:08 -0800393 if (transport == nullptr && announce) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000394 LOG(ERROR) << "error: " << error;
David Pursell2ec418a2016-01-20 08:32:08 -0800395 }
396 } else {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000397 transport = usb_open(match_fastboot(local_serial));
David Pursell2ec418a2016-01-20 08:32:08 -0800398 }
399
400 if (transport != nullptr) {
401 return transport;
402 }
403
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000404 if (!wait_for_device) {
405 return nullptr;
406 }
407
David Pursell0b156632015-10-30 11:22:01 -0700408 if (announce) {
David Pursell2ec418a2016-01-20 08:32:08 -0800409 announce = false;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000410 LOG(ERROR) << "< waiting for " << local_serial << ">";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800411 }
Elliott Hughes290a2282016-11-14 17:08:47 -0800412 std::this_thread::sleep_for(std::chrono::milliseconds(1));
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800413 }
414}
415
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000416static Transport* NetworkDeviceConnected(bool print = false) {
417 Transport* transport = nullptr;
418 Transport* result = nullptr;
419
420 ConnectedDevicesStorage storage;
421 std::set<std::string> devices;
422 {
423 FileLock lock = storage.Lock();
424 devices = storage.ReadDevices(lock);
425 }
426
427 for (const std::string& device : devices) {
428 transport = open_device(device.c_str(), false, false);
429
430 if (print) {
431 PrintDevice(device.c_str(), transport == nullptr ? "offline" : "device");
432 }
433
434 if (transport != nullptr) {
435 result = transport;
436 }
437 }
438
439 return result;
440}
441
442// Detects the fastboot connected device to open a new Transport.
443// Detecting logic:
444//
445// if serial is provided - try to connect to this particular usb/network device
446// othervise:
447// 1. Check connected usb devices and return the last connected one
448// 2. Check connected network devices and return the last connected one
449// 2. If nothing is connected - wait for any device by repeating p. 1 and 2
450//
451// The returned Transport is a singleton, so multiple calls to this function will return the same
452// object, and the caller should not attempt to delete the returned Transport.
453static Transport* open_device() {
454 if (serial != nullptr) {
455 return open_device(serial);
456 }
457
458 bool announce = true;
459 Transport* transport = nullptr;
460 while (true) {
461 transport = usb_open(match_fastboot(nullptr));
462 if (transport != nullptr) {
463 return transport;
464 }
465
466 transport = NetworkDeviceConnected();
467 if (transport != nullptr) {
468 return transport;
469 }
470
471 if (announce) {
472 announce = false;
473 LOG(ERROR) << "< waiting for any device >";
474 }
475 std::this_thread::sleep_for(std::chrono::milliseconds(1));
476 }
477}
478
479static int Connect(int argc, char* argv[]) {
480 if (argc != 1) {
481 LOG(FATAL) << "connect command requires to receive only 1 argument. Usage:" << std::endl
482 << "fastboot connect [tcp:|udp:host:port]";
483 }
484
485 const char* local_serial = *argv;
486 EXPECT(ParseNetworkSerial(local_serial));
487
488 const Transport* transport = open_device(local_serial, false);
489 if (transport == nullptr) {
490 return 1;
491 }
492
493 ConnectedDevicesStorage storage;
494 {
495 FileLock lock = storage.Lock();
496 std::set<std::string> devices = storage.ReadDevices(lock);
497 devices.insert(local_serial);
498 storage.WriteDevices(lock, devices);
499 }
500
501 return 0;
502}
503
504static int Disconnect(const char* local_serial) {
505 EXPECT(ParseNetworkSerial(local_serial));
506
507 ConnectedDevicesStorage storage;
508 {
509 FileLock lock = storage.Lock();
510 std::set<std::string> devices = storage.ReadDevices(lock);
511 devices.erase(local_serial);
512 storage.WriteDevices(lock, devices);
513 }
514
515 return 0;
516}
517
518static int Disconnect() {
519 ConnectedDevicesStorage storage;
520 {
521 FileLock lock = storage.Lock();
522 storage.Clear(lock);
523 }
524
525 return 0;
526}
527
528static int Disconnect(int argc, char* argv[]) {
529 switch (argc) {
530 case 0: {
531 return Disconnect();
532 }
533 case 1: {
534 return Disconnect(*argv);
535 }
536 default:
537 LOG(FATAL) << "disconnect command can receive only 0 or 1 arguments. Usage:"
538 << std::endl
539 << "fastboot disconnect # disconnect all devices" << std::endl
540 << "fastboot disconnect [tcp:|udp:host:port] # disconnect device";
541 }
542
543 return 0;
544}
545
Elliott Hughesfc797672015-04-07 20:12:50 -0700546static void list_devices() {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800547 // We don't actually open a USB device here,
548 // just getting our callback called so we can
549 // list all the connected devices.
550 usb_open(list_devices_callback);
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000551 NetworkDeviceConnected(/* print */ true);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800552}
553
Elliott Hughesd6365a72017-05-08 18:04:49 -0700554static void syntax_error(const char* fmt, ...) {
555 fprintf(stderr, "fastboot: usage: ");
556
557 va_list ap;
558 va_start(ap, fmt);
559 vfprintf(stderr, fmt, ap);
560 va_end(ap);
561
562 fprintf(stderr, "\n");
563 exit(1);
564}
565
566static int show_help() {
567 // clang-format off
568 fprintf(stdout,
Elliott Hughes07fc6822018-05-24 16:36:05 -0700569// 1 2 3 4 5 6 7 8
570// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
Elliott Hughesb76188f2018-04-03 13:30:18 -0700571 "usage: fastboot [OPTION...] COMMAND...\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800572 "\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700573 "flashing:\n"
574 " update ZIP Flash all partitions from an update.zip package.\n"
575 " flashall Flash all partitions from $ANDROID_PRODUCT_OUT.\n"
576 " On A/B devices, flashed slot is set as active.\n"
577 " Secondary images may be flashed to inactive slot.\n"
Elliott Hughes07fc6822018-05-24 16:36:05 -0700578 " flash PARTITION [FILENAME] Flash given partition, using the image from\n"
579 " $ANDROID_PRODUCT_OUT if no filename is given.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700580 "\n"
581 "basics:\n"
582 " devices [-l] List devices in bootloader (-l: with device paths).\n"
583 " getvar NAME Display given bootloader variable.\n"
584 " reboot [bootloader] Reboot device.\n"
585 "\n"
586 "locking/unlocking:\n"
587 " flashing lock|unlock Lock/unlock partitions for flashing\n"
588 " flashing lock_critical|unlock_critical\n"
589 " Lock/unlock 'critical' bootloader partitions.\n"
590 " flashing get_unlock_ability\n"
591 " Check whether unlocking is allowed (1) or not(0).\n"
592 "\n"
593 "advanced:\n"
594 " erase PARTITION Erase a flash partition.\n"
595 " format[:FS_TYPE[:SIZE]] PARTITION\n"
596 " Format a flash partition.\n"
597 " set_active SLOT Set the active slot.\n"
598 " oem [COMMAND...] Execute OEM-specific command.\n"
David Anderson1d504e32019-01-15 14:38:20 -0800599 " gsi wipe|disable Wipe or disable a GSI installation (fastbootd only).\n"
David Anderson7c84b9f2019-06-27 22:15:29 -0700600 " wipe-super [SUPER_EMPTY] Wipe the super partition. This will reset it to\n"
601 " contain an empty set of default dynamic partitions.\n"
Luca Stefani173667b2021-04-12 19:16:43 +0200602 " create-logical-partition NAME SIZE\n"
603 " Create a logical partition with the given name and\n"
604 " size, in the super partition.\n"
605 " delete-logical-partition NAME\n"
606 " Delete a logical partition with the given name.\n"
607 " resize-logical-partition NAME SIZE\n"
608 " Change the size of the named logical partition.\n"
David Andersonab8f4662019-10-21 16:45:59 -0700609 " snapshot-update cancel On devices that support snapshot-based updates, cancel\n"
610 " an in-progress update. This may make the device\n"
611 " unbootable until it is reflashed.\n"
David Anderson220ddb12019-10-31 18:02:41 -0700612 " snapshot-update merge On devices that support snapshot-based updates, finish\n"
613 " an in-progress update if it is in the \"merging\"\n"
614 " phase.\n"
Pierre-ClƩment Tosi96941a02021-06-14 12:16:06 +0000615 " fetch PARTITION OUT_FILE Fetch a partition image from the device."
Elliott Hughesb76188f2018-04-03 13:30:18 -0700616 "\n"
617 "boot image:\n"
618 " boot KERNEL [RAMDISK [SECOND]]\n"
619 " Download and boot kernel from RAM.\n"
620 " flash:raw PARTITION KERNEL [RAMDISK [SECOND]]\n"
621 " Create boot image and flash it.\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800622 " --dtb DTB Specify path to DTB for boot image header version 2.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700623 " --cmdline CMDLINE Override kernel command line.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700624 " --base ADDRESS Set kernel base address (default: 0x10000000).\n"
625 " --kernel-offset Set kernel offset (default: 0x00008000).\n"
626 " --ramdisk-offset Set ramdisk offset (default: 0x01000000).\n"
627 " --tags-offset Set tags offset (default: 0x00000100).\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800628 " --dtb-offset Set dtb offset (default: 0x01100000).\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700629 " --page-size BYTES Set flash page size (default: 2048).\n"
630 " --header-version VERSION Set boot image header version.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700631 " --os-version MAJOR[.MINOR[.PATCH]]\n"
632 " Set boot image OS version (default: 0.0.0).\n"
633 " --os-patch-level YYYY-MM-DD\n"
634 " Set boot image OS security patch level.\n"
635 // TODO: still missing: `second_addr`, `name`, `id`, `recovery_dtbo_*`.
Elliott Hughesb76188f2018-04-03 13:30:18 -0700636 "\n"
Elliott Hughes2e9b7792018-04-04 13:36:44 -0700637 // TODO: what device(s) used this? is there any documentation?
Elliott Hughesb76188f2018-04-03 13:30:18 -0700638 //" continue Continue with autoboot.\n"
639 //"\n"
640 "Android Things:\n"
641 " stage IN_FILE Sends given file to stage for the next command.\n"
642 " get_staged OUT_FILE Writes data staged by the last command to a file.\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800643 "\n"
644 "options:\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700645 " -w Wipe userdata.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700646 " -s SERIAL Specify a USB device.\n"
647 " -s tcp|udp:HOST[:PORT] Specify a network device.\n"
Elliott Hughes542370d2018-04-19 19:49:44 -0700648 " -S SIZE[K|M|G] Break into sparse files no larger than SIZE.\n"
David Anderson89569642018-11-16 15:53:35 -0800649 " --force Force a flash operation that may be unsafe.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700650 " --slot SLOT Use SLOT; 'all' for both slots, 'other' for\n"
651 " non-current slot (default: current active slot).\n"
652 " --set-active[=SLOT] Sets the active slot before rebooting.\n"
653 " --skip-secondary Don't flash secondary slots in flashall/update.\n"
654 " --skip-reboot Don't reboot device after flashing.\n"
655 " --disable-verity Sets disable-verity when flashing vbmeta.\n"
656 " --disable-verification Sets disable-verification when flashing vbmeta.\n"
Jaegeuk Kim638d05e2020-11-09 08:54:13 -0800657 " --fs-options=OPTION[,OPTION]\n"
658 " Enable filesystem features. OPTION supports casefold, projid, compress\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700659 // TODO: remove --unbuffered?
660 " --unbuffered Don't buffer input or output.\n"
661 " --verbose, -v Verbose output.\n"
662 " --version Display version.\n"
663 " --help, -h Show this message.\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800664 );
Yifan Hongbcd27702021-02-16 19:37:32 -0800665 // clang-format on
Elliott Hughesd6365a72017-05-08 18:04:49 -0700666 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800667}
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000668
Tom Cherrydfd85df2018-09-20 14:45:05 -0700669static std::vector<char> LoadBootableImage(const std::string& kernel, const std::string& ramdisk,
670 const std::string& second_stage) {
671 std::vector<char> kernel_data;
672 if (!ReadFileToVector(kernel, &kernel_data)) {
673 die("cannot load '%s': %s", kernel.c_str(), strerror(errno));
674 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800675
Elliott Hughesfc797672015-04-07 20:12:50 -0700676 // Is this actually a boot image?
Steve Muckle15303f22020-03-18 14:55:06 -0700677 if (kernel_data.size() < sizeof(boot_img_hdr_v3)) {
Elliott Hughesaaa3b6b2018-01-18 16:08:24 -0800678 die("cannot load '%s': too short", kernel.c_str());
679 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700680 if (!memcmp(kernel_data.data(), BOOT_MAGIC, BOOT_MAGIC_SIZE)) {
Elliott Hughes577e8b42018-04-05 16:12:47 -0700681 if (!g_cmdline.empty()) {
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800682 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(kernel_data.data()), g_cmdline);
Elliott Hughes577e8b42018-04-05 16:12:47 -0700683 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800684
Elliott Hughes4089d342017-10-27 14:21:12 -0700685 if (!ramdisk.empty()) die("cannot boot a boot.img *and* ramdisk");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800686
Tom Cherrydfd85df2018-09-20 14:45:05 -0700687 return kernel_data;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800688 }
689
Tom Cherrydfd85df2018-09-20 14:45:05 -0700690 std::vector<char> ramdisk_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700691 if (!ramdisk.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700692 if (!ReadFileToVector(ramdisk, &ramdisk_data)) {
693 die("cannot load '%s': %s", ramdisk.c_str(), strerror(errno));
694 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800695 }
696
Tom Cherrydfd85df2018-09-20 14:45:05 -0700697 std::vector<char> second_stage_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700698 if (!second_stage.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700699 if (!ReadFileToVector(second_stage, &second_stage_data)) {
700 die("cannot load '%s': %s", second_stage.c_str(), strerror(errno));
701 }
Jeremy Compostellaa42adff2014-07-17 17:17:54 +0200702 }
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800703
704 std::vector<char> dtb_data;
705 if (!g_dtb_path.empty()) {
Steve Muckle15303f22020-03-18 14:55:06 -0700706 if (g_boot_img_hdr.header_version != 2) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000707 die("Argument dtb not supported for boot image header version %d\n",
708 g_boot_img_hdr.header_version);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800709 }
710 if (!ReadFileToVector(g_dtb_path, &dtb_data)) {
711 die("cannot load '%s': %s", g_dtb_path.c_str(), strerror(errno));
712 }
713 }
714
Daniel Zheng65452d02022-11-30 02:25:31 +0000715 fprintf(stderr, "creating boot image...\n");
Elliott Hughesd6365a72017-05-08 18:04:49 -0700716
Tom Cherrydfd85df2018-09-20 14:45:05 -0700717 std::vector<char> out;
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800718 mkbootimg(kernel_data, ramdisk_data, second_stage_data, dtb_data, g_base_addr, g_boot_img_hdr,
719 &out);
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800720
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800721 if (!g_cmdline.empty()) {
722 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(out.data()), g_cmdline);
723 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700724 fprintf(stderr, "creating boot image - %zu bytes\n", out.size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700725 return out;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800726}
727
Tom Cherrydfd85df2018-09-20 14:45:05 -0700728static bool UnzipToMemory(ZipArchiveHandle zip, const std::string& entry_name,
729 std::vector<char>* out) {
Elliott Hughesb4074142020-09-15 14:26:17 -0700730 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700731 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700732 fprintf(stderr, "archive does not contain '%s'\n", entry_name.c_str());
733 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800734 }
735
Elliott Hughesb4074142020-09-15 14:26:17 -0700736 if (zip_entry.uncompressed_length > std::numeric_limits<size_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000737 die("entry '%s' is too large: %" PRIu64, entry_name.c_str(), zip_entry.uncompressed_length);
Elliott Hughesb4074142020-09-15 14:26:17 -0700738 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700739 out->resize(zip_entry.uncompressed_length);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800740
Tom Cherrydfd85df2018-09-20 14:45:05 -0700741 fprintf(stderr, "extracting %s (%zu MB) to RAM...\n", entry_name.c_str(),
742 out->size() / 1024 / 1024);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800743
Daniel Zheng65452d02022-11-30 02:25:31 +0000744 int error =
745 ExtractToMemory(zip, &zip_entry, reinterpret_cast<uint8_t*>(out->data()), out->size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700746 if (error != 0) die("failed to extract '%s': %s", entry_name.c_str(), ErrorCodeString(error));
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000747
Tom Cherrydfd85df2018-09-20 14:45:05 -0700748 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800749}
750
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700751#if defined(_WIN32)
752
753// TODO: move this to somewhere it can be shared.
754
755#include <windows.h>
756
757// Windows' tmpfile(3) requires administrator rights because
758// it creates temporary files in the root directory.
759static FILE* win32_tmpfile() {
760 char temp_path[PATH_MAX];
761 DWORD nchars = GetTempPath(sizeof(temp_path), temp_path);
762 if (nchars == 0 || nchars >= sizeof(temp_path)) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700763 die("GetTempPath failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700764 }
765
766 char filename[PATH_MAX];
767 if (GetTempFileName(temp_path, "fastboot", 0, filename) == 0) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700768 die("GetTempFileName failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700769 }
770
771 return fopen(filename, "w+bTD");
772}
773
774#define tmpfile win32_tmpfile
775
Elliott Hughes855cdf82018-04-02 14:24:03 -0700776static int make_temporary_fd(const char* /*what*/) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700777 // TODO: reimplement to avoid leaking a FILE*.
778 return fileno(tmpfile());
779}
780
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000781#else
782
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700783static std::string make_temporary_template() {
784 const char* tmpdir = getenv("TMPDIR");
785 if (tmpdir == nullptr) tmpdir = P_tmpdir;
786 return std::string(tmpdir) + "/fastboot_userdata_XXXXXX";
787}
788
Elliott Hughes855cdf82018-04-02 14:24:03 -0700789static int make_temporary_fd(const char* what) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700790 std::string path_template(make_temporary_template());
791 int fd = mkstemp(&path_template[0]);
792 if (fd == -1) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000793 die("failed to create temporary file for %s with template %s: %s\n", path_template.c_str(),
794 what, strerror(errno));
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700795 }
796 unlink(path_template.c_str());
797 return fd;
798}
799
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700800#endif
801
Yifan Hongb10d0672021-02-22 15:06:27 -0800802static unique_fd unzip_to_file(ZipArchiveHandle zip, const char* entry_name) {
Elliott Hughes855cdf82018-04-02 14:24:03 -0700803 unique_fd fd(make_temporary_fd(entry_name));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700804
Elliott Hughesb4074142020-09-15 14:26:17 -0700805 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700806 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700807 fprintf(stderr, "archive does not contain '%s'\n", entry_name);
David Andersoncf444f32018-08-29 14:15:49 -0700808 errno = ENOENT;
Yifan Hongb10d0672021-02-22 15:06:27 -0800809 return unique_fd();
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000810 }
811
Elliott Hughesb4074142020-09-15 14:26:17 -0700812 fprintf(stderr, "extracting %s (%" PRIu64 " MB) to disk...", entry_name,
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700813 zip_entry.uncompressed_length / 1024 / 1024);
Elliott Hughes23af1122017-11-10 08:42:17 -0800814 double start = now();
Yifan Hong58532df2021-03-22 16:39:13 -0700815 int error = ExtractEntryToFile(zip, &zip_entry, fd.get());
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700816 if (error != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800817 die("\nfailed to extract '%s': %s", entry_name, ErrorCodeString(error));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700818 }
819
Yifan Hong58532df2021-03-22 16:39:13 -0700820 if (lseek(fd.get(), 0, SEEK_SET) != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800821 die("\nlseek on extracted file '%s' failed: %s", entry_name, strerror(errno));
Elliott Hughes4089d342017-10-27 14:21:12 -0700822 }
823
Elliott Hughes23af1122017-11-10 08:42:17 -0800824 fprintf(stderr, " took %.3fs\n", now() - start);
825
Yifan Hongb10d0672021-02-22 15:06:27 -0800826 return fd;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700827}
828
Andrew Chantd64b9882021-04-06 12:48:27 -0700829static bool CheckRequirement(const std::string& cur_product, const std::string& var,
Tom Cherry4aa60b32018-09-05 15:11:44 -0700830 const std::string& product, bool invert,
831 const std::vector<std::string>& options) {
832 Status("Checking '" + var + "'");
Elliott Hughes5620d222018-03-28 08:20:00 -0700833
Tom Cherry4aa60b32018-09-05 15:11:44 -0700834 double start = now();
835
836 if (!product.empty()) {
837 if (product != cur_product) {
838 double split = now();
839 fprintf(stderr, "IGNORE, product is %s required only for %s [%7.3fs]\n",
840 cur_product.c_str(), product.c_str(), (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700841 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700842 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800843 }
Tom Cherry4aa60b32018-09-05 15:11:44 -0700844
845 std::string var_value;
Tom Cherry9027af02018-09-24 15:48:09 -0700846 if (fb->GetVar(var, &var_value) != fastboot::SUCCESS) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700847 fprintf(stderr, "FAILED\n\n");
Daniel Zheng65452d02022-11-30 02:25:31 +0000848 fprintf(stderr, "Could not getvar for '%s' (%s)\n\n", var.c_str(), fb->Error().c_str());
Andrew Chantd64b9882021-04-06 12:48:27 -0700849 return false;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700850 }
851
852 bool match = false;
853 for (const auto& option : options) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000854 if (option == var_value ||
855 (option.back() == '*' &&
856 !var_value.compare(0, option.length() - 1, option, 0, option.length() - 1))) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700857 match = true;
858 break;
859 }
860 }
861
862 if (invert) {
863 match = !match;
864 }
865
866 if (match) {
867 double split = now();
868 fprintf(stderr, "OKAY [%7.3fs]\n", (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700869 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700870 }
871
872 fprintf(stderr, "FAILED\n\n");
873 fprintf(stderr, "Device %s is '%s'.\n", var.c_str(), var_value.c_str());
874 fprintf(stderr, "Update %s '%s'", invert ? "rejects" : "requires", options[0].c_str());
875 for (auto it = std::next(options.begin()); it != options.end(); ++it) {
876 fprintf(stderr, " or '%s'", it->c_str());
877 }
878 fprintf(stderr, ".\n\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700879 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800880}
881
Tom Cherry4aa60b32018-09-05 15:11:44 -0700882bool ParseRequirementLine(const std::string& line, std::string* name, std::string* product,
883 bool* invert, std::vector<std::string>* options) {
Elliott Hughes5620d222018-03-28 08:20:00 -0700884 // "require product=alpha|beta|gamma"
885 // "require version-bootloader=1234"
886 // "require-for-product:gamma version-bootloader=istanbul|constantinople"
887 // "require partition-exists=vendor"
Tom Cherry4aa60b32018-09-05 15:11:44 -0700888 *product = "";
889 *invert = false;
Elliott Hughes5620d222018-03-28 08:20:00 -0700890
Tom Cherry4aa60b32018-09-05 15:11:44 -0700891 auto require_reject_regex = std::regex{"(require\\s+|reject\\s+)?\\s*(\\S+)\\s*=\\s*(.*)"};
892 auto require_product_regex =
893 std::regex{"require-for-product:\\s*(\\S+)\\s+(\\S+)\\s*=\\s*(.*)"};
894 std::smatch match_results;
895
896 if (std::regex_match(line, match_results, require_reject_regex)) {
897 *invert = Trim(match_results[1]) == "reject";
898 } else if (std::regex_match(line, match_results, require_product_regex)) {
899 *product = match_results[1];
900 } else {
901 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800902 }
903
Tom Cherry4aa60b32018-09-05 15:11:44 -0700904 *name = match_results[2];
Elliott Hughes253c18d2015-03-18 22:47:09 -0700905 // Work around an unfortunate name mismatch.
Tom Cherry4aa60b32018-09-05 15:11:44 -0700906 if (*name == "board") {
907 *name = "product";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800908 }
909
Tom Cherry4aa60b32018-09-05 15:11:44 -0700910 auto raw_options = Split(match_results[3], "|");
911 for (const auto& option : raw_options) {
912 auto trimmed_option = Trim(option);
913 options->emplace_back(trimmed_option);
914 }
915
916 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800917}
918
Tom Cherry4aa60b32018-09-05 15:11:44 -0700919// "require partition-exists=x" is a special case, added because of the trouble we had when
920// Pixel 2 shipped with new partitions and users used old versions of fastboot to flash them,
921// missing out new partitions. A device with new partitions can use "partition-exists" to
922// override the fields `optional_if_no_image` in the `images` array.
923static void HandlePartitionExists(const std::vector<std::string>& options) {
924 const std::string& partition_name = options[0];
925 std::string has_slot;
Tom Cherry9027af02018-09-24 15:48:09 -0700926 if (fb->GetVar("has-slot:" + partition_name, &has_slot) != fastboot::SUCCESS ||
Tom Cherry4aa60b32018-09-05 15:11:44 -0700927 (has_slot != "yes" && has_slot != "no")) {
928 die("device doesn't have required partition %s!", partition_name.c_str());
929 }
930 bool known_partition = false;
Daniel Zheng65452d02022-11-30 02:25:31 +0000931 for (size_t i = 0; i < images.size(); ++i) {
932 if (!images[i].nickname.empty() && images[i].nickname == partition_name) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700933 images[i].optional_if_no_image = false;
934 known_partition = true;
935 }
936 }
937 if (!known_partition) {
938 die("device requires partition %s which is not known to this version of fastboot",
939 partition_name.c_str());
940 }
941}
942
Andrew Chantd64b9882021-04-06 12:48:27 -0700943static void CheckRequirements(const std::string& data, bool force_flash) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700944 std::string cur_product;
Tom Cherry9027af02018-09-24 15:48:09 -0700945 if (fb->GetVar("product", &cur_product) != fastboot::SUCCESS) {
946 fprintf(stderr, "getvar:product FAILED (%s)\n", fb->Error().c_str());
Tom Cherry4aa60b32018-09-05 15:11:44 -0700947 }
948
949 auto lines = Split(data, "\n");
950 for (const auto& line : lines) {
951 if (line.empty()) {
952 continue;
953 }
954
955 std::string name;
956 std::string product;
957 bool invert;
958 std::vector<std::string> options;
959
960 if (!ParseRequirementLine(line, &name, &product, &invert, &options)) {
961 fprintf(stderr, "android-info.txt syntax error: %s\n", line.c_str());
962 continue;
963 }
964 if (name == "partition-exists") {
965 HandlePartitionExists(options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800966 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -0700967 bool met = CheckRequirement(cur_product, name, product, invert, options);
968 if (!met) {
969 if (!force_flash) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000970 die("requirements not met!");
Andrew Chantd64b9882021-04-06 12:48:27 -0700971 } else {
Daniel Zheng65452d02022-11-30 02:25:31 +0000972 fprintf(stderr, "requirements not met! but proceeding due to --force\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700973 }
974 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800975 }
976 }
977}
978
Tom Cherry9027af02018-09-24 15:48:09 -0700979static void DisplayVarOrError(const std::string& label, const std::string& var) {
980 std::string value;
981
982 if (fb->GetVar(var, &value) != fastboot::SUCCESS) {
983 Status("getvar:" + var);
984 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
985 return;
986 }
987 fprintf(stderr, "%s: %s\n", label.c_str(), value.c_str());
988}
989
990static void DumpInfo() {
991 fprintf(stderr, "--------------------------------------------\n");
992 DisplayVarOrError("Bootloader Version...", "version-bootloader");
993 DisplayVarOrError("Baseband Version.....", "version-baseband");
994 DisplayVarOrError("Serial Number........", "serialno");
995 fprintf(stderr, "--------------------------------------------\n");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800996}
997
David Andersonaa87dc52023-01-27 20:39:06 -0800998static std::vector<SparsePtr> resparse_file(sparse_file* s, int64_t max_size) {
Tao Bao41cf35f2018-04-24 10:54:21 -0700999 if (max_size <= 0 || max_size > std::numeric_limits<uint32_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001000 die("invalid max size %" PRId64, max_size);
Tao Bao41cf35f2018-04-24 10:54:21 -07001001 }
1002
David Andersonaa87dc52023-01-27 20:39:06 -08001003 const int files = sparse_file_resparse(s, max_size, nullptr, 0);
Elliott Hughes4089d342017-10-27 14:21:12 -07001004 if (files < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001005
David Andersona1c983e2023-01-27 11:57:27 -08001006 auto temp = std::make_unique<sparse_file*[]>(files);
David Andersonaa87dc52023-01-27 20:39:06 -08001007 const int rv = sparse_file_resparse(s, max_size, temp.get(), files);
David Andersona1c983e2023-01-27 11:57:27 -08001008 if (rv < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001009
David Andersona1c983e2023-01-27 11:57:27 -08001010 std::vector<SparsePtr> out_s;
1011 for (int i = 0; i < files; i++) {
1012 out_s.emplace_back(temp[i], sparse_file_destroy);
1013 }
Colin Crossf8387882012-05-24 17:18:41 -07001014 return out_s;
1015}
1016
David Andersonaa87dc52023-01-27 20:39:06 -08001017static std::vector<SparsePtr> load_sparse_files(int fd, int64_t max_size) {
1018 SparsePtr s(sparse_file_import_auto(fd, false, true), sparse_file_destroy);
1019 if (!s) die("cannot sparse read file");
1020
1021 return resparse_file(s.get(), max_size);
1022}
1023
Yifan Hongbcd27702021-02-16 19:37:32 -08001024static uint64_t get_uint_var(const char* var_name) {
1025 std::string value_str;
1026 if (fb->GetVar(var_name, &value_str) != fastboot::SUCCESS || value_str.empty()) {
1027 verbose("target didn't report %s", var_name);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001028 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001029 }
1030
Elliott Hughes77c0e662015-11-02 15:51:12 -08001031 // Some bootloaders (angler, for example) send spurious whitespace too.
Yifan Hongbcd27702021-02-16 19:37:32 -08001032 value_str = android::base::Trim(value_str);
Elliott Hughes77c0e662015-11-02 15:51:12 -08001033
Yifan Hongbcd27702021-02-16 19:37:32 -08001034 uint64_t value;
1035 if (!android::base::ParseUint(value_str, &value)) {
1036 fprintf(stderr, "couldn't parse %s '%s'\n", var_name, value_str.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001037 return 0;
1038 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001039 if (value > 0) verbose("target reported %s of %" PRId64 " bytes", var_name, value);
1040 return value;
Colin Crossf8387882012-05-24 17:18:41 -07001041}
1042
Aaron Wisnerdb511202018-06-26 15:38:35 -05001043static int64_t get_sparse_limit(int64_t size) {
Elliott Hughes542370d2018-04-19 19:49:44 -07001044 int64_t limit = sparse_limit;
1045 if (limit == 0) {
1046 // Unlimited, so see what the target device's limit is.
1047 // TODO: shouldn't we apply this limit even if you've used -S?
Colin Crossf8387882012-05-24 17:18:41 -07001048 if (target_sparse_limit == -1) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001049 target_sparse_limit = static_cast<int64_t>(get_uint_var("max-download-size"));
Colin Crossf8387882012-05-24 17:18:41 -07001050 }
1051 if (target_sparse_limit > 0) {
1052 limit = target_sparse_limit;
1053 } else {
Colin Cross0bbfb392012-07-24 18:05:21 -07001054 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001055 }
1056 }
1057
1058 if (size > limit) {
Chris Fries6a999712017-04-04 09:52:47 -05001059 return std::min(limit, RESPARSE_LIMIT);
Colin Crossf8387882012-05-24 17:18:41 -07001060 }
1061
1062 return 0;
1063}
1064
Yifan Hongb10d0672021-02-22 15:06:27 -08001065static bool load_buf_fd(unique_fd fd, struct fastboot_buffer* buf) {
Elliott Hughesfc797672015-04-07 20:12:50 -07001066 int64_t sz = get_file_size(fd);
1067 if (sz == -1) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001068 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001069 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001070
Yifan Hong58532df2021-03-22 16:39:13 -07001071 if (sparse_file* s = sparse_file_import(fd.get(), false, false)) {
David Anderson32e376f2018-08-16 13:43:11 -07001072 buf->image_size = sparse_file_len(s, false, false);
1073 sparse_file_destroy(s);
1074 } else {
1075 buf->image_size = sz;
1076 }
1077
Yifan Hong58532df2021-03-22 16:39:13 -07001078 lseek(fd.get(), 0, SEEK_SET);
Aaron Wisnerdb511202018-06-26 15:38:35 -05001079 int64_t limit = get_sparse_limit(sz);
Yifan Honge9f067b2021-03-22 16:55:39 -07001080 buf->fd = std::move(fd);
Colin Crossf8387882012-05-24 17:18:41 -07001081 if (limit) {
David Andersona1c983e2023-01-27 11:57:27 -08001082 buf->files = load_sparse_files(buf->fd.get(), limit);
1083 if (buf->files.empty()) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001084 return false;
Colin Crossf8387882012-05-24 17:18:41 -07001085 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001086 buf->type = FB_BUFFER_SPARSE;
Colin Crossf8387882012-05-24 17:18:41 -07001087 } else {
Chris Fries0ea946c2017-04-12 10:25:57 -05001088 buf->type = FB_BUFFER_FD;
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +00001089 buf->sz = sz;
Colin Crossf8387882012-05-24 17:18:41 -07001090 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001091
Elliott Hughes53ec4952016-05-11 12:39:27 -07001092 return true;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001093}
1094
Aaron Wisnerdb511202018-06-26 15:38:35 -05001095static bool load_buf(const char* fname, struct fastboot_buffer* buf) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001096 unique_fd fd(TEMP_FAILURE_RETRY(open(fname, O_RDONLY | O_BINARY)));
1097
Elliott Hughes53ec4952016-05-11 12:39:27 -07001098 if (fd == -1) {
1099 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001100 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001101
1102 struct stat s;
Yifan Hong58532df2021-03-22 16:39:13 -07001103 if (fstat(fd.get(), &s)) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001104 return false;
1105 }
1106 if (!S_ISREG(s.st_mode)) {
1107 errno = S_ISDIR(s.st_mode) ? EISDIR : EINVAL;
1108 return false;
1109 }
1110
Yifan Hongb10d0672021-02-22 15:06:27 -08001111 return load_buf_fd(std::move(fd), buf);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001112}
1113
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001114static void rewrite_vbmeta_buffer(struct fastboot_buffer* buf, bool vbmeta_in_boot) {
David Zeuthenb6ea4352017-08-07 14:29:26 -04001115 // Buffer needs to be at least the size of the VBMeta struct which
1116 // is 256 bytes.
1117 if (buf->sz < 256) {
1118 return;
1119 }
1120
David Zeuthenb6ea4352017-08-07 14:29:26 -04001121 std::string data;
1122 if (!android::base::ReadFdToString(buf->fd, &data)) {
1123 die("Failed reading from vbmeta");
1124 }
1125
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001126 uint64_t vbmeta_offset = 0;
1127 if (vbmeta_in_boot) {
1128 // Tries to locate top-level vbmeta from boot.img footer.
1129 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1130 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001131 die("Failed to find AVB_FOOTER at offset: %" PRId64 ", is BOARD_AVB_ENABLE true?",
1132 footer_offset);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001133 }
1134 const AvbFooter* footer = reinterpret_cast<const AvbFooter*>(data.c_str() + footer_offset);
1135 vbmeta_offset = be64toh(footer->vbmeta_offset);
1136 }
1137 // Ensures there is AVB_MAGIC at vbmeta_offset.
1138 if (0 != data.compare(vbmeta_offset, AVB_MAGIC_LEN, AVB_MAGIC)) {
1139 die("Failed to find AVB_MAGIC at offset: %" PRId64, vbmeta_offset);
1140 }
1141
1142 fprintf(stderr, "Rewriting vbmeta struct at offset: %" PRId64 "\n", vbmeta_offset);
1143
David Zeuthenb6ea4352017-08-07 14:29:26 -04001144 // There's a 32-bit big endian |flags| field at offset 120 where
1145 // bit 0 corresponds to disable-verity and bit 1 corresponds to
1146 // disable-verification.
1147 //
1148 // See external/avb/libavb/avb_vbmeta_image.h for the layout of
1149 // the VBMeta struct.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001150 uint64_t flags_offset = 123 + vbmeta_offset;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001151 if (g_disable_verity) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001152 data[flags_offset] |= 0x01;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001153 }
1154 if (g_disable_verification) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001155 data[flags_offset] |= 0x02;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001156 }
1157
Yifan Hongb10d0672021-02-22 15:06:27 -08001158 unique_fd fd(make_temporary_fd("vbmeta rewriting"));
David Zeuthenb6ea4352017-08-07 14:29:26 -04001159 if (!android::base::WriteStringToFd(data, fd)) {
1160 die("Failed writing to modified vbmeta");
1161 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001162 buf->fd = std::move(fd);
Yifan Hong58532df2021-03-22 16:39:13 -07001163 lseek(buf->fd.get(), 0, SEEK_SET);
David Zeuthenb6ea4352017-08-07 14:29:26 -04001164}
1165
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001166static bool has_vbmeta_partition() {
1167 std::string partition_type;
1168 return fb->GetVar("partition-type:vbmeta", &partition_type) == fastboot::SUCCESS ||
1169 fb->GetVar("partition-type:vbmeta_a", &partition_type) == fastboot::SUCCESS ||
1170 fb->GetVar("partition-type:vbmeta_b", &partition_type) == fastboot::SUCCESS;
1171}
1172
David Andersonaa87dc52023-01-27 20:39:06 -08001173// Note: this only works in userspace fastboot. In the bootloader, use
1174// should_flash_in_userspace().
Michael Bestasa495be72020-11-06 17:58:28 +02001175static bool is_logical(const std::string& partition) {
1176 std::string value;
1177 return fb->GetVar("is-logical:" + partition, &value) == fastboot::SUCCESS && value == "yes";
1178}
1179
Steve Muckle3af575b2020-06-18 17:02:15 -07001180static std::string fb_fix_numeric_var(std::string var) {
1181 // Some bootloaders (angler, for example), send spurious leading whitespace.
1182 var = android::base::Trim(var);
1183 // Some bootloaders (hammerhead, for example) use implicit hex.
1184 // This code used to use strtol with base 16.
1185 if (!android::base::StartsWith(var, "0x")) var = "0x" + var;
1186 return var;
1187}
1188
Yifan Hongbcd27702021-02-16 19:37:32 -08001189static uint64_t get_partition_size(const std::string& partition) {
Steve Muckle3af575b2020-06-18 17:02:15 -07001190 std::string partition_size_str;
1191 if (fb->GetVar("partition-size:" + partition, &partition_size_str) != fastboot::SUCCESS) {
Michael Bestasa495be72020-11-06 17:58:28 +02001192 if (!is_logical(partition)) {
1193 return 0;
1194 }
Yifan Hong60de9692021-02-17 13:51:54 -08001195 die("cannot get partition size for %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001196 }
1197
1198 partition_size_str = fb_fix_numeric_var(partition_size_str);
Yifan Hongbcd27702021-02-16 19:37:32 -08001199 uint64_t partition_size;
1200 if (!android::base::ParseUint(partition_size_str, &partition_size)) {
Michael Bestasa495be72020-11-06 17:58:28 +02001201 if (!is_logical(partition)) {
1202 return 0;
1203 }
Steve Muckle3af575b2020-06-18 17:02:15 -07001204 die("Couldn't parse partition size '%s'.", partition_size_str.c_str());
1205 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001206 return partition_size;
1207}
1208
Devin Moorecb5098f2022-01-07 16:33:46 +00001209static void copy_avb_footer(const std::string& partition, struct fastboot_buffer* buf) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001210 if (buf->sz < AVB_FOOTER_SIZE) {
1211 return;
1212 }
1213
Bowgo Tsai671249a2021-08-10 16:32:37 +08001214 // If overflows and negative, it should be < buf->sz.
1215 int64_t partition_size = static_cast<int64_t>(get_partition_size(partition));
1216
1217 if (partition_size == buf->sz) {
1218 return;
1219 }
1220 // Some device bootloaders might not implement `fastboot getvar partition-size:boot[_a|_b]`.
1221 // In this case, partition_size will be zero.
1222 if (partition_size < buf->sz) {
1223 fprintf(stderr,
Devin Moorecb5098f2022-01-07 16:33:46 +00001224 "Warning: skip copying %s image avb footer"
1225 " (%s partition size: %" PRId64 ", %s image size: %" PRId64 ").\n",
1226 partition.c_str(), partition.c_str(), partition_size, partition.c_str(), buf->sz);
Bowgo Tsai671249a2021-08-10 16:32:37 +08001227 return;
1228 }
1229
1230 // IMPORTANT: after the following read, we need to reset buf->fd before return (if not die).
1231 // Because buf->fd will still be used afterwards.
Steve Muckle3af575b2020-06-18 17:02:15 -07001232 std::string data;
1233 if (!android::base::ReadFdToString(buf->fd, &data)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001234 die("Failed reading from %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001235 }
1236
1237 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1238 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001239 lseek(buf->fd.get(), 0, SEEK_SET); // IMPORTANT: resets buf->fd before return.
Steve Muckle3af575b2020-06-18 17:02:15 -07001240 return;
1241 }
1242
Devin Moorecb5098f2022-01-07 16:33:46 +00001243 const std::string tmp_fd_template = partition + " rewriting";
1244 unique_fd fd(make_temporary_fd(tmp_fd_template.c_str()));
Steve Muckle3af575b2020-06-18 17:02:15 -07001245 if (!android::base::WriteStringToFd(data, fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001246 die("Failed writing to modified %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001247 }
Yifan Hong58532df2021-03-22 16:39:13 -07001248 lseek(fd.get(), partition_size - AVB_FOOTER_SIZE, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001249 if (!android::base::WriteStringToFd(data.substr(footer_offset), fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001250 die("Failed copying AVB footer in %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001251 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001252 buf->fd = std::move(fd);
Steve Muckle3af575b2020-06-18 17:02:15 -07001253 buf->sz = partition_size;
Yifan Hong58532df2021-03-22 16:39:13 -07001254 lseek(buf->fd.get(), 0, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001255}
1256
David Andersonaa87dc52023-01-27 20:39:06 -08001257static void flash_partition_files(const std::string& partition,
1258 const std::vector<SparsePtr>& files) {
1259 for (size_t i = 0; i < files.size(); i++) {
1260 sparse_file* s = files[i].get();
1261 int64_t sz = sparse_file_len(s, true, false);
1262 fb->FlashPartition(partition, s, sz, i + 1, files.size());
1263 }
1264}
1265
Daniel Zheng65452d02022-11-30 02:25:31 +00001266static void flash_buf(const std::string& partition, struct fastboot_buffer* buf) {
Devin Moore1af12022022-01-06 01:11:23 +00001267 if (partition == "boot" || partition == "boot_a" || partition == "boot_b" ||
Isaac J. Manjarresacb49522023-01-12 14:28:29 -08001268 partition == "init_boot" || partition == "init_boot_a" || partition == "init_boot_b" ||
1269 partition == "recovery" || partition == "recovery_a" || partition == "recovery_b") {
Devin Moorecb5098f2022-01-07 16:33:46 +00001270 copy_avb_footer(partition, buf);
Steve Muckle3af575b2020-06-18 17:02:15 -07001271 }
1272
David Zeuthenb6ea4352017-08-07 14:29:26 -04001273 // Rewrite vbmeta if that's what we're flashing and modification has been requested.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001274 if (g_disable_verity || g_disable_verification) {
Paweł Grabasff9cfac2021-03-04 13:11:25 +01001275 // The vbmeta partition might have additional prefix if running in virtual machine
1276 // e.g., guest_vbmeta_a.
1277 if (android::base::EndsWith(partition, "vbmeta") ||
1278 android::base::EndsWith(partition, "vbmeta_a") ||
1279 android::base::EndsWith(partition, "vbmeta_b")) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001280 rewrite_vbmeta_buffer(buf, false /* vbmeta_in_boot */);
1281 } else if (!has_vbmeta_partition() &&
1282 (partition == "boot" || partition == "boot_a" || partition == "boot_b")) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001283 rewrite_vbmeta_buffer(buf, true /* vbmeta_in_boot */);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001284 }
David Zeuthenb6ea4352017-08-07 14:29:26 -04001285 }
1286
Rom Lemarchand622810c2013-06-28 09:54:59 -07001287 switch (buf->type) {
Josh Gao9da9ac52016-01-19 14:50:18 -08001288 case FB_BUFFER_SPARSE: {
David Andersonaa87dc52023-01-27 20:39:06 -08001289 flash_partition_files(partition, buf->files);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001290 break;
Josh Gao9da9ac52016-01-19 14:50:18 -08001291 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001292 case FB_BUFFER_FD:
Tom Cherry9027af02018-09-24 15:48:09 -07001293 fb->FlashPartition(partition, buf->fd, buf->sz);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001294 break;
1295 default:
1296 die("unknown buffer type: %d", buf->type);
1297 }
1298}
1299
Aaron Wisnerdb511202018-06-26 15:38:35 -05001300static std::string get_current_slot() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001301 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07001302 if (fb->GetVar("current-slot", &current_slot) != fastboot::SUCCESS) return "";
LuK1337dae48ef2020-04-06 14:38:58 +02001303 if (current_slot[0] == '_') current_slot.erase(0, 1);
Elliott Hughes42b18a52018-04-10 15:32:21 -07001304 return current_slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001305}
1306
Aaron Wisnerdb511202018-06-26 15:38:35 -05001307static int get_slot_count() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001308 std::string var;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001309 int count = 0;
Tom Cherry9027af02018-09-24 15:48:09 -07001310 if (fb->GetVar("slot-count", &var) != fastboot::SUCCESS ||
1311 !android::base::ParseInt(var, &count)) {
Elliott Hughes42b18a52018-04-10 15:32:21 -07001312 return 0;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001313 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001314 return count;
1315}
1316
Aaron Wisnerdb511202018-06-26 15:38:35 -05001317static bool supports_AB() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001318 return get_slot_count() >= 2;
Alex Lightbb9b8a52016-06-29 09:26:44 -07001319}
1320
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001321// Given a current slot, this returns what the 'other' slot is.
Daniel Rosenberg80919472016-06-30 19:25:31 -07001322static std::string get_other_slot(const std::string& current_slot, int count) {
1323 if (count == 0) return "";
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001324
Daniel Zheng65452d02022-11-30 02:25:31 +00001325 char next = (current_slot[0] - 'a' + 1) % count + 'a';
Daniel Rosenberg80919472016-06-30 19:25:31 -07001326 return std::string(1, next);
1327}
1328
Aaron Wisnerdb511202018-06-26 15:38:35 -05001329static std::string get_other_slot(const std::string& current_slot) {
1330 return get_other_slot(current_slot, get_slot_count());
Daniel Rosenberg80919472016-06-30 19:25:31 -07001331}
1332
Aaron Wisnerdb511202018-06-26 15:38:35 -05001333static std::string get_other_slot(int count) {
1334 return get_other_slot(get_current_slot(), count);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001335}
1336
Aaron Wisnerdb511202018-06-26 15:38:35 -05001337static std::string get_other_slot() {
1338 return get_other_slot(get_current_slot(), get_slot_count());
Alex Lightbb9b8a52016-06-29 09:26:44 -07001339}
1340
Aaron Wisnerdb511202018-06-26 15:38:35 -05001341static std::string verify_slot(const std::string& slot_name, bool allow_all) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001342 std::string slot = slot_name;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001343 if (slot == "all") {
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001344 if (allow_all) {
1345 return "all";
1346 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001347 int count = get_slot_count();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001348 if (count > 0) {
1349 return "a";
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001350 } else {
Elliott Hughes4089d342017-10-27 14:21:12 -07001351 die("No known slots");
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001352 }
1353 }
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001354 }
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001355
Aaron Wisnerdb511202018-06-26 15:38:35 -05001356 int count = get_slot_count();
Elliott Hughes4089d342017-10-27 14:21:12 -07001357 if (count == 0) die("Device does not support slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001358
Daniel Rosenberg80919472016-06-30 19:25:31 -07001359 if (slot == "other") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001360 std::string other = get_other_slot(count);
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001361 if (other == "") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001362 die("No known slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001363 }
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001364 return other;
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001365 }
1366
Daniel Zheng65452d02022-11-30 02:25:31 +00001367 if (slot.size() == 1 && (slot[0] - 'a' >= 0 && slot[0] - 'a' < count)) return slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001368
1369 fprintf(stderr, "Slot %s does not exist. supported slots are:\n", slot.c_str());
Daniel Zheng65452d02022-11-30 02:25:31 +00001370 for (int i = 0; i < count; i++) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001371 fprintf(stderr, "%c\n", (char)(i + 'a'));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001372 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001373
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001374 exit(1);
1375}
1376
Aaron Wisnerdb511202018-06-26 15:38:35 -05001377static std::string verify_slot(const std::string& slot) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001378 return verify_slot(slot, true);
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001379}
1380
Aaron Wisnerdb511202018-06-26 15:38:35 -05001381static void do_for_partition(const std::string& part, const std::string& slot,
Chih-Hung Hsieh8f7b9e32016-07-27 16:25:51 -07001382 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001383 std::string has_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001384 std::string current_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001385 // |part| can be vendor_boot:default. Append slot to the first token.
1386 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001387
Yifan Hong6d7da632021-02-23 12:15:51 -08001388 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001389 /* If has-slot is not supported, the answer is no. */
1390 has_slot = "no";
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001391 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001392 if (has_slot == "yes") {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001393 if (slot == "") {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001394 current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001395 if (current_slot == "") {
Elliott Hughes4089d342017-10-27 14:21:12 -07001396 die("Failed to identify current slot");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001397 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001398 part_tokens[0] += "_" + current_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001399 } else {
Yifan Hong6d7da632021-02-23 12:15:51 -08001400 part_tokens[0] += "_" + slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001401 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001402 func(android::base::Join(part_tokens, ":"));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001403 } else {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001404 if (force_slot && slot != "") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001405 fprintf(stderr, "Warning: %s does not support slots, and slot %s was requested.\n",
1406 part_tokens[0].c_str(), slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001407 }
1408 func(part);
1409 }
1410}
1411
David Pursell0b156632015-10-30 11:22:01 -07001412/* This function will find the real partition name given a base name, and a slot. If slot is NULL or
1413 * empty, it will use the current slot. If slot is "all", it will return a list of all possible
1414 * partition names. If force_slot is true, it will fail if a slot is specified, and the given
1415 * partition does not support slots.
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001416 */
Aaron Wisnerdb511202018-06-26 15:38:35 -05001417static void do_for_partitions(const std::string& part, const std::string& slot,
Daniel Zheng65452d02022-11-30 02:25:31 +00001418 const std::function<void(const std::string&)>& func,
1419 bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001420 std::string has_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001421 // |part| can be vendor_boot:default. Query has-slot on the first token only.
1422 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001423
Daniel Rosenberg80919472016-06-30 19:25:31 -07001424 if (slot == "all") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001425 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1426 die("Could not check if partition %s has slot %s", part_tokens[0].c_str(),
1427 slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001428 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001429 if (has_slot == "yes") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001430 for (int i = 0; i < get_slot_count(); i++) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001431 do_for_partition(part, std::string(1, (char)(i + 'a')), func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001432 }
1433 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001434 do_for_partition(part, "", func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001435 }
1436 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001437 do_for_partition(part, slot, func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001438 }
1439}
1440
David Anderson0c732342018-11-28 17:10:42 -08001441static bool is_retrofit_device() {
1442 std::string value;
1443 if (fb->GetVar("super-partition-name", &value) != fastboot::SUCCESS) {
1444 return false;
1445 }
1446 return android::base::StartsWith(value, "system_");
1447}
1448
Yifan Hongbcd27702021-02-16 19:37:32 -08001449// Fetch a partition from the device to a given fd. This is a wrapper over FetchToFd to fetch
1450// the full image.
1451static uint64_t fetch_partition(const std::string& partition, borrowed_fd fd) {
1452 uint64_t fetch_size = get_uint_var(FB_VAR_MAX_FETCH_SIZE);
1453 if (fetch_size == 0) {
1454 die("Unable to get %s. Device does not support fetch command.", FB_VAR_MAX_FETCH_SIZE);
1455 }
1456 uint64_t partition_size = get_partition_size(partition);
1457 if (partition_size <= 0) {
1458 die("Invalid partition size for partition %s: %" PRId64, partition.c_str(), partition_size);
1459 }
1460
1461 uint64_t offset = 0;
1462 while (offset < partition_size) {
1463 uint64_t chunk_size = std::min(fetch_size, partition_size - offset);
1464 if (fb->FetchToFd(partition, fd, offset, chunk_size) != fastboot::RetCode::SUCCESS) {
1465 die("Unable to fetch %s (offset=%" PRIx64 ", size=%" PRIx64 ")", partition.c_str(),
1466 offset, chunk_size);
1467 }
1468 offset += chunk_size;
1469 }
1470 return partition_size;
1471}
1472
1473static void do_fetch(const std::string& partition, const std::string& slot_override,
1474 const std::string& outfile) {
1475 unique_fd fd(TEMP_FAILURE_RETRY(
1476 open(outfile.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0644)));
1477 auto fetch = std::bind(fetch_partition, _1, borrowed_fd(fd));
1478 do_for_partitions(partition, slot_override, fetch, false /* force slot */);
1479}
1480
Yifan Honge71fe242021-02-22 15:00:15 -08001481// Return immediately if not flashing a vendor boot image. If flashing a vendor boot image,
1482// repack vendor_boot image with an updated ramdisk. After execution, buf is set
1483// to the new image to flash, and return value is the real partition name to flash.
1484static std::string repack_ramdisk(const char* pname, struct fastboot_buffer* buf) {
1485 std::string_view pname_sv{pname};
1486
1487 if (!android::base::StartsWith(pname_sv, "vendor_boot:") &&
1488 !android::base::StartsWith(pname_sv, "vendor_boot_a:") &&
1489 !android::base::StartsWith(pname_sv, "vendor_boot_b:")) {
1490 return std::string(pname_sv);
1491 }
1492 if (buf->type != FB_BUFFER_FD) {
1493 die("Flashing sparse vendor ramdisk image is not supported.");
1494 }
1495 if (buf->sz <= 0) {
1496 die("repack_ramdisk() sees negative size: %" PRId64, buf->sz);
1497 }
1498 std::string partition(pname_sv.substr(0, pname_sv.find(':')));
1499 std::string ramdisk(pname_sv.substr(pname_sv.find(':') + 1));
1500
1501 unique_fd vendor_boot(make_temporary_fd("vendor boot repack"));
1502 uint64_t vendor_boot_size = fetch_partition(partition, vendor_boot);
1503 auto repack_res = replace_vendor_ramdisk(vendor_boot, vendor_boot_size, ramdisk, buf->fd,
1504 static_cast<uint64_t>(buf->sz));
1505 if (!repack_res.ok()) {
1506 die("%s", repack_res.error().message().c_str());
1507 }
1508
1509 buf->fd = std::move(vendor_boot);
1510 buf->sz = vendor_boot_size;
1511 buf->image_size = vendor_boot_size;
1512 return partition;
1513}
1514
Aaron Wisnerdb511202018-06-26 15:38:35 -05001515static void do_flash(const char* pname, const char* fname) {
Yifan Hong6d7da632021-02-23 12:15:51 -08001516 verbose("Do flash %s %s", pname, fname);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001517 struct fastboot_buffer buf;
1518
Aaron Wisnerdb511202018-06-26 15:38:35 -05001519 if (!load_buf(fname, &buf)) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001520 die("cannot load '%s': %s", fname, strerror(errno));
Rom Lemarchand622810c2013-06-28 09:54:59 -07001521 }
David Anderson629e51c2018-10-25 12:51:25 -07001522 if (is_logical(pname)) {
1523 fb->ResizePartition(pname, std::to_string(buf.image_size));
1524 }
Yifan Honge71fe242021-02-22 15:00:15 -08001525 std::string flash_pname = repack_ramdisk(pname, &buf);
1526 flash_buf(flash_pname, &buf);
Colin Crossf8387882012-05-24 17:18:41 -07001527}
1528
Daniel Rosenberg13454092016-06-27 19:43:11 -07001529// Sets slot_override as the active slot. If slot_override is blank,
1530// set current slot as active instead. This clears slot-unbootable.
Aaron Wisnerdb511202018-06-26 15:38:35 -05001531static void set_active(const std::string& slot_override) {
1532 if (!supports_AB()) return;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001533
Daniel Rosenberg80919472016-06-30 19:25:31 -07001534 if (slot_override != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001535 fb->SetActive(slot_override);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001536 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001537 std::string current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001538 if (current_slot != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001539 fb->SetActive(current_slot);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001540 }
1541 }
1542}
1543
David Anderson32e376f2018-08-16 13:43:11 -07001544static bool is_userspace_fastboot() {
1545 std::string value;
Tom Cherry9027af02018-09-24 15:48:09 -07001546 return fb->GetVar("is-userspace", &value) == fastboot::SUCCESS && value == "yes";
David Anderson32e376f2018-08-16 13:43:11 -07001547}
1548
David Anderson1d887432018-08-27 16:47:32 -07001549static void reboot_to_userspace_fastboot() {
Tom Cherry9027af02018-09-24 15:48:09 -07001550 fb->RebootTo("fastboot");
1551
1552 auto* old_transport = fb->set_transport(nullptr);
1553 delete old_transport;
David Anderson1d887432018-08-27 16:47:32 -07001554
1555 // Give the current connection time to close.
1556 std::this_thread::sleep_for(std::chrono::milliseconds(1000));
1557
Tom Cherry9027af02018-09-24 15:48:09 -07001558 fb->set_transport(open_device());
David Anderson11d6d272018-12-07 16:39:07 -08001559
1560 if (!is_userspace_fastboot()) {
1561 die("Failed to boot into userspace fastboot; one or more components might be unbootable.");
1562 }
Hridya Valsaraju83d856e2019-05-17 14:24:19 -07001563
1564 // Reset target_sparse_limit after reboot to userspace fastboot. Max
1565 // download sizes may differ in bootloader and fastbootd.
1566 target_sparse_limit = -1;
David Anderson1d887432018-08-27 16:47:32 -07001567}
1568
David Andersonab8f4662019-10-21 16:45:59 -07001569static void CancelSnapshotIfNeeded() {
1570 std::string merge_status = "none";
1571 if (fb->GetVar(FB_VAR_SNAPSHOT_UPDATE_STATUS, &merge_status) == fastboot::SUCCESS &&
Elliott Hughes6a7ff582020-06-05 14:06:15 -07001572 !merge_status.empty() && merge_status != "none") {
Yifan Hong712c32b2019-12-10 18:11:13 -08001573 fb->SnapshotUpdateCommand("cancel");
David Andersonab8f4662019-10-21 16:45:59 -07001574 }
1575}
1576
David Andersoncf444f32018-08-29 14:15:49 -07001577class FlashAllTool {
1578 public:
Andrew Chantd64b9882021-04-06 12:48:27 -07001579 FlashAllTool(const ImageSource& source, const std::string& slot_override, bool skip_secondary,
1580 bool wipe, bool force_flash);
David Anderson32e376f2018-08-16 13:43:11 -07001581
David Andersoncf444f32018-08-29 14:15:49 -07001582 void Flash();
David Anderson32e376f2018-08-16 13:43:11 -07001583
David Andersoncf444f32018-08-29 14:15:49 -07001584 private:
1585 void CheckRequirements();
David Anderson667b1ef2023-01-27 21:11:11 -08001586 void DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001587 void CollectImages();
1588 void FlashImages(const std::vector<std::pair<const Image*, std::string>>& images);
1589 void FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf);
1590 void UpdateSuperPartition();
David Anderson667b1ef2023-01-27 21:11:11 -08001591 bool OptimizedFlashSuper();
1592
1593 // If the image uses the default slot, or the user specified "all", then
1594 // the paired string will be empty. If the image requests a specific slot
1595 // (for example, system_other) it is specified instead.
1596 using ImageEntry = std::pair<const Image*, std::string>;
1597
1598 std::string GetPartitionName(const ImageEntry& entry);
David Anderson32e376f2018-08-16 13:43:11 -07001599
David Andersoncf444f32018-08-29 14:15:49 -07001600 const ImageSource& source_;
1601 std::string slot_override_;
1602 bool skip_secondary_;
1603 bool wipe_;
Andrew Chantd64b9882021-04-06 12:48:27 -07001604 bool force_flash_;
David Anderson667b1ef2023-01-27 21:11:11 -08001605 std::string current_slot_;
David Andersoncf444f32018-08-29 14:15:49 -07001606 std::string secondary_slot_;
David Anderson667b1ef2023-01-27 21:11:11 -08001607
1608 std::vector<ImageEntry> boot_images_;
1609 std::vector<ImageEntry> os_images_;
David Andersoncf444f32018-08-29 14:15:49 -07001610};
1611
Andrew Chantd64b9882021-04-06 12:48:27 -07001612FlashAllTool::FlashAllTool(const ImageSource& source, const std::string& slot_override,
1613 bool skip_secondary, bool wipe, bool force_flash)
Daniel Zheng65452d02022-11-30 02:25:31 +00001614 : source_(source),
1615 slot_override_(slot_override),
1616 skip_secondary_(skip_secondary),
1617 wipe_(wipe),
1618 force_flash_(force_flash) {}
David Anderson32e376f2018-08-16 13:43:11 -07001619
David Andersoncf444f32018-08-29 14:15:49 -07001620void FlashAllTool::Flash() {
Tom Cherry9027af02018-09-24 15:48:09 -07001621 DumpInfo();
David Andersoncf444f32018-08-29 14:15:49 -07001622 CheckRequirements();
David Anderson96a9fd42018-11-05 15:21:44 -08001623
1624 // Change the slot first, so we boot into the correct recovery image when
1625 // using fastbootd.
1626 if (slot_override_ == "all") {
1627 set_active("a");
1628 } else {
1629 set_active(slot_override_);
1630 }
1631
David Anderson667b1ef2023-01-27 21:11:11 -08001632 DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001633 CollectImages();
David Anderson32e376f2018-08-16 13:43:11 -07001634
David Andersonab8f4662019-10-21 16:45:59 -07001635 CancelSnapshotIfNeeded();
1636
David Anderson95d40932018-08-28 12:14:33 -07001637 // First flash boot partitions. We allow this to happen either in userspace
1638 // or in bootloader fastboot.
David Andersoncf444f32018-08-29 14:15:49 -07001639 FlashImages(boot_images_);
David Anderson95d40932018-08-28 12:14:33 -07001640
David Anderson667b1ef2023-01-27 21:11:11 -08001641 if (!OptimizedFlashSuper()) {
1642 // Sync the super partition. This will reboot to userspace fastboot if needed.
1643 UpdateSuperPartition();
David Anderson95d40932018-08-28 12:14:33 -07001644
David Anderson667b1ef2023-01-27 21:11:11 -08001645 // Resize any logical partition to 0, so each partition is reset to 0
1646 // extents, and will achieve more optimal allocation.
1647 for (const auto& [image, slot] : os_images_) {
1648 auto resize_partition = [](const std::string& partition) -> void {
1649 if (is_logical(partition)) {
1650 fb->ResizePartition(partition, "0");
1651 }
1652 };
1653 do_for_partitions(image->part_name, slot, resize_partition, false);
1654 }
David Anderson32e376f2018-08-16 13:43:11 -07001655 }
1656
David Anderson95d40932018-08-28 12:14:33 -07001657 // Flash OS images, resizing logical partitions as needed.
David Andersoncf444f32018-08-29 14:15:49 -07001658 FlashImages(os_images_);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001659}
1660
David Anderson667b1ef2023-01-27 21:11:11 -08001661bool FlashAllTool::OptimizedFlashSuper() {
1662 if (!supports_AB()) {
1663 LOG(VERBOSE) << "Cannot optimize flashing super on non-AB device";
1664 return false;
1665 }
1666 if (slot_override_ == "all") {
1667 LOG(VERBOSE) << "Cannot optimize flashing super for all slots";
1668 return false;
1669 }
1670
1671 // Does this device use dynamic partitions at all?
1672 unique_fd fd = source_.OpenFile("super_empty.img");
1673 if (fd < 0) {
1674 LOG(VERBOSE) << "could not open super_empty.img";
1675 return false;
1676 }
1677
1678 // Try to find whether there is a super partition.
1679 std::string super_name;
1680 if (fb->GetVar("super-partition-name", &super_name) != fastboot::SUCCESS) {
1681 super_name = "super";
1682 }
1683 std::string partition_size_str;
1684 if (fb->GetVar("partition-size:" + super_name, &partition_size_str) != fastboot::SUCCESS) {
1685 LOG(VERBOSE) << "Cannot optimize super flashing: could not determine super partition";
1686 return false;
1687 }
1688
1689 SuperFlashHelper helper(source_);
1690 if (!helper.Open(fd)) {
1691 return false;
1692 }
1693
1694 for (const auto& entry : os_images_) {
1695 auto partition = GetPartitionName(entry);
1696 auto image = entry.first;
1697
1698 if (!helper.AddPartition(partition, image->img_name, image->optional_if_no_image)) {
1699 return false;
1700 }
1701 }
1702
1703 auto s = helper.GetSparseLayout();
1704 if (!s) {
1705 return false;
1706 }
1707
1708 std::vector<SparsePtr> files;
1709 if (int limit = get_sparse_limit(sparse_file_len(s.get(), false, false))) {
1710 files = resparse_file(s.get(), limit);
1711 } else {
1712 files.emplace_back(std::move(s));
1713 }
1714
1715 // Send the data to the device.
1716 flash_partition_files(super_name, files);
1717
1718 // Remove images that we already flashed, just in case we have non-dynamic OS images.
1719 auto remove_if_callback = [&, this](const ImageEntry& entry) -> bool {
1720 return helper.WillFlash(GetPartitionName(entry));
1721 };
1722 os_images_.erase(std::remove_if(os_images_.begin(), os_images_.end(), remove_if_callback),
1723 os_images_.end());
1724 return true;
1725}
1726
David Andersoncf444f32018-08-29 14:15:49 -07001727void FlashAllTool::CheckRequirements() {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001728 std::vector<char> contents;
1729 if (!source_.ReadFile("android-info.txt", &contents)) {
David Andersoncf444f32018-08-29 14:15:49 -07001730 die("could not read android-info.txt");
1731 }
Andrew Chantd64b9882021-04-06 12:48:27 -07001732 ::CheckRequirements({contents.data(), contents.size()}, force_flash_);
David Andersoncf444f32018-08-29 14:15:49 -07001733}
1734
David Anderson667b1ef2023-01-27 21:11:11 -08001735void FlashAllTool::DetermineSlot() {
1736 if (slot_override_.empty()) {
1737 current_slot_ = get_current_slot();
1738 } else {
1739 current_slot_ = slot_override_;
1740 }
1741
David Andersoncf444f32018-08-29 14:15:49 -07001742 if (skip_secondary_) {
1743 return;
1744 }
David Anderson96a9fd42018-11-05 15:21:44 -08001745 if (slot_override_ != "" && slot_override_ != "all") {
David Andersoncf444f32018-08-29 14:15:49 -07001746 secondary_slot_ = get_other_slot(slot_override_);
1747 } else {
1748 secondary_slot_ = get_other_slot();
1749 }
1750 if (secondary_slot_ == "") {
1751 if (supports_AB()) {
1752 fprintf(stderr, "Warning: Could not determine slot for secondary images. Ignoring.\n");
1753 }
1754 skip_secondary_ = true;
1755 }
1756}
1757
1758void FlashAllTool::CollectImages() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001759 for (size_t i = 0; i < images.size(); ++i) {
David Andersoncf444f32018-08-29 14:15:49 -07001760 std::string slot = slot_override_;
1761 if (images[i].IsSecondary()) {
1762 if (skip_secondary_) {
1763 continue;
1764 }
1765 slot = secondary_slot_;
1766 }
1767 if (images[i].type == ImageType::BootCritical) {
1768 boot_images_.emplace_back(&images[i], slot);
1769 } else if (images[i].type == ImageType::Normal) {
1770 os_images_.emplace_back(&images[i], slot);
1771 }
1772 }
1773}
1774
1775void FlashAllTool::FlashImages(const std::vector<std::pair<const Image*, std::string>>& images) {
1776 for (const auto& [image, slot] : images) {
1777 fastboot_buffer buf;
Yifan Hongb10d0672021-02-22 15:06:27 -08001778 unique_fd fd = source_.OpenFile(image->img_name);
1779 if (fd < 0 || !load_buf_fd(std::move(fd), &buf)) {
David Andersoncf444f32018-08-29 14:15:49 -07001780 if (image->optional_if_no_image) {
1781 continue;
1782 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001783 die("could not load '%s': %s", image->img_name.c_str(), strerror(errno));
David Andersoncf444f32018-08-29 14:15:49 -07001784 }
1785 FlashImage(*image, slot, &buf);
1786 }
1787}
1788
1789void FlashAllTool::FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf) {
1790 auto flash = [&, this](const std::string& partition_name) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001791 std::vector<char> signature_data;
1792 if (source_.ReadFile(image.sig_name, &signature_data)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001793 fb->Download("signature", signature_data);
1794 fb->RawCommand("signature", "installing signature");
David Andersoncf444f32018-08-29 14:15:49 -07001795 }
1796
1797 if (is_logical(partition_name)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001798 fb->ResizePartition(partition_name, std::to_string(buf->image_size));
David Andersoncf444f32018-08-29 14:15:49 -07001799 }
1800 flash_buf(partition_name.c_str(), buf);
1801 };
1802 do_for_partitions(image.part_name, slot, flash, false);
1803}
1804
1805void FlashAllTool::UpdateSuperPartition() {
Yifan Hong58532df2021-03-22 16:39:13 -07001806 unique_fd fd = source_.OpenFile("super_empty.img");
David Andersoncf444f32018-08-29 14:15:49 -07001807 if (fd < 0) {
1808 return;
1809 }
1810 if (!is_userspace_fastboot()) {
1811 reboot_to_userspace_fastboot();
1812 }
David Andersoncf444f32018-08-29 14:15:49 -07001813
David Anderson90fe0a42018-11-05 18:01:32 -08001814 std::string super_name;
1815 if (fb->GetVar("super-partition-name", &super_name) != fastboot::RetCode::SUCCESS) {
1816 super_name = "super";
1817 }
1818 fb->Download(super_name, fd, get_file_size(fd));
1819
1820 std::string command = "update-super:" + super_name;
David Andersoncf444f32018-08-29 14:15:49 -07001821 if (wipe_) {
1822 command += ":wipe";
1823 }
Tom Cherry9027af02018-09-24 15:48:09 -07001824 fb->RawCommand(command, "Updating super partition");
David Anderson0c732342018-11-28 17:10:42 -08001825
1826 // Retrofit devices have two super partitions, named super_a and super_b.
1827 // On these devices, secondary slots must be flashed as physical
1828 // partitions (otherwise they would not mount on first boot). To enforce
1829 // this, we delete any logical partitions for the "other" slot.
1830 if (is_retrofit_device()) {
1831 for (const auto& [image, slot] : os_images_) {
1832 std::string partition_name = image->part_name + "_"s + slot;
1833 if (image->IsSecondary() && is_logical(partition_name)) {
1834 fb->DeletePartition(partition_name);
1835 }
1836 }
1837 }
David Andersoncf444f32018-08-29 14:15:49 -07001838}
1839
David Anderson667b1ef2023-01-27 21:11:11 -08001840std::string FlashAllTool::GetPartitionName(const ImageEntry& entry) {
1841 auto slot = entry.second;
1842 if (slot.empty()) {
1843 slot = current_slot_;
1844 }
1845 if (slot.empty()) {
1846 return entry.first->part_name;
1847 }
1848 if (slot == "all") {
1849 LOG(FATAL) << "Cannot retrieve a singular name when using all slots";
1850 }
1851 return entry.first->part_name + "_" + slot;
1852}
1853
David Andersoncf444f32018-08-29 14:15:49 -07001854class ZipImageSource final : public ImageSource {
1855 public:
1856 explicit ZipImageSource(ZipArchiveHandle zip) : zip_(zip) {}
Tom Cherrydfd85df2018-09-20 14:45:05 -07001857 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001858 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001859
1860 private:
1861 ZipArchiveHandle zip_;
1862};
1863
Tom Cherrydfd85df2018-09-20 14:45:05 -07001864bool ZipImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1865 return UnzipToMemory(zip_, name, out);
David Andersoncf444f32018-08-29 14:15:49 -07001866}
1867
Yifan Hongb10d0672021-02-22 15:06:27 -08001868unique_fd ZipImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001869 return unzip_to_file(zip_, name.c_str());
1870}
1871
Andrew Chantd64b9882021-04-06 12:48:27 -07001872static void do_update(const char* filename, const std::string& slot_override, bool skip_secondary,
1873 bool force_flash) {
David Andersoncf444f32018-08-29 14:15:49 -07001874 ZipArchiveHandle zip;
1875 int error = OpenArchive(filename, &zip);
1876 if (error != 0) {
1877 die("failed to open zip file '%s': %s", filename, ErrorCodeString(error));
1878 }
1879
Andrew Chantd64b9882021-04-06 12:48:27 -07001880 FlashAllTool tool(ZipImageSource(zip), slot_override, skip_secondary, false, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001881 tool.Flash();
1882
1883 CloseArchive(zip);
1884}
1885
1886class LocalImageSource final : public ImageSource {
1887 public:
Tom Cherrydfd85df2018-09-20 14:45:05 -07001888 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001889 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001890};
1891
Tom Cherrydfd85df2018-09-20 14:45:05 -07001892bool LocalImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
David Andersoncf444f32018-08-29 14:15:49 -07001893 auto path = find_item_given_name(name);
1894 if (path.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001895 return false;
David Andersoncf444f32018-08-29 14:15:49 -07001896 }
Tom Cherrydfd85df2018-09-20 14:45:05 -07001897 return ReadFileToVector(path, out);
David Andersoncf444f32018-08-29 14:15:49 -07001898}
1899
Yifan Hongb10d0672021-02-22 15:06:27 -08001900unique_fd LocalImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001901 auto path = find_item_given_name(name);
Yifan Hongb10d0672021-02-22 15:06:27 -08001902 return unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
David Andersoncf444f32018-08-29 14:15:49 -07001903}
1904
Andrew Chantd64b9882021-04-06 12:48:27 -07001905static void do_flashall(const std::string& slot_override, bool skip_secondary, bool wipe,
1906 bool force_flash) {
1907 FlashAllTool tool(LocalImageSource(), slot_override, skip_secondary, wipe, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001908 tool.Flash();
1909}
1910
Elliott Hughesd6365a72017-05-08 18:04:49 -07001911static std::string next_arg(std::vector<std::string>* args) {
1912 if (args->empty()) syntax_error("expected argument");
1913 std::string result = args->front();
1914 args->erase(args->begin());
1915 return result;
Patrick Tjin51e8b032015-09-01 08:15:23 -07001916}
1917
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001918static void do_oem_command(const std::string& cmd, std::vector<std::string>* args) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07001919 if (args->empty()) syntax_error("empty oem command");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08001920
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001921 std::string command(cmd);
Elliott Hughesd6365a72017-05-08 18:04:49 -07001922 while (!args->empty()) {
Elliott Hughes29d5d7d2017-05-11 15:05:13 -07001923 command += " " + next_arg(args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001924 }
Tom Cherry9027af02018-09-24 15:48:09 -07001925 fb->RawCommand(command, "");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001926}
1927
Aaron Wisnerdb511202018-06-26 15:38:35 -05001928static unsigned fb_get_flash_block_size(std::string name) {
Connor O'Brience16a8a2017-02-06 14:39:31 -08001929 std::string sizeString;
Tom Cherry9027af02018-09-24 15:48:09 -07001930 if (fb->GetVar(name, &sizeString) != fastboot::SUCCESS || sizeString.empty()) {
Elliott Hughes5620d222018-03-28 08:20:00 -07001931 // This device does not report flash block sizes, so return 0.
Connor O'Brience16a8a2017-02-06 14:39:31 -08001932 return 0;
1933 }
1934 sizeString = fb_fix_numeric_var(sizeString);
1935
1936 unsigned size;
1937 if (!android::base::ParseUint(sizeString, &size)) {
1938 fprintf(stderr, "Couldn't parse %s '%s'.\n", name.c_str(), sizeString.c_str());
1939 return 0;
1940 }
Connor O'Brien6ef5c242017-11-01 17:37:32 -07001941 if ((size & (size - 1)) != 0) {
1942 fprintf(stderr, "Invalid %s %u: must be a power of 2.\n", name.c_str(), size);
Connor O'Brience16a8a2017-02-06 14:39:31 -08001943 return 0;
1944 }
1945 return size;
1946}
1947
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001948static void fb_perform_format(const std::string& partition, int skip_if_not_supported,
Elliott Hughesd6365a72017-05-08 18:04:49 -07001949 const std::string& type_override, const std::string& size_override,
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001950 const unsigned fs_options) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001951 std::string partition_type, partition_size;
1952
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001953 struct fastboot_buffer buf;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001954 const char* errMsg = nullptr;
1955 const struct fs_generator* gen = nullptr;
Jin Qian4a335822017-04-18 16:23:18 -07001956 TemporaryFile output;
1957 unique_fd fd;
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001958
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001959 unsigned int limit = INT_MAX;
1960 if (target_sparse_limit > 0 && target_sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001961 limit = target_sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001962 }
1963 if (sparse_limit > 0 && sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001964 limit = sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001965 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001966
Tom Cherry9027af02018-09-24 15:48:09 -07001967 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001968 errMsg = "Can't determine partition type.\n";
1969 goto failed;
1970 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001971 if (!type_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001972 if (partition_type != type_override) {
1973 fprintf(stderr, "Warning: %s type is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001974 partition.c_str(), partition_type.c_str(), type_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001975 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001976 partition_type = type_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001977 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001978
Tom Cherry9027af02018-09-24 15:48:09 -07001979 if (fb->GetVar("partition-size:" + partition, &partition_size) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001980 errMsg = "Unable to get partition size\n";
1981 goto failed;
1982 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001983 if (!size_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001984 if (partition_size != size_override) {
1985 fprintf(stderr, "Warning: %s size is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001986 partition.c_str(), partition_size.c_str(), size_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001987 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001988 partition_size = size_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001989 }
Connor O'Brience16a8a2017-02-06 14:39:31 -08001990 partition_size = fb_fix_numeric_var(partition_size);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001991
Elliott Hughes8ab9a322015-11-02 14:05:57 -08001992 gen = fs_get_generator(partition_type);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001993 if (!gen) {
1994 if (skip_if_not_supported) {
1995 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001996 fprintf(stderr, "File system type %s not supported.\n", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001997 return;
1998 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001999 die("Formatting is not supported for file system with type '%s'.", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002000 }
2001
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002002 int64_t size;
Elliott Hughesda46b392016-10-11 17:09:00 -07002003 if (!android::base::ParseInt(partition_size, &size)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002004 die("Couldn't parse partition size '%s'.", partition_size.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002005 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002006
Connor O'Brience16a8a2017-02-06 14:39:31 -08002007 unsigned eraseBlkSize, logicalBlkSize;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002008 eraseBlkSize = fb_get_flash_block_size("erase-block-size");
2009 logicalBlkSize = fb_get_flash_block_size("logical-block-size");
Connor O'Brience16a8a2017-02-06 14:39:31 -08002010
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002011 if (fs_generator_generate(gen, output.path, size, eraseBlkSize, logicalBlkSize, fs_options)) {
Elliott Hughes5620d222018-03-28 08:20:00 -07002012 die("Cannot generate image for %s", partition.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002013 }
2014
Jin Qian4a335822017-04-18 16:23:18 -07002015 fd.reset(open(output.path, O_RDONLY));
2016 if (fd == -1) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002017 die("Cannot open generated image: %s", strerror(errno));
Jin Qian4a335822017-04-18 16:23:18 -07002018 }
Yifan Hongb10d0672021-02-22 15:06:27 -08002019 if (!load_buf_fd(std::move(fd), &buf)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002020 die("Cannot read image: %s", strerror(errno));
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002021 }
2022 flash_buf(partition, &buf);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002023 return;
2024
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002025failed:
2026 if (skip_if_not_supported) {
2027 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002028 if (errMsg) fprintf(stderr, "%s", errMsg);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002029 }
Tom Cherry9027af02018-09-24 15:48:09 -07002030 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
Mark Salyzyna30b6962018-11-20 11:04:15 -08002031 if (!skip_if_not_supported) {
2032 die("Command failed");
2033 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002034}
2035
David Anderson89569642018-11-16 15:53:35 -08002036static bool should_flash_in_userspace(const std::string& partition_name) {
David Andersone0e693c2018-11-27 20:19:26 -08002037 if (!get_android_product_out()) {
2038 return false;
2039 }
David Anderson89569642018-11-16 15:53:35 -08002040 auto path = find_item_given_name("super_empty.img");
David Anderson00475802018-12-04 17:05:47 -08002041 if (path.empty() || access(path.c_str(), R_OK)) {
David Anderson89569642018-11-16 15:53:35 -08002042 return false;
2043 }
2044 auto metadata = android::fs_mgr::ReadFromImageFile(path);
2045 if (!metadata) {
2046 return false;
2047 }
David Andersonaa87dc52023-01-27 20:39:06 -08002048 return should_flash_in_userspace(*metadata.get(), partition_name);
David Anderson89569642018-11-16 15:53:35 -08002049}
2050
David Anderson7c84b9f2019-06-27 22:15:29 -07002051static bool wipe_super(const android::fs_mgr::LpMetadata& metadata, const std::string& slot,
2052 std::string* message) {
2053 auto super_device = GetMetadataSuperBlockDevice(metadata);
2054 auto block_size = metadata.geometry.logical_block_size;
2055 auto super_bdev_name = android::fs_mgr::GetBlockDevicePartitionName(*super_device);
2056
2057 if (super_bdev_name != "super") {
2058 // retrofit devices do not allow flashing to the retrofit partitions,
2059 // so enable it if we can.
2060 fb->RawCommand("oem allow-flash-super");
2061 }
2062
2063 // Note: do not use die() in here, since we want TemporaryDir's destructor
2064 // to be called.
2065 TemporaryDir temp_dir;
2066
2067 bool ok;
2068 if (metadata.block_devices.size() > 1) {
2069 ok = WriteSplitImageFiles(temp_dir.path, metadata, block_size, {}, true);
2070 } else {
2071 auto image_path = temp_dir.path + "/"s + super_bdev_name + ".img";
2072 ok = WriteToImageFile(image_path, metadata, block_size, {}, true);
2073 }
2074 if (!ok) {
2075 *message = "Could not generate a flashable super image file";
2076 return false;
2077 }
2078
2079 for (const auto& block_device : metadata.block_devices) {
2080 auto partition = android::fs_mgr::GetBlockDevicePartitionName(block_device);
2081 bool force_slot = !!(block_device.flags & LP_BLOCK_DEVICE_SLOT_SUFFIXED);
2082
2083 std::string image_name;
2084 if (metadata.block_devices.size() > 1) {
2085 image_name = "super_" + partition + ".img";
2086 } else {
2087 image_name = partition + ".img";
2088 }
2089
2090 auto image_path = temp_dir.path + "/"s + image_name;
2091 auto flash = [&](const std::string& partition_name) {
2092 do_flash(partition_name.c_str(), image_path.c_str());
2093 };
2094 do_for_partitions(partition, slot, flash, force_slot);
2095
2096 unlink(image_path.c_str());
2097 }
2098 return true;
2099}
2100
2101static void do_wipe_super(const std::string& image, const std::string& slot_override) {
2102 if (access(image.c_str(), R_OK) != 0) {
2103 die("Could not read image: %s", image.c_str());
2104 }
2105 auto metadata = android::fs_mgr::ReadFromImageFile(image);
2106 if (!metadata) {
2107 die("Could not parse image: %s", image.c_str());
2108 }
2109
2110 auto slot = slot_override;
2111 if (slot.empty()) {
2112 slot = get_current_slot();
2113 }
2114
2115 std::string message;
2116 if (!wipe_super(*metadata.get(), slot, &message)) {
2117 die(message);
2118 }
2119}
2120
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002121static void FastbootLogger(android::base::LogId /* id */, android::base::LogSeverity severity,
David Andersona67fc322023-01-27 16:15:52 -08002122 const char* /* tag */, const char* /* file */, unsigned int /* line */,
2123 const char* message) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002124 switch (severity) {
2125 case android::base::INFO:
2126 fprintf(stdout, "%s\n", message);
2127 break;
2128 case android::base::ERROR:
2129 fprintf(stderr, "%s\n", message);
2130 break;
2131 default:
2132 verbose("%s\n", message);
2133 }
David Andersona67fc322023-01-27 16:15:52 -08002134}
2135
2136static void FastbootAborter(const char* message) {
2137 die("%s", message);
2138}
2139
Aaron Wisnerdb511202018-06-26 15:38:35 -05002140int FastBootTool::Main(int argc, char* argv[]) {
David Andersona67fc322023-01-27 16:15:52 -08002141 android::base::InitLogging(argv, FastbootLogger, FastbootAborter);
2142
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002143 bool wants_wipe = false;
2144 bool wants_reboot = false;
2145 bool wants_reboot_bootloader = false;
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002146 bool wants_reboot_recovery = false;
2147 bool wants_reboot_fastboot = false;
Mitchell Wills31dce302016-09-26 10:26:21 -07002148 bool skip_reboot = false;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002149 bool wants_set_active = false;
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002150 bool skip_secondary = false;
David Anderson89569642018-11-16 15:53:35 -08002151 bool force_flash = false;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002152 unsigned fs_options = 0;
Florian BƤuerle27ded482014-11-24 11:29:34 +01002153 int longindex;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002154 std::string slot_override;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002155 std::string next_active;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002156
Elliott Hughes577e8b42018-04-05 16:12:47 -07002157 g_boot_img_hdr.kernel_addr = 0x00008000;
2158 g_boot_img_hdr.ramdisk_addr = 0x01000000;
2159 g_boot_img_hdr.second_addr = 0x00f00000;
2160 g_boot_img_hdr.tags_addr = 0x00000100;
2161 g_boot_img_hdr.page_size = 2048;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002162 g_boot_img_hdr.dtb_addr = 0x01100000;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002163
Daniel Zheng65452d02022-11-30 02:25:31 +00002164 const struct option longopts[] = {{"base", required_argument, 0, 0},
2165 {"cmdline", required_argument, 0, 0},
2166 {"disable-verification", no_argument, 0, 0},
2167 {"disable-verity", no_argument, 0, 0},
2168 {"force", no_argument, 0, 0},
2169 {"fs-options", required_argument, 0, 0},
2170 {"header-version", required_argument, 0, 0},
2171 {"help", no_argument, 0, 'h'},
2172 {"kernel-offset", required_argument, 0, 0},
2173 {"os-patch-level", required_argument, 0, 0},
2174 {"os-version", required_argument, 0, 0},
2175 {"page-size", required_argument, 0, 0},
2176 {"ramdisk-offset", required_argument, 0, 0},
2177 {"set-active", optional_argument, 0, 'a'},
2178 {"skip-reboot", no_argument, 0, 0},
2179 {"skip-secondary", no_argument, 0, 0},
2180 {"slot", required_argument, 0, 0},
2181 {"tags-offset", required_argument, 0, 0},
2182 {"dtb", required_argument, 0, 0},
2183 {"dtb-offset", required_argument, 0, 0},
2184 {"unbuffered", no_argument, 0, 0},
2185 {"verbose", no_argument, 0, 'v'},
2186 {"version", no_argument, 0, 0},
2187 {0, 0, 0, 0}};
Colin Cross8879f982012-05-22 17:53:34 -07002188
2189 serial = getenv("ANDROID_SERIAL");
2190
Elliott Hughes577e8b42018-04-05 16:12:47 -07002191 int c;
Elliott Hughesf3192bd2018-04-10 15:38:08 -07002192 while ((c = getopt_long(argc, argv, "a::hls:S:vw", longopts, &longindex)) != -1) {
Elliott Hughes577e8b42018-04-05 16:12:47 -07002193 if (c == 0) {
2194 std::string name{longopts[longindex].name};
2195 if (name == "base") {
2196 g_base_addr = strtoul(optarg, 0, 16);
2197 } else if (name == "cmdline") {
2198 g_cmdline = optarg;
2199 } else if (name == "disable-verification") {
2200 g_disable_verification = true;
2201 } else if (name == "disable-verity") {
2202 g_disable_verity = true;
David Anderson89569642018-11-16 15:53:35 -08002203 } else if (name == "force") {
2204 force_flash = true;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002205 } else if (name == "fs-options") {
2206 fs_options = ParseFsOption(optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002207 } else if (name == "header-version") {
2208 g_boot_img_hdr.header_version = strtoul(optarg, nullptr, 0);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002209 } else if (name == "dtb") {
2210 g_dtb_path = optarg;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002211 } else if (name == "kernel-offset") {
2212 g_boot_img_hdr.kernel_addr = strtoul(optarg, 0, 16);
2213 } else if (name == "os-patch-level") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002214 ParseOsPatchLevel(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002215 } else if (name == "os-version") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002216 ParseOsVersion(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002217 } else if (name == "page-size") {
2218 g_boot_img_hdr.page_size = strtoul(optarg, nullptr, 0);
2219 if (g_boot_img_hdr.page_size == 0) die("invalid page size");
2220 } else if (name == "ramdisk-offset") {
2221 g_boot_img_hdr.ramdisk_addr = strtoul(optarg, 0, 16);
2222 } else if (name == "skip-reboot") {
2223 skip_reboot = true;
2224 } else if (name == "skip-secondary") {
2225 skip_secondary = true;
2226 } else if (name == "slot") {
2227 slot_override = optarg;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002228 } else if (name == "dtb-offset") {
2229 g_boot_img_hdr.dtb_addr = strtoul(optarg, 0, 16);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002230 } else if (name == "tags-offset") {
2231 g_boot_img_hdr.tags_addr = strtoul(optarg, 0, 16);
2232 } else if (name == "unbuffered") {
Elliott Hughesfc797672015-04-07 20:12:50 -07002233 setvbuf(stdout, nullptr, _IONBF, 0);
2234 setvbuf(stderr, nullptr, _IONBF, 0);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002235 } else if (name == "version") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002236 fprintf(stdout, "fastboot version %s-%s\n", PLATFORM_TOOLS_VERSION,
2237 android::build::GetBuildNumber().c_str());
Elliott Hughes1fd46df2017-03-30 15:08:28 -07002238 fprintf(stdout, "Installed as %s\n", android::base::GetExecutablePath().c_str());
Elliott Hughes379646b2015-06-02 13:50:00 -07002239 return 0;
Paul Crowley8f7f56e2015-11-27 09:29:37 +00002240 } else {
Elliott Hughes855cdf82018-04-02 14:24:03 -07002241 die("unknown option %s", longopts[longindex].name);
Florian BƤuerle27ded482014-11-24 11:29:34 +01002242 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002243 } else {
2244 switch (c) {
2245 case 'a':
2246 wants_set_active = true;
2247 if (optarg) next_active = optarg;
2248 break;
2249 case 'h':
2250 return show_help();
Elliott Hughes577e8b42018-04-05 16:12:47 -07002251 case 'l':
2252 g_long_listing = true;
2253 break;
2254 case 's':
2255 serial = optarg;
2256 break;
2257 case 'S':
Elliott Hughes542370d2018-04-19 19:49:44 -07002258 if (!android::base::ParseByteCount(optarg, &sparse_limit)) {
2259 die("invalid sparse limit %s", optarg);
2260 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002261 break;
2262 case 'v':
2263 set_verbose();
2264 break;
2265 case 'w':
2266 wants_wipe = true;
2267 break;
2268 case '?':
2269 return 1;
2270 default:
2271 abort();
2272 }
Colin Cross8879f982012-05-22 17:53:34 -07002273 }
2274 }
2275
2276 argc -= optind;
2277 argv += optind;
2278
Elliott Hughesd6365a72017-05-08 18:04:49 -07002279 if (argc == 0 && !wants_wipe && !wants_set_active) syntax_error("no command");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002280
Colin Cross8fb6e062012-07-24 16:36:41 -07002281 if (argc > 0 && !strcmp(*argv, "devices")) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002282 list_devices();
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08002283 return 0;
2284 }
2285
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002286 if (argc > 0 && !strcmp(*argv, "connect")) {
2287 argc -= optind;
2288 argv += optind;
2289 return Connect(argc, argv);
2290 }
2291
2292 if (argc > 0 && !strcmp(*argv, "disconnect")) {
2293 argc -= optind;
2294 argv += optind;
2295 return Disconnect(argc, argv);
2296 }
2297
Colin Crossc7b75dc2012-08-29 18:17:06 -07002298 if (argc > 0 && !strcmp(*argv, "help")) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002299 return show_help();
Colin Crossc7b75dc2012-08-29 18:17:06 -07002300 }
2301
David Pursell0b156632015-10-30 11:22:01 -07002302 Transport* transport = open_device();
David Pursell2ec418a2016-01-20 08:32:08 -08002303 if (transport == nullptr) {
2304 return 1;
2305 }
Tom Cherry9027af02018-09-24 15:48:09 -07002306 fastboot::DriverCallbacks driver_callbacks = {
Daniel Zheng65452d02022-11-30 02:25:31 +00002307 .prolog = Status,
2308 .epilog = Epilog,
2309 .info = InfoMessage,
Raphael Herouart99097cc2022-12-30 11:51:54 +00002310 .text = TextMessage,
Tom Cherry9027af02018-09-24 15:48:09 -07002311 };
Raphael Herouart99097cc2022-12-30 11:51:54 +00002312
Tom Cherry9027af02018-09-24 15:48:09 -07002313 fastboot::FastBootDriver fastboot_driver(transport, driver_callbacks, false);
2314 fb = &fastboot_driver;
David Pursell2ec418a2016-01-20 08:32:08 -08002315
Elliott Hughes5620d222018-03-28 08:20:00 -07002316 const double start = now();
2317
Aaron Wisnerdb511202018-06-26 15:38:35 -05002318 if (slot_override != "") slot_override = verify_slot(slot_override);
2319 if (next_active != "") next_active = verify_slot(next_active, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002320
2321 if (wants_set_active) {
2322 if (next_active == "") {
2323 if (slot_override == "") {
Daniel Rosenberg13454092016-06-27 19:43:11 -07002324 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07002325 if (fb->GetVar("current-slot", &current_slot) == fastboot::SUCCESS) {
LuK1337dae48ef2020-04-06 14:38:58 +02002326 if (current_slot[0] == '_') current_slot.erase(0, 1);
Aaron Wisnerdb511202018-06-26 15:38:35 -05002327 next_active = verify_slot(current_slot, false);
Daniel Rosenberg13454092016-06-27 19:43:11 -07002328 } else {
2329 wants_set_active = false;
2330 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002331 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002332 next_active = verify_slot(slot_override, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002333 }
2334 }
2335 }
Elliott Hughes31dbed72009-10-07 15:38:53 -07002336
Elliott Hughesd6365a72017-05-08 18:04:49 -07002337 std::vector<std::string> args(argv, argv + argc);
2338 while (!args.empty()) {
2339 std::string command = next_arg(&args);
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002340
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002341 if (command == FB_CMD_GETVAR) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002342 std::string variable = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002343 DisplayVarOrError(variable, variable);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002344 } else if (command == FB_CMD_ERASE) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002345 std::string partition = next_arg(&args);
2346 auto erase = [&](const std::string& partition) {
David Pursell0b156632015-10-30 11:22:01 -07002347 std::string partition_type;
Daniel Zheng65452d02022-11-30 02:25:31 +00002348 if (fb->GetVar("partition-type:" + partition, &partition_type) ==
2349 fastboot::SUCCESS &&
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002350 fs_get_generator(partition_type) != nullptr) {
2351 fprintf(stderr, "******** Did you mean to fastboot format this %s partition?\n",
2352 partition_type.c_str());
2353 }
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002354
Tom Cherry9027af02018-09-24 15:48:09 -07002355 fb->Erase(partition);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002356 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002357 do_for_partitions(partition, slot_override, erase, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002358 } else if (android::base::StartsWith(command, "format")) {
2359 // Parsing for: "format[:[type][:[size]]]"
2360 // Some valid things:
2361 // - select only the size, and leave default fs type:
2362 // format::0x4000000 userdata
2363 // - default fs type and size:
2364 // format userdata
2365 // format:: userdata
2366 std::vector<std::string> pieces = android::base::Split(command, ":");
2367 std::string type_override;
2368 if (pieces.size() > 1) type_override = pieces[1].c_str();
2369 std::string size_override;
2370 if (pieces.size() > 2) size_override = pieces[2].c_str();
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002371
Elliott Hughesd6365a72017-05-08 18:04:49 -07002372 std::string partition = next_arg(&args);
2373
2374 auto format = [&](const std::string& partition) {
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002375 fb_perform_format(partition, 0, type_override, size_override, fs_options);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002376 };
Greg Kaiserb49d9e12019-03-26 12:04:05 -07002377 do_for_partitions(partition, slot_override, format, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002378 } else if (command == "signature") {
2379 std::string filename = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002380 std::vector<char> data;
2381 if (!ReadFileToVector(filename, &data)) {
2382 die("could not load '%s': %s", filename.c_str(), strerror(errno));
2383 }
2384 if (data.size() != 256) die("signature must be 256 bytes (got %zu)", data.size());
Tom Cherry9027af02018-09-24 15:48:09 -07002385 fb->Download("signature", data);
2386 fb->RawCommand("signature", "installing signature");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002387 } else if (command == FB_CMD_REBOOT) {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002388 wants_reboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002389
2390 if (args.size() == 1) {
2391 std::string what = next_arg(&args);
2392 if (what == "bootloader") {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002393 wants_reboot = false;
2394 wants_reboot_bootloader = true;
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002395 } else if (what == "recovery") {
2396 wants_reboot = false;
2397 wants_reboot_recovery = true;
2398 } else if (what == "fastboot") {
2399 wants_reboot = false;
2400 wants_reboot_fastboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002401 } else {
2402 syntax_error("unknown reboot target %s", what.c_str());
Alexey Polyudove0bfb752017-01-03 19:39:13 -08002403 }
Elliott Hughesca85df02015-02-25 10:02:00 -08002404 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002405 if (!args.empty()) syntax_error("junk after reboot command");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002406 } else if (command == FB_CMD_REBOOT_BOOTLOADER) {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002407 wants_reboot_bootloader = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002408 } else if (command == FB_CMD_REBOOT_RECOVERY) {
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002409 wants_reboot_recovery = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002410 } else if (command == FB_CMD_REBOOT_FASTBOOT) {
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002411 wants_reboot_fastboot = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002412 } else if (command == FB_CMD_CONTINUE) {
Tom Cherry9027af02018-09-24 15:48:09 -07002413 fb->Continue();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002414 } else if (command == FB_CMD_BOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002415 std::string kernel = next_arg(&args);
2416 std::string ramdisk;
2417 if (!args.empty()) ramdisk = next_arg(&args);
2418 std::string second_stage;
2419 if (!args.empty()) second_stage = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002420 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
Tom Cherry9027af02018-09-24 15:48:09 -07002421 fb->Download("boot.img", data);
2422 fb->Boot();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002423 } else if (command == FB_CMD_FLASH) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002424 std::string pname = next_arg(&args);
2425
Elliott Hughes2810d002016-04-25 14:31:18 -07002426 std::string fname;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002427 if (!args.empty()) {
2428 fname = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002429 } else {
Elliott Hughes45964a82017-05-03 22:43:23 -07002430 fname = find_item(pname);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002431 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002432 if (fname.empty()) die("cannot determine image filename for '%s'", pname.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002433
Daniel Zheng65452d02022-11-30 02:25:31 +00002434 auto flash = [&](const std::string& partition) {
David Anderson89569642018-11-16 15:53:35 -08002435 if (should_flash_in_userspace(partition) && !is_userspace_fastboot() &&
2436 !force_flash) {
2437 die("The partition you are trying to flash is dynamic, and "
2438 "should be flashed via fastbootd. Please run:\n"
2439 "\n"
2440 " fastboot reboot fastboot\n"
2441 "\n"
2442 "And try again. If you are intentionally trying to "
2443 "overwrite a fixed partition, use --force.");
2444 }
Aaron Wisnerdb511202018-06-26 15:38:35 -05002445 do_flash(partition.c_str(), fname.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002446 };
Greg Kaiserb49d9e12019-03-26 12:04:05 -07002447 do_for_partitions(pname, slot_override, flash, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002448 } else if (command == "flash:raw") {
2449 std::string partition = next_arg(&args);
2450 std::string kernel = next_arg(&args);
2451 std::string ramdisk;
2452 if (!args.empty()) ramdisk = next_arg(&args);
2453 std::string second_stage;
2454 if (!args.empty()) second_stage = next_arg(&args);
2455
Tom Cherrydfd85df2018-09-20 14:45:05 -07002456 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2457 auto flashraw = [&data](const std::string& partition) {
Tom Cherry9027af02018-09-24 15:48:09 -07002458 fb->FlashPartition(partition, data);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002459 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002460 do_for_partitions(partition, slot_override, flashraw, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002461 } else if (command == "flashall") {
Alex Lightbb9b8a52016-06-29 09:26:44 -07002462 if (slot_override == "all") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002463 fprintf(stderr,
2464 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Andrew Chantd64b9882021-04-06 12:48:27 -07002465 do_flashall(slot_override, true, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002466 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -07002467 do_flashall(slot_override, skip_secondary, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002468 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002469 wants_reboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002470 } else if (command == "update") {
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002471 bool slot_all = (slot_override == "all");
2472 if (slot_all) {
Daniel Zheng65452d02022-11-30 02:25:31 +00002473 fprintf(stderr,
2474 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002475 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002476 std::string filename = "update.zip";
2477 if (!args.empty()) {
2478 filename = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002479 }
Andrew Chantd64b9882021-04-06 12:48:27 -07002480 do_update(filename.c_str(), slot_override, skip_secondary || slot_all, force_flash);
Mitchell Wills31dce302016-09-26 10:26:21 -07002481 wants_reboot = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002482 } else if (command == FB_CMD_SET_ACTIVE) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002483 std::string slot = verify_slot(next_arg(&args), false);
Tom Cherry9027af02018-09-24 15:48:09 -07002484 fb->SetActive(slot);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002485 } else if (command == "stage") {
2486 std::string filename = next_arg(&args);
2487
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002488 struct fastboot_buffer buf;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002489 if (!load_buf(filename.c_str(), &buf) || buf.type != FB_BUFFER_FD) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002490 die("cannot load '%s'", filename.c_str());
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002491 }
Yifan Hong58532df2021-03-22 16:39:13 -07002492 fb->Download(filename, buf.fd.get(), buf.sz);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002493 } else if (command == "get_staged") {
2494 std::string filename = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002495 fb->Upload(filename);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002496 } else if (command == FB_CMD_OEM) {
2497 do_oem_command(FB_CMD_OEM, &args);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002498 } else if (command == "flashing") {
2499 if (args.empty()) {
2500 syntax_error("missing 'flashing' command");
Daniel Zheng65452d02022-11-30 02:25:31 +00002501 } else if (args.size() == 1 &&
2502 (args[0] == "unlock" || args[0] == "lock" || args[0] == "unlock_critical" ||
2503 args[0] == "lock_critical" || args[0] == "get_unlock_ability")) {
Elliott Hughes1eec97a2017-05-15 16:53:53 -07002504 do_oem_command("flashing", &args);
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002505 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002506 syntax_error("unknown 'flashing' command %s", args[0].c_str());
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002507 }
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002508 } else if (command == FB_CMD_CREATE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002509 std::string partition = next_arg(&args);
2510 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002511 fb->CreatePartition(partition, size);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002512 } else if (command == FB_CMD_DELETE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002513 std::string partition = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002514 fb->DeletePartition(partition);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002515 } else if (command == FB_CMD_RESIZE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002516 std::string partition = next_arg(&args);
2517 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002518 fb->ResizePartition(partition, size);
David Anderson1d504e32019-01-15 14:38:20 -08002519 } else if (command == "gsi") {
David Anderson3d782d52019-01-29 13:09:49 -08002520 std::string arg = next_arg(&args);
2521 if (arg == "wipe") {
David Anderson1d504e32019-01-15 14:38:20 -08002522 fb->RawCommand("gsi:wipe", "wiping GSI");
David Anderson3d782d52019-01-29 13:09:49 -08002523 } else if (arg == "disable") {
David Anderson1d504e32019-01-15 14:38:20 -08002524 fb->RawCommand("gsi:disable", "disabling GSI");
2525 } else {
2526 syntax_error("expected 'wipe' or 'disable'");
2527 }
David Anderson7c84b9f2019-06-27 22:15:29 -07002528 } else if (command == "wipe-super") {
2529 std::string image;
2530 if (args.empty()) {
2531 image = find_item_given_name("super_empty.img");
2532 } else {
2533 image = next_arg(&args);
2534 }
2535 do_wipe_super(image, slot_override);
David Andersonab8f4662019-10-21 16:45:59 -07002536 } else if (command == "snapshot-update") {
2537 std::string arg;
2538 if (!args.empty()) {
2539 arg = next_arg(&args);
2540 }
David Anderson220ddb12019-10-31 18:02:41 -07002541 if (!arg.empty() && (arg != "cancel" && arg != "merge")) {
2542 syntax_error("expected: snapshot-update [cancel|merge]");
David Andersonab8f4662019-10-21 16:45:59 -07002543 }
2544 fb->SnapshotUpdateCommand(arg);
Yifan Hongbcd27702021-02-16 19:37:32 -08002545 } else if (command == FB_CMD_FETCH) {
2546 std::string partition = next_arg(&args);
2547 std::string outfile = next_arg(&args);
2548 do_fetch(partition, slot_override, outfile);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002549 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002550 syntax_error("unknown command %s", command.c_str());
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002551 }
2552 }
2553
2554 if (wants_wipe) {
David Andersonab8f4662019-10-21 16:45:59 -07002555 if (force_flash) {
2556 CancelSnapshotIfNeeded();
2557 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002558 std::vector<std::string> partitions = {"userdata", "cache", "metadata"};
Paul Crowley4d170062018-04-24 17:06:30 -07002559 for (const auto& partition : partitions) {
2560 std::string partition_type;
Tom Cherry9027af02018-09-24 15:48:09 -07002561 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
2562 continue;
2563 }
Paul Crowley4d170062018-04-24 17:06:30 -07002564 if (partition_type.empty()) continue;
Tom Cherry9027af02018-09-24 15:48:09 -07002565 fb->Erase(partition);
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002566 fb_perform_format(partition, 1, partition_type, "", fs_options);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002567 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002568 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002569 if (wants_set_active) {
Tom Cherry9027af02018-09-24 15:48:09 -07002570 fb->SetActive(next_active);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002571 }
Mitchell Wills31dce302016-09-26 10:26:21 -07002572 if (wants_reboot && !skip_reboot) {
Tom Cherry9027af02018-09-24 15:48:09 -07002573 fb->Reboot();
2574 fb->WaitForDisconnect();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002575 } else if (wants_reboot_bootloader) {
Tom Cherry9027af02018-09-24 15:48:09 -07002576 fb->RebootTo("bootloader");
2577 fb->WaitForDisconnect();
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002578 } else if (wants_reboot_recovery) {
Tom Cherry9027af02018-09-24 15:48:09 -07002579 fb->RebootTo("recovery");
2580 fb->WaitForDisconnect();
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002581 } else if (wants_reboot_fastboot) {
David Anderson11d6d272018-12-07 16:39:07 -08002582 reboot_to_userspace_fastboot();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002583 }
2584
Elliott Hughes5620d222018-03-28 08:20:00 -07002585 fprintf(stderr, "Finished. Total time: %.3fs\n", (now() - start));
David Anderson03de6452018-09-04 14:32:54 -07002586
Tom Cherry9027af02018-09-24 15:48:09 -07002587 auto* old_transport = fb->set_transport(nullptr);
2588 delete old_transport;
2589
Tom Cherry11f12092018-08-29 21:36:28 -07002590 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002591}
Elliott Hughes6ebec932018-04-10 14:22:13 -07002592
Aaron Wisnerdb511202018-06-26 15:38:35 -05002593void FastBootTool::ParseOsPatchLevel(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002594 unsigned year, month, day;
2595 if (sscanf(arg, "%u-%u-%u", &year, &month, &day) != 3) {
2596 syntax_error("OS patch level should be YYYY-MM-DD: %s", arg);
2597 }
2598 if (year < 2000 || year >= 2128) syntax_error("year out of range: %d", year);
2599 if (month < 1 || month > 12) syntax_error("month out of range: %d", month);
2600 hdr->SetOsPatchLevel(year, month);
2601}
2602
Aaron Wisnerdb511202018-06-26 15:38:35 -05002603void FastBootTool::ParseOsVersion(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002604 unsigned major = 0, minor = 0, patch = 0;
2605 std::vector<std::string> versions = android::base::Split(arg, ".");
2606 if (versions.size() < 1 || versions.size() > 3 ||
2607 (versions.size() >= 1 && !android::base::ParseUint(versions[0], &major)) ||
2608 (versions.size() >= 2 && !android::base::ParseUint(versions[1], &minor)) ||
2609 (versions.size() == 3 && !android::base::ParseUint(versions[2], &patch)) ||
2610 (major > 0x7f || minor > 0x7f || patch > 0x7f)) {
2611 syntax_error("bad OS version: %s", arg);
2612 }
2613 hdr->SetOsVersion(major, minor, patch);
2614}
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002615
2616unsigned FastBootTool::ParseFsOption(const char* arg) {
2617 unsigned fsOptions = 0;
2618
2619 std::vector<std::string> options = android::base::Split(arg, ",");
Daniel Zheng65452d02022-11-30 02:25:31 +00002620 if (options.size() < 1) syntax_error("bad options: %s", arg);
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002621
2622 for (size_t i = 0; i < options.size(); ++i) {
2623 if (options[i] == "casefold")
2624 fsOptions |= (1 << FS_OPT_CASEFOLD);
2625 else if (options[i] == "projid")
2626 fsOptions |= (1 << FS_OPT_PROJID);
2627 else if (options[i] == "compress")
2628 fsOptions |= (1 << FS_OPT_COMPRESS);
2629 else
2630 syntax_error("unsupported options: %s", options[i].c_str());
2631 }
2632 return fsOptions;
2633}