blob: 5dac3f5fffe06d0a54479a1c0bd48dc2d9d52bf8 [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 Zheng0d307182023-01-31 21:07:53 +000047#include <fstream>
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -070048#include <functional>
Daniel Zheng0d307182023-01-31 21:07:53 +000049#include <iostream>
50#include <memory>
Tom Cherry4aa60b32018-09-05 15:11:44 -070051#include <regex>
Daniel Zheng0d307182023-01-31 21:07:53 +000052#include <sstream>
David Anderson0c732342018-11-28 17:10:42 -080053#include <string>
Elliott Hughes290a2282016-11-14 17:08:47 -080054#include <thread>
Josh Gao9da9ac52016-01-19 14:50:18 -080055#include <utility>
56#include <vector>
Colin Crossf8387882012-05-24 17:18:41 -070057
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +080058#include <android-base/endian.h>
Elliott Hughes82ff3152016-08-31 15:07:18 -070059#include <android-base/file.h>
David Andersona67fc322023-01-27 16:15:52 -080060#include <android-base/logging.h>
Elliott Hughes749ae2d2016-06-28 14:48:45 -070061#include <android-base/macros.h>
Elliott Hughes4f713192015-12-04 22:00:26 -080062#include <android-base/parseint.h>
David Pursell2ec418a2016-01-20 08:32:08 -080063#include <android-base/parsenetaddress.h>
Elliott Hughes2810d002016-04-25 14:31:18 -070064#include <android-base/stringprintf.h>
Elliott Hughes4f713192015-12-04 22:00:26 -080065#include <android-base/strings.h>
Chris Fries0ea946c2017-04-12 10:25:57 -050066#include <android-base/unique_fd.h>
Dan Willemsenab971b52018-08-29 14:58:02 -070067#include <build/version.h>
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +080068#include <libavb/libavb.h>
David Anderson89569642018-11-16 15:53:35 -080069#include <liblp/liblp.h>
David Anderson667b1ef2023-01-27 21:11:11 -080070#include <liblp/super_layout_builder.h>
Dan Willemsenab971b52018-08-29 14:58:02 -070071#include <platform_tools_version.h>
Colin Crossf8387882012-05-24 17:18:41 -070072#include <sparse/sparse.h>
Elliott Hughesd30ad8a2015-03-18 23:12:44 -070073#include <ziparchive/zip_archive.h>
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080074
Elliott Hughes253c18d2015-03-18 22:47:09 -070075#include "bootimg_utils.h"
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -070076#include "constants.h"
Elliott Hughes1b708d32015-12-11 19:07:01 -080077#include "diagnose_usb.h"
Tom Cherry9027af02018-09-24 15:48:09 -070078#include "fastboot_driver.h"
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -070079#include "fs.h"
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +000080#include "storage.h"
David Anderson667b1ef2023-01-27 21:11:11 -080081#include "super_flash_helper.h"
Daniel Zheng1a01a1c2023-01-30 23:29:50 +000082#include "task.h"
David Pursell2ec418a2016-01-20 08:32:08 -080083#include "tcp.h"
David Pursell0b156632015-10-30 11:22:01 -070084#include "transport.h"
David Pursell4601c972016-02-05 15:35:09 -080085#include "udp.h"
David Pursell0b156632015-10-30 11:22:01 -070086#include "usb.h"
Tom Cherry9027af02018-09-24 15:48:09 -070087#include "util.h"
Yifan Honge71fe242021-02-22 15:00:15 -080088#include "vendor_boot_img_utils.h"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080089
Yifan Hongbcd27702021-02-16 19:37:32 -080090using android::base::borrowed_fd;
Tom Cherrydfd85df2018-09-20 14:45:05 -070091using android::base::ReadFully;
Tom Cherry4aa60b32018-09-05 15:11:44 -070092using android::base::Split;
93using android::base::Trim;
Chris Fries0ea946c2017-04-12 10:25:57 -050094using android::base::unique_fd;
David Anderson0c732342018-11-28 17:10:42 -080095using namespace std::string_literals;
Yifan Hongbcd27702021-02-16 19:37:32 -080096using namespace std::placeholders;
Chris Fries0ea946c2017-04-12 10:25:57 -050097
David Pursell2ec418a2016-01-20 08:32:08 -080098static const char* serial = nullptr;
Elliott Hughes577e8b42018-04-05 16:12:47 -070099
Elliott Hughes577e8b42018-04-05 16:12:47 -0700100static bool g_long_listing = false;
Chris Fries6a999712017-04-04 09:52:47 -0500101// Don't resparse files in too-big chunks.
102// libsparse will support INT_MAX, but this results in large allocations, so
103// let's keep it at 1GB to avoid memory pressure on the host.
104static constexpr int64_t RESPARSE_LIMIT = 1 * 1024 * 1024 * 1024;
Elliott Hughes542370d2018-04-19 19:49:44 -0700105static uint64_t sparse_limit = 0;
Colin Crossf8387882012-05-24 17:18:41 -0700106static int64_t target_sparse_limit = -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800107
Elliott Hughes577e8b42018-04-05 16:12:47 -0700108static unsigned g_base_addr = 0x10000000;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800109static boot_img_hdr_v2 g_boot_img_hdr = {};
Elliott Hughes577e8b42018-04-05 16:12:47 -0700110static std::string g_cmdline;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800111static std::string g_dtb_path;
JP Abgrall7b8970c2013-03-07 17:06:41 -0800112
David Zeuthenb6ea4352017-08-07 14:29:26 -0400113static bool g_disable_verity = false;
114static bool g_disable_verification = false;
115
Tom Cherry9027af02018-09-24 15:48:09 -0700116fastboot::FastBootDriver* fb = nullptr;
117
Rom Lemarchand622810c2013-06-28 09:54:59 -0700118enum fb_buffer_type {
Chris Fries0ea946c2017-04-12 10:25:57 -0500119 FB_BUFFER_FD,
Rom Lemarchand622810c2013-06-28 09:54:59 -0700120 FB_BUFFER_SPARSE,
121};
122
123struct fastboot_buffer {
124 enum fb_buffer_type type;
David Andersona1c983e2023-01-27 11:57:27 -0800125 std::vector<SparsePtr> files;
Elliott Hughesfc797672015-04-07 20:12:50 -0700126 int64_t sz;
Yifan Hongb10d0672021-02-22 15:06:27 -0800127 unique_fd fd;
David Anderson32e376f2018-08-16 13:43:11 -0700128 int64_t image_size;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700129};
130
David Anderson0debda02018-08-28 13:54:03 -0700131enum class ImageType {
132 // Must be flashed for device to boot into the kernel.
133 BootCritical,
134 // Normal partition to be flashed during "flashall".
135 Normal,
136 // Partition that is never flashed during "flashall".
137 Extra
138};
139
David Anderson32e376f2018-08-16 13:43:11 -0700140struct Image {
Daniel Zheng65452d02022-11-30 02:25:31 +0000141 std::string nickname;
142 std::string img_name;
143 std::string sig_name;
144 std::string part_name;
Hridya Valsarajuf1f0a9c2018-08-02 10:46:21 -0700145 bool optional_if_no_image;
David Anderson0debda02018-08-28 13:54:03 -0700146 ImageType type;
Daniel Zheng65452d02022-11-30 02:25:31 +0000147 bool IsSecondary() const { return nickname.empty(); }
David Anderson32e376f2018-08-16 13:43:11 -0700148};
149
Daniel Zheng65452d02022-11-30 02:25:31 +0000150static std::vector<Image> images = {
Dario Frenic7ea1af2018-05-25 16:07:19 +0100151 // clang-format off
David Anderson0debda02018-08-28 13:54:03 -0700152 { "boot", "boot.img", "boot.sig", "boot", false, ImageType::BootCritical },
Devin Mooredd1eb872022-01-05 00:20:15 +0000153 { "init_boot",
154 "init_boot.img", "init_boot.sig",
155 "init_boot",
Devin Moore60bd33f2022-01-11 02:01:26 +0000156 true, ImageType::BootCritical },
Daniel Zheng65452d02022-11-30 02:25:31 +0000157 { "", "boot_other.img", "boot.sig", "boot", true, ImageType::Normal },
David Anderson0debda02018-08-28 13:54:03 -0700158 { "cache", "cache.img", "cache.sig", "cache", true, ImageType::Extra },
159 { "dtbo", "dtbo.img", "dtbo.sig", "dtbo", true, ImageType::BootCritical },
160 { "dts", "dt.img", "dt.sig", "dts", true, ImageType::BootCritical },
161 { "odm", "odm.img", "odm.sig", "odm", true, ImageType::Normal },
Yifan Hongbe78bb62020-07-15 17:07:11 -0700162 { "odm_dlkm", "odm_dlkm.img", "odm_dlkm.sig", "odm_dlkm", true, ImageType::Normal },
David Anderson0debda02018-08-28 13:54:03 -0700163 { "product", "product.img", "product.sig", "product", true, ImageType::Normal },
Andrew Scullbe823d72021-01-15 14:37:15 +0000164 { "pvmfw", "pvmfw.img", "pvmfw.sig", "pvmfw", true, ImageType::BootCritical },
David Anderson0debda02018-08-28 13:54:03 -0700165 { "recovery", "recovery.img", "recovery.sig", "recovery", true, ImageType::BootCritical },
166 { "super", "super.img", "super.sig", "super", true, ImageType::Extra },
167 { "system", "system.img", "system.sig", "system", false, ImageType::Normal },
Ramji Jiyanib3ddb532021-12-06 02:28:28 +0000168 { "system_dlkm",
169 "system_dlkm.img", "system_dlkm.sig",
170 "system_dlkm",
171 true, ImageType::Normal },
Justin Yun5d0ac622019-06-26 09:18:03 +0900172 { "system_ext",
173 "system_ext.img", "system_ext.sig",
174 "system_ext",
175 true, ImageType::Normal },
Daniel Zheng65452d02022-11-30 02:25:31 +0000176 { "", "system_other.img", "system.sig", "system", true, ImageType::Normal },
David Anderson0debda02018-08-28 13:54:03 -0700177 { "userdata", "userdata.img", "userdata.sig", "userdata", true, ImageType::Extra },
178 { "vbmeta", "vbmeta.img", "vbmeta.sig", "vbmeta", true, ImageType::BootCritical },
David Anderson166bfef2018-10-15 14:46:59 -0700179 { "vbmeta_system",
180 "vbmeta_system.img",
181 "vbmeta_system.sig",
182 "vbmeta_system",
David Anderson1109c922018-09-17 17:32:54 -0700183 true, ImageType::BootCritical },
Bowgo Tsaia48a7832021-06-03 14:39:34 +0800184 { "vbmeta_vendor",
185 "vbmeta_vendor.img",
186 "vbmeta_vendor.sig",
187 "vbmeta_vendor",
188 true, ImageType::BootCritical },
David Anderson0debda02018-08-28 13:54:03 -0700189 { "vendor", "vendor.img", "vendor.sig", "vendor", true, ImageType::Normal },
Steve Muckle36112432019-08-21 11:16:14 -0700190 { "vendor_boot",
191 "vendor_boot.img", "vendor_boot.sig",
192 "vendor_boot",
193 true, ImageType::BootCritical },
Yifan Hong6b1c15c2020-05-12 10:38:53 -0700194 { "vendor_dlkm",
195 "vendor_dlkm.img", "vendor_dlkm.sig",
196 "vendor_dlkm",
197 true, ImageType::Normal },
Lucas Weif0fb5dd2022-03-28 21:57:58 +0800198 { "vendor_kernel_boot",
199 "vendor_kernel_boot.img",
200 "vendor_kernel_boot.sig",
201 "vendor_kernel_boot",
202 true, ImageType::BootCritical },
Daniel Zheng65452d02022-11-30 02:25:31 +0000203 { "", "vendor_other.img", "vendor.sig", "vendor", true, ImageType::Normal },
Dario Frenic7ea1af2018-05-25 16:07:19 +0100204 // clang-format on
Rom Lemarchand622810c2013-06-28 09:54:59 -0700205};
Brian Swetland2a63bb72009-04-28 16:05:07 -0700206
David Andersone0e693c2018-11-27 20:19:26 -0800207static char* get_android_product_out() {
Elliott Hughes45964a82017-05-03 22:43:23 -0700208 char* dir = getenv("ANDROID_PRODUCT_OUT");
Alex Lightbb9b8a52016-06-29 09:26:44 -0700209 if (dir == nullptr || dir[0] == '\0') {
David Andersone0e693c2018-11-27 20:19:26 -0800210 return nullptr;
211 }
212 return dir;
213}
214
215static std::string find_item_given_name(const std::string& img_name) {
216 char* dir = get_android_product_out();
217 if (!dir) {
Elliott Hughes45964a82017-05-03 22:43:23 -0700218 die("ANDROID_PRODUCT_OUT not set");
Alex Lightbb9b8a52016-06-29 09:26:44 -0700219 }
David Anderson0debda02018-08-28 13:54:03 -0700220 return std::string(dir) + "/" + img_name;
Alex Lightbb9b8a52016-06-29 09:26:44 -0700221}
222
Daniel Zheng0d307182023-01-31 21:07:53 +0000223std::string find_item(const std::string& item) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000224 for (size_t i = 0; i < images.size(); ++i) {
225 if (!images[i].nickname.empty() && item == images[i].nickname) {
Elliott Hughes45964a82017-05-03 22:43:23 -0700226 return find_item_given_name(images[i].img_name);
227 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800228 }
229
Elliott Hughesd6365a72017-05-08 18:04:49 -0700230 fprintf(stderr, "unknown partition '%s'\n", item.c_str());
Elliott Hughes45964a82017-05-03 22:43:23 -0700231 return "";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800232}
233
Tom Cherry9027af02018-09-24 15:48:09 -0700234double last_start_time;
235
236static void Status(const std::string& message) {
Tom Cherry2217c502020-06-10 09:29:25 -0700237 if (!message.empty()) {
238 static constexpr char kStatusFormat[] = "%-50s ";
239 fprintf(stderr, kStatusFormat, message.c_str());
240 }
Tom Cherry9027af02018-09-24 15:48:09 -0700241 last_start_time = now();
242}
243
244static void Epilog(int status) {
245 if (status) {
246 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
247 die("Command failed");
248 } else {
249 double split = now();
250 fprintf(stderr, "OKAY [%7.3fs]\n", (split - last_start_time));
251 }
252}
253
254static void InfoMessage(const std::string& info) {
255 fprintf(stderr, "(bootloader) %s\n", info.c_str());
256}
257
Raphael Herouart99097cc2022-12-30 11:51:54 +0000258static void TextMessage(const std::string& text) {
259 fprintf(stderr, "%s", text.c_str());
260}
261
Tom Cherrydfd85df2018-09-20 14:45:05 -0700262bool ReadFileToVector(const std::string& file, std::vector<char>* out) {
263 out->clear();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800264
Tom Cherrydfd85df2018-09-20 14:45:05 -0700265 unique_fd fd(TEMP_FAILURE_RETRY(open(file.c_str(), O_RDONLY | O_CLOEXEC | O_BINARY)));
266 if (fd == -1) {
267 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700268 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800269
Tom Cherrydfd85df2018-09-20 14:45:05 -0700270 out->resize(get_file_size(fd));
271 return ReadFully(fd, out->data(), out->size());
Rom Lemarchand622810c2013-06-28 09:54:59 -0700272}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800273
Elliott Hughesfc797672015-04-07 20:12:50 -0700274static int match_fastboot_with_serial(usb_ifc_info* info, const char* local_serial) {
Elliott Hughese1746fd2015-08-10 15:30:54 -0700275 if (info->ifc_class != 0xff || info->ifc_subclass != 0x42 || info->ifc_protocol != 0x03) {
276 return -1;
277 }
278
Scott Anderson13081c62012-04-06 12:39:30 -0700279 // require matching serial number or device path if requested
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800280 // at the command line with the -s option.
JP Abgralla032ded2012-06-06 11:53:33 -0700281 if (local_serial && (strcmp(local_serial, info->serial_number) != 0 &&
Daniel Zheng65452d02022-11-30 02:25:31 +0000282 strcmp(local_serial, info->device_path) != 0))
283 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800284 return 0;
285}
286
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000287static ifc_match_func match_fastboot(const char* local_serial = serial) {
288 return [local_serial](usb_ifc_info* info) -> int {
289 return match_fastboot_with_serial(info, local_serial);
290 };
291}
292
293// output compatible with "adb devices"
294static void PrintDevice(const char* local_serial, const char* status = nullptr,
295 const char* details = nullptr) {
296 if (local_serial == nullptr || strlen(local_serial) == 0) {
297 return;
298 }
299
300 if (g_long_listing) {
301 printf("%-22s", local_serial);
302 } else {
303 printf("%s\t", local_serial);
304 }
305
306 if (status != nullptr && strlen(status) > 0) {
307 printf(" %s", status);
308 }
309
310 if (g_long_listing) {
311 if (details != nullptr && strlen(details) > 0) {
312 printf(" %s", details);
313 }
314 }
315
316 putchar('\n');
JP Abgrall7b8970c2013-03-07 17:06:41 -0800317}
318
Elliott Hughesfc797672015-04-07 20:12:50 -0700319static int list_devices_callback(usb_ifc_info* info) {
320 if (match_fastboot_with_serial(info, nullptr) == 0) {
Elliott Hughes1b708d32015-12-11 19:07:01 -0800321 std::string serial = info->serial_number;
David Anderson4e058ca2020-05-28 04:39:37 +0000322 std::string interface = info->interface;
323 if (interface.empty()) {
324 interface = "fastboot";
325 }
Elliott Hughesb4add9b2009-10-06 18:07:49 -0700326 if (!info->writable) {
Elliott Hughes1b708d32015-12-11 19:07:01 -0800327 serial = UsbNoPermissionsShortHelpText();
Elliott Hughesb4add9b2009-10-06 18:07:49 -0700328 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800329 if (!serial[0]) {
330 serial = "????????????";
331 }
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000332
333 PrintDevice(serial.c_str(), interface.c_str(), info->device_path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800334 }
335
336 return -1;
337}
338
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000339struct NetworkSerial {
340 Socket::Protocol protocol;
341 std::string address;
342 int port;
343};
344
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000345class ParseNetworkAddressError {
346 public:
347 enum Type { WRONG_PREFIX = 1, WRONG_ADDRESS = 2 };
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000348
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000349 ParseNetworkAddressError(Type&& type) : type_(std::forward<Type>(type)) {}
350
351 Type value() const { return type_; }
352 operator Type() const { return value(); }
353 std::string print() const { return ""; }
354
355 private:
356 Type type_;
357};
358
359static Result<NetworkSerial, ParseNetworkAddressError> ParseNetworkSerial(
360 const std::string& serial) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000361 Socket::Protocol protocol;
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000362 const char* net_address = nullptr;
363 int port = 0;
364
365 if (android::base::StartsWith(serial, "tcp:")) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000366 protocol = Socket::Protocol::kTcp;
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000367 net_address = serial.c_str() + strlen("tcp:");
368 port = tcp::kDefaultPort;
369 } else if (android::base::StartsWith(serial, "udp:")) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000370 protocol = Socket::Protocol::kUdp;
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000371 net_address = serial.c_str() + strlen("udp:");
372 port = udp::kDefaultPort;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000373 } else {
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000374 return Error<ParseNetworkAddressError>(ParseNetworkAddressError::Type::WRONG_PREFIX)
375 << "protocol prefix ('tcp:' or 'udp:') is missed: " << serial << ". "
376 << "Expected address format:\n"
377 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000378 }
379
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000380 std::string error;
381 std::string host;
382 if (!android::base::ParseNetAddress(net_address, &host, &port, nullptr, &error)) {
383 return Error<ParseNetworkAddressError>(ParseNetworkAddressError::Type::WRONG_ADDRESS)
384 << "invalid network address '" << net_address << "': " << error;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000385 }
386
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000387 return NetworkSerial{protocol, host, port};
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000388}
389
390// Opens a new Transport connected to the particular device.
391// arguments:
David Pursell2ec418a2016-01-20 08:32:08 -0800392//
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000393// local_serial - device to connect (can be a network or usb serial name)
394// wait_for_device - flag indicates whether we need to wait for device
395// announce - flag indicates whether we need to print error to stdout in case
396// we cannot connect to the device
David Pursell2ec418a2016-01-20 08:32:08 -0800397//
398// The returned Transport is a singleton, so multiple calls to this function will return the same
399// object, and the caller should not attempt to delete the returned Transport.
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000400static Transport* open_device(const char* local_serial, bool wait_for_device = true,
401 bool announce = true) {
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000402 const Result<NetworkSerial, ParseNetworkAddressError> network_serial =
403 ParseNetworkSerial(local_serial);
David Pursell2ec418a2016-01-20 08:32:08 -0800404
David Anderson1d887432018-08-27 16:47:32 -0700405 Transport* transport = nullptr;
David Pursell2ec418a2016-01-20 08:32:08 -0800406 while (true) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000407 if (network_serial.ok()) {
David Pursell2ec418a2016-01-20 08:32:08 -0800408 std::string error;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000409 if (network_serial->protocol == Socket::Protocol::kTcp) {
410 transport = tcp::Connect(network_serial->address, network_serial->port, &error)
411 .release();
412 } else if (network_serial->protocol == Socket::Protocol::kUdp) {
413 transport = udp::Connect(network_serial->address, network_serial->port, &error)
414 .release();
David Pursell4601c972016-02-05 15:35:09 -0800415 }
416
David Pursell2ec418a2016-01-20 08:32:08 -0800417 if (transport == nullptr && announce) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000418 LOG(ERROR) << "error: " << error;
David Pursell2ec418a2016-01-20 08:32:08 -0800419 }
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000420 } else if (network_serial.error().code() == ParseNetworkAddressError::Type::WRONG_PREFIX) {
421 // WRONG_PREFIX is special because it happens when user wants to communicate with USB
422 // device
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000423 transport = usb_open(match_fastboot(local_serial));
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000424 } else {
425 Expect(network_serial);
David Pursell2ec418a2016-01-20 08:32:08 -0800426 }
427
428 if (transport != nullptr) {
429 return transport;
430 }
431
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000432 if (!wait_for_device) {
433 return nullptr;
434 }
435
David Pursell0b156632015-10-30 11:22:01 -0700436 if (announce) {
David Pursell2ec418a2016-01-20 08:32:08 -0800437 announce = false;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000438 LOG(ERROR) << "< waiting for " << local_serial << ">";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800439 }
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000440 std::this_thread::sleep_for(std::chrono::seconds(1));
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800441 }
442}
443
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000444static Transport* NetworkDeviceConnected(bool print = false) {
445 Transport* transport = nullptr;
446 Transport* result = nullptr;
447
448 ConnectedDevicesStorage storage;
449 std::set<std::string> devices;
450 {
451 FileLock lock = storage.Lock();
452 devices = storage.ReadDevices(lock);
453 }
454
455 for (const std::string& device : devices) {
456 transport = open_device(device.c_str(), false, false);
457
458 if (print) {
Dmitrii Merkurevc48cd9f2023-02-15 15:34:58 +0000459 PrintDevice(device.c_str(), transport == nullptr ? "offline" : "fastboot");
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000460 }
461
462 if (transport != nullptr) {
463 result = transport;
464 }
465 }
466
467 return result;
468}
469
470// Detects the fastboot connected device to open a new Transport.
471// Detecting logic:
472//
473// if serial is provided - try to connect to this particular usb/network device
474// othervise:
475// 1. Check connected usb devices and return the last connected one
476// 2. Check connected network devices and return the last connected one
477// 2. If nothing is connected - wait for any device by repeating p. 1 and 2
478//
479// The returned Transport is a singleton, so multiple calls to this function will return the same
480// object, and the caller should not attempt to delete the returned Transport.
481static Transport* open_device() {
482 if (serial != nullptr) {
483 return open_device(serial);
484 }
485
486 bool announce = true;
487 Transport* transport = nullptr;
488 while (true) {
489 transport = usb_open(match_fastboot(nullptr));
490 if (transport != nullptr) {
491 return transport;
492 }
493
494 transport = NetworkDeviceConnected();
495 if (transport != nullptr) {
496 return transport;
497 }
498
499 if (announce) {
500 announce = false;
501 LOG(ERROR) << "< waiting for any device >";
502 }
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000503 std::this_thread::sleep_for(std::chrono::seconds(1));
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000504 }
505}
506
507static int Connect(int argc, char* argv[]) {
508 if (argc != 1) {
509 LOG(FATAL) << "connect command requires to receive only 1 argument. Usage:" << std::endl
510 << "fastboot connect [tcp:|udp:host:port]";
511 }
512
513 const char* local_serial = *argv;
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000514 Expect(ParseNetworkSerial(local_serial));
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000515
516 const Transport* transport = open_device(local_serial, false);
517 if (transport == nullptr) {
518 return 1;
519 }
520
521 ConnectedDevicesStorage storage;
522 {
523 FileLock lock = storage.Lock();
524 std::set<std::string> devices = storage.ReadDevices(lock);
525 devices.insert(local_serial);
526 storage.WriteDevices(lock, devices);
527 }
528
529 return 0;
530}
531
532static int Disconnect(const char* local_serial) {
Dmitrii Merkurev47855542023-02-28 21:02:48 +0000533 Expect(ParseNetworkSerial(local_serial));
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000534
535 ConnectedDevicesStorage storage;
536 {
537 FileLock lock = storage.Lock();
538 std::set<std::string> devices = storage.ReadDevices(lock);
539 devices.erase(local_serial);
540 storage.WriteDevices(lock, devices);
541 }
542
543 return 0;
544}
545
546static int Disconnect() {
547 ConnectedDevicesStorage storage;
548 {
549 FileLock lock = storage.Lock();
550 storage.Clear(lock);
551 }
552
553 return 0;
554}
555
556static int Disconnect(int argc, char* argv[]) {
557 switch (argc) {
558 case 0: {
559 return Disconnect();
560 }
561 case 1: {
562 return Disconnect(*argv);
563 }
564 default:
565 LOG(FATAL) << "disconnect command can receive only 0 or 1 arguments. Usage:"
566 << std::endl
567 << "fastboot disconnect # disconnect all devices" << std::endl
568 << "fastboot disconnect [tcp:|udp:host:port] # disconnect device";
569 }
570
571 return 0;
572}
573
Elliott Hughesfc797672015-04-07 20:12:50 -0700574static void list_devices() {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800575 // We don't actually open a USB device here,
576 // just getting our callback called so we can
577 // list all the connected devices.
578 usb_open(list_devices_callback);
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000579 NetworkDeviceConnected(/* print */ true);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800580}
Daniel Zheng0d307182023-01-31 21:07:53 +0000581void syntax_error(const char* fmt, ...) {
Elliott Hughesd6365a72017-05-08 18:04:49 -0700582 fprintf(stderr, "fastboot: usage: ");
583
584 va_list ap;
585 va_start(ap, fmt);
586 vfprintf(stderr, fmt, ap);
587 va_end(ap);
588
589 fprintf(stderr, "\n");
590 exit(1);
591}
592
593static int show_help() {
594 // clang-format off
595 fprintf(stdout,
Elliott Hughes07fc6822018-05-24 16:36:05 -0700596// 1 2 3 4 5 6 7 8
597// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
Elliott Hughesb76188f2018-04-03 13:30:18 -0700598 "usage: fastboot [OPTION...] COMMAND...\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800599 "\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700600 "flashing:\n"
601 " update ZIP Flash all partitions from an update.zip package.\n"
602 " flashall Flash all partitions from $ANDROID_PRODUCT_OUT.\n"
603 " On A/B devices, flashed slot is set as active.\n"
604 " Secondary images may be flashed to inactive slot.\n"
Elliott Hughes07fc6822018-05-24 16:36:05 -0700605 " flash PARTITION [FILENAME] Flash given partition, using the image from\n"
606 " $ANDROID_PRODUCT_OUT if no filename is given.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700607 "\n"
608 "basics:\n"
609 " devices [-l] List devices in bootloader (-l: with device paths).\n"
610 " getvar NAME Display given bootloader variable.\n"
611 " reboot [bootloader] Reboot device.\n"
612 "\n"
613 "locking/unlocking:\n"
614 " flashing lock|unlock Lock/unlock partitions for flashing\n"
615 " flashing lock_critical|unlock_critical\n"
616 " Lock/unlock 'critical' bootloader partitions.\n"
617 " flashing get_unlock_ability\n"
618 " Check whether unlocking is allowed (1) or not(0).\n"
619 "\n"
620 "advanced:\n"
621 " erase PARTITION Erase a flash partition.\n"
622 " format[:FS_TYPE[:SIZE]] PARTITION\n"
623 " Format a flash partition.\n"
624 " set_active SLOT Set the active slot.\n"
625 " oem [COMMAND...] Execute OEM-specific command.\n"
David Anderson1d504e32019-01-15 14:38:20 -0800626 " gsi wipe|disable Wipe or disable a GSI installation (fastbootd only).\n"
David Anderson7c84b9f2019-06-27 22:15:29 -0700627 " wipe-super [SUPER_EMPTY] Wipe the super partition. This will reset it to\n"
628 " contain an empty set of default dynamic partitions.\n"
Luca Stefani173667b2021-04-12 19:16:43 +0200629 " create-logical-partition NAME SIZE\n"
630 " Create a logical partition with the given name and\n"
631 " size, in the super partition.\n"
632 " delete-logical-partition NAME\n"
633 " Delete a logical partition with the given name.\n"
634 " resize-logical-partition NAME SIZE\n"
635 " Change the size of the named logical partition.\n"
David Andersonab8f4662019-10-21 16:45:59 -0700636 " snapshot-update cancel On devices that support snapshot-based updates, cancel\n"
637 " an in-progress update. This may make the device\n"
638 " unbootable until it is reflashed.\n"
David Anderson220ddb12019-10-31 18:02:41 -0700639 " snapshot-update merge On devices that support snapshot-based updates, finish\n"
640 " an in-progress update if it is in the \"merging\"\n"
641 " phase.\n"
Pierre-ClƩment Tosi96941a02021-06-14 12:16:06 +0000642 " fetch PARTITION OUT_FILE Fetch a partition image from the device."
Elliott Hughesb76188f2018-04-03 13:30:18 -0700643 "\n"
644 "boot image:\n"
645 " boot KERNEL [RAMDISK [SECOND]]\n"
646 " Download and boot kernel from RAM.\n"
647 " flash:raw PARTITION KERNEL [RAMDISK [SECOND]]\n"
648 " Create boot image and flash it.\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800649 " --dtb DTB Specify path to DTB for boot image header version 2.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700650 " --cmdline CMDLINE Override kernel command line.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700651 " --base ADDRESS Set kernel base address (default: 0x10000000).\n"
652 " --kernel-offset Set kernel offset (default: 0x00008000).\n"
653 " --ramdisk-offset Set ramdisk offset (default: 0x01000000).\n"
654 " --tags-offset Set tags offset (default: 0x00000100).\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800655 " --dtb-offset Set dtb offset (default: 0x01100000).\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700656 " --page-size BYTES Set flash page size (default: 2048).\n"
657 " --header-version VERSION Set boot image header version.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700658 " --os-version MAJOR[.MINOR[.PATCH]]\n"
659 " Set boot image OS version (default: 0.0.0).\n"
660 " --os-patch-level YYYY-MM-DD\n"
661 " Set boot image OS security patch level.\n"
662 // TODO: still missing: `second_addr`, `name`, `id`, `recovery_dtbo_*`.
Elliott Hughesb76188f2018-04-03 13:30:18 -0700663 "\n"
Elliott Hughes2e9b7792018-04-04 13:36:44 -0700664 // TODO: what device(s) used this? is there any documentation?
Elliott Hughesb76188f2018-04-03 13:30:18 -0700665 //" continue Continue with autoboot.\n"
666 //"\n"
667 "Android Things:\n"
668 " stage IN_FILE Sends given file to stage for the next command.\n"
669 " 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 -0800670 "\n"
671 "options:\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700672 " -w Wipe userdata.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700673 " -s SERIAL Specify a USB device.\n"
674 " -s tcp|udp:HOST[:PORT] Specify a network device.\n"
Elliott Hughes542370d2018-04-19 19:49:44 -0700675 " -S SIZE[K|M|G] Break into sparse files no larger than SIZE.\n"
David Anderson89569642018-11-16 15:53:35 -0800676 " --force Force a flash operation that may be unsafe.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700677 " --slot SLOT Use SLOT; 'all' for both slots, 'other' for\n"
678 " non-current slot (default: current active slot).\n"
679 " --set-active[=SLOT] Sets the active slot before rebooting.\n"
680 " --skip-secondary Don't flash secondary slots in flashall/update.\n"
681 " --skip-reboot Don't reboot device after flashing.\n"
682 " --disable-verity Sets disable-verity when flashing vbmeta.\n"
683 " --disable-verification Sets disable-verification when flashing vbmeta.\n"
Jaegeuk Kim638d05e2020-11-09 08:54:13 -0800684 " --fs-options=OPTION[,OPTION]\n"
685 " Enable filesystem features. OPTION supports casefold, projid, compress\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700686 // TODO: remove --unbuffered?
687 " --unbuffered Don't buffer input or output.\n"
688 " --verbose, -v Verbose output.\n"
689 " --version Display version.\n"
690 " --help, -h Show this message.\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800691 );
Yifan Hongbcd27702021-02-16 19:37:32 -0800692 // clang-format on
Elliott Hughesd6365a72017-05-08 18:04:49 -0700693 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800694}
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000695
Tom Cherrydfd85df2018-09-20 14:45:05 -0700696static std::vector<char> LoadBootableImage(const std::string& kernel, const std::string& ramdisk,
697 const std::string& second_stage) {
698 std::vector<char> kernel_data;
699 if (!ReadFileToVector(kernel, &kernel_data)) {
700 die("cannot load '%s': %s", kernel.c_str(), strerror(errno));
701 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800702
Elliott Hughesfc797672015-04-07 20:12:50 -0700703 // Is this actually a boot image?
Steve Muckle15303f22020-03-18 14:55:06 -0700704 if (kernel_data.size() < sizeof(boot_img_hdr_v3)) {
Elliott Hughesaaa3b6b2018-01-18 16:08:24 -0800705 die("cannot load '%s': too short", kernel.c_str());
706 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700707 if (!memcmp(kernel_data.data(), BOOT_MAGIC, BOOT_MAGIC_SIZE)) {
Elliott Hughes577e8b42018-04-05 16:12:47 -0700708 if (!g_cmdline.empty()) {
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800709 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(kernel_data.data()), g_cmdline);
Elliott Hughes577e8b42018-04-05 16:12:47 -0700710 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800711
Elliott Hughes4089d342017-10-27 14:21:12 -0700712 if (!ramdisk.empty()) die("cannot boot a boot.img *and* ramdisk");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800713
Tom Cherrydfd85df2018-09-20 14:45:05 -0700714 return kernel_data;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800715 }
716
Tom Cherrydfd85df2018-09-20 14:45:05 -0700717 std::vector<char> ramdisk_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700718 if (!ramdisk.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700719 if (!ReadFileToVector(ramdisk, &ramdisk_data)) {
720 die("cannot load '%s': %s", ramdisk.c_str(), strerror(errno));
721 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800722 }
723
Tom Cherrydfd85df2018-09-20 14:45:05 -0700724 std::vector<char> second_stage_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700725 if (!second_stage.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700726 if (!ReadFileToVector(second_stage, &second_stage_data)) {
727 die("cannot load '%s': %s", second_stage.c_str(), strerror(errno));
728 }
Jeremy Compostellaa42adff2014-07-17 17:17:54 +0200729 }
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800730
731 std::vector<char> dtb_data;
732 if (!g_dtb_path.empty()) {
Steve Muckle15303f22020-03-18 14:55:06 -0700733 if (g_boot_img_hdr.header_version != 2) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000734 die("Argument dtb not supported for boot image header version %d\n",
735 g_boot_img_hdr.header_version);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800736 }
737 if (!ReadFileToVector(g_dtb_path, &dtb_data)) {
738 die("cannot load '%s': %s", g_dtb_path.c_str(), strerror(errno));
739 }
740 }
741
Daniel Zheng65452d02022-11-30 02:25:31 +0000742 fprintf(stderr, "creating boot image...\n");
Elliott Hughesd6365a72017-05-08 18:04:49 -0700743
Tom Cherrydfd85df2018-09-20 14:45:05 -0700744 std::vector<char> out;
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800745 mkbootimg(kernel_data, ramdisk_data, second_stage_data, dtb_data, g_base_addr, g_boot_img_hdr,
746 &out);
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800747
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800748 if (!g_cmdline.empty()) {
749 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(out.data()), g_cmdline);
750 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700751 fprintf(stderr, "creating boot image - %zu bytes\n", out.size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700752 return out;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800753}
754
Tom Cherrydfd85df2018-09-20 14:45:05 -0700755static bool UnzipToMemory(ZipArchiveHandle zip, const std::string& entry_name,
756 std::vector<char>* out) {
Elliott Hughesb4074142020-09-15 14:26:17 -0700757 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700758 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700759 fprintf(stderr, "archive does not contain '%s'\n", entry_name.c_str());
760 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800761 }
762
Elliott Hughesb4074142020-09-15 14:26:17 -0700763 if (zip_entry.uncompressed_length > std::numeric_limits<size_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000764 die("entry '%s' is too large: %" PRIu64, entry_name.c_str(), zip_entry.uncompressed_length);
Elliott Hughesb4074142020-09-15 14:26:17 -0700765 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700766 out->resize(zip_entry.uncompressed_length);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800767
Tom Cherrydfd85df2018-09-20 14:45:05 -0700768 fprintf(stderr, "extracting %s (%zu MB) to RAM...\n", entry_name.c_str(),
769 out->size() / 1024 / 1024);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800770
Daniel Zheng65452d02022-11-30 02:25:31 +0000771 int error =
772 ExtractToMemory(zip, &zip_entry, reinterpret_cast<uint8_t*>(out->data()), out->size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700773 if (error != 0) die("failed to extract '%s': %s", entry_name.c_str(), ErrorCodeString(error));
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000774
Tom Cherrydfd85df2018-09-20 14:45:05 -0700775 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800776}
777
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700778#if defined(_WIN32)
779
780// TODO: move this to somewhere it can be shared.
781
782#include <windows.h>
783
784// Windows' tmpfile(3) requires administrator rights because
785// it creates temporary files in the root directory.
786static FILE* win32_tmpfile() {
787 char temp_path[PATH_MAX];
788 DWORD nchars = GetTempPath(sizeof(temp_path), temp_path);
789 if (nchars == 0 || nchars >= sizeof(temp_path)) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700790 die("GetTempPath failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700791 }
792
793 char filename[PATH_MAX];
794 if (GetTempFileName(temp_path, "fastboot", 0, filename) == 0) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700795 die("GetTempFileName failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700796 }
797
798 return fopen(filename, "w+bTD");
799}
800
801#define tmpfile win32_tmpfile
802
Elliott Hughes855cdf82018-04-02 14:24:03 -0700803static int make_temporary_fd(const char* /*what*/) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700804 // TODO: reimplement to avoid leaking a FILE*.
805 return fileno(tmpfile());
806}
807
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000808#else
809
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700810static std::string make_temporary_template() {
811 const char* tmpdir = getenv("TMPDIR");
812 if (tmpdir == nullptr) tmpdir = P_tmpdir;
813 return std::string(tmpdir) + "/fastboot_userdata_XXXXXX";
814}
815
Elliott Hughes855cdf82018-04-02 14:24:03 -0700816static int make_temporary_fd(const char* what) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700817 std::string path_template(make_temporary_template());
818 int fd = mkstemp(&path_template[0]);
819 if (fd == -1) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000820 die("failed to create temporary file for %s with template %s: %s\n", path_template.c_str(),
821 what, strerror(errno));
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700822 }
823 unlink(path_template.c_str());
824 return fd;
825}
826
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700827#endif
828
Yifan Hongb10d0672021-02-22 15:06:27 -0800829static unique_fd unzip_to_file(ZipArchiveHandle zip, const char* entry_name) {
Elliott Hughes855cdf82018-04-02 14:24:03 -0700830 unique_fd fd(make_temporary_fd(entry_name));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700831
Elliott Hughesb4074142020-09-15 14:26:17 -0700832 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700833 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700834 fprintf(stderr, "archive does not contain '%s'\n", entry_name);
David Andersoncf444f32018-08-29 14:15:49 -0700835 errno = ENOENT;
Yifan Hongb10d0672021-02-22 15:06:27 -0800836 return unique_fd();
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000837 }
838
Elliott Hughesb4074142020-09-15 14:26:17 -0700839 fprintf(stderr, "extracting %s (%" PRIu64 " MB) to disk...", entry_name,
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700840 zip_entry.uncompressed_length / 1024 / 1024);
Elliott Hughes23af1122017-11-10 08:42:17 -0800841 double start = now();
Yifan Hong58532df2021-03-22 16:39:13 -0700842 int error = ExtractEntryToFile(zip, &zip_entry, fd.get());
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700843 if (error != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800844 die("\nfailed to extract '%s': %s", entry_name, ErrorCodeString(error));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700845 }
846
Yifan Hong58532df2021-03-22 16:39:13 -0700847 if (lseek(fd.get(), 0, SEEK_SET) != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800848 die("\nlseek on extracted file '%s' failed: %s", entry_name, strerror(errno));
Elliott Hughes4089d342017-10-27 14:21:12 -0700849 }
850
Elliott Hughes23af1122017-11-10 08:42:17 -0800851 fprintf(stderr, " took %.3fs\n", now() - start);
852
Yifan Hongb10d0672021-02-22 15:06:27 -0800853 return fd;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700854}
855
Andrew Chantd64b9882021-04-06 12:48:27 -0700856static bool CheckRequirement(const std::string& cur_product, const std::string& var,
Tom Cherry4aa60b32018-09-05 15:11:44 -0700857 const std::string& product, bool invert,
858 const std::vector<std::string>& options) {
859 Status("Checking '" + var + "'");
Elliott Hughes5620d222018-03-28 08:20:00 -0700860
Tom Cherry4aa60b32018-09-05 15:11:44 -0700861 double start = now();
862
863 if (!product.empty()) {
864 if (product != cur_product) {
865 double split = now();
866 fprintf(stderr, "IGNORE, product is %s required only for %s [%7.3fs]\n",
867 cur_product.c_str(), product.c_str(), (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700868 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700869 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800870 }
Tom Cherry4aa60b32018-09-05 15:11:44 -0700871
872 std::string var_value;
Tom Cherry9027af02018-09-24 15:48:09 -0700873 if (fb->GetVar(var, &var_value) != fastboot::SUCCESS) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700874 fprintf(stderr, "FAILED\n\n");
Daniel Zheng65452d02022-11-30 02:25:31 +0000875 fprintf(stderr, "Could not getvar for '%s' (%s)\n\n", var.c_str(), fb->Error().c_str());
Andrew Chantd64b9882021-04-06 12:48:27 -0700876 return false;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700877 }
878
879 bool match = false;
880 for (const auto& option : options) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000881 if (option == var_value ||
882 (option.back() == '*' &&
883 !var_value.compare(0, option.length() - 1, option, 0, option.length() - 1))) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700884 match = true;
885 break;
886 }
887 }
888
889 if (invert) {
890 match = !match;
891 }
892
893 if (match) {
894 double split = now();
895 fprintf(stderr, "OKAY [%7.3fs]\n", (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700896 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700897 }
898
899 fprintf(stderr, "FAILED\n\n");
900 fprintf(stderr, "Device %s is '%s'.\n", var.c_str(), var_value.c_str());
901 fprintf(stderr, "Update %s '%s'", invert ? "rejects" : "requires", options[0].c_str());
902 for (auto it = std::next(options.begin()); it != options.end(); ++it) {
903 fprintf(stderr, " or '%s'", it->c_str());
904 }
905 fprintf(stderr, ".\n\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700906 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800907}
908
Tom Cherry4aa60b32018-09-05 15:11:44 -0700909bool ParseRequirementLine(const std::string& line, std::string* name, std::string* product,
910 bool* invert, std::vector<std::string>* options) {
Elliott Hughes5620d222018-03-28 08:20:00 -0700911 // "require product=alpha|beta|gamma"
912 // "require version-bootloader=1234"
913 // "require-for-product:gamma version-bootloader=istanbul|constantinople"
914 // "require partition-exists=vendor"
Tom Cherry4aa60b32018-09-05 15:11:44 -0700915 *product = "";
916 *invert = false;
Elliott Hughes5620d222018-03-28 08:20:00 -0700917
Tom Cherry4aa60b32018-09-05 15:11:44 -0700918 auto require_reject_regex = std::regex{"(require\\s+|reject\\s+)?\\s*(\\S+)\\s*=\\s*(.*)"};
919 auto require_product_regex =
920 std::regex{"require-for-product:\\s*(\\S+)\\s+(\\S+)\\s*=\\s*(.*)"};
921 std::smatch match_results;
922
923 if (std::regex_match(line, match_results, require_reject_regex)) {
924 *invert = Trim(match_results[1]) == "reject";
925 } else if (std::regex_match(line, match_results, require_product_regex)) {
926 *product = match_results[1];
927 } else {
928 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800929 }
930
Tom Cherry4aa60b32018-09-05 15:11:44 -0700931 *name = match_results[2];
Elliott Hughes253c18d2015-03-18 22:47:09 -0700932 // Work around an unfortunate name mismatch.
Tom Cherry4aa60b32018-09-05 15:11:44 -0700933 if (*name == "board") {
934 *name = "product";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800935 }
936
Tom Cherry4aa60b32018-09-05 15:11:44 -0700937 auto raw_options = Split(match_results[3], "|");
938 for (const auto& option : raw_options) {
939 auto trimmed_option = Trim(option);
940 options->emplace_back(trimmed_option);
941 }
942
943 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800944}
945
Tom Cherry4aa60b32018-09-05 15:11:44 -0700946// "require partition-exists=x" is a special case, added because of the trouble we had when
947// Pixel 2 shipped with new partitions and users used old versions of fastboot to flash them,
948// missing out new partitions. A device with new partitions can use "partition-exists" to
949// override the fields `optional_if_no_image` in the `images` array.
950static void HandlePartitionExists(const std::vector<std::string>& options) {
951 const std::string& partition_name = options[0];
952 std::string has_slot;
Tom Cherry9027af02018-09-24 15:48:09 -0700953 if (fb->GetVar("has-slot:" + partition_name, &has_slot) != fastboot::SUCCESS ||
Tom Cherry4aa60b32018-09-05 15:11:44 -0700954 (has_slot != "yes" && has_slot != "no")) {
955 die("device doesn't have required partition %s!", partition_name.c_str());
956 }
957 bool known_partition = false;
Daniel Zheng65452d02022-11-30 02:25:31 +0000958 for (size_t i = 0; i < images.size(); ++i) {
959 if (!images[i].nickname.empty() && images[i].nickname == partition_name) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700960 images[i].optional_if_no_image = false;
961 known_partition = true;
962 }
963 }
964 if (!known_partition) {
965 die("device requires partition %s which is not known to this version of fastboot",
966 partition_name.c_str());
967 }
968}
969
Andrew Chantd64b9882021-04-06 12:48:27 -0700970static void CheckRequirements(const std::string& data, bool force_flash) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700971 std::string cur_product;
Tom Cherry9027af02018-09-24 15:48:09 -0700972 if (fb->GetVar("product", &cur_product) != fastboot::SUCCESS) {
973 fprintf(stderr, "getvar:product FAILED (%s)\n", fb->Error().c_str());
Tom Cherry4aa60b32018-09-05 15:11:44 -0700974 }
975
976 auto lines = Split(data, "\n");
977 for (const auto& line : lines) {
978 if (line.empty()) {
979 continue;
980 }
981
982 std::string name;
983 std::string product;
984 bool invert;
985 std::vector<std::string> options;
986
987 if (!ParseRequirementLine(line, &name, &product, &invert, &options)) {
988 fprintf(stderr, "android-info.txt syntax error: %s\n", line.c_str());
989 continue;
990 }
991 if (name == "partition-exists") {
992 HandlePartitionExists(options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800993 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -0700994 bool met = CheckRequirement(cur_product, name, product, invert, options);
995 if (!met) {
996 if (!force_flash) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000997 die("requirements not met!");
Andrew Chantd64b9882021-04-06 12:48:27 -0700998 } else {
Daniel Zheng65452d02022-11-30 02:25:31 +0000999 fprintf(stderr, "requirements not met! but proceeding due to --force\n");
Andrew Chantd64b9882021-04-06 12:48:27 -07001000 }
1001 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001002 }
1003 }
1004}
1005
Tom Cherry9027af02018-09-24 15:48:09 -07001006static void DisplayVarOrError(const std::string& label, const std::string& var) {
1007 std::string value;
1008
1009 if (fb->GetVar(var, &value) != fastboot::SUCCESS) {
1010 Status("getvar:" + var);
1011 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
1012 return;
1013 }
1014 fprintf(stderr, "%s: %s\n", label.c_str(), value.c_str());
1015}
1016
1017static void DumpInfo() {
1018 fprintf(stderr, "--------------------------------------------\n");
1019 DisplayVarOrError("Bootloader Version...", "version-bootloader");
1020 DisplayVarOrError("Baseband Version.....", "version-baseband");
1021 DisplayVarOrError("Serial Number........", "serialno");
1022 fprintf(stderr, "--------------------------------------------\n");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001023}
1024
David Andersonaa87dc52023-01-27 20:39:06 -08001025static std::vector<SparsePtr> resparse_file(sparse_file* s, int64_t max_size) {
Tao Bao41cf35f2018-04-24 10:54:21 -07001026 if (max_size <= 0 || max_size > std::numeric_limits<uint32_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001027 die("invalid max size %" PRId64, max_size);
Tao Bao41cf35f2018-04-24 10:54:21 -07001028 }
1029
David Andersonaa87dc52023-01-27 20:39:06 -08001030 const int files = sparse_file_resparse(s, max_size, nullptr, 0);
Elliott Hughes4089d342017-10-27 14:21:12 -07001031 if (files < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001032
David Andersona1c983e2023-01-27 11:57:27 -08001033 auto temp = std::make_unique<sparse_file*[]>(files);
David Andersonaa87dc52023-01-27 20:39:06 -08001034 const int rv = sparse_file_resparse(s, max_size, temp.get(), files);
David Andersona1c983e2023-01-27 11:57:27 -08001035 if (rv < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001036
David Andersona1c983e2023-01-27 11:57:27 -08001037 std::vector<SparsePtr> out_s;
1038 for (int i = 0; i < files; i++) {
1039 out_s.emplace_back(temp[i], sparse_file_destroy);
1040 }
Colin Crossf8387882012-05-24 17:18:41 -07001041 return out_s;
1042}
1043
David Andersonaa87dc52023-01-27 20:39:06 -08001044static std::vector<SparsePtr> load_sparse_files(int fd, int64_t max_size) {
1045 SparsePtr s(sparse_file_import_auto(fd, false, true), sparse_file_destroy);
1046 if (!s) die("cannot sparse read file");
1047
1048 return resparse_file(s.get(), max_size);
1049}
1050
Yifan Hongbcd27702021-02-16 19:37:32 -08001051static uint64_t get_uint_var(const char* var_name) {
1052 std::string value_str;
1053 if (fb->GetVar(var_name, &value_str) != fastboot::SUCCESS || value_str.empty()) {
1054 verbose("target didn't report %s", var_name);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001055 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001056 }
1057
Elliott Hughes77c0e662015-11-02 15:51:12 -08001058 // Some bootloaders (angler, for example) send spurious whitespace too.
Yifan Hongbcd27702021-02-16 19:37:32 -08001059 value_str = android::base::Trim(value_str);
Elliott Hughes77c0e662015-11-02 15:51:12 -08001060
Yifan Hongbcd27702021-02-16 19:37:32 -08001061 uint64_t value;
1062 if (!android::base::ParseUint(value_str, &value)) {
1063 fprintf(stderr, "couldn't parse %s '%s'\n", var_name, value_str.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001064 return 0;
1065 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001066 if (value > 0) verbose("target reported %s of %" PRId64 " bytes", var_name, value);
1067 return value;
Colin Crossf8387882012-05-24 17:18:41 -07001068}
1069
Aaron Wisnerdb511202018-06-26 15:38:35 -05001070static int64_t get_sparse_limit(int64_t size) {
Elliott Hughes542370d2018-04-19 19:49:44 -07001071 int64_t limit = sparse_limit;
1072 if (limit == 0) {
1073 // Unlimited, so see what the target device's limit is.
1074 // TODO: shouldn't we apply this limit even if you've used -S?
Colin Crossf8387882012-05-24 17:18:41 -07001075 if (target_sparse_limit == -1) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001076 target_sparse_limit = static_cast<int64_t>(get_uint_var("max-download-size"));
Colin Crossf8387882012-05-24 17:18:41 -07001077 }
1078 if (target_sparse_limit > 0) {
1079 limit = target_sparse_limit;
1080 } else {
Colin Cross0bbfb392012-07-24 18:05:21 -07001081 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001082 }
1083 }
1084
1085 if (size > limit) {
Chris Fries6a999712017-04-04 09:52:47 -05001086 return std::min(limit, RESPARSE_LIMIT);
Colin Crossf8387882012-05-24 17:18:41 -07001087 }
1088
1089 return 0;
1090}
1091
Yifan Hongb10d0672021-02-22 15:06:27 -08001092static bool load_buf_fd(unique_fd fd, struct fastboot_buffer* buf) {
Elliott Hughesfc797672015-04-07 20:12:50 -07001093 int64_t sz = get_file_size(fd);
1094 if (sz == -1) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001095 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001096 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001097
Yifan Hong58532df2021-03-22 16:39:13 -07001098 if (sparse_file* s = sparse_file_import(fd.get(), false, false)) {
David Anderson32e376f2018-08-16 13:43:11 -07001099 buf->image_size = sparse_file_len(s, false, false);
1100 sparse_file_destroy(s);
1101 } else {
1102 buf->image_size = sz;
1103 }
1104
Yifan Hong58532df2021-03-22 16:39:13 -07001105 lseek(fd.get(), 0, SEEK_SET);
Aaron Wisnerdb511202018-06-26 15:38:35 -05001106 int64_t limit = get_sparse_limit(sz);
Yifan Honge9f067b2021-03-22 16:55:39 -07001107 buf->fd = std::move(fd);
Colin Crossf8387882012-05-24 17:18:41 -07001108 if (limit) {
David Andersona1c983e2023-01-27 11:57:27 -08001109 buf->files = load_sparse_files(buf->fd.get(), limit);
1110 if (buf->files.empty()) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001111 return false;
Colin Crossf8387882012-05-24 17:18:41 -07001112 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001113 buf->type = FB_BUFFER_SPARSE;
Colin Crossf8387882012-05-24 17:18:41 -07001114 } else {
Chris Fries0ea946c2017-04-12 10:25:57 -05001115 buf->type = FB_BUFFER_FD;
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +00001116 buf->sz = sz;
Colin Crossf8387882012-05-24 17:18:41 -07001117 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001118
Elliott Hughes53ec4952016-05-11 12:39:27 -07001119 return true;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001120}
1121
Aaron Wisnerdb511202018-06-26 15:38:35 -05001122static bool load_buf(const char* fname, struct fastboot_buffer* buf) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001123 unique_fd fd(TEMP_FAILURE_RETRY(open(fname, O_RDONLY | O_BINARY)));
1124
Elliott Hughes53ec4952016-05-11 12:39:27 -07001125 if (fd == -1) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00001126 auto path = find_item_given_name(fname);
1127 fd = unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
1128 if (fd == -1) return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001129 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001130
1131 struct stat s;
Yifan Hong58532df2021-03-22 16:39:13 -07001132 if (fstat(fd.get(), &s)) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001133 return false;
1134 }
1135 if (!S_ISREG(s.st_mode)) {
1136 errno = S_ISDIR(s.st_mode) ? EISDIR : EINVAL;
1137 return false;
1138 }
1139
Yifan Hongb10d0672021-02-22 15:06:27 -08001140 return load_buf_fd(std::move(fd), buf);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001141}
1142
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001143static void rewrite_vbmeta_buffer(struct fastboot_buffer* buf, bool vbmeta_in_boot) {
David Zeuthenb6ea4352017-08-07 14:29:26 -04001144 // Buffer needs to be at least the size of the VBMeta struct which
1145 // is 256 bytes.
1146 if (buf->sz < 256) {
1147 return;
1148 }
1149
David Zeuthenb6ea4352017-08-07 14:29:26 -04001150 std::string data;
1151 if (!android::base::ReadFdToString(buf->fd, &data)) {
1152 die("Failed reading from vbmeta");
1153 }
1154
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001155 uint64_t vbmeta_offset = 0;
1156 if (vbmeta_in_boot) {
1157 // Tries to locate top-level vbmeta from boot.img footer.
1158 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1159 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001160 die("Failed to find AVB_FOOTER at offset: %" PRId64 ", is BOARD_AVB_ENABLE true?",
1161 footer_offset);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001162 }
1163 const AvbFooter* footer = reinterpret_cast<const AvbFooter*>(data.c_str() + footer_offset);
1164 vbmeta_offset = be64toh(footer->vbmeta_offset);
1165 }
1166 // Ensures there is AVB_MAGIC at vbmeta_offset.
1167 if (0 != data.compare(vbmeta_offset, AVB_MAGIC_LEN, AVB_MAGIC)) {
1168 die("Failed to find AVB_MAGIC at offset: %" PRId64, vbmeta_offset);
1169 }
1170
1171 fprintf(stderr, "Rewriting vbmeta struct at offset: %" PRId64 "\n", vbmeta_offset);
1172
David Zeuthenb6ea4352017-08-07 14:29:26 -04001173 // There's a 32-bit big endian |flags| field at offset 120 where
1174 // bit 0 corresponds to disable-verity and bit 1 corresponds to
1175 // disable-verification.
1176 //
1177 // See external/avb/libavb/avb_vbmeta_image.h for the layout of
1178 // the VBMeta struct.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001179 uint64_t flags_offset = 123 + vbmeta_offset;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001180 if (g_disable_verity) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001181 data[flags_offset] |= 0x01;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001182 }
1183 if (g_disable_verification) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001184 data[flags_offset] |= 0x02;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001185 }
1186
Yifan Hongb10d0672021-02-22 15:06:27 -08001187 unique_fd fd(make_temporary_fd("vbmeta rewriting"));
David Zeuthenb6ea4352017-08-07 14:29:26 -04001188 if (!android::base::WriteStringToFd(data, fd)) {
1189 die("Failed writing to modified vbmeta");
1190 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001191 buf->fd = std::move(fd);
Yifan Hong58532df2021-03-22 16:39:13 -07001192 lseek(buf->fd.get(), 0, SEEK_SET);
David Zeuthenb6ea4352017-08-07 14:29:26 -04001193}
1194
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001195static bool has_vbmeta_partition() {
1196 std::string partition_type;
1197 return fb->GetVar("partition-type:vbmeta", &partition_type) == fastboot::SUCCESS ||
1198 fb->GetVar("partition-type:vbmeta_a", &partition_type) == fastboot::SUCCESS ||
1199 fb->GetVar("partition-type:vbmeta_b", &partition_type) == fastboot::SUCCESS;
1200}
1201
David Andersonaa87dc52023-01-27 20:39:06 -08001202// Note: this only works in userspace fastboot. In the bootloader, use
1203// should_flash_in_userspace().
Michael Bestasa495be72020-11-06 17:58:28 +02001204static bool is_logical(const std::string& partition) {
1205 std::string value;
1206 return fb->GetVar("is-logical:" + partition, &value) == fastboot::SUCCESS && value == "yes";
1207}
1208
Steve Muckle3af575b2020-06-18 17:02:15 -07001209static std::string fb_fix_numeric_var(std::string var) {
1210 // Some bootloaders (angler, for example), send spurious leading whitespace.
1211 var = android::base::Trim(var);
1212 // Some bootloaders (hammerhead, for example) use implicit hex.
1213 // This code used to use strtol with base 16.
1214 if (!android::base::StartsWith(var, "0x")) var = "0x" + var;
1215 return var;
1216}
1217
Yifan Hongbcd27702021-02-16 19:37:32 -08001218static uint64_t get_partition_size(const std::string& partition) {
Steve Muckle3af575b2020-06-18 17:02:15 -07001219 std::string partition_size_str;
1220 if (fb->GetVar("partition-size:" + partition, &partition_size_str) != fastboot::SUCCESS) {
Michael Bestasa495be72020-11-06 17:58:28 +02001221 if (!is_logical(partition)) {
1222 return 0;
1223 }
Yifan Hong60de9692021-02-17 13:51:54 -08001224 die("cannot get partition size for %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001225 }
1226
1227 partition_size_str = fb_fix_numeric_var(partition_size_str);
Yifan Hongbcd27702021-02-16 19:37:32 -08001228 uint64_t partition_size;
1229 if (!android::base::ParseUint(partition_size_str, &partition_size)) {
Michael Bestasa495be72020-11-06 17:58:28 +02001230 if (!is_logical(partition)) {
1231 return 0;
1232 }
Steve Muckle3af575b2020-06-18 17:02:15 -07001233 die("Couldn't parse partition size '%s'.", partition_size_str.c_str());
1234 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001235 return partition_size;
1236}
1237
Devin Moorecb5098f2022-01-07 16:33:46 +00001238static void copy_avb_footer(const std::string& partition, struct fastboot_buffer* buf) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001239 if (buf->sz < AVB_FOOTER_SIZE) {
1240 return;
1241 }
1242
Bowgo Tsai671249a2021-08-10 16:32:37 +08001243 // If overflows and negative, it should be < buf->sz.
1244 int64_t partition_size = static_cast<int64_t>(get_partition_size(partition));
1245
1246 if (partition_size == buf->sz) {
1247 return;
1248 }
1249 // Some device bootloaders might not implement `fastboot getvar partition-size:boot[_a|_b]`.
1250 // In this case, partition_size will be zero.
1251 if (partition_size < buf->sz) {
1252 fprintf(stderr,
Devin Moorecb5098f2022-01-07 16:33:46 +00001253 "Warning: skip copying %s image avb footer"
1254 " (%s partition size: %" PRId64 ", %s image size: %" PRId64 ").\n",
1255 partition.c_str(), partition.c_str(), partition_size, partition.c_str(), buf->sz);
Bowgo Tsai671249a2021-08-10 16:32:37 +08001256 return;
1257 }
1258
1259 // IMPORTANT: after the following read, we need to reset buf->fd before return (if not die).
1260 // Because buf->fd will still be used afterwards.
Steve Muckle3af575b2020-06-18 17:02:15 -07001261 std::string data;
1262 if (!android::base::ReadFdToString(buf->fd, &data)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001263 die("Failed reading from %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001264 }
1265
1266 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1267 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001268 lseek(buf->fd.get(), 0, SEEK_SET); // IMPORTANT: resets buf->fd before return.
Steve Muckle3af575b2020-06-18 17:02:15 -07001269 return;
1270 }
1271
Devin Moorecb5098f2022-01-07 16:33:46 +00001272 const std::string tmp_fd_template = partition + " rewriting";
1273 unique_fd fd(make_temporary_fd(tmp_fd_template.c_str()));
Steve Muckle3af575b2020-06-18 17:02:15 -07001274 if (!android::base::WriteStringToFd(data, fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001275 die("Failed writing to modified %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001276 }
Yifan Hong58532df2021-03-22 16:39:13 -07001277 lseek(fd.get(), partition_size - AVB_FOOTER_SIZE, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001278 if (!android::base::WriteStringToFd(data.substr(footer_offset), fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001279 die("Failed copying AVB footer in %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001280 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001281 buf->fd = std::move(fd);
Steve Muckle3af575b2020-06-18 17:02:15 -07001282 buf->sz = partition_size;
Yifan Hong58532df2021-03-22 16:39:13 -07001283 lseek(buf->fd.get(), 0, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001284}
1285
David Andersonaa87dc52023-01-27 20:39:06 -08001286static void flash_partition_files(const std::string& partition,
1287 const std::vector<SparsePtr>& files) {
1288 for (size_t i = 0; i < files.size(); i++) {
1289 sparse_file* s = files[i].get();
1290 int64_t sz = sparse_file_len(s, true, false);
1291 fb->FlashPartition(partition, s, sz, i + 1, files.size());
1292 }
1293}
1294
Daniel Zheng65452d02022-11-30 02:25:31 +00001295static void flash_buf(const std::string& partition, struct fastboot_buffer* buf) {
Devin Moore1af12022022-01-06 01:11:23 +00001296 if (partition == "boot" || partition == "boot_a" || partition == "boot_b" ||
Isaac J. Manjarresacb49522023-01-12 14:28:29 -08001297 partition == "init_boot" || partition == "init_boot_a" || partition == "init_boot_b" ||
1298 partition == "recovery" || partition == "recovery_a" || partition == "recovery_b") {
Devin Moorecb5098f2022-01-07 16:33:46 +00001299 copy_avb_footer(partition, buf);
Steve Muckle3af575b2020-06-18 17:02:15 -07001300 }
1301
David Zeuthenb6ea4352017-08-07 14:29:26 -04001302 // Rewrite vbmeta if that's what we're flashing and modification has been requested.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001303 if (g_disable_verity || g_disable_verification) {
Paweł Grabasff9cfac2021-03-04 13:11:25 +01001304 // The vbmeta partition might have additional prefix if running in virtual machine
1305 // e.g., guest_vbmeta_a.
1306 if (android::base::EndsWith(partition, "vbmeta") ||
1307 android::base::EndsWith(partition, "vbmeta_a") ||
1308 android::base::EndsWith(partition, "vbmeta_b")) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001309 rewrite_vbmeta_buffer(buf, false /* vbmeta_in_boot */);
1310 } else if (!has_vbmeta_partition() &&
1311 (partition == "boot" || partition == "boot_a" || partition == "boot_b")) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001312 rewrite_vbmeta_buffer(buf, true /* vbmeta_in_boot */);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001313 }
David Zeuthenb6ea4352017-08-07 14:29:26 -04001314 }
1315
Rom Lemarchand622810c2013-06-28 09:54:59 -07001316 switch (buf->type) {
Josh Gao9da9ac52016-01-19 14:50:18 -08001317 case FB_BUFFER_SPARSE: {
David Andersonaa87dc52023-01-27 20:39:06 -08001318 flash_partition_files(partition, buf->files);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001319 break;
Josh Gao9da9ac52016-01-19 14:50:18 -08001320 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001321 case FB_BUFFER_FD:
Tom Cherry9027af02018-09-24 15:48:09 -07001322 fb->FlashPartition(partition, buf->fd, buf->sz);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001323 break;
1324 default:
1325 die("unknown buffer type: %d", buf->type);
1326 }
1327}
1328
Aaron Wisnerdb511202018-06-26 15:38:35 -05001329static std::string get_current_slot() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001330 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07001331 if (fb->GetVar("current-slot", &current_slot) != fastboot::SUCCESS) return "";
LuK1337dae48ef2020-04-06 14:38:58 +02001332 if (current_slot[0] == '_') current_slot.erase(0, 1);
Elliott Hughes42b18a52018-04-10 15:32:21 -07001333 return current_slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001334}
1335
Aaron Wisnerdb511202018-06-26 15:38:35 -05001336static int get_slot_count() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001337 std::string var;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001338 int count = 0;
Tom Cherry9027af02018-09-24 15:48:09 -07001339 if (fb->GetVar("slot-count", &var) != fastboot::SUCCESS ||
1340 !android::base::ParseInt(var, &count)) {
Elliott Hughes42b18a52018-04-10 15:32:21 -07001341 return 0;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001342 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001343 return count;
1344}
1345
Aaron Wisnerdb511202018-06-26 15:38:35 -05001346static bool supports_AB() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001347 return get_slot_count() >= 2;
Alex Lightbb9b8a52016-06-29 09:26:44 -07001348}
1349
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001350// Given a current slot, this returns what the 'other' slot is.
Daniel Rosenberg80919472016-06-30 19:25:31 -07001351static std::string get_other_slot(const std::string& current_slot, int count) {
1352 if (count == 0) return "";
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001353
Daniel Zheng65452d02022-11-30 02:25:31 +00001354 char next = (current_slot[0] - 'a' + 1) % count + 'a';
Daniel Rosenberg80919472016-06-30 19:25:31 -07001355 return std::string(1, next);
1356}
1357
Aaron Wisnerdb511202018-06-26 15:38:35 -05001358static std::string get_other_slot(const std::string& current_slot) {
1359 return get_other_slot(current_slot, get_slot_count());
Daniel Rosenberg80919472016-06-30 19:25:31 -07001360}
1361
Aaron Wisnerdb511202018-06-26 15:38:35 -05001362static std::string get_other_slot(int count) {
1363 return get_other_slot(get_current_slot(), count);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001364}
1365
Aaron Wisnerdb511202018-06-26 15:38:35 -05001366static std::string get_other_slot() {
1367 return get_other_slot(get_current_slot(), get_slot_count());
Alex Lightbb9b8a52016-06-29 09:26:44 -07001368}
1369
Aaron Wisnerdb511202018-06-26 15:38:35 -05001370static std::string verify_slot(const std::string& slot_name, bool allow_all) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001371 std::string slot = slot_name;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001372 if (slot == "all") {
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001373 if (allow_all) {
1374 return "all";
1375 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001376 int count = get_slot_count();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001377 if (count > 0) {
1378 return "a";
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001379 } else {
Elliott Hughes4089d342017-10-27 14:21:12 -07001380 die("No known slots");
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001381 }
1382 }
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001383 }
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001384
Aaron Wisnerdb511202018-06-26 15:38:35 -05001385 int count = get_slot_count();
Elliott Hughes4089d342017-10-27 14:21:12 -07001386 if (count == 0) die("Device does not support slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001387
Daniel Rosenberg80919472016-06-30 19:25:31 -07001388 if (slot == "other") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001389 std::string other = get_other_slot(count);
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001390 if (other == "") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001391 die("No known slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001392 }
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001393 return other;
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001394 }
1395
Daniel Zheng65452d02022-11-30 02:25:31 +00001396 if (slot.size() == 1 && (slot[0] - 'a' >= 0 && slot[0] - 'a' < count)) return slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001397
1398 fprintf(stderr, "Slot %s does not exist. supported slots are:\n", slot.c_str());
Daniel Zheng65452d02022-11-30 02:25:31 +00001399 for (int i = 0; i < count; i++) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001400 fprintf(stderr, "%c\n", (char)(i + 'a'));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001401 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001402
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001403 exit(1);
1404}
1405
Aaron Wisnerdb511202018-06-26 15:38:35 -05001406static std::string verify_slot(const std::string& slot) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001407 return verify_slot(slot, true);
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001408}
1409
Aaron Wisnerdb511202018-06-26 15:38:35 -05001410static void do_for_partition(const std::string& part, const std::string& slot,
Chih-Hung Hsieh8f7b9e32016-07-27 16:25:51 -07001411 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001412 std::string has_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001413 std::string current_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001414 // |part| can be vendor_boot:default. Append slot to the first token.
1415 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001416
Yifan Hong6d7da632021-02-23 12:15:51 -08001417 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001418 /* If has-slot is not supported, the answer is no. */
1419 has_slot = "no";
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001420 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001421 if (has_slot == "yes") {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001422 if (slot == "") {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001423 current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001424 if (current_slot == "") {
Elliott Hughes4089d342017-10-27 14:21:12 -07001425 die("Failed to identify current slot");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001426 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001427 part_tokens[0] += "_" + current_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001428 } else {
Yifan Hong6d7da632021-02-23 12:15:51 -08001429 part_tokens[0] += "_" + slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001430 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001431 func(android::base::Join(part_tokens, ":"));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001432 } else {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001433 if (force_slot && slot != "") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001434 fprintf(stderr, "Warning: %s does not support slots, and slot %s was requested.\n",
1435 part_tokens[0].c_str(), slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001436 }
1437 func(part);
1438 }
1439}
1440
David Pursell0b156632015-10-30 11:22:01 -07001441/* This function will find the real partition name given a base name, and a slot. If slot is NULL or
1442 * empty, it will use the current slot. If slot is "all", it will return a list of all possible
1443 * partition names. If force_slot is true, it will fail if a slot is specified, and the given
1444 * partition does not support slots.
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001445 */
Daniel Zheng0d307182023-01-31 21:07:53 +00001446void do_for_partitions(const std::string& part, const std::string& slot,
1447 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001448 std::string has_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001449 // |part| can be vendor_boot:default. Query has-slot on the first token only.
1450 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001451
Daniel Rosenberg80919472016-06-30 19:25:31 -07001452 if (slot == "all") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001453 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1454 die("Could not check if partition %s has slot %s", part_tokens[0].c_str(),
1455 slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001456 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001457 if (has_slot == "yes") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001458 for (int i = 0; i < get_slot_count(); i++) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001459 do_for_partition(part, std::string(1, (char)(i + 'a')), func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001460 }
1461 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001462 do_for_partition(part, "", func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001463 }
1464 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001465 do_for_partition(part, slot, func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001466 }
1467}
1468
David Anderson0c732342018-11-28 17:10:42 -08001469static bool is_retrofit_device() {
1470 std::string value;
1471 if (fb->GetVar("super-partition-name", &value) != fastboot::SUCCESS) {
1472 return false;
1473 }
1474 return android::base::StartsWith(value, "system_");
1475}
1476
Yifan Hongbcd27702021-02-16 19:37:32 -08001477// Fetch a partition from the device to a given fd. This is a wrapper over FetchToFd to fetch
1478// the full image.
1479static uint64_t fetch_partition(const std::string& partition, borrowed_fd fd) {
1480 uint64_t fetch_size = get_uint_var(FB_VAR_MAX_FETCH_SIZE);
1481 if (fetch_size == 0) {
1482 die("Unable to get %s. Device does not support fetch command.", FB_VAR_MAX_FETCH_SIZE);
1483 }
1484 uint64_t partition_size = get_partition_size(partition);
1485 if (partition_size <= 0) {
1486 die("Invalid partition size for partition %s: %" PRId64, partition.c_str(), partition_size);
1487 }
1488
1489 uint64_t offset = 0;
1490 while (offset < partition_size) {
1491 uint64_t chunk_size = std::min(fetch_size, partition_size - offset);
1492 if (fb->FetchToFd(partition, fd, offset, chunk_size) != fastboot::RetCode::SUCCESS) {
1493 die("Unable to fetch %s (offset=%" PRIx64 ", size=%" PRIx64 ")", partition.c_str(),
1494 offset, chunk_size);
1495 }
1496 offset += chunk_size;
1497 }
1498 return partition_size;
1499}
1500
1501static void do_fetch(const std::string& partition, const std::string& slot_override,
1502 const std::string& outfile) {
1503 unique_fd fd(TEMP_FAILURE_RETRY(
1504 open(outfile.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0644)));
1505 auto fetch = std::bind(fetch_partition, _1, borrowed_fd(fd));
1506 do_for_partitions(partition, slot_override, fetch, false /* force slot */);
1507}
1508
Yifan Honge71fe242021-02-22 15:00:15 -08001509// Return immediately if not flashing a vendor boot image. If flashing a vendor boot image,
1510// repack vendor_boot image with an updated ramdisk. After execution, buf is set
1511// to the new image to flash, and return value is the real partition name to flash.
1512static std::string repack_ramdisk(const char* pname, struct fastboot_buffer* buf) {
1513 std::string_view pname_sv{pname};
1514
1515 if (!android::base::StartsWith(pname_sv, "vendor_boot:") &&
1516 !android::base::StartsWith(pname_sv, "vendor_boot_a:") &&
1517 !android::base::StartsWith(pname_sv, "vendor_boot_b:")) {
1518 return std::string(pname_sv);
1519 }
1520 if (buf->type != FB_BUFFER_FD) {
1521 die("Flashing sparse vendor ramdisk image is not supported.");
1522 }
1523 if (buf->sz <= 0) {
1524 die("repack_ramdisk() sees negative size: %" PRId64, buf->sz);
1525 }
1526 std::string partition(pname_sv.substr(0, pname_sv.find(':')));
1527 std::string ramdisk(pname_sv.substr(pname_sv.find(':') + 1));
1528
1529 unique_fd vendor_boot(make_temporary_fd("vendor boot repack"));
1530 uint64_t vendor_boot_size = fetch_partition(partition, vendor_boot);
1531 auto repack_res = replace_vendor_ramdisk(vendor_boot, vendor_boot_size, ramdisk, buf->fd,
1532 static_cast<uint64_t>(buf->sz));
1533 if (!repack_res.ok()) {
1534 die("%s", repack_res.error().message().c_str());
1535 }
1536
1537 buf->fd = std::move(vendor_boot);
1538 buf->sz = vendor_boot_size;
1539 buf->image_size = vendor_boot_size;
1540 return partition;
1541}
1542
Daniel Zheng0d307182023-01-31 21:07:53 +00001543void do_flash(const char* pname, const char* fname) {
Yifan Hong6d7da632021-02-23 12:15:51 -08001544 verbose("Do flash %s %s", pname, fname);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001545 struct fastboot_buffer buf;
1546
Aaron Wisnerdb511202018-06-26 15:38:35 -05001547 if (!load_buf(fname, &buf)) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001548 die("cannot load '%s': %s", fname, strerror(errno));
Rom Lemarchand622810c2013-06-28 09:54:59 -07001549 }
David Anderson629e51c2018-10-25 12:51:25 -07001550 if (is_logical(pname)) {
1551 fb->ResizePartition(pname, std::to_string(buf.image_size));
1552 }
Yifan Honge71fe242021-02-22 15:00:15 -08001553 std::string flash_pname = repack_ramdisk(pname, &buf);
1554 flash_buf(flash_pname, &buf);
Colin Crossf8387882012-05-24 17:18:41 -07001555}
1556
Daniel Rosenberg13454092016-06-27 19:43:11 -07001557// Sets slot_override as the active slot. If slot_override is blank,
1558// set current slot as active instead. This clears slot-unbootable.
Aaron Wisnerdb511202018-06-26 15:38:35 -05001559static void set_active(const std::string& slot_override) {
1560 if (!supports_AB()) return;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001561
Daniel Rosenberg80919472016-06-30 19:25:31 -07001562 if (slot_override != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001563 fb->SetActive(slot_override);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001564 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001565 std::string current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001566 if (current_slot != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001567 fb->SetActive(current_slot);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001568 }
1569 }
1570}
1571
Daniel Zheng0d307182023-01-31 21:07:53 +00001572bool is_userspace_fastboot() {
David Anderson32e376f2018-08-16 13:43:11 -07001573 std::string value;
Tom Cherry9027af02018-09-24 15:48:09 -07001574 return fb->GetVar("is-userspace", &value) == fastboot::SUCCESS && value == "yes";
David Anderson32e376f2018-08-16 13:43:11 -07001575}
1576
Daniel Zheng0d307182023-01-31 21:07:53 +00001577void reboot_to_userspace_fastboot() {
Tom Cherry9027af02018-09-24 15:48:09 -07001578 fb->RebootTo("fastboot");
1579
1580 auto* old_transport = fb->set_transport(nullptr);
1581 delete old_transport;
David Anderson1d887432018-08-27 16:47:32 -07001582
1583 // Give the current connection time to close.
Dmitrii Merkurev47855542023-02-28 21:02:48 +00001584 std::this_thread::sleep_for(std::chrono::seconds(1));
David Anderson1d887432018-08-27 16:47:32 -07001585
Tom Cherry9027af02018-09-24 15:48:09 -07001586 fb->set_transport(open_device());
David Anderson11d6d272018-12-07 16:39:07 -08001587
1588 if (!is_userspace_fastboot()) {
1589 die("Failed to boot into userspace fastboot; one or more components might be unbootable.");
1590 }
Hridya Valsaraju83d856e2019-05-17 14:24:19 -07001591
1592 // Reset target_sparse_limit after reboot to userspace fastboot. Max
1593 // download sizes may differ in bootloader and fastbootd.
1594 target_sparse_limit = -1;
David Anderson1d887432018-08-27 16:47:32 -07001595}
1596
David Andersonab8f4662019-10-21 16:45:59 -07001597static void CancelSnapshotIfNeeded() {
1598 std::string merge_status = "none";
1599 if (fb->GetVar(FB_VAR_SNAPSHOT_UPDATE_STATUS, &merge_status) == fastboot::SUCCESS &&
Elliott Hughes6a7ff582020-06-05 14:06:15 -07001600 !merge_status.empty() && merge_status != "none") {
Yifan Hong712c32b2019-12-10 18:11:13 -08001601 fb->SnapshotUpdateCommand("cancel");
David Andersonab8f4662019-10-21 16:45:59 -07001602 }
1603}
1604
David Andersoncf444f32018-08-29 14:15:49 -07001605class FlashAllTool {
1606 public:
Andrew Chantd64b9882021-04-06 12:48:27 -07001607 FlashAllTool(const ImageSource& source, const std::string& slot_override, bool skip_secondary,
1608 bool wipe, bool force_flash);
David Anderson32e376f2018-08-16 13:43:11 -07001609
David Andersoncf444f32018-08-29 14:15:49 -07001610 void Flash();
David Anderson32e376f2018-08-16 13:43:11 -07001611
David Andersoncf444f32018-08-29 14:15:49 -07001612 private:
1613 void CheckRequirements();
David Anderson667b1ef2023-01-27 21:11:11 -08001614 void DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001615 void CollectImages();
1616 void FlashImages(const std::vector<std::pair<const Image*, std::string>>& images);
1617 void FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf);
1618 void UpdateSuperPartition();
David Anderson667b1ef2023-01-27 21:11:11 -08001619 bool OptimizedFlashSuper();
1620
1621 // If the image uses the default slot, or the user specified "all", then
1622 // the paired string will be empty. If the image requests a specific slot
1623 // (for example, system_other) it is specified instead.
1624 using ImageEntry = std::pair<const Image*, std::string>;
1625
1626 std::string GetPartitionName(const ImageEntry& entry);
David Anderson32e376f2018-08-16 13:43:11 -07001627
David Andersoncf444f32018-08-29 14:15:49 -07001628 const ImageSource& source_;
1629 std::string slot_override_;
1630 bool skip_secondary_;
1631 bool wipe_;
Andrew Chantd64b9882021-04-06 12:48:27 -07001632 bool force_flash_;
David Anderson667b1ef2023-01-27 21:11:11 -08001633 std::string current_slot_;
David Andersoncf444f32018-08-29 14:15:49 -07001634 std::string secondary_slot_;
David Anderson667b1ef2023-01-27 21:11:11 -08001635
1636 std::vector<ImageEntry> boot_images_;
1637 std::vector<ImageEntry> os_images_;
David Andersoncf444f32018-08-29 14:15:49 -07001638};
1639
Andrew Chantd64b9882021-04-06 12:48:27 -07001640FlashAllTool::FlashAllTool(const ImageSource& source, const std::string& slot_override,
1641 bool skip_secondary, bool wipe, bool force_flash)
Daniel Zheng65452d02022-11-30 02:25:31 +00001642 : source_(source),
1643 slot_override_(slot_override),
1644 skip_secondary_(skip_secondary),
1645 wipe_(wipe),
1646 force_flash_(force_flash) {}
David Anderson32e376f2018-08-16 13:43:11 -07001647
David Andersoncf444f32018-08-29 14:15:49 -07001648void FlashAllTool::Flash() {
Tom Cherry9027af02018-09-24 15:48:09 -07001649 DumpInfo();
David Andersoncf444f32018-08-29 14:15:49 -07001650 CheckRequirements();
David Anderson96a9fd42018-11-05 15:21:44 -08001651
1652 // Change the slot first, so we boot into the correct recovery image when
1653 // using fastbootd.
1654 if (slot_override_ == "all") {
1655 set_active("a");
1656 } else {
1657 set_active(slot_override_);
1658 }
1659
David Anderson667b1ef2023-01-27 21:11:11 -08001660 DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001661 CollectImages();
David Anderson32e376f2018-08-16 13:43:11 -07001662
David Andersonab8f4662019-10-21 16:45:59 -07001663 CancelSnapshotIfNeeded();
1664
David Anderson95d40932018-08-28 12:14:33 -07001665 // First flash boot partitions. We allow this to happen either in userspace
1666 // or in bootloader fastboot.
David Andersoncf444f32018-08-29 14:15:49 -07001667 FlashImages(boot_images_);
David Anderson95d40932018-08-28 12:14:33 -07001668
David Anderson667b1ef2023-01-27 21:11:11 -08001669 if (!OptimizedFlashSuper()) {
1670 // Sync the super partition. This will reboot to userspace fastboot if needed.
1671 UpdateSuperPartition();
David Anderson95d40932018-08-28 12:14:33 -07001672
David Anderson667b1ef2023-01-27 21:11:11 -08001673 // Resize any logical partition to 0, so each partition is reset to 0
1674 // extents, and will achieve more optimal allocation.
1675 for (const auto& [image, slot] : os_images_) {
1676 auto resize_partition = [](const std::string& partition) -> void {
1677 if (is_logical(partition)) {
1678 fb->ResizePartition(partition, "0");
1679 }
1680 };
1681 do_for_partitions(image->part_name, slot, resize_partition, false);
1682 }
David Anderson32e376f2018-08-16 13:43:11 -07001683 }
1684
David Anderson95d40932018-08-28 12:14:33 -07001685 // Flash OS images, resizing logical partitions as needed.
David Andersoncf444f32018-08-29 14:15:49 -07001686 FlashImages(os_images_);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001687}
1688
David Anderson667b1ef2023-01-27 21:11:11 -08001689bool FlashAllTool::OptimizedFlashSuper() {
1690 if (!supports_AB()) {
1691 LOG(VERBOSE) << "Cannot optimize flashing super on non-AB device";
1692 return false;
1693 }
1694 if (slot_override_ == "all") {
1695 LOG(VERBOSE) << "Cannot optimize flashing super for all slots";
1696 return false;
1697 }
1698
1699 // Does this device use dynamic partitions at all?
1700 unique_fd fd = source_.OpenFile("super_empty.img");
1701 if (fd < 0) {
1702 LOG(VERBOSE) << "could not open super_empty.img";
1703 return false;
1704 }
1705
1706 // Try to find whether there is a super partition.
1707 std::string super_name;
1708 if (fb->GetVar("super-partition-name", &super_name) != fastboot::SUCCESS) {
1709 super_name = "super";
1710 }
1711 std::string partition_size_str;
1712 if (fb->GetVar("partition-size:" + super_name, &partition_size_str) != fastboot::SUCCESS) {
1713 LOG(VERBOSE) << "Cannot optimize super flashing: could not determine super partition";
1714 return false;
1715 }
1716
1717 SuperFlashHelper helper(source_);
1718 if (!helper.Open(fd)) {
1719 return false;
1720 }
1721
1722 for (const auto& entry : os_images_) {
1723 auto partition = GetPartitionName(entry);
1724 auto image = entry.first;
1725
1726 if (!helper.AddPartition(partition, image->img_name, image->optional_if_no_image)) {
1727 return false;
1728 }
1729 }
1730
1731 auto s = helper.GetSparseLayout();
1732 if (!s) {
1733 return false;
1734 }
1735
1736 std::vector<SparsePtr> files;
1737 if (int limit = get_sparse_limit(sparse_file_len(s.get(), false, false))) {
1738 files = resparse_file(s.get(), limit);
1739 } else {
1740 files.emplace_back(std::move(s));
1741 }
1742
1743 // Send the data to the device.
1744 flash_partition_files(super_name, files);
1745
1746 // Remove images that we already flashed, just in case we have non-dynamic OS images.
1747 auto remove_if_callback = [&, this](const ImageEntry& entry) -> bool {
1748 return helper.WillFlash(GetPartitionName(entry));
1749 };
1750 os_images_.erase(std::remove_if(os_images_.begin(), os_images_.end(), remove_if_callback),
1751 os_images_.end());
1752 return true;
1753}
1754
David Andersoncf444f32018-08-29 14:15:49 -07001755void FlashAllTool::CheckRequirements() {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001756 std::vector<char> contents;
1757 if (!source_.ReadFile("android-info.txt", &contents)) {
David Andersoncf444f32018-08-29 14:15:49 -07001758 die("could not read android-info.txt");
1759 }
Andrew Chantd64b9882021-04-06 12:48:27 -07001760 ::CheckRequirements({contents.data(), contents.size()}, force_flash_);
David Andersoncf444f32018-08-29 14:15:49 -07001761}
1762
David Anderson667b1ef2023-01-27 21:11:11 -08001763void FlashAllTool::DetermineSlot() {
1764 if (slot_override_.empty()) {
1765 current_slot_ = get_current_slot();
1766 } else {
1767 current_slot_ = slot_override_;
1768 }
1769
David Andersoncf444f32018-08-29 14:15:49 -07001770 if (skip_secondary_) {
1771 return;
1772 }
David Anderson96a9fd42018-11-05 15:21:44 -08001773 if (slot_override_ != "" && slot_override_ != "all") {
David Andersoncf444f32018-08-29 14:15:49 -07001774 secondary_slot_ = get_other_slot(slot_override_);
1775 } else {
1776 secondary_slot_ = get_other_slot();
1777 }
1778 if (secondary_slot_ == "") {
1779 if (supports_AB()) {
1780 fprintf(stderr, "Warning: Could not determine slot for secondary images. Ignoring.\n");
1781 }
1782 skip_secondary_ = true;
1783 }
1784}
1785
1786void FlashAllTool::CollectImages() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001787 for (size_t i = 0; i < images.size(); ++i) {
David Andersoncf444f32018-08-29 14:15:49 -07001788 std::string slot = slot_override_;
1789 if (images[i].IsSecondary()) {
1790 if (skip_secondary_) {
1791 continue;
1792 }
1793 slot = secondary_slot_;
1794 }
1795 if (images[i].type == ImageType::BootCritical) {
1796 boot_images_.emplace_back(&images[i], slot);
1797 } else if (images[i].type == ImageType::Normal) {
1798 os_images_.emplace_back(&images[i], slot);
1799 }
1800 }
1801}
1802
1803void FlashAllTool::FlashImages(const std::vector<std::pair<const Image*, std::string>>& images) {
1804 for (const auto& [image, slot] : images) {
1805 fastboot_buffer buf;
Yifan Hongb10d0672021-02-22 15:06:27 -08001806 unique_fd fd = source_.OpenFile(image->img_name);
1807 if (fd < 0 || !load_buf_fd(std::move(fd), &buf)) {
David Andersoncf444f32018-08-29 14:15:49 -07001808 if (image->optional_if_no_image) {
1809 continue;
1810 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001811 die("could not load '%s': %s", image->img_name.c_str(), strerror(errno));
David Andersoncf444f32018-08-29 14:15:49 -07001812 }
1813 FlashImage(*image, slot, &buf);
1814 }
1815}
1816
1817void FlashAllTool::FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf) {
1818 auto flash = [&, this](const std::string& partition_name) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001819 std::vector<char> signature_data;
1820 if (source_.ReadFile(image.sig_name, &signature_data)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001821 fb->Download("signature", signature_data);
1822 fb->RawCommand("signature", "installing signature");
David Andersoncf444f32018-08-29 14:15:49 -07001823 }
1824
1825 if (is_logical(partition_name)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001826 fb->ResizePartition(partition_name, std::to_string(buf->image_size));
David Andersoncf444f32018-08-29 14:15:49 -07001827 }
1828 flash_buf(partition_name.c_str(), buf);
1829 };
1830 do_for_partitions(image.part_name, slot, flash, false);
1831}
1832
1833void FlashAllTool::UpdateSuperPartition() {
Yifan Hong58532df2021-03-22 16:39:13 -07001834 unique_fd fd = source_.OpenFile("super_empty.img");
David Andersoncf444f32018-08-29 14:15:49 -07001835 if (fd < 0) {
1836 return;
1837 }
1838 if (!is_userspace_fastboot()) {
1839 reboot_to_userspace_fastboot();
1840 }
David Andersoncf444f32018-08-29 14:15:49 -07001841
David Anderson90fe0a42018-11-05 18:01:32 -08001842 std::string super_name;
1843 if (fb->GetVar("super-partition-name", &super_name) != fastboot::RetCode::SUCCESS) {
1844 super_name = "super";
1845 }
1846 fb->Download(super_name, fd, get_file_size(fd));
1847
1848 std::string command = "update-super:" + super_name;
David Andersoncf444f32018-08-29 14:15:49 -07001849 if (wipe_) {
1850 command += ":wipe";
1851 }
Tom Cherry9027af02018-09-24 15:48:09 -07001852 fb->RawCommand(command, "Updating super partition");
David Anderson0c732342018-11-28 17:10:42 -08001853
1854 // Retrofit devices have two super partitions, named super_a and super_b.
1855 // On these devices, secondary slots must be flashed as physical
1856 // partitions (otherwise they would not mount on first boot). To enforce
1857 // this, we delete any logical partitions for the "other" slot.
1858 if (is_retrofit_device()) {
1859 for (const auto& [image, slot] : os_images_) {
1860 std::string partition_name = image->part_name + "_"s + slot;
1861 if (image->IsSecondary() && is_logical(partition_name)) {
1862 fb->DeletePartition(partition_name);
1863 }
1864 }
1865 }
David Andersoncf444f32018-08-29 14:15:49 -07001866}
1867
David Anderson667b1ef2023-01-27 21:11:11 -08001868std::string FlashAllTool::GetPartitionName(const ImageEntry& entry) {
1869 auto slot = entry.second;
1870 if (slot.empty()) {
1871 slot = current_slot_;
1872 }
1873 if (slot.empty()) {
1874 return entry.first->part_name;
1875 }
1876 if (slot == "all") {
1877 LOG(FATAL) << "Cannot retrieve a singular name when using all slots";
1878 }
1879 return entry.first->part_name + "_" + slot;
1880}
1881
David Andersoncf444f32018-08-29 14:15:49 -07001882class ZipImageSource final : public ImageSource {
1883 public:
1884 explicit ZipImageSource(ZipArchiveHandle zip) : zip_(zip) {}
Tom Cherrydfd85df2018-09-20 14:45:05 -07001885 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001886 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001887
1888 private:
1889 ZipArchiveHandle zip_;
1890};
1891
Tom Cherrydfd85df2018-09-20 14:45:05 -07001892bool ZipImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1893 return UnzipToMemory(zip_, name, out);
David Andersoncf444f32018-08-29 14:15:49 -07001894}
1895
Yifan Hongb10d0672021-02-22 15:06:27 -08001896unique_fd ZipImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001897 return unzip_to_file(zip_, name.c_str());
1898}
1899
Andrew Chantd64b9882021-04-06 12:48:27 -07001900static void do_update(const char* filename, const std::string& slot_override, bool skip_secondary,
1901 bool force_flash) {
David Andersoncf444f32018-08-29 14:15:49 -07001902 ZipArchiveHandle zip;
1903 int error = OpenArchive(filename, &zip);
1904 if (error != 0) {
1905 die("failed to open zip file '%s': %s", filename, ErrorCodeString(error));
1906 }
1907
Andrew Chantd64b9882021-04-06 12:48:27 -07001908 FlashAllTool tool(ZipImageSource(zip), slot_override, skip_secondary, false, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001909 tool.Flash();
1910
1911 CloseArchive(zip);
1912}
1913
1914class LocalImageSource final : public ImageSource {
1915 public:
Tom Cherrydfd85df2018-09-20 14:45:05 -07001916 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001917 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001918};
1919
Tom Cherrydfd85df2018-09-20 14:45:05 -07001920bool LocalImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
David Andersoncf444f32018-08-29 14:15:49 -07001921 auto path = find_item_given_name(name);
1922 if (path.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001923 return false;
David Andersoncf444f32018-08-29 14:15:49 -07001924 }
Tom Cherrydfd85df2018-09-20 14:45:05 -07001925 return ReadFileToVector(path, out);
David Andersoncf444f32018-08-29 14:15:49 -07001926}
1927
Yifan Hongb10d0672021-02-22 15:06:27 -08001928unique_fd LocalImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001929 auto path = find_item_given_name(name);
Yifan Hongb10d0672021-02-22 15:06:27 -08001930 return unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
David Andersoncf444f32018-08-29 14:15:49 -07001931}
1932
Andrew Chantd64b9882021-04-06 12:48:27 -07001933static void do_flashall(const std::string& slot_override, bool skip_secondary, bool wipe,
1934 bool force_flash) {
1935 FlashAllTool tool(LocalImageSource(), slot_override, skip_secondary, wipe, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001936 tool.Flash();
1937}
1938
Elliott Hughesd6365a72017-05-08 18:04:49 -07001939static std::string next_arg(std::vector<std::string>* args) {
1940 if (args->empty()) syntax_error("expected argument");
1941 std::string result = args->front();
1942 args->erase(args->begin());
1943 return result;
Patrick Tjin51e8b032015-09-01 08:15:23 -07001944}
1945
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001946static void do_oem_command(const std::string& cmd, std::vector<std::string>* args) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07001947 if (args->empty()) syntax_error("empty oem command");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08001948
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001949 std::string command(cmd);
Elliott Hughesd6365a72017-05-08 18:04:49 -07001950 while (!args->empty()) {
Elliott Hughes29d5d7d2017-05-11 15:05:13 -07001951 command += " " + next_arg(args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001952 }
Tom Cherry9027af02018-09-24 15:48:09 -07001953 fb->RawCommand(command, "");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001954}
1955
Aaron Wisnerdb511202018-06-26 15:38:35 -05001956static unsigned fb_get_flash_block_size(std::string name) {
Connor O'Brience16a8a2017-02-06 14:39:31 -08001957 std::string sizeString;
Tom Cherry9027af02018-09-24 15:48:09 -07001958 if (fb->GetVar(name, &sizeString) != fastboot::SUCCESS || sizeString.empty()) {
Elliott Hughes5620d222018-03-28 08:20:00 -07001959 // This device does not report flash block sizes, so return 0.
Connor O'Brience16a8a2017-02-06 14:39:31 -08001960 return 0;
1961 }
1962 sizeString = fb_fix_numeric_var(sizeString);
1963
1964 unsigned size;
1965 if (!android::base::ParseUint(sizeString, &size)) {
1966 fprintf(stderr, "Couldn't parse %s '%s'.\n", name.c_str(), sizeString.c_str());
1967 return 0;
1968 }
Connor O'Brien6ef5c242017-11-01 17:37:32 -07001969 if ((size & (size - 1)) != 0) {
1970 fprintf(stderr, "Invalid %s %u: must be a power of 2.\n", name.c_str(), size);
Connor O'Brience16a8a2017-02-06 14:39:31 -08001971 return 0;
1972 }
1973 return size;
1974}
1975
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001976static void fb_perform_format(const std::string& partition, int skip_if_not_supported,
Elliott Hughesd6365a72017-05-08 18:04:49 -07001977 const std::string& type_override, const std::string& size_override,
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001978 const unsigned fs_options) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001979 std::string partition_type, partition_size;
1980
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001981 struct fastboot_buffer buf;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001982 const char* errMsg = nullptr;
1983 const struct fs_generator* gen = nullptr;
Jin Qian4a335822017-04-18 16:23:18 -07001984 TemporaryFile output;
1985 unique_fd fd;
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001986
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001987 unsigned int limit = INT_MAX;
1988 if (target_sparse_limit > 0 && target_sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001989 limit = target_sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001990 }
1991 if (sparse_limit > 0 && sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001992 limit = sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001993 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001994
Tom Cherry9027af02018-09-24 15:48:09 -07001995 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001996 errMsg = "Can't determine partition type.\n";
1997 goto failed;
1998 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001999 if (!type_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002000 if (partition_type != type_override) {
2001 fprintf(stderr, "Warning: %s type is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07002002 partition.c_str(), partition_type.c_str(), type_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07002003 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002004 partition_type = type_override;
JP Abgrall7e859742014-05-06 15:14:15 -07002005 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002006
Tom Cherry9027af02018-09-24 15:48:09 -07002007 if (fb->GetVar("partition-size:" + partition, &partition_size) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002008 errMsg = "Unable to get partition size\n";
2009 goto failed;
2010 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002011 if (!size_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002012 if (partition_size != size_override) {
2013 fprintf(stderr, "Warning: %s size is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07002014 partition.c_str(), partition_size.c_str(), size_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07002015 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002016 partition_size = size_override;
JP Abgrall7e859742014-05-06 15:14:15 -07002017 }
Connor O'Brience16a8a2017-02-06 14:39:31 -08002018 partition_size = fb_fix_numeric_var(partition_size);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002019
Elliott Hughes8ab9a322015-11-02 14:05:57 -08002020 gen = fs_get_generator(partition_type);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002021 if (!gen) {
2022 if (skip_if_not_supported) {
2023 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002024 fprintf(stderr, "File system type %s not supported.\n", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002025 return;
2026 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002027 die("Formatting is not supported for file system with type '%s'.", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002028 }
2029
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002030 int64_t size;
Elliott Hughesda46b392016-10-11 17:09:00 -07002031 if (!android::base::ParseInt(partition_size, &size)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002032 die("Couldn't parse partition size '%s'.", partition_size.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002033 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002034
Connor O'Brience16a8a2017-02-06 14:39:31 -08002035 unsigned eraseBlkSize, logicalBlkSize;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002036 eraseBlkSize = fb_get_flash_block_size("erase-block-size");
2037 logicalBlkSize = fb_get_flash_block_size("logical-block-size");
Connor O'Brience16a8a2017-02-06 14:39:31 -08002038
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002039 if (fs_generator_generate(gen, output.path, size, eraseBlkSize, logicalBlkSize, fs_options)) {
Elliott Hughes5620d222018-03-28 08:20:00 -07002040 die("Cannot generate image for %s", partition.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002041 }
2042
Jin Qian4a335822017-04-18 16:23:18 -07002043 fd.reset(open(output.path, O_RDONLY));
2044 if (fd == -1) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002045 die("Cannot open generated image: %s", strerror(errno));
Jin Qian4a335822017-04-18 16:23:18 -07002046 }
Yifan Hongb10d0672021-02-22 15:06:27 -08002047 if (!load_buf_fd(std::move(fd), &buf)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002048 die("Cannot read image: %s", strerror(errno));
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002049 }
2050 flash_buf(partition, &buf);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002051 return;
2052
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002053failed:
2054 if (skip_if_not_supported) {
2055 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002056 if (errMsg) fprintf(stderr, "%s", errMsg);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002057 }
Tom Cherry9027af02018-09-24 15:48:09 -07002058 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
Mark Salyzyna30b6962018-11-20 11:04:15 -08002059 if (!skip_if_not_supported) {
2060 die("Command failed");
2061 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002062}
2063
Daniel Zheng0d307182023-01-31 21:07:53 +00002064bool should_flash_in_userspace(const std::string& partition_name) {
David Andersone0e693c2018-11-27 20:19:26 -08002065 if (!get_android_product_out()) {
2066 return false;
2067 }
David Anderson89569642018-11-16 15:53:35 -08002068 auto path = find_item_given_name("super_empty.img");
David Anderson00475802018-12-04 17:05:47 -08002069 if (path.empty() || access(path.c_str(), R_OK)) {
David Anderson89569642018-11-16 15:53:35 -08002070 return false;
2071 }
2072 auto metadata = android::fs_mgr::ReadFromImageFile(path);
2073 if (!metadata) {
2074 return false;
2075 }
David Andersonaa87dc52023-01-27 20:39:06 -08002076 return should_flash_in_userspace(*metadata.get(), partition_name);
David Anderson89569642018-11-16 15:53:35 -08002077}
2078
David Anderson7c84b9f2019-06-27 22:15:29 -07002079static bool wipe_super(const android::fs_mgr::LpMetadata& metadata, const std::string& slot,
2080 std::string* message) {
2081 auto super_device = GetMetadataSuperBlockDevice(metadata);
2082 auto block_size = metadata.geometry.logical_block_size;
2083 auto super_bdev_name = android::fs_mgr::GetBlockDevicePartitionName(*super_device);
2084
2085 if (super_bdev_name != "super") {
2086 // retrofit devices do not allow flashing to the retrofit partitions,
2087 // so enable it if we can.
2088 fb->RawCommand("oem allow-flash-super");
2089 }
2090
2091 // Note: do not use die() in here, since we want TemporaryDir's destructor
2092 // to be called.
2093 TemporaryDir temp_dir;
2094
2095 bool ok;
2096 if (metadata.block_devices.size() > 1) {
2097 ok = WriteSplitImageFiles(temp_dir.path, metadata, block_size, {}, true);
2098 } else {
2099 auto image_path = temp_dir.path + "/"s + super_bdev_name + ".img";
2100 ok = WriteToImageFile(image_path, metadata, block_size, {}, true);
2101 }
2102 if (!ok) {
2103 *message = "Could not generate a flashable super image file";
2104 return false;
2105 }
2106
2107 for (const auto& block_device : metadata.block_devices) {
2108 auto partition = android::fs_mgr::GetBlockDevicePartitionName(block_device);
2109 bool force_slot = !!(block_device.flags & LP_BLOCK_DEVICE_SLOT_SUFFIXED);
2110
2111 std::string image_name;
2112 if (metadata.block_devices.size() > 1) {
2113 image_name = "super_" + partition + ".img";
2114 } else {
2115 image_name = partition + ".img";
2116 }
2117
2118 auto image_path = temp_dir.path + "/"s + image_name;
2119 auto flash = [&](const std::string& partition_name) {
2120 do_flash(partition_name.c_str(), image_path.c_str());
2121 };
2122 do_for_partitions(partition, slot, flash, force_slot);
2123
2124 unlink(image_path.c_str());
2125 }
2126 return true;
2127}
2128
2129static void do_wipe_super(const std::string& image, const std::string& slot_override) {
2130 if (access(image.c_str(), R_OK) != 0) {
2131 die("Could not read image: %s", image.c_str());
2132 }
2133 auto metadata = android::fs_mgr::ReadFromImageFile(image);
2134 if (!metadata) {
2135 die("Could not parse image: %s", image.c_str());
2136 }
2137
2138 auto slot = slot_override;
2139 if (slot.empty()) {
2140 slot = get_current_slot();
2141 }
2142
2143 std::string message;
2144 if (!wipe_super(*metadata.get(), slot, &message)) {
2145 die(message);
2146 }
2147}
2148
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002149static void FastbootLogger(android::base::LogId /* id */, android::base::LogSeverity severity,
David Andersona67fc322023-01-27 16:15:52 -08002150 const char* /* tag */, const char* /* file */, unsigned int /* line */,
2151 const char* message) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002152 switch (severity) {
2153 case android::base::INFO:
2154 fprintf(stdout, "%s\n", message);
2155 break;
2156 case android::base::ERROR:
2157 fprintf(stderr, "%s\n", message);
2158 break;
2159 default:
2160 verbose("%s\n", message);
2161 }
David Andersona67fc322023-01-27 16:15:52 -08002162}
2163
2164static void FastbootAborter(const char* message) {
2165 die("%s", message);
2166}
2167
Aaron Wisnerdb511202018-06-26 15:38:35 -05002168int FastBootTool::Main(int argc, char* argv[]) {
David Andersona67fc322023-01-27 16:15:52 -08002169 android::base::InitLogging(argv, FastbootLogger, FastbootAborter);
2170
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002171 bool wants_wipe = false;
Mitchell Wills31dce302016-09-26 10:26:21 -07002172 bool skip_reboot = false;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002173 bool wants_set_active = false;
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002174 bool skip_secondary = false;
David Anderson89569642018-11-16 15:53:35 -08002175 bool force_flash = false;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002176 unsigned fs_options = 0;
Florian BƤuerle27ded482014-11-24 11:29:34 +01002177 int longindex;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002178 std::string slot_override;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002179 std::string next_active;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002180
Elliott Hughes577e8b42018-04-05 16:12:47 -07002181 g_boot_img_hdr.kernel_addr = 0x00008000;
2182 g_boot_img_hdr.ramdisk_addr = 0x01000000;
2183 g_boot_img_hdr.second_addr = 0x00f00000;
2184 g_boot_img_hdr.tags_addr = 0x00000100;
2185 g_boot_img_hdr.page_size = 2048;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002186 g_boot_img_hdr.dtb_addr = 0x01100000;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002187
Daniel Zheng65452d02022-11-30 02:25:31 +00002188 const struct option longopts[] = {{"base", required_argument, 0, 0},
2189 {"cmdline", required_argument, 0, 0},
2190 {"disable-verification", no_argument, 0, 0},
2191 {"disable-verity", no_argument, 0, 0},
2192 {"force", no_argument, 0, 0},
2193 {"fs-options", required_argument, 0, 0},
2194 {"header-version", required_argument, 0, 0},
2195 {"help", no_argument, 0, 'h'},
2196 {"kernel-offset", required_argument, 0, 0},
2197 {"os-patch-level", required_argument, 0, 0},
2198 {"os-version", required_argument, 0, 0},
2199 {"page-size", required_argument, 0, 0},
2200 {"ramdisk-offset", required_argument, 0, 0},
2201 {"set-active", optional_argument, 0, 'a'},
2202 {"skip-reboot", no_argument, 0, 0},
2203 {"skip-secondary", no_argument, 0, 0},
2204 {"slot", required_argument, 0, 0},
2205 {"tags-offset", required_argument, 0, 0},
2206 {"dtb", required_argument, 0, 0},
2207 {"dtb-offset", required_argument, 0, 0},
2208 {"unbuffered", no_argument, 0, 0},
2209 {"verbose", no_argument, 0, 'v'},
2210 {"version", no_argument, 0, 0},
2211 {0, 0, 0, 0}};
Colin Cross8879f982012-05-22 17:53:34 -07002212
2213 serial = getenv("ANDROID_SERIAL");
2214
Elliott Hughes577e8b42018-04-05 16:12:47 -07002215 int c;
Elliott Hughesf3192bd2018-04-10 15:38:08 -07002216 while ((c = getopt_long(argc, argv, "a::hls:S:vw", longopts, &longindex)) != -1) {
Elliott Hughes577e8b42018-04-05 16:12:47 -07002217 if (c == 0) {
2218 std::string name{longopts[longindex].name};
2219 if (name == "base") {
2220 g_base_addr = strtoul(optarg, 0, 16);
2221 } else if (name == "cmdline") {
2222 g_cmdline = optarg;
2223 } else if (name == "disable-verification") {
2224 g_disable_verification = true;
2225 } else if (name == "disable-verity") {
2226 g_disable_verity = true;
David Anderson89569642018-11-16 15:53:35 -08002227 } else if (name == "force") {
2228 force_flash = true;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002229 } else if (name == "fs-options") {
2230 fs_options = ParseFsOption(optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002231 } else if (name == "header-version") {
2232 g_boot_img_hdr.header_version = strtoul(optarg, nullptr, 0);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002233 } else if (name == "dtb") {
2234 g_dtb_path = optarg;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002235 } else if (name == "kernel-offset") {
2236 g_boot_img_hdr.kernel_addr = strtoul(optarg, 0, 16);
2237 } else if (name == "os-patch-level") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002238 ParseOsPatchLevel(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002239 } else if (name == "os-version") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002240 ParseOsVersion(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002241 } else if (name == "page-size") {
2242 g_boot_img_hdr.page_size = strtoul(optarg, nullptr, 0);
2243 if (g_boot_img_hdr.page_size == 0) die("invalid page size");
2244 } else if (name == "ramdisk-offset") {
2245 g_boot_img_hdr.ramdisk_addr = strtoul(optarg, 0, 16);
2246 } else if (name == "skip-reboot") {
2247 skip_reboot = true;
2248 } else if (name == "skip-secondary") {
2249 skip_secondary = true;
2250 } else if (name == "slot") {
2251 slot_override = optarg;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002252 } else if (name == "dtb-offset") {
2253 g_boot_img_hdr.dtb_addr = strtoul(optarg, 0, 16);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002254 } else if (name == "tags-offset") {
2255 g_boot_img_hdr.tags_addr = strtoul(optarg, 0, 16);
2256 } else if (name == "unbuffered") {
Elliott Hughesfc797672015-04-07 20:12:50 -07002257 setvbuf(stdout, nullptr, _IONBF, 0);
2258 setvbuf(stderr, nullptr, _IONBF, 0);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002259 } else if (name == "version") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002260 fprintf(stdout, "fastboot version %s-%s\n", PLATFORM_TOOLS_VERSION,
2261 android::build::GetBuildNumber().c_str());
Elliott Hughes1fd46df2017-03-30 15:08:28 -07002262 fprintf(stdout, "Installed as %s\n", android::base::GetExecutablePath().c_str());
Elliott Hughes379646b2015-06-02 13:50:00 -07002263 return 0;
Paul Crowley8f7f56e2015-11-27 09:29:37 +00002264 } else {
Elliott Hughes855cdf82018-04-02 14:24:03 -07002265 die("unknown option %s", longopts[longindex].name);
Florian BƤuerle27ded482014-11-24 11:29:34 +01002266 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002267 } else {
2268 switch (c) {
2269 case 'a':
2270 wants_set_active = true;
2271 if (optarg) next_active = optarg;
2272 break;
2273 case 'h':
2274 return show_help();
Elliott Hughes577e8b42018-04-05 16:12:47 -07002275 case 'l':
2276 g_long_listing = true;
2277 break;
2278 case 's':
2279 serial = optarg;
2280 break;
2281 case 'S':
Elliott Hughes542370d2018-04-19 19:49:44 -07002282 if (!android::base::ParseByteCount(optarg, &sparse_limit)) {
2283 die("invalid sparse limit %s", optarg);
2284 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002285 break;
2286 case 'v':
2287 set_verbose();
2288 break;
2289 case 'w':
2290 wants_wipe = true;
2291 break;
2292 case '?':
2293 return 1;
2294 default:
2295 abort();
2296 }
Colin Cross8879f982012-05-22 17:53:34 -07002297 }
2298 }
2299
2300 argc -= optind;
2301 argv += optind;
2302
Elliott Hughesd6365a72017-05-08 18:04:49 -07002303 if (argc == 0 && !wants_wipe && !wants_set_active) syntax_error("no command");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002304
Colin Cross8fb6e062012-07-24 16:36:41 -07002305 if (argc > 0 && !strcmp(*argv, "devices")) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002306 list_devices();
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08002307 return 0;
2308 }
2309
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002310 if (argc > 0 && !strcmp(*argv, "connect")) {
2311 argc -= optind;
2312 argv += optind;
2313 return Connect(argc, argv);
2314 }
2315
2316 if (argc > 0 && !strcmp(*argv, "disconnect")) {
2317 argc -= optind;
2318 argv += optind;
2319 return Disconnect(argc, argv);
2320 }
2321
Colin Crossc7b75dc2012-08-29 18:17:06 -07002322 if (argc > 0 && !strcmp(*argv, "help")) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002323 return show_help();
Colin Crossc7b75dc2012-08-29 18:17:06 -07002324 }
2325
David Pursell0b156632015-10-30 11:22:01 -07002326 Transport* transport = open_device();
David Pursell2ec418a2016-01-20 08:32:08 -08002327 if (transport == nullptr) {
2328 return 1;
2329 }
Tom Cherry9027af02018-09-24 15:48:09 -07002330 fastboot::DriverCallbacks driver_callbacks = {
Daniel Zheng65452d02022-11-30 02:25:31 +00002331 .prolog = Status,
2332 .epilog = Epilog,
2333 .info = InfoMessage,
Raphael Herouart99097cc2022-12-30 11:51:54 +00002334 .text = TextMessage,
Tom Cherry9027af02018-09-24 15:48:09 -07002335 };
Raphael Herouart99097cc2022-12-30 11:51:54 +00002336
Tom Cherry9027af02018-09-24 15:48:09 -07002337 fastboot::FastBootDriver fastboot_driver(transport, driver_callbacks, false);
2338 fb = &fastboot_driver;
David Pursell2ec418a2016-01-20 08:32:08 -08002339
Elliott Hughes5620d222018-03-28 08:20:00 -07002340 const double start = now();
2341
Aaron Wisnerdb511202018-06-26 15:38:35 -05002342 if (slot_override != "") slot_override = verify_slot(slot_override);
2343 if (next_active != "") next_active = verify_slot(next_active, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002344
2345 if (wants_set_active) {
2346 if (next_active == "") {
2347 if (slot_override == "") {
Daniel Rosenberg13454092016-06-27 19:43:11 -07002348 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07002349 if (fb->GetVar("current-slot", &current_slot) == fastboot::SUCCESS) {
LuK1337dae48ef2020-04-06 14:38:58 +02002350 if (current_slot[0] == '_') current_slot.erase(0, 1);
Aaron Wisnerdb511202018-06-26 15:38:35 -05002351 next_active = verify_slot(current_slot, false);
Daniel Rosenberg13454092016-06-27 19:43:11 -07002352 } else {
2353 wants_set_active = false;
2354 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002355 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002356 next_active = verify_slot(slot_override, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002357 }
2358 }
2359 }
Daniel Zheng71b3b432023-01-30 17:43:00 +00002360 std::unique_ptr<Task> reboot_task = nullptr;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002361 std::vector<std::string> args(argv, argv + argc);
2362 while (!args.empty()) {
2363 std::string command = next_arg(&args);
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002364
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002365 if (command == FB_CMD_GETVAR) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002366 std::string variable = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002367 DisplayVarOrError(variable, variable);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002368 } else if (command == FB_CMD_ERASE) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002369 std::string partition = next_arg(&args);
2370 auto erase = [&](const std::string& partition) {
David Pursell0b156632015-10-30 11:22:01 -07002371 std::string partition_type;
Daniel Zheng65452d02022-11-30 02:25:31 +00002372 if (fb->GetVar("partition-type:" + partition, &partition_type) ==
2373 fastboot::SUCCESS &&
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002374 fs_get_generator(partition_type) != nullptr) {
2375 fprintf(stderr, "******** Did you mean to fastboot format this %s partition?\n",
2376 partition_type.c_str());
2377 }
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002378
Tom Cherry9027af02018-09-24 15:48:09 -07002379 fb->Erase(partition);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002380 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002381 do_for_partitions(partition, slot_override, erase, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002382 } else if (android::base::StartsWith(command, "format")) {
2383 // Parsing for: "format[:[type][:[size]]]"
2384 // Some valid things:
2385 // - select only the size, and leave default fs type:
2386 // format::0x4000000 userdata
2387 // - default fs type and size:
2388 // format userdata
2389 // format:: userdata
2390 std::vector<std::string> pieces = android::base::Split(command, ":");
2391 std::string type_override;
2392 if (pieces.size() > 1) type_override = pieces[1].c_str();
2393 std::string size_override;
2394 if (pieces.size() > 2) size_override = pieces[2].c_str();
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002395
Elliott Hughesd6365a72017-05-08 18:04:49 -07002396 std::string partition = next_arg(&args);
2397
2398 auto format = [&](const std::string& partition) {
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002399 fb_perform_format(partition, 0, type_override, size_override, fs_options);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002400 };
Greg Kaiserb49d9e12019-03-26 12:04:05 -07002401 do_for_partitions(partition, slot_override, format, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002402 } else if (command == "signature") {
2403 std::string filename = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002404 std::vector<char> data;
2405 if (!ReadFileToVector(filename, &data)) {
2406 die("could not load '%s': %s", filename.c_str(), strerror(errno));
2407 }
2408 if (data.size() != 256) die("signature must be 256 bytes (got %zu)", data.size());
Tom Cherry9027af02018-09-24 15:48:09 -07002409 fb->Download("signature", data);
2410 fb->RawCommand("signature", "installing signature");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002411 } else if (command == FB_CMD_REBOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002412 if (args.size() == 1) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002413 std::string reboot_target = next_arg(&args);
2414 reboot_task = std::make_unique<RebootTask>(fb, reboot_target);
2415 } else {
2416 reboot_task = std::make_unique<RebootTask>(fb);
Elliott Hughesca85df02015-02-25 10:02:00 -08002417 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002418 if (!args.empty()) syntax_error("junk after reboot command");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002419 } else if (command == FB_CMD_REBOOT_BOOTLOADER) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002420 reboot_task = std::make_unique<RebootTask>(fb, "bootloader");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002421 } else if (command == FB_CMD_REBOOT_RECOVERY) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002422 reboot_task = std::make_unique<RebootTask>(fb, "recovery");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002423 } else if (command == FB_CMD_REBOOT_FASTBOOT) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002424 reboot_task = std::make_unique<RebootTask>(fb, "fastboot");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002425 } else if (command == FB_CMD_CONTINUE) {
Tom Cherry9027af02018-09-24 15:48:09 -07002426 fb->Continue();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002427 } else if (command == FB_CMD_BOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002428 std::string kernel = next_arg(&args);
2429 std::string ramdisk;
2430 if (!args.empty()) ramdisk = next_arg(&args);
2431 std::string second_stage;
2432 if (!args.empty()) second_stage = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002433 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
Tom Cherry9027af02018-09-24 15:48:09 -07002434 fb->Download("boot.img", data);
2435 fb->Boot();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002436 } else if (command == FB_CMD_FLASH) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002437 std::string pname = next_arg(&args);
Elliott Hughes2810d002016-04-25 14:31:18 -07002438 std::string fname;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002439 if (!args.empty()) {
2440 fname = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002441 } else {
Elliott Hughes45964a82017-05-03 22:43:23 -07002442 fname = find_item(pname);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002443 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002444 if (fname.empty()) die("cannot determine image filename for '%s'", pname.c_str());
Daniel Zheng0d307182023-01-31 21:07:53 +00002445 FlashTask task(slot_override, force_flash, pname, fname);
2446 task.Run();
Elliott Hughesd6365a72017-05-08 18:04:49 -07002447 } else if (command == "flash:raw") {
2448 std::string partition = next_arg(&args);
2449 std::string kernel = next_arg(&args);
2450 std::string ramdisk;
2451 if (!args.empty()) ramdisk = next_arg(&args);
2452 std::string second_stage;
2453 if (!args.empty()) second_stage = next_arg(&args);
2454
Tom Cherrydfd85df2018-09-20 14:45:05 -07002455 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2456 auto flashraw = [&data](const std::string& partition) {
Tom Cherry9027af02018-09-24 15:48:09 -07002457 fb->FlashPartition(partition, data);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002458 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002459 do_for_partitions(partition, slot_override, flashraw, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002460 } else if (command == "flashall") {
Alex Lightbb9b8a52016-06-29 09:26:44 -07002461 if (slot_override == "all") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002462 fprintf(stderr,
2463 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Andrew Chantd64b9882021-04-06 12:48:27 -07002464 do_flashall(slot_override, true, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002465 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -07002466 do_flashall(slot_override, skip_secondary, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002467 }
Daniel Zheng71b3b432023-01-30 17:43:00 +00002468 reboot_task = std::make_unique<RebootTask>(fb);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002469 } else if (command == "update") {
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002470 bool slot_all = (slot_override == "all");
2471 if (slot_all) {
Daniel Zheng65452d02022-11-30 02:25:31 +00002472 fprintf(stderr,
2473 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002474 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002475 std::string filename = "update.zip";
2476 if (!args.empty()) {
2477 filename = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002478 }
Andrew Chantd64b9882021-04-06 12:48:27 -07002479 do_update(filename.c_str(), slot_override, skip_secondary || slot_all, force_flash);
Daniel Zheng71b3b432023-01-30 17:43:00 +00002480 reboot_task = std::make_unique<RebootTask>(fb);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002481 } else if (command == FB_CMD_SET_ACTIVE) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002482 std::string slot = verify_slot(next_arg(&args), false);
Tom Cherry9027af02018-09-24 15:48:09 -07002483 fb->SetActive(slot);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002484 } else if (command == "stage") {
2485 std::string filename = next_arg(&args);
2486
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002487 struct fastboot_buffer buf;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002488 if (!load_buf(filename.c_str(), &buf) || buf.type != FB_BUFFER_FD) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002489 die("cannot load '%s'", filename.c_str());
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002490 }
Yifan Hong58532df2021-03-22 16:39:13 -07002491 fb->Download(filename, buf.fd.get(), buf.sz);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002492 } else if (command == "get_staged") {
2493 std::string filename = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002494 fb->Upload(filename);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002495 } else if (command == FB_CMD_OEM) {
2496 do_oem_command(FB_CMD_OEM, &args);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002497 } else if (command == "flashing") {
2498 if (args.empty()) {
2499 syntax_error("missing 'flashing' command");
Daniel Zheng65452d02022-11-30 02:25:31 +00002500 } else if (args.size() == 1 &&
2501 (args[0] == "unlock" || args[0] == "lock" || args[0] == "unlock_critical" ||
2502 args[0] == "lock_critical" || args[0] == "get_unlock_ability")) {
Elliott Hughes1eec97a2017-05-15 16:53:53 -07002503 do_oem_command("flashing", &args);
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002504 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002505 syntax_error("unknown 'flashing' command %s", args[0].c_str());
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002506 }
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002507 } else if (command == FB_CMD_CREATE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002508 std::string partition = next_arg(&args);
2509 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002510 fb->CreatePartition(partition, size);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002511 } else if (command == FB_CMD_DELETE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002512 std::string partition = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002513 fb->DeletePartition(partition);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002514 } else if (command == FB_CMD_RESIZE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002515 std::string partition = next_arg(&args);
2516 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002517 fb->ResizePartition(partition, size);
David Anderson1d504e32019-01-15 14:38:20 -08002518 } else if (command == "gsi") {
David Anderson3d782d52019-01-29 13:09:49 -08002519 std::string arg = next_arg(&args);
2520 if (arg == "wipe") {
David Anderson1d504e32019-01-15 14:38:20 -08002521 fb->RawCommand("gsi:wipe", "wiping GSI");
David Anderson3d782d52019-01-29 13:09:49 -08002522 } else if (arg == "disable") {
David Anderson1d504e32019-01-15 14:38:20 -08002523 fb->RawCommand("gsi:disable", "disabling GSI");
2524 } else {
2525 syntax_error("expected 'wipe' or 'disable'");
2526 }
David Anderson7c84b9f2019-06-27 22:15:29 -07002527 } else if (command == "wipe-super") {
2528 std::string image;
2529 if (args.empty()) {
2530 image = find_item_given_name("super_empty.img");
2531 } else {
2532 image = next_arg(&args);
2533 }
2534 do_wipe_super(image, slot_override);
David Andersonab8f4662019-10-21 16:45:59 -07002535 } else if (command == "snapshot-update") {
2536 std::string arg;
2537 if (!args.empty()) {
2538 arg = next_arg(&args);
2539 }
David Anderson220ddb12019-10-31 18:02:41 -07002540 if (!arg.empty() && (arg != "cancel" && arg != "merge")) {
2541 syntax_error("expected: snapshot-update [cancel|merge]");
David Andersonab8f4662019-10-21 16:45:59 -07002542 }
2543 fb->SnapshotUpdateCommand(arg);
Yifan Hongbcd27702021-02-16 19:37:32 -08002544 } else if (command == FB_CMD_FETCH) {
2545 std::string partition = next_arg(&args);
2546 std::string outfile = next_arg(&args);
2547 do_fetch(partition, slot_override, outfile);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002548 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002549 syntax_error("unknown command %s", command.c_str());
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002550 }
2551 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002552 if (wants_wipe) {
David Andersonab8f4662019-10-21 16:45:59 -07002553 if (force_flash) {
2554 CancelSnapshotIfNeeded();
2555 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002556 std::vector<std::string> partitions = {"userdata", "cache", "metadata"};
Paul Crowley4d170062018-04-24 17:06:30 -07002557 for (const auto& partition : partitions) {
2558 std::string partition_type;
Tom Cherry9027af02018-09-24 15:48:09 -07002559 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
2560 continue;
2561 }
Paul Crowley4d170062018-04-24 17:06:30 -07002562 if (partition_type.empty()) continue;
Tom Cherry9027af02018-09-24 15:48:09 -07002563 fb->Erase(partition);
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002564 fb_perform_format(partition, 1, partition_type, "", fs_options);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002565 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002566 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002567 if (wants_set_active) {
Tom Cherry9027af02018-09-24 15:48:09 -07002568 fb->SetActive(next_active);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002569 }
Daniel Zheng71b3b432023-01-30 17:43:00 +00002570 if (reboot_task && !skip_reboot) {
2571 reboot_task->Run();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002572 }
Elliott Hughes5620d222018-03-28 08:20:00 -07002573 fprintf(stderr, "Finished. Total time: %.3fs\n", (now() - start));
David Anderson03de6452018-09-04 14:32:54 -07002574
Tom Cherry9027af02018-09-24 15:48:09 -07002575 auto* old_transport = fb->set_transport(nullptr);
2576 delete old_transport;
2577
Tom Cherry11f12092018-08-29 21:36:28 -07002578 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002579}
Elliott Hughes6ebec932018-04-10 14:22:13 -07002580
Aaron Wisnerdb511202018-06-26 15:38:35 -05002581void FastBootTool::ParseOsPatchLevel(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002582 unsigned year, month, day;
2583 if (sscanf(arg, "%u-%u-%u", &year, &month, &day) != 3) {
2584 syntax_error("OS patch level should be YYYY-MM-DD: %s", arg);
2585 }
2586 if (year < 2000 || year >= 2128) syntax_error("year out of range: %d", year);
2587 if (month < 1 || month > 12) syntax_error("month out of range: %d", month);
2588 hdr->SetOsPatchLevel(year, month);
2589}
2590
Aaron Wisnerdb511202018-06-26 15:38:35 -05002591void FastBootTool::ParseOsVersion(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002592 unsigned major = 0, minor = 0, patch = 0;
2593 std::vector<std::string> versions = android::base::Split(arg, ".");
2594 if (versions.size() < 1 || versions.size() > 3 ||
2595 (versions.size() >= 1 && !android::base::ParseUint(versions[0], &major)) ||
2596 (versions.size() >= 2 && !android::base::ParseUint(versions[1], &minor)) ||
2597 (versions.size() == 3 && !android::base::ParseUint(versions[2], &patch)) ||
2598 (major > 0x7f || minor > 0x7f || patch > 0x7f)) {
2599 syntax_error("bad OS version: %s", arg);
2600 }
2601 hdr->SetOsVersion(major, minor, patch);
2602}
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002603
2604unsigned FastBootTool::ParseFsOption(const char* arg) {
2605 unsigned fsOptions = 0;
2606
2607 std::vector<std::string> options = android::base::Split(arg, ",");
Daniel Zheng65452d02022-11-30 02:25:31 +00002608 if (options.size() < 1) syntax_error("bad options: %s", arg);
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002609
2610 for (size_t i = 0; i < options.size(); ++i) {
2611 if (options[i] == "casefold")
2612 fsOptions |= (1 << FS_OPT_CASEFOLD);
2613 else if (options[i] == "projid")
2614 fsOptions |= (1 << FS_OPT_PROJID);
2615 else if (options[i] == "compress")
2616 fsOptions |= (1 << FS_OPT_COMPRESS);
2617 else
2618 syntax_error("unsupported options: %s", options[i].c_str());
2619 }
2620 return fsOptions;
2621}