blob: 799c9f9111e760faeda0ee0439721cedbf78f804 [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
345static Result<NetworkSerial> ParseNetworkSerial(const std::string& serial) {
346 const auto serial_parsed = android::base::Tokenize(serial, ":");
347 const auto parsed_segments_count = serial_parsed.size();
348 if (parsed_segments_count != 2 && parsed_segments_count != 3) {
349 return Error() << "invalid network address: " << serial << ". Expected format:\n"
350 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
351 }
352
353 Socket::Protocol protocol;
354 if (serial_parsed[0] == "tcp") {
355 protocol = Socket::Protocol::kTcp;
356 } else if (serial_parsed[0] == "udp") {
357 protocol = Socket::Protocol::kUdp;
358 } else {
359 return Error() << "invalid network address: " << serial << ". Expected format:\n"
360 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
361 }
362
363 int port = 5554;
364 if (parsed_segments_count == 3) {
365 android::base::ParseInt(serial_parsed[2], &port, 5554);
366 }
367
368 return NetworkSerial{protocol, serial_parsed[1], port};
369}
370
371// Opens a new Transport connected to the particular device.
372// arguments:
David Pursell2ec418a2016-01-20 08:32:08 -0800373//
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000374// local_serial - device to connect (can be a network or usb serial name)
375// wait_for_device - flag indicates whether we need to wait for device
376// announce - flag indicates whether we need to print error to stdout in case
377// we cannot connect to the device
David Pursell2ec418a2016-01-20 08:32:08 -0800378//
379// The returned Transport is a singleton, so multiple calls to this function will return the same
380// object, and the caller should not attempt to delete the returned Transport.
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000381static Transport* open_device(const char* local_serial, bool wait_for_device = true,
382 bool announce = true) {
383 const Result<NetworkSerial> network_serial = ParseNetworkSerial(local_serial);
David Pursell2ec418a2016-01-20 08:32:08 -0800384
David Anderson1d887432018-08-27 16:47:32 -0700385 Transport* transport = nullptr;
David Pursell2ec418a2016-01-20 08:32:08 -0800386 while (true) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000387 if (network_serial.ok()) {
David Pursell2ec418a2016-01-20 08:32:08 -0800388 std::string error;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000389 if (network_serial->protocol == Socket::Protocol::kTcp) {
390 transport = tcp::Connect(network_serial->address, network_serial->port, &error)
391 .release();
392 } else if (network_serial->protocol == Socket::Protocol::kUdp) {
393 transport = udp::Connect(network_serial->address, network_serial->port, &error)
394 .release();
David Pursell4601c972016-02-05 15:35:09 -0800395 }
396
David Pursell2ec418a2016-01-20 08:32:08 -0800397 if (transport == nullptr && announce) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000398 LOG(ERROR) << "error: " << error;
David Pursell2ec418a2016-01-20 08:32:08 -0800399 }
400 } else {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000401 transport = usb_open(match_fastboot(local_serial));
David Pursell2ec418a2016-01-20 08:32:08 -0800402 }
403
404 if (transport != nullptr) {
405 return transport;
406 }
407
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000408 if (!wait_for_device) {
409 return nullptr;
410 }
411
David Pursell0b156632015-10-30 11:22:01 -0700412 if (announce) {
David Pursell2ec418a2016-01-20 08:32:08 -0800413 announce = false;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000414 LOG(ERROR) << "< waiting for " << local_serial << ">";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800415 }
Elliott Hughes290a2282016-11-14 17:08:47 -0800416 std::this_thread::sleep_for(std::chrono::milliseconds(1));
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800417 }
418}
419
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000420static Transport* NetworkDeviceConnected(bool print = false) {
421 Transport* transport = nullptr;
422 Transport* result = nullptr;
423
424 ConnectedDevicesStorage storage;
425 std::set<std::string> devices;
426 {
427 FileLock lock = storage.Lock();
428 devices = storage.ReadDevices(lock);
429 }
430
431 for (const std::string& device : devices) {
432 transport = open_device(device.c_str(), false, false);
433
434 if (print) {
Dmitrii Merkurevc48cd9f2023-02-15 15:34:58 +0000435 PrintDevice(device.c_str(), transport == nullptr ? "offline" : "fastboot");
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000436 }
437
438 if (transport != nullptr) {
439 result = transport;
440 }
441 }
442
443 return result;
444}
445
446// Detects the fastboot connected device to open a new Transport.
447// Detecting logic:
448//
449// if serial is provided - try to connect to this particular usb/network device
450// othervise:
451// 1. Check connected usb devices and return the last connected one
452// 2. Check connected network devices and return the last connected one
453// 2. If nothing is connected - wait for any device by repeating p. 1 and 2
454//
455// The returned Transport is a singleton, so multiple calls to this function will return the same
456// object, and the caller should not attempt to delete the returned Transport.
457static Transport* open_device() {
458 if (serial != nullptr) {
459 return open_device(serial);
460 }
461
462 bool announce = true;
463 Transport* transport = nullptr;
464 while (true) {
465 transport = usb_open(match_fastboot(nullptr));
466 if (transport != nullptr) {
467 return transport;
468 }
469
470 transport = NetworkDeviceConnected();
471 if (transport != nullptr) {
472 return transport;
473 }
474
475 if (announce) {
476 announce = false;
477 LOG(ERROR) << "< waiting for any device >";
478 }
479 std::this_thread::sleep_for(std::chrono::milliseconds(1));
480 }
481}
482
483static int Connect(int argc, char* argv[]) {
484 if (argc != 1) {
485 LOG(FATAL) << "connect command requires to receive only 1 argument. Usage:" << std::endl
486 << "fastboot connect [tcp:|udp:host:port]";
487 }
488
489 const char* local_serial = *argv;
490 EXPECT(ParseNetworkSerial(local_serial));
491
492 const Transport* transport = open_device(local_serial, false);
493 if (transport == nullptr) {
494 return 1;
495 }
496
497 ConnectedDevicesStorage storage;
498 {
499 FileLock lock = storage.Lock();
500 std::set<std::string> devices = storage.ReadDevices(lock);
501 devices.insert(local_serial);
502 storage.WriteDevices(lock, devices);
503 }
504
505 return 0;
506}
507
508static int Disconnect(const char* local_serial) {
509 EXPECT(ParseNetworkSerial(local_serial));
510
511 ConnectedDevicesStorage storage;
512 {
513 FileLock lock = storage.Lock();
514 std::set<std::string> devices = storage.ReadDevices(lock);
515 devices.erase(local_serial);
516 storage.WriteDevices(lock, devices);
517 }
518
519 return 0;
520}
521
522static int Disconnect() {
523 ConnectedDevicesStorage storage;
524 {
525 FileLock lock = storage.Lock();
526 storage.Clear(lock);
527 }
528
529 return 0;
530}
531
532static int Disconnect(int argc, char* argv[]) {
533 switch (argc) {
534 case 0: {
535 return Disconnect();
536 }
537 case 1: {
538 return Disconnect(*argv);
539 }
540 default:
541 LOG(FATAL) << "disconnect command can receive only 0 or 1 arguments. Usage:"
542 << std::endl
543 << "fastboot disconnect # disconnect all devices" << std::endl
544 << "fastboot disconnect [tcp:|udp:host:port] # disconnect device";
545 }
546
547 return 0;
548}
549
Elliott Hughesfc797672015-04-07 20:12:50 -0700550static void list_devices() {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800551 // We don't actually open a USB device here,
552 // just getting our callback called so we can
553 // list all the connected devices.
554 usb_open(list_devices_callback);
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000555 NetworkDeviceConnected(/* print */ true);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800556}
Daniel Zheng0d307182023-01-31 21:07:53 +0000557void syntax_error(const char* fmt, ...) {
Elliott Hughesd6365a72017-05-08 18:04:49 -0700558 fprintf(stderr, "fastboot: usage: ");
559
560 va_list ap;
561 va_start(ap, fmt);
562 vfprintf(stderr, fmt, ap);
563 va_end(ap);
564
565 fprintf(stderr, "\n");
566 exit(1);
567}
568
569static int show_help() {
570 // clang-format off
571 fprintf(stdout,
Elliott Hughes07fc6822018-05-24 16:36:05 -0700572// 1 2 3 4 5 6 7 8
573// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
Elliott Hughesb76188f2018-04-03 13:30:18 -0700574 "usage: fastboot [OPTION...] COMMAND...\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800575 "\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700576 "flashing:\n"
577 " update ZIP Flash all partitions from an update.zip package.\n"
578 " flashall Flash all partitions from $ANDROID_PRODUCT_OUT.\n"
579 " On A/B devices, flashed slot is set as active.\n"
580 " Secondary images may be flashed to inactive slot.\n"
Elliott Hughes07fc6822018-05-24 16:36:05 -0700581 " flash PARTITION [FILENAME] Flash given partition, using the image from\n"
582 " $ANDROID_PRODUCT_OUT if no filename is given.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700583 "\n"
584 "basics:\n"
585 " devices [-l] List devices in bootloader (-l: with device paths).\n"
586 " getvar NAME Display given bootloader variable.\n"
587 " reboot [bootloader] Reboot device.\n"
588 "\n"
589 "locking/unlocking:\n"
590 " flashing lock|unlock Lock/unlock partitions for flashing\n"
591 " flashing lock_critical|unlock_critical\n"
592 " Lock/unlock 'critical' bootloader partitions.\n"
593 " flashing get_unlock_ability\n"
594 " Check whether unlocking is allowed (1) or not(0).\n"
595 "\n"
596 "advanced:\n"
597 " erase PARTITION Erase a flash partition.\n"
598 " format[:FS_TYPE[:SIZE]] PARTITION\n"
599 " Format a flash partition.\n"
600 " set_active SLOT Set the active slot.\n"
601 " oem [COMMAND...] Execute OEM-specific command.\n"
David Anderson1d504e32019-01-15 14:38:20 -0800602 " gsi wipe|disable Wipe or disable a GSI installation (fastbootd only).\n"
David Anderson7c84b9f2019-06-27 22:15:29 -0700603 " wipe-super [SUPER_EMPTY] Wipe the super partition. This will reset it to\n"
604 " contain an empty set of default dynamic partitions.\n"
Luca Stefani173667b2021-04-12 19:16:43 +0200605 " create-logical-partition NAME SIZE\n"
606 " Create a logical partition with the given name and\n"
607 " size, in the super partition.\n"
608 " delete-logical-partition NAME\n"
609 " Delete a logical partition with the given name.\n"
610 " resize-logical-partition NAME SIZE\n"
611 " Change the size of the named logical partition.\n"
David Andersonab8f4662019-10-21 16:45:59 -0700612 " snapshot-update cancel On devices that support snapshot-based updates, cancel\n"
613 " an in-progress update. This may make the device\n"
614 " unbootable until it is reflashed.\n"
David Anderson220ddb12019-10-31 18:02:41 -0700615 " snapshot-update merge On devices that support snapshot-based updates, finish\n"
616 " an in-progress update if it is in the \"merging\"\n"
617 " phase.\n"
Pierre-ClƩment Tosi96941a02021-06-14 12:16:06 +0000618 " fetch PARTITION OUT_FILE Fetch a partition image from the device."
Elliott Hughesb76188f2018-04-03 13:30:18 -0700619 "\n"
620 "boot image:\n"
621 " boot KERNEL [RAMDISK [SECOND]]\n"
622 " Download and boot kernel from RAM.\n"
623 " flash:raw PARTITION KERNEL [RAMDISK [SECOND]]\n"
624 " Create boot image and flash it.\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800625 " --dtb DTB Specify path to DTB for boot image header version 2.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700626 " --cmdline CMDLINE Override kernel command line.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700627 " --base ADDRESS Set kernel base address (default: 0x10000000).\n"
628 " --kernel-offset Set kernel offset (default: 0x00008000).\n"
629 " --ramdisk-offset Set ramdisk offset (default: 0x01000000).\n"
630 " --tags-offset Set tags offset (default: 0x00000100).\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800631 " --dtb-offset Set dtb offset (default: 0x01100000).\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700632 " --page-size BYTES Set flash page size (default: 2048).\n"
633 " --header-version VERSION Set boot image header version.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700634 " --os-version MAJOR[.MINOR[.PATCH]]\n"
635 " Set boot image OS version (default: 0.0.0).\n"
636 " --os-patch-level YYYY-MM-DD\n"
637 " Set boot image OS security patch level.\n"
638 // TODO: still missing: `second_addr`, `name`, `id`, `recovery_dtbo_*`.
Elliott Hughesb76188f2018-04-03 13:30:18 -0700639 "\n"
Elliott Hughes2e9b7792018-04-04 13:36:44 -0700640 // TODO: what device(s) used this? is there any documentation?
Elliott Hughesb76188f2018-04-03 13:30:18 -0700641 //" continue Continue with autoboot.\n"
642 //"\n"
643 "Android Things:\n"
644 " stage IN_FILE Sends given file to stage for the next command.\n"
645 " 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 -0800646 "\n"
647 "options:\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700648 " -w Wipe userdata.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700649 " -s SERIAL Specify a USB device.\n"
650 " -s tcp|udp:HOST[:PORT] Specify a network device.\n"
Elliott Hughes542370d2018-04-19 19:49:44 -0700651 " -S SIZE[K|M|G] Break into sparse files no larger than SIZE.\n"
David Anderson89569642018-11-16 15:53:35 -0800652 " --force Force a flash operation that may be unsafe.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700653 " --slot SLOT Use SLOT; 'all' for both slots, 'other' for\n"
654 " non-current slot (default: current active slot).\n"
655 " --set-active[=SLOT] Sets the active slot before rebooting.\n"
656 " --skip-secondary Don't flash secondary slots in flashall/update.\n"
657 " --skip-reboot Don't reboot device after flashing.\n"
658 " --disable-verity Sets disable-verity when flashing vbmeta.\n"
659 " --disable-verification Sets disable-verification when flashing vbmeta.\n"
Jaegeuk Kim638d05e2020-11-09 08:54:13 -0800660 " --fs-options=OPTION[,OPTION]\n"
661 " Enable filesystem features. OPTION supports casefold, projid, compress\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700662 // TODO: remove --unbuffered?
663 " --unbuffered Don't buffer input or output.\n"
664 " --verbose, -v Verbose output.\n"
665 " --version Display version.\n"
666 " --help, -h Show this message.\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800667 );
Yifan Hongbcd27702021-02-16 19:37:32 -0800668 // clang-format on
Elliott Hughesd6365a72017-05-08 18:04:49 -0700669 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800670}
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000671
Tom Cherrydfd85df2018-09-20 14:45:05 -0700672static std::vector<char> LoadBootableImage(const std::string& kernel, const std::string& ramdisk,
673 const std::string& second_stage) {
674 std::vector<char> kernel_data;
675 if (!ReadFileToVector(kernel, &kernel_data)) {
676 die("cannot load '%s': %s", kernel.c_str(), strerror(errno));
677 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800678
Elliott Hughesfc797672015-04-07 20:12:50 -0700679 // Is this actually a boot image?
Steve Muckle15303f22020-03-18 14:55:06 -0700680 if (kernel_data.size() < sizeof(boot_img_hdr_v3)) {
Elliott Hughesaaa3b6b2018-01-18 16:08:24 -0800681 die("cannot load '%s': too short", kernel.c_str());
682 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700683 if (!memcmp(kernel_data.data(), BOOT_MAGIC, BOOT_MAGIC_SIZE)) {
Elliott Hughes577e8b42018-04-05 16:12:47 -0700684 if (!g_cmdline.empty()) {
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800685 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(kernel_data.data()), g_cmdline);
Elliott Hughes577e8b42018-04-05 16:12:47 -0700686 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800687
Elliott Hughes4089d342017-10-27 14:21:12 -0700688 if (!ramdisk.empty()) die("cannot boot a boot.img *and* ramdisk");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800689
Tom Cherrydfd85df2018-09-20 14:45:05 -0700690 return kernel_data;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800691 }
692
Tom Cherrydfd85df2018-09-20 14:45:05 -0700693 std::vector<char> ramdisk_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700694 if (!ramdisk.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700695 if (!ReadFileToVector(ramdisk, &ramdisk_data)) {
696 die("cannot load '%s': %s", ramdisk.c_str(), strerror(errno));
697 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800698 }
699
Tom Cherrydfd85df2018-09-20 14:45:05 -0700700 std::vector<char> second_stage_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700701 if (!second_stage.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700702 if (!ReadFileToVector(second_stage, &second_stage_data)) {
703 die("cannot load '%s': %s", second_stage.c_str(), strerror(errno));
704 }
Jeremy Compostellaa42adff2014-07-17 17:17:54 +0200705 }
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800706
707 std::vector<char> dtb_data;
708 if (!g_dtb_path.empty()) {
Steve Muckle15303f22020-03-18 14:55:06 -0700709 if (g_boot_img_hdr.header_version != 2) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000710 die("Argument dtb not supported for boot image header version %d\n",
711 g_boot_img_hdr.header_version);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800712 }
713 if (!ReadFileToVector(g_dtb_path, &dtb_data)) {
714 die("cannot load '%s': %s", g_dtb_path.c_str(), strerror(errno));
715 }
716 }
717
Daniel Zheng65452d02022-11-30 02:25:31 +0000718 fprintf(stderr, "creating boot image...\n");
Elliott Hughesd6365a72017-05-08 18:04:49 -0700719
Tom Cherrydfd85df2018-09-20 14:45:05 -0700720 std::vector<char> out;
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800721 mkbootimg(kernel_data, ramdisk_data, second_stage_data, dtb_data, g_base_addr, g_boot_img_hdr,
722 &out);
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800723
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800724 if (!g_cmdline.empty()) {
725 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(out.data()), g_cmdline);
726 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700727 fprintf(stderr, "creating boot image - %zu bytes\n", out.size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700728 return out;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800729}
730
Tom Cherrydfd85df2018-09-20 14:45:05 -0700731static bool UnzipToMemory(ZipArchiveHandle zip, const std::string& entry_name,
732 std::vector<char>* out) {
Elliott Hughesb4074142020-09-15 14:26:17 -0700733 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700734 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700735 fprintf(stderr, "archive does not contain '%s'\n", entry_name.c_str());
736 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800737 }
738
Elliott Hughesb4074142020-09-15 14:26:17 -0700739 if (zip_entry.uncompressed_length > std::numeric_limits<size_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000740 die("entry '%s' is too large: %" PRIu64, entry_name.c_str(), zip_entry.uncompressed_length);
Elliott Hughesb4074142020-09-15 14:26:17 -0700741 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700742 out->resize(zip_entry.uncompressed_length);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800743
Tom Cherrydfd85df2018-09-20 14:45:05 -0700744 fprintf(stderr, "extracting %s (%zu MB) to RAM...\n", entry_name.c_str(),
745 out->size() / 1024 / 1024);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800746
Daniel Zheng65452d02022-11-30 02:25:31 +0000747 int error =
748 ExtractToMemory(zip, &zip_entry, reinterpret_cast<uint8_t*>(out->data()), out->size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700749 if (error != 0) die("failed to extract '%s': %s", entry_name.c_str(), ErrorCodeString(error));
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000750
Tom Cherrydfd85df2018-09-20 14:45:05 -0700751 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800752}
753
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700754#if defined(_WIN32)
755
756// TODO: move this to somewhere it can be shared.
757
758#include <windows.h>
759
760// Windows' tmpfile(3) requires administrator rights because
761// it creates temporary files in the root directory.
762static FILE* win32_tmpfile() {
763 char temp_path[PATH_MAX];
764 DWORD nchars = GetTempPath(sizeof(temp_path), temp_path);
765 if (nchars == 0 || nchars >= sizeof(temp_path)) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700766 die("GetTempPath failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700767 }
768
769 char filename[PATH_MAX];
770 if (GetTempFileName(temp_path, "fastboot", 0, filename) == 0) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700771 die("GetTempFileName failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700772 }
773
774 return fopen(filename, "w+bTD");
775}
776
777#define tmpfile win32_tmpfile
778
Elliott Hughes855cdf82018-04-02 14:24:03 -0700779static int make_temporary_fd(const char* /*what*/) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700780 // TODO: reimplement to avoid leaking a FILE*.
781 return fileno(tmpfile());
782}
783
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000784#else
785
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700786static std::string make_temporary_template() {
787 const char* tmpdir = getenv("TMPDIR");
788 if (tmpdir == nullptr) tmpdir = P_tmpdir;
789 return std::string(tmpdir) + "/fastboot_userdata_XXXXXX";
790}
791
Elliott Hughes855cdf82018-04-02 14:24:03 -0700792static int make_temporary_fd(const char* what) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700793 std::string path_template(make_temporary_template());
794 int fd = mkstemp(&path_template[0]);
795 if (fd == -1) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000796 die("failed to create temporary file for %s with template %s: %s\n", path_template.c_str(),
797 what, strerror(errno));
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700798 }
799 unlink(path_template.c_str());
800 return fd;
801}
802
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700803#endif
804
Yifan Hongb10d0672021-02-22 15:06:27 -0800805static unique_fd unzip_to_file(ZipArchiveHandle zip, const char* entry_name) {
Elliott Hughes855cdf82018-04-02 14:24:03 -0700806 unique_fd fd(make_temporary_fd(entry_name));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700807
Elliott Hughesb4074142020-09-15 14:26:17 -0700808 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700809 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700810 fprintf(stderr, "archive does not contain '%s'\n", entry_name);
David Andersoncf444f32018-08-29 14:15:49 -0700811 errno = ENOENT;
Yifan Hongb10d0672021-02-22 15:06:27 -0800812 return unique_fd();
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000813 }
814
Elliott Hughesb4074142020-09-15 14:26:17 -0700815 fprintf(stderr, "extracting %s (%" PRIu64 " MB) to disk...", entry_name,
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700816 zip_entry.uncompressed_length / 1024 / 1024);
Elliott Hughes23af1122017-11-10 08:42:17 -0800817 double start = now();
Yifan Hong58532df2021-03-22 16:39:13 -0700818 int error = ExtractEntryToFile(zip, &zip_entry, fd.get());
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700819 if (error != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800820 die("\nfailed to extract '%s': %s", entry_name, ErrorCodeString(error));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700821 }
822
Yifan Hong58532df2021-03-22 16:39:13 -0700823 if (lseek(fd.get(), 0, SEEK_SET) != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800824 die("\nlseek on extracted file '%s' failed: %s", entry_name, strerror(errno));
Elliott Hughes4089d342017-10-27 14:21:12 -0700825 }
826
Elliott Hughes23af1122017-11-10 08:42:17 -0800827 fprintf(stderr, " took %.3fs\n", now() - start);
828
Yifan Hongb10d0672021-02-22 15:06:27 -0800829 return fd;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700830}
831
Andrew Chantd64b9882021-04-06 12:48:27 -0700832static bool CheckRequirement(const std::string& cur_product, const std::string& var,
Tom Cherry4aa60b32018-09-05 15:11:44 -0700833 const std::string& product, bool invert,
834 const std::vector<std::string>& options) {
835 Status("Checking '" + var + "'");
Elliott Hughes5620d222018-03-28 08:20:00 -0700836
Tom Cherry4aa60b32018-09-05 15:11:44 -0700837 double start = now();
838
839 if (!product.empty()) {
840 if (product != cur_product) {
841 double split = now();
842 fprintf(stderr, "IGNORE, product is %s required only for %s [%7.3fs]\n",
843 cur_product.c_str(), product.c_str(), (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700844 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700845 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800846 }
Tom Cherry4aa60b32018-09-05 15:11:44 -0700847
848 std::string var_value;
Tom Cherry9027af02018-09-24 15:48:09 -0700849 if (fb->GetVar(var, &var_value) != fastboot::SUCCESS) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700850 fprintf(stderr, "FAILED\n\n");
Daniel Zheng65452d02022-11-30 02:25:31 +0000851 fprintf(stderr, "Could not getvar for '%s' (%s)\n\n", var.c_str(), fb->Error().c_str());
Andrew Chantd64b9882021-04-06 12:48:27 -0700852 return false;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700853 }
854
855 bool match = false;
856 for (const auto& option : options) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000857 if (option == var_value ||
858 (option.back() == '*' &&
859 !var_value.compare(0, option.length() - 1, option, 0, option.length() - 1))) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700860 match = true;
861 break;
862 }
863 }
864
865 if (invert) {
866 match = !match;
867 }
868
869 if (match) {
870 double split = now();
871 fprintf(stderr, "OKAY [%7.3fs]\n", (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700872 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700873 }
874
875 fprintf(stderr, "FAILED\n\n");
876 fprintf(stderr, "Device %s is '%s'.\n", var.c_str(), var_value.c_str());
877 fprintf(stderr, "Update %s '%s'", invert ? "rejects" : "requires", options[0].c_str());
878 for (auto it = std::next(options.begin()); it != options.end(); ++it) {
879 fprintf(stderr, " or '%s'", it->c_str());
880 }
881 fprintf(stderr, ".\n\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700882 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800883}
884
Tom Cherry4aa60b32018-09-05 15:11:44 -0700885bool ParseRequirementLine(const std::string& line, std::string* name, std::string* product,
886 bool* invert, std::vector<std::string>* options) {
Elliott Hughes5620d222018-03-28 08:20:00 -0700887 // "require product=alpha|beta|gamma"
888 // "require version-bootloader=1234"
889 // "require-for-product:gamma version-bootloader=istanbul|constantinople"
890 // "require partition-exists=vendor"
Tom Cherry4aa60b32018-09-05 15:11:44 -0700891 *product = "";
892 *invert = false;
Elliott Hughes5620d222018-03-28 08:20:00 -0700893
Tom Cherry4aa60b32018-09-05 15:11:44 -0700894 auto require_reject_regex = std::regex{"(require\\s+|reject\\s+)?\\s*(\\S+)\\s*=\\s*(.*)"};
895 auto require_product_regex =
896 std::regex{"require-for-product:\\s*(\\S+)\\s+(\\S+)\\s*=\\s*(.*)"};
897 std::smatch match_results;
898
899 if (std::regex_match(line, match_results, require_reject_regex)) {
900 *invert = Trim(match_results[1]) == "reject";
901 } else if (std::regex_match(line, match_results, require_product_regex)) {
902 *product = match_results[1];
903 } else {
904 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800905 }
906
Tom Cherry4aa60b32018-09-05 15:11:44 -0700907 *name = match_results[2];
Elliott Hughes253c18d2015-03-18 22:47:09 -0700908 // Work around an unfortunate name mismatch.
Tom Cherry4aa60b32018-09-05 15:11:44 -0700909 if (*name == "board") {
910 *name = "product";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800911 }
912
Tom Cherry4aa60b32018-09-05 15:11:44 -0700913 auto raw_options = Split(match_results[3], "|");
914 for (const auto& option : raw_options) {
915 auto trimmed_option = Trim(option);
916 options->emplace_back(trimmed_option);
917 }
918
919 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800920}
921
Tom Cherry4aa60b32018-09-05 15:11:44 -0700922// "require partition-exists=x" is a special case, added because of the trouble we had when
923// Pixel 2 shipped with new partitions and users used old versions of fastboot to flash them,
924// missing out new partitions. A device with new partitions can use "partition-exists" to
925// override the fields `optional_if_no_image` in the `images` array.
926static void HandlePartitionExists(const std::vector<std::string>& options) {
927 const std::string& partition_name = options[0];
928 std::string has_slot;
Tom Cherry9027af02018-09-24 15:48:09 -0700929 if (fb->GetVar("has-slot:" + partition_name, &has_slot) != fastboot::SUCCESS ||
Tom Cherry4aa60b32018-09-05 15:11:44 -0700930 (has_slot != "yes" && has_slot != "no")) {
931 die("device doesn't have required partition %s!", partition_name.c_str());
932 }
933 bool known_partition = false;
Daniel Zheng65452d02022-11-30 02:25:31 +0000934 for (size_t i = 0; i < images.size(); ++i) {
935 if (!images[i].nickname.empty() && images[i].nickname == partition_name) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700936 images[i].optional_if_no_image = false;
937 known_partition = true;
938 }
939 }
940 if (!known_partition) {
941 die("device requires partition %s which is not known to this version of fastboot",
942 partition_name.c_str());
943 }
944}
945
Andrew Chantd64b9882021-04-06 12:48:27 -0700946static void CheckRequirements(const std::string& data, bool force_flash) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700947 std::string cur_product;
Tom Cherry9027af02018-09-24 15:48:09 -0700948 if (fb->GetVar("product", &cur_product) != fastboot::SUCCESS) {
949 fprintf(stderr, "getvar:product FAILED (%s)\n", fb->Error().c_str());
Tom Cherry4aa60b32018-09-05 15:11:44 -0700950 }
951
952 auto lines = Split(data, "\n");
953 for (const auto& line : lines) {
954 if (line.empty()) {
955 continue;
956 }
957
958 std::string name;
959 std::string product;
960 bool invert;
961 std::vector<std::string> options;
962
963 if (!ParseRequirementLine(line, &name, &product, &invert, &options)) {
964 fprintf(stderr, "android-info.txt syntax error: %s\n", line.c_str());
965 continue;
966 }
967 if (name == "partition-exists") {
968 HandlePartitionExists(options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800969 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -0700970 bool met = CheckRequirement(cur_product, name, product, invert, options);
971 if (!met) {
972 if (!force_flash) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000973 die("requirements not met!");
Andrew Chantd64b9882021-04-06 12:48:27 -0700974 } else {
Daniel Zheng65452d02022-11-30 02:25:31 +0000975 fprintf(stderr, "requirements not met! but proceeding due to --force\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700976 }
977 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800978 }
979 }
980}
981
Tom Cherry9027af02018-09-24 15:48:09 -0700982static void DisplayVarOrError(const std::string& label, const std::string& var) {
983 std::string value;
984
985 if (fb->GetVar(var, &value) != fastboot::SUCCESS) {
986 Status("getvar:" + var);
987 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
988 return;
989 }
990 fprintf(stderr, "%s: %s\n", label.c_str(), value.c_str());
991}
992
993static void DumpInfo() {
994 fprintf(stderr, "--------------------------------------------\n");
995 DisplayVarOrError("Bootloader Version...", "version-bootloader");
996 DisplayVarOrError("Baseband Version.....", "version-baseband");
997 DisplayVarOrError("Serial Number........", "serialno");
998 fprintf(stderr, "--------------------------------------------\n");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800999}
1000
David Andersonaa87dc52023-01-27 20:39:06 -08001001static std::vector<SparsePtr> resparse_file(sparse_file* s, int64_t max_size) {
Tao Bao41cf35f2018-04-24 10:54:21 -07001002 if (max_size <= 0 || max_size > std::numeric_limits<uint32_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001003 die("invalid max size %" PRId64, max_size);
Tao Bao41cf35f2018-04-24 10:54:21 -07001004 }
1005
David Andersonaa87dc52023-01-27 20:39:06 -08001006 const int files = sparse_file_resparse(s, max_size, nullptr, 0);
Elliott Hughes4089d342017-10-27 14:21:12 -07001007 if (files < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001008
David Andersona1c983e2023-01-27 11:57:27 -08001009 auto temp = std::make_unique<sparse_file*[]>(files);
David Andersonaa87dc52023-01-27 20:39:06 -08001010 const int rv = sparse_file_resparse(s, max_size, temp.get(), files);
David Andersona1c983e2023-01-27 11:57:27 -08001011 if (rv < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001012
David Andersona1c983e2023-01-27 11:57:27 -08001013 std::vector<SparsePtr> out_s;
1014 for (int i = 0; i < files; i++) {
1015 out_s.emplace_back(temp[i], sparse_file_destroy);
1016 }
Colin Crossf8387882012-05-24 17:18:41 -07001017 return out_s;
1018}
1019
David Andersonaa87dc52023-01-27 20:39:06 -08001020static std::vector<SparsePtr> load_sparse_files(int fd, int64_t max_size) {
1021 SparsePtr s(sparse_file_import_auto(fd, false, true), sparse_file_destroy);
1022 if (!s) die("cannot sparse read file");
1023
1024 return resparse_file(s.get(), max_size);
1025}
1026
Yifan Hongbcd27702021-02-16 19:37:32 -08001027static uint64_t get_uint_var(const char* var_name) {
1028 std::string value_str;
1029 if (fb->GetVar(var_name, &value_str) != fastboot::SUCCESS || value_str.empty()) {
1030 verbose("target didn't report %s", var_name);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001031 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001032 }
1033
Elliott Hughes77c0e662015-11-02 15:51:12 -08001034 // Some bootloaders (angler, for example) send spurious whitespace too.
Yifan Hongbcd27702021-02-16 19:37:32 -08001035 value_str = android::base::Trim(value_str);
Elliott Hughes77c0e662015-11-02 15:51:12 -08001036
Yifan Hongbcd27702021-02-16 19:37:32 -08001037 uint64_t value;
1038 if (!android::base::ParseUint(value_str, &value)) {
1039 fprintf(stderr, "couldn't parse %s '%s'\n", var_name, value_str.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001040 return 0;
1041 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001042 if (value > 0) verbose("target reported %s of %" PRId64 " bytes", var_name, value);
1043 return value;
Colin Crossf8387882012-05-24 17:18:41 -07001044}
1045
Aaron Wisnerdb511202018-06-26 15:38:35 -05001046static int64_t get_sparse_limit(int64_t size) {
Elliott Hughes542370d2018-04-19 19:49:44 -07001047 int64_t limit = sparse_limit;
1048 if (limit == 0) {
1049 // Unlimited, so see what the target device's limit is.
1050 // TODO: shouldn't we apply this limit even if you've used -S?
Colin Crossf8387882012-05-24 17:18:41 -07001051 if (target_sparse_limit == -1) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001052 target_sparse_limit = static_cast<int64_t>(get_uint_var("max-download-size"));
Colin Crossf8387882012-05-24 17:18:41 -07001053 }
1054 if (target_sparse_limit > 0) {
1055 limit = target_sparse_limit;
1056 } else {
Colin Cross0bbfb392012-07-24 18:05:21 -07001057 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001058 }
1059 }
1060
1061 if (size > limit) {
Chris Fries6a999712017-04-04 09:52:47 -05001062 return std::min(limit, RESPARSE_LIMIT);
Colin Crossf8387882012-05-24 17:18:41 -07001063 }
1064
1065 return 0;
1066}
1067
Yifan Hongb10d0672021-02-22 15:06:27 -08001068static bool load_buf_fd(unique_fd fd, struct fastboot_buffer* buf) {
Elliott Hughesfc797672015-04-07 20:12:50 -07001069 int64_t sz = get_file_size(fd);
1070 if (sz == -1) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001071 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001072 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001073
Yifan Hong58532df2021-03-22 16:39:13 -07001074 if (sparse_file* s = sparse_file_import(fd.get(), false, false)) {
David Anderson32e376f2018-08-16 13:43:11 -07001075 buf->image_size = sparse_file_len(s, false, false);
1076 sparse_file_destroy(s);
1077 } else {
1078 buf->image_size = sz;
1079 }
1080
Yifan Hong58532df2021-03-22 16:39:13 -07001081 lseek(fd.get(), 0, SEEK_SET);
Aaron Wisnerdb511202018-06-26 15:38:35 -05001082 int64_t limit = get_sparse_limit(sz);
Yifan Honge9f067b2021-03-22 16:55:39 -07001083 buf->fd = std::move(fd);
Colin Crossf8387882012-05-24 17:18:41 -07001084 if (limit) {
David Andersona1c983e2023-01-27 11:57:27 -08001085 buf->files = load_sparse_files(buf->fd.get(), limit);
1086 if (buf->files.empty()) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001087 return false;
Colin Crossf8387882012-05-24 17:18:41 -07001088 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001089 buf->type = FB_BUFFER_SPARSE;
Colin Crossf8387882012-05-24 17:18:41 -07001090 } else {
Chris Fries0ea946c2017-04-12 10:25:57 -05001091 buf->type = FB_BUFFER_FD;
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +00001092 buf->sz = sz;
Colin Crossf8387882012-05-24 17:18:41 -07001093 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001094
Elliott Hughes53ec4952016-05-11 12:39:27 -07001095 return true;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001096}
1097
Aaron Wisnerdb511202018-06-26 15:38:35 -05001098static bool load_buf(const char* fname, struct fastboot_buffer* buf) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001099 unique_fd fd(TEMP_FAILURE_RETRY(open(fname, O_RDONLY | O_BINARY)));
1100
Elliott Hughes53ec4952016-05-11 12:39:27 -07001101 if (fd == -1) {
1102 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001103 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001104
1105 struct stat s;
Yifan Hong58532df2021-03-22 16:39:13 -07001106 if (fstat(fd.get(), &s)) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001107 return false;
1108 }
1109 if (!S_ISREG(s.st_mode)) {
1110 errno = S_ISDIR(s.st_mode) ? EISDIR : EINVAL;
1111 return false;
1112 }
1113
Yifan Hongb10d0672021-02-22 15:06:27 -08001114 return load_buf_fd(std::move(fd), buf);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001115}
1116
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001117static void rewrite_vbmeta_buffer(struct fastboot_buffer* buf, bool vbmeta_in_boot) {
David Zeuthenb6ea4352017-08-07 14:29:26 -04001118 // Buffer needs to be at least the size of the VBMeta struct which
1119 // is 256 bytes.
1120 if (buf->sz < 256) {
1121 return;
1122 }
1123
David Zeuthenb6ea4352017-08-07 14:29:26 -04001124 std::string data;
1125 if (!android::base::ReadFdToString(buf->fd, &data)) {
1126 die("Failed reading from vbmeta");
1127 }
1128
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001129 uint64_t vbmeta_offset = 0;
1130 if (vbmeta_in_boot) {
1131 // Tries to locate top-level vbmeta from boot.img footer.
1132 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1133 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001134 die("Failed to find AVB_FOOTER at offset: %" PRId64 ", is BOARD_AVB_ENABLE true?",
1135 footer_offset);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001136 }
1137 const AvbFooter* footer = reinterpret_cast<const AvbFooter*>(data.c_str() + footer_offset);
1138 vbmeta_offset = be64toh(footer->vbmeta_offset);
1139 }
1140 // Ensures there is AVB_MAGIC at vbmeta_offset.
1141 if (0 != data.compare(vbmeta_offset, AVB_MAGIC_LEN, AVB_MAGIC)) {
1142 die("Failed to find AVB_MAGIC at offset: %" PRId64, vbmeta_offset);
1143 }
1144
1145 fprintf(stderr, "Rewriting vbmeta struct at offset: %" PRId64 "\n", vbmeta_offset);
1146
David Zeuthenb6ea4352017-08-07 14:29:26 -04001147 // There's a 32-bit big endian |flags| field at offset 120 where
1148 // bit 0 corresponds to disable-verity and bit 1 corresponds to
1149 // disable-verification.
1150 //
1151 // See external/avb/libavb/avb_vbmeta_image.h for the layout of
1152 // the VBMeta struct.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001153 uint64_t flags_offset = 123 + vbmeta_offset;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001154 if (g_disable_verity) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001155 data[flags_offset] |= 0x01;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001156 }
1157 if (g_disable_verification) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001158 data[flags_offset] |= 0x02;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001159 }
1160
Yifan Hongb10d0672021-02-22 15:06:27 -08001161 unique_fd fd(make_temporary_fd("vbmeta rewriting"));
David Zeuthenb6ea4352017-08-07 14:29:26 -04001162 if (!android::base::WriteStringToFd(data, fd)) {
1163 die("Failed writing to modified vbmeta");
1164 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001165 buf->fd = std::move(fd);
Yifan Hong58532df2021-03-22 16:39:13 -07001166 lseek(buf->fd.get(), 0, SEEK_SET);
David Zeuthenb6ea4352017-08-07 14:29:26 -04001167}
1168
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001169static bool has_vbmeta_partition() {
1170 std::string partition_type;
1171 return fb->GetVar("partition-type:vbmeta", &partition_type) == fastboot::SUCCESS ||
1172 fb->GetVar("partition-type:vbmeta_a", &partition_type) == fastboot::SUCCESS ||
1173 fb->GetVar("partition-type:vbmeta_b", &partition_type) == fastboot::SUCCESS;
1174}
1175
David Andersonaa87dc52023-01-27 20:39:06 -08001176// Note: this only works in userspace fastboot. In the bootloader, use
1177// should_flash_in_userspace().
Michael Bestasa495be72020-11-06 17:58:28 +02001178static bool is_logical(const std::string& partition) {
1179 std::string value;
1180 return fb->GetVar("is-logical:" + partition, &value) == fastboot::SUCCESS && value == "yes";
1181}
1182
Steve Muckle3af575b2020-06-18 17:02:15 -07001183static std::string fb_fix_numeric_var(std::string var) {
1184 // Some bootloaders (angler, for example), send spurious leading whitespace.
1185 var = android::base::Trim(var);
1186 // Some bootloaders (hammerhead, for example) use implicit hex.
1187 // This code used to use strtol with base 16.
1188 if (!android::base::StartsWith(var, "0x")) var = "0x" + var;
1189 return var;
1190}
1191
Yifan Hongbcd27702021-02-16 19:37:32 -08001192static uint64_t get_partition_size(const std::string& partition) {
Steve Muckle3af575b2020-06-18 17:02:15 -07001193 std::string partition_size_str;
1194 if (fb->GetVar("partition-size:" + partition, &partition_size_str) != fastboot::SUCCESS) {
Michael Bestasa495be72020-11-06 17:58:28 +02001195 if (!is_logical(partition)) {
1196 return 0;
1197 }
Yifan Hong60de9692021-02-17 13:51:54 -08001198 die("cannot get partition size for %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001199 }
1200
1201 partition_size_str = fb_fix_numeric_var(partition_size_str);
Yifan Hongbcd27702021-02-16 19:37:32 -08001202 uint64_t partition_size;
1203 if (!android::base::ParseUint(partition_size_str, &partition_size)) {
Michael Bestasa495be72020-11-06 17:58:28 +02001204 if (!is_logical(partition)) {
1205 return 0;
1206 }
Steve Muckle3af575b2020-06-18 17:02:15 -07001207 die("Couldn't parse partition size '%s'.", partition_size_str.c_str());
1208 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001209 return partition_size;
1210}
1211
Devin Moorecb5098f2022-01-07 16:33:46 +00001212static void copy_avb_footer(const std::string& partition, struct fastboot_buffer* buf) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001213 if (buf->sz < AVB_FOOTER_SIZE) {
1214 return;
1215 }
1216
Bowgo Tsai671249a2021-08-10 16:32:37 +08001217 // If overflows and negative, it should be < buf->sz.
1218 int64_t partition_size = static_cast<int64_t>(get_partition_size(partition));
1219
1220 if (partition_size == buf->sz) {
1221 return;
1222 }
1223 // Some device bootloaders might not implement `fastboot getvar partition-size:boot[_a|_b]`.
1224 // In this case, partition_size will be zero.
1225 if (partition_size < buf->sz) {
1226 fprintf(stderr,
Devin Moorecb5098f2022-01-07 16:33:46 +00001227 "Warning: skip copying %s image avb footer"
1228 " (%s partition size: %" PRId64 ", %s image size: %" PRId64 ").\n",
1229 partition.c_str(), partition.c_str(), partition_size, partition.c_str(), buf->sz);
Bowgo Tsai671249a2021-08-10 16:32:37 +08001230 return;
1231 }
1232
1233 // IMPORTANT: after the following read, we need to reset buf->fd before return (if not die).
1234 // Because buf->fd will still be used afterwards.
Steve Muckle3af575b2020-06-18 17:02:15 -07001235 std::string data;
1236 if (!android::base::ReadFdToString(buf->fd, &data)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001237 die("Failed reading from %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001238 }
1239
1240 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1241 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001242 lseek(buf->fd.get(), 0, SEEK_SET); // IMPORTANT: resets buf->fd before return.
Steve Muckle3af575b2020-06-18 17:02:15 -07001243 return;
1244 }
1245
Devin Moorecb5098f2022-01-07 16:33:46 +00001246 const std::string tmp_fd_template = partition + " rewriting";
1247 unique_fd fd(make_temporary_fd(tmp_fd_template.c_str()));
Steve Muckle3af575b2020-06-18 17:02:15 -07001248 if (!android::base::WriteStringToFd(data, fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001249 die("Failed writing to modified %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001250 }
Yifan Hong58532df2021-03-22 16:39:13 -07001251 lseek(fd.get(), partition_size - AVB_FOOTER_SIZE, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001252 if (!android::base::WriteStringToFd(data.substr(footer_offset), fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001253 die("Failed copying AVB footer in %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001254 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001255 buf->fd = std::move(fd);
Steve Muckle3af575b2020-06-18 17:02:15 -07001256 buf->sz = partition_size;
Yifan Hong58532df2021-03-22 16:39:13 -07001257 lseek(buf->fd.get(), 0, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001258}
1259
David Andersonaa87dc52023-01-27 20:39:06 -08001260static void flash_partition_files(const std::string& partition,
1261 const std::vector<SparsePtr>& files) {
1262 for (size_t i = 0; i < files.size(); i++) {
1263 sparse_file* s = files[i].get();
1264 int64_t sz = sparse_file_len(s, true, false);
1265 fb->FlashPartition(partition, s, sz, i + 1, files.size());
1266 }
1267}
1268
Daniel Zheng65452d02022-11-30 02:25:31 +00001269static void flash_buf(const std::string& partition, struct fastboot_buffer* buf) {
Devin Moore1af12022022-01-06 01:11:23 +00001270 if (partition == "boot" || partition == "boot_a" || partition == "boot_b" ||
Isaac J. Manjarresacb49522023-01-12 14:28:29 -08001271 partition == "init_boot" || partition == "init_boot_a" || partition == "init_boot_b" ||
1272 partition == "recovery" || partition == "recovery_a" || partition == "recovery_b") {
Devin Moorecb5098f2022-01-07 16:33:46 +00001273 copy_avb_footer(partition, buf);
Steve Muckle3af575b2020-06-18 17:02:15 -07001274 }
1275
David Zeuthenb6ea4352017-08-07 14:29:26 -04001276 // Rewrite vbmeta if that's what we're flashing and modification has been requested.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001277 if (g_disable_verity || g_disable_verification) {
Paweł Grabasff9cfac2021-03-04 13:11:25 +01001278 // The vbmeta partition might have additional prefix if running in virtual machine
1279 // e.g., guest_vbmeta_a.
1280 if (android::base::EndsWith(partition, "vbmeta") ||
1281 android::base::EndsWith(partition, "vbmeta_a") ||
1282 android::base::EndsWith(partition, "vbmeta_b")) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001283 rewrite_vbmeta_buffer(buf, false /* vbmeta_in_boot */);
1284 } else if (!has_vbmeta_partition() &&
1285 (partition == "boot" || partition == "boot_a" || partition == "boot_b")) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001286 rewrite_vbmeta_buffer(buf, true /* vbmeta_in_boot */);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001287 }
David Zeuthenb6ea4352017-08-07 14:29:26 -04001288 }
1289
Rom Lemarchand622810c2013-06-28 09:54:59 -07001290 switch (buf->type) {
Josh Gao9da9ac52016-01-19 14:50:18 -08001291 case FB_BUFFER_SPARSE: {
David Andersonaa87dc52023-01-27 20:39:06 -08001292 flash_partition_files(partition, buf->files);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001293 break;
Josh Gao9da9ac52016-01-19 14:50:18 -08001294 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001295 case FB_BUFFER_FD:
Tom Cherry9027af02018-09-24 15:48:09 -07001296 fb->FlashPartition(partition, buf->fd, buf->sz);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001297 break;
1298 default:
1299 die("unknown buffer type: %d", buf->type);
1300 }
1301}
1302
Aaron Wisnerdb511202018-06-26 15:38:35 -05001303static std::string get_current_slot() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001304 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07001305 if (fb->GetVar("current-slot", &current_slot) != fastboot::SUCCESS) return "";
LuK1337dae48ef2020-04-06 14:38:58 +02001306 if (current_slot[0] == '_') current_slot.erase(0, 1);
Elliott Hughes42b18a52018-04-10 15:32:21 -07001307 return current_slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001308}
1309
Aaron Wisnerdb511202018-06-26 15:38:35 -05001310static int get_slot_count() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001311 std::string var;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001312 int count = 0;
Tom Cherry9027af02018-09-24 15:48:09 -07001313 if (fb->GetVar("slot-count", &var) != fastboot::SUCCESS ||
1314 !android::base::ParseInt(var, &count)) {
Elliott Hughes42b18a52018-04-10 15:32:21 -07001315 return 0;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001316 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001317 return count;
1318}
1319
Aaron Wisnerdb511202018-06-26 15:38:35 -05001320static bool supports_AB() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001321 return get_slot_count() >= 2;
Alex Lightbb9b8a52016-06-29 09:26:44 -07001322}
1323
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001324// Given a current slot, this returns what the 'other' slot is.
Daniel Rosenberg80919472016-06-30 19:25:31 -07001325static std::string get_other_slot(const std::string& current_slot, int count) {
1326 if (count == 0) return "";
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001327
Daniel Zheng65452d02022-11-30 02:25:31 +00001328 char next = (current_slot[0] - 'a' + 1) % count + 'a';
Daniel Rosenberg80919472016-06-30 19:25:31 -07001329 return std::string(1, next);
1330}
1331
Aaron Wisnerdb511202018-06-26 15:38:35 -05001332static std::string get_other_slot(const std::string& current_slot) {
1333 return get_other_slot(current_slot, get_slot_count());
Daniel Rosenberg80919472016-06-30 19:25:31 -07001334}
1335
Aaron Wisnerdb511202018-06-26 15:38:35 -05001336static std::string get_other_slot(int count) {
1337 return get_other_slot(get_current_slot(), count);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001338}
1339
Aaron Wisnerdb511202018-06-26 15:38:35 -05001340static std::string get_other_slot() {
1341 return get_other_slot(get_current_slot(), get_slot_count());
Alex Lightbb9b8a52016-06-29 09:26:44 -07001342}
1343
Aaron Wisnerdb511202018-06-26 15:38:35 -05001344static std::string verify_slot(const std::string& slot_name, bool allow_all) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001345 std::string slot = slot_name;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001346 if (slot == "all") {
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001347 if (allow_all) {
1348 return "all";
1349 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001350 int count = get_slot_count();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001351 if (count > 0) {
1352 return "a";
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001353 } else {
Elliott Hughes4089d342017-10-27 14:21:12 -07001354 die("No known slots");
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001355 }
1356 }
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001357 }
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001358
Aaron Wisnerdb511202018-06-26 15:38:35 -05001359 int count = get_slot_count();
Elliott Hughes4089d342017-10-27 14:21:12 -07001360 if (count == 0) die("Device does not support slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001361
Daniel Rosenberg80919472016-06-30 19:25:31 -07001362 if (slot == "other") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001363 std::string other = get_other_slot(count);
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001364 if (other == "") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001365 die("No known slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001366 }
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001367 return other;
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001368 }
1369
Daniel Zheng65452d02022-11-30 02:25:31 +00001370 if (slot.size() == 1 && (slot[0] - 'a' >= 0 && slot[0] - 'a' < count)) return slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001371
1372 fprintf(stderr, "Slot %s does not exist. supported slots are:\n", slot.c_str());
Daniel Zheng65452d02022-11-30 02:25:31 +00001373 for (int i = 0; i < count; i++) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001374 fprintf(stderr, "%c\n", (char)(i + 'a'));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001375 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001376
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001377 exit(1);
1378}
1379
Aaron Wisnerdb511202018-06-26 15:38:35 -05001380static std::string verify_slot(const std::string& slot) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001381 return verify_slot(slot, true);
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001382}
1383
Aaron Wisnerdb511202018-06-26 15:38:35 -05001384static void do_for_partition(const std::string& part, const std::string& slot,
Chih-Hung Hsieh8f7b9e32016-07-27 16:25:51 -07001385 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001386 std::string has_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001387 std::string current_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001388 // |part| can be vendor_boot:default. Append slot to the first token.
1389 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001390
Yifan Hong6d7da632021-02-23 12:15:51 -08001391 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001392 /* If has-slot is not supported, the answer is no. */
1393 has_slot = "no";
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001394 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001395 if (has_slot == "yes") {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001396 if (slot == "") {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001397 current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001398 if (current_slot == "") {
Elliott Hughes4089d342017-10-27 14:21:12 -07001399 die("Failed to identify current slot");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001400 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001401 part_tokens[0] += "_" + current_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001402 } else {
Yifan Hong6d7da632021-02-23 12:15:51 -08001403 part_tokens[0] += "_" + slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001404 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001405 func(android::base::Join(part_tokens, ":"));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001406 } else {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001407 if (force_slot && slot != "") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001408 fprintf(stderr, "Warning: %s does not support slots, and slot %s was requested.\n",
1409 part_tokens[0].c_str(), slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001410 }
1411 func(part);
1412 }
1413}
1414
David Pursell0b156632015-10-30 11:22:01 -07001415/* This function will find the real partition name given a base name, and a slot. If slot is NULL or
1416 * empty, it will use the current slot. If slot is "all", it will return a list of all possible
1417 * partition names. If force_slot is true, it will fail if a slot is specified, and the given
1418 * partition does not support slots.
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001419 */
Daniel Zheng0d307182023-01-31 21:07:53 +00001420void do_for_partitions(const std::string& part, const std::string& slot,
1421 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001422 std::string has_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001423 // |part| can be vendor_boot:default. Query has-slot on the first token only.
1424 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001425
Daniel Rosenberg80919472016-06-30 19:25:31 -07001426 if (slot == "all") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001427 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1428 die("Could not check if partition %s has slot %s", part_tokens[0].c_str(),
1429 slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001430 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001431 if (has_slot == "yes") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001432 for (int i = 0; i < get_slot_count(); i++) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001433 do_for_partition(part, std::string(1, (char)(i + 'a')), func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001434 }
1435 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001436 do_for_partition(part, "", func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001437 }
1438 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001439 do_for_partition(part, slot, func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001440 }
1441}
1442
David Anderson0c732342018-11-28 17:10:42 -08001443static bool is_retrofit_device() {
1444 std::string value;
1445 if (fb->GetVar("super-partition-name", &value) != fastboot::SUCCESS) {
1446 return false;
1447 }
1448 return android::base::StartsWith(value, "system_");
1449}
1450
Yifan Hongbcd27702021-02-16 19:37:32 -08001451// Fetch a partition from the device to a given fd. This is a wrapper over FetchToFd to fetch
1452// the full image.
1453static uint64_t fetch_partition(const std::string& partition, borrowed_fd fd) {
1454 uint64_t fetch_size = get_uint_var(FB_VAR_MAX_FETCH_SIZE);
1455 if (fetch_size == 0) {
1456 die("Unable to get %s. Device does not support fetch command.", FB_VAR_MAX_FETCH_SIZE);
1457 }
1458 uint64_t partition_size = get_partition_size(partition);
1459 if (partition_size <= 0) {
1460 die("Invalid partition size for partition %s: %" PRId64, partition.c_str(), partition_size);
1461 }
1462
1463 uint64_t offset = 0;
1464 while (offset < partition_size) {
1465 uint64_t chunk_size = std::min(fetch_size, partition_size - offset);
1466 if (fb->FetchToFd(partition, fd, offset, chunk_size) != fastboot::RetCode::SUCCESS) {
1467 die("Unable to fetch %s (offset=%" PRIx64 ", size=%" PRIx64 ")", partition.c_str(),
1468 offset, chunk_size);
1469 }
1470 offset += chunk_size;
1471 }
1472 return partition_size;
1473}
1474
1475static void do_fetch(const std::string& partition, const std::string& slot_override,
1476 const std::string& outfile) {
1477 unique_fd fd(TEMP_FAILURE_RETRY(
1478 open(outfile.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0644)));
1479 auto fetch = std::bind(fetch_partition, _1, borrowed_fd(fd));
1480 do_for_partitions(partition, slot_override, fetch, false /* force slot */);
1481}
1482
Yifan Honge71fe242021-02-22 15:00:15 -08001483// Return immediately if not flashing a vendor boot image. If flashing a vendor boot image,
1484// repack vendor_boot image with an updated ramdisk. After execution, buf is set
1485// to the new image to flash, and return value is the real partition name to flash.
1486static std::string repack_ramdisk(const char* pname, struct fastboot_buffer* buf) {
1487 std::string_view pname_sv{pname};
1488
1489 if (!android::base::StartsWith(pname_sv, "vendor_boot:") &&
1490 !android::base::StartsWith(pname_sv, "vendor_boot_a:") &&
1491 !android::base::StartsWith(pname_sv, "vendor_boot_b:")) {
1492 return std::string(pname_sv);
1493 }
1494 if (buf->type != FB_BUFFER_FD) {
1495 die("Flashing sparse vendor ramdisk image is not supported.");
1496 }
1497 if (buf->sz <= 0) {
1498 die("repack_ramdisk() sees negative size: %" PRId64, buf->sz);
1499 }
1500 std::string partition(pname_sv.substr(0, pname_sv.find(':')));
1501 std::string ramdisk(pname_sv.substr(pname_sv.find(':') + 1));
1502
1503 unique_fd vendor_boot(make_temporary_fd("vendor boot repack"));
1504 uint64_t vendor_boot_size = fetch_partition(partition, vendor_boot);
1505 auto repack_res = replace_vendor_ramdisk(vendor_boot, vendor_boot_size, ramdisk, buf->fd,
1506 static_cast<uint64_t>(buf->sz));
1507 if (!repack_res.ok()) {
1508 die("%s", repack_res.error().message().c_str());
1509 }
1510
1511 buf->fd = std::move(vendor_boot);
1512 buf->sz = vendor_boot_size;
1513 buf->image_size = vendor_boot_size;
1514 return partition;
1515}
1516
Daniel Zheng0d307182023-01-31 21:07:53 +00001517void do_flash(const char* pname, const char* fname) {
Yifan Hong6d7da632021-02-23 12:15:51 -08001518 verbose("Do flash %s %s", pname, fname);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001519 struct fastboot_buffer buf;
1520
Aaron Wisnerdb511202018-06-26 15:38:35 -05001521 if (!load_buf(fname, &buf)) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001522 die("cannot load '%s': %s", fname, strerror(errno));
Rom Lemarchand622810c2013-06-28 09:54:59 -07001523 }
David Anderson629e51c2018-10-25 12:51:25 -07001524 if (is_logical(pname)) {
1525 fb->ResizePartition(pname, std::to_string(buf.image_size));
1526 }
Yifan Honge71fe242021-02-22 15:00:15 -08001527 std::string flash_pname = repack_ramdisk(pname, &buf);
1528 flash_buf(flash_pname, &buf);
Colin Crossf8387882012-05-24 17:18:41 -07001529}
1530
Daniel Rosenberg13454092016-06-27 19:43:11 -07001531// Sets slot_override as the active slot. If slot_override is blank,
1532// set current slot as active instead. This clears slot-unbootable.
Aaron Wisnerdb511202018-06-26 15:38:35 -05001533static void set_active(const std::string& slot_override) {
1534 if (!supports_AB()) return;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001535
Daniel Rosenberg80919472016-06-30 19:25:31 -07001536 if (slot_override != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001537 fb->SetActive(slot_override);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001538 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001539 std::string current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001540 if (current_slot != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001541 fb->SetActive(current_slot);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001542 }
1543 }
1544}
1545
Daniel Zheng0d307182023-01-31 21:07:53 +00001546bool is_userspace_fastboot() {
David Anderson32e376f2018-08-16 13:43:11 -07001547 std::string value;
Tom Cherry9027af02018-09-24 15:48:09 -07001548 return fb->GetVar("is-userspace", &value) == fastboot::SUCCESS && value == "yes";
David Anderson32e376f2018-08-16 13:43:11 -07001549}
1550
Daniel Zheng0d307182023-01-31 21:07:53 +00001551void reboot_to_userspace_fastboot() {
Tom Cherry9027af02018-09-24 15:48:09 -07001552 fb->RebootTo("fastboot");
1553
1554 auto* old_transport = fb->set_transport(nullptr);
1555 delete old_transport;
David Anderson1d887432018-08-27 16:47:32 -07001556
1557 // Give the current connection time to close.
1558 std::this_thread::sleep_for(std::chrono::milliseconds(1000));
1559
Tom Cherry9027af02018-09-24 15:48:09 -07001560 fb->set_transport(open_device());
David Anderson11d6d272018-12-07 16:39:07 -08001561
1562 if (!is_userspace_fastboot()) {
1563 die("Failed to boot into userspace fastboot; one or more components might be unbootable.");
1564 }
Hridya Valsaraju83d856e2019-05-17 14:24:19 -07001565
1566 // Reset target_sparse_limit after reboot to userspace fastboot. Max
1567 // download sizes may differ in bootloader and fastbootd.
1568 target_sparse_limit = -1;
David Anderson1d887432018-08-27 16:47:32 -07001569}
1570
David Andersonab8f4662019-10-21 16:45:59 -07001571static void CancelSnapshotIfNeeded() {
1572 std::string merge_status = "none";
1573 if (fb->GetVar(FB_VAR_SNAPSHOT_UPDATE_STATUS, &merge_status) == fastboot::SUCCESS &&
Elliott Hughes6a7ff582020-06-05 14:06:15 -07001574 !merge_status.empty() && merge_status != "none") {
Yifan Hong712c32b2019-12-10 18:11:13 -08001575 fb->SnapshotUpdateCommand("cancel");
David Andersonab8f4662019-10-21 16:45:59 -07001576 }
1577}
1578
David Andersoncf444f32018-08-29 14:15:49 -07001579class FlashAllTool {
1580 public:
Andrew Chantd64b9882021-04-06 12:48:27 -07001581 FlashAllTool(const ImageSource& source, const std::string& slot_override, bool skip_secondary,
1582 bool wipe, bool force_flash);
David Anderson32e376f2018-08-16 13:43:11 -07001583
David Andersoncf444f32018-08-29 14:15:49 -07001584 void Flash();
David Anderson32e376f2018-08-16 13:43:11 -07001585
David Andersoncf444f32018-08-29 14:15:49 -07001586 private:
1587 void CheckRequirements();
David Anderson667b1ef2023-01-27 21:11:11 -08001588 void DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001589 void CollectImages();
1590 void FlashImages(const std::vector<std::pair<const Image*, std::string>>& images);
1591 void FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf);
1592 void UpdateSuperPartition();
David Anderson667b1ef2023-01-27 21:11:11 -08001593 bool OptimizedFlashSuper();
1594
1595 // If the image uses the default slot, or the user specified "all", then
1596 // the paired string will be empty. If the image requests a specific slot
1597 // (for example, system_other) it is specified instead.
1598 using ImageEntry = std::pair<const Image*, std::string>;
1599
1600 std::string GetPartitionName(const ImageEntry& entry);
David Anderson32e376f2018-08-16 13:43:11 -07001601
David Andersoncf444f32018-08-29 14:15:49 -07001602 const ImageSource& source_;
1603 std::string slot_override_;
1604 bool skip_secondary_;
1605 bool wipe_;
Andrew Chantd64b9882021-04-06 12:48:27 -07001606 bool force_flash_;
David Anderson667b1ef2023-01-27 21:11:11 -08001607 std::string current_slot_;
David Andersoncf444f32018-08-29 14:15:49 -07001608 std::string secondary_slot_;
David Anderson667b1ef2023-01-27 21:11:11 -08001609
1610 std::vector<ImageEntry> boot_images_;
1611 std::vector<ImageEntry> os_images_;
David Andersoncf444f32018-08-29 14:15:49 -07001612};
1613
Andrew Chantd64b9882021-04-06 12:48:27 -07001614FlashAllTool::FlashAllTool(const ImageSource& source, const std::string& slot_override,
1615 bool skip_secondary, bool wipe, bool force_flash)
Daniel Zheng65452d02022-11-30 02:25:31 +00001616 : source_(source),
1617 slot_override_(slot_override),
1618 skip_secondary_(skip_secondary),
1619 wipe_(wipe),
1620 force_flash_(force_flash) {}
David Anderson32e376f2018-08-16 13:43:11 -07001621
David Andersoncf444f32018-08-29 14:15:49 -07001622void FlashAllTool::Flash() {
Tom Cherry9027af02018-09-24 15:48:09 -07001623 DumpInfo();
David Andersoncf444f32018-08-29 14:15:49 -07001624 CheckRequirements();
David Anderson96a9fd42018-11-05 15:21:44 -08001625
1626 // Change the slot first, so we boot into the correct recovery image when
1627 // using fastbootd.
1628 if (slot_override_ == "all") {
1629 set_active("a");
1630 } else {
1631 set_active(slot_override_);
1632 }
1633
David Anderson667b1ef2023-01-27 21:11:11 -08001634 DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001635 CollectImages();
David Anderson32e376f2018-08-16 13:43:11 -07001636
David Andersonab8f4662019-10-21 16:45:59 -07001637 CancelSnapshotIfNeeded();
1638
David Anderson95d40932018-08-28 12:14:33 -07001639 // First flash boot partitions. We allow this to happen either in userspace
1640 // or in bootloader fastboot.
David Andersoncf444f32018-08-29 14:15:49 -07001641 FlashImages(boot_images_);
David Anderson95d40932018-08-28 12:14:33 -07001642
David Anderson667b1ef2023-01-27 21:11:11 -08001643 if (!OptimizedFlashSuper()) {
1644 // Sync the super partition. This will reboot to userspace fastboot if needed.
1645 UpdateSuperPartition();
David Anderson95d40932018-08-28 12:14:33 -07001646
David Anderson667b1ef2023-01-27 21:11:11 -08001647 // Resize any logical partition to 0, so each partition is reset to 0
1648 // extents, and will achieve more optimal allocation.
1649 for (const auto& [image, slot] : os_images_) {
1650 auto resize_partition = [](const std::string& partition) -> void {
1651 if (is_logical(partition)) {
1652 fb->ResizePartition(partition, "0");
1653 }
1654 };
1655 do_for_partitions(image->part_name, slot, resize_partition, false);
1656 }
David Anderson32e376f2018-08-16 13:43:11 -07001657 }
1658
David Anderson95d40932018-08-28 12:14:33 -07001659 // Flash OS images, resizing logical partitions as needed.
David Andersoncf444f32018-08-29 14:15:49 -07001660 FlashImages(os_images_);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001661}
1662
David Anderson667b1ef2023-01-27 21:11:11 -08001663bool FlashAllTool::OptimizedFlashSuper() {
1664 if (!supports_AB()) {
1665 LOG(VERBOSE) << "Cannot optimize flashing super on non-AB device";
1666 return false;
1667 }
1668 if (slot_override_ == "all") {
1669 LOG(VERBOSE) << "Cannot optimize flashing super for all slots";
1670 return false;
1671 }
1672
1673 // Does this device use dynamic partitions at all?
1674 unique_fd fd = source_.OpenFile("super_empty.img");
1675 if (fd < 0) {
1676 LOG(VERBOSE) << "could not open super_empty.img";
1677 return false;
1678 }
1679
1680 // Try to find whether there is a super partition.
1681 std::string super_name;
1682 if (fb->GetVar("super-partition-name", &super_name) != fastboot::SUCCESS) {
1683 super_name = "super";
1684 }
1685 std::string partition_size_str;
1686 if (fb->GetVar("partition-size:" + super_name, &partition_size_str) != fastboot::SUCCESS) {
1687 LOG(VERBOSE) << "Cannot optimize super flashing: could not determine super partition";
1688 return false;
1689 }
1690
1691 SuperFlashHelper helper(source_);
1692 if (!helper.Open(fd)) {
1693 return false;
1694 }
1695
1696 for (const auto& entry : os_images_) {
1697 auto partition = GetPartitionName(entry);
1698 auto image = entry.first;
1699
1700 if (!helper.AddPartition(partition, image->img_name, image->optional_if_no_image)) {
1701 return false;
1702 }
1703 }
1704
1705 auto s = helper.GetSparseLayout();
1706 if (!s) {
1707 return false;
1708 }
1709
1710 std::vector<SparsePtr> files;
1711 if (int limit = get_sparse_limit(sparse_file_len(s.get(), false, false))) {
1712 files = resparse_file(s.get(), limit);
1713 } else {
1714 files.emplace_back(std::move(s));
1715 }
1716
1717 // Send the data to the device.
1718 flash_partition_files(super_name, files);
1719
1720 // Remove images that we already flashed, just in case we have non-dynamic OS images.
1721 auto remove_if_callback = [&, this](const ImageEntry& entry) -> bool {
1722 return helper.WillFlash(GetPartitionName(entry));
1723 };
1724 os_images_.erase(std::remove_if(os_images_.begin(), os_images_.end(), remove_if_callback),
1725 os_images_.end());
1726 return true;
1727}
1728
David Andersoncf444f32018-08-29 14:15:49 -07001729void FlashAllTool::CheckRequirements() {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001730 std::vector<char> contents;
1731 if (!source_.ReadFile("android-info.txt", &contents)) {
David Andersoncf444f32018-08-29 14:15:49 -07001732 die("could not read android-info.txt");
1733 }
Andrew Chantd64b9882021-04-06 12:48:27 -07001734 ::CheckRequirements({contents.data(), contents.size()}, force_flash_);
David Andersoncf444f32018-08-29 14:15:49 -07001735}
1736
David Anderson667b1ef2023-01-27 21:11:11 -08001737void FlashAllTool::DetermineSlot() {
1738 if (slot_override_.empty()) {
1739 current_slot_ = get_current_slot();
1740 } else {
1741 current_slot_ = slot_override_;
1742 }
1743
David Andersoncf444f32018-08-29 14:15:49 -07001744 if (skip_secondary_) {
1745 return;
1746 }
David Anderson96a9fd42018-11-05 15:21:44 -08001747 if (slot_override_ != "" && slot_override_ != "all") {
David Andersoncf444f32018-08-29 14:15:49 -07001748 secondary_slot_ = get_other_slot(slot_override_);
1749 } else {
1750 secondary_slot_ = get_other_slot();
1751 }
1752 if (secondary_slot_ == "") {
1753 if (supports_AB()) {
1754 fprintf(stderr, "Warning: Could not determine slot for secondary images. Ignoring.\n");
1755 }
1756 skip_secondary_ = true;
1757 }
1758}
1759
1760void FlashAllTool::CollectImages() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001761 for (size_t i = 0; i < images.size(); ++i) {
David Andersoncf444f32018-08-29 14:15:49 -07001762 std::string slot = slot_override_;
1763 if (images[i].IsSecondary()) {
1764 if (skip_secondary_) {
1765 continue;
1766 }
1767 slot = secondary_slot_;
1768 }
1769 if (images[i].type == ImageType::BootCritical) {
1770 boot_images_.emplace_back(&images[i], slot);
1771 } else if (images[i].type == ImageType::Normal) {
1772 os_images_.emplace_back(&images[i], slot);
1773 }
1774 }
1775}
1776
1777void FlashAllTool::FlashImages(const std::vector<std::pair<const Image*, std::string>>& images) {
1778 for (const auto& [image, slot] : images) {
1779 fastboot_buffer buf;
Yifan Hongb10d0672021-02-22 15:06:27 -08001780 unique_fd fd = source_.OpenFile(image->img_name);
1781 if (fd < 0 || !load_buf_fd(std::move(fd), &buf)) {
David Andersoncf444f32018-08-29 14:15:49 -07001782 if (image->optional_if_no_image) {
1783 continue;
1784 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001785 die("could not load '%s': %s", image->img_name.c_str(), strerror(errno));
David Andersoncf444f32018-08-29 14:15:49 -07001786 }
1787 FlashImage(*image, slot, &buf);
1788 }
1789}
1790
1791void FlashAllTool::FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf) {
1792 auto flash = [&, this](const std::string& partition_name) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001793 std::vector<char> signature_data;
1794 if (source_.ReadFile(image.sig_name, &signature_data)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001795 fb->Download("signature", signature_data);
1796 fb->RawCommand("signature", "installing signature");
David Andersoncf444f32018-08-29 14:15:49 -07001797 }
1798
1799 if (is_logical(partition_name)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001800 fb->ResizePartition(partition_name, std::to_string(buf->image_size));
David Andersoncf444f32018-08-29 14:15:49 -07001801 }
1802 flash_buf(partition_name.c_str(), buf);
1803 };
1804 do_for_partitions(image.part_name, slot, flash, false);
1805}
1806
1807void FlashAllTool::UpdateSuperPartition() {
Yifan Hong58532df2021-03-22 16:39:13 -07001808 unique_fd fd = source_.OpenFile("super_empty.img");
David Andersoncf444f32018-08-29 14:15:49 -07001809 if (fd < 0) {
1810 return;
1811 }
1812 if (!is_userspace_fastboot()) {
1813 reboot_to_userspace_fastboot();
1814 }
David Andersoncf444f32018-08-29 14:15:49 -07001815
David Anderson90fe0a42018-11-05 18:01:32 -08001816 std::string super_name;
1817 if (fb->GetVar("super-partition-name", &super_name) != fastboot::RetCode::SUCCESS) {
1818 super_name = "super";
1819 }
1820 fb->Download(super_name, fd, get_file_size(fd));
1821
1822 std::string command = "update-super:" + super_name;
David Andersoncf444f32018-08-29 14:15:49 -07001823 if (wipe_) {
1824 command += ":wipe";
1825 }
Tom Cherry9027af02018-09-24 15:48:09 -07001826 fb->RawCommand(command, "Updating super partition");
David Anderson0c732342018-11-28 17:10:42 -08001827
1828 // Retrofit devices have two super partitions, named super_a and super_b.
1829 // On these devices, secondary slots must be flashed as physical
1830 // partitions (otherwise they would not mount on first boot). To enforce
1831 // this, we delete any logical partitions for the "other" slot.
1832 if (is_retrofit_device()) {
1833 for (const auto& [image, slot] : os_images_) {
1834 std::string partition_name = image->part_name + "_"s + slot;
1835 if (image->IsSecondary() && is_logical(partition_name)) {
1836 fb->DeletePartition(partition_name);
1837 }
1838 }
1839 }
David Andersoncf444f32018-08-29 14:15:49 -07001840}
1841
David Anderson667b1ef2023-01-27 21:11:11 -08001842std::string FlashAllTool::GetPartitionName(const ImageEntry& entry) {
1843 auto slot = entry.second;
1844 if (slot.empty()) {
1845 slot = current_slot_;
1846 }
1847 if (slot.empty()) {
1848 return entry.first->part_name;
1849 }
1850 if (slot == "all") {
1851 LOG(FATAL) << "Cannot retrieve a singular name when using all slots";
1852 }
1853 return entry.first->part_name + "_" + slot;
1854}
1855
David Andersoncf444f32018-08-29 14:15:49 -07001856class ZipImageSource final : public ImageSource {
1857 public:
1858 explicit ZipImageSource(ZipArchiveHandle zip) : zip_(zip) {}
Tom Cherrydfd85df2018-09-20 14:45:05 -07001859 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001860 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001861
1862 private:
1863 ZipArchiveHandle zip_;
1864};
1865
Tom Cherrydfd85df2018-09-20 14:45:05 -07001866bool ZipImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1867 return UnzipToMemory(zip_, name, out);
David Andersoncf444f32018-08-29 14:15:49 -07001868}
1869
Yifan Hongb10d0672021-02-22 15:06:27 -08001870unique_fd ZipImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001871 return unzip_to_file(zip_, name.c_str());
1872}
1873
Andrew Chantd64b9882021-04-06 12:48:27 -07001874static void do_update(const char* filename, const std::string& slot_override, bool skip_secondary,
1875 bool force_flash) {
David Andersoncf444f32018-08-29 14:15:49 -07001876 ZipArchiveHandle zip;
1877 int error = OpenArchive(filename, &zip);
1878 if (error != 0) {
1879 die("failed to open zip file '%s': %s", filename, ErrorCodeString(error));
1880 }
1881
Andrew Chantd64b9882021-04-06 12:48:27 -07001882 FlashAllTool tool(ZipImageSource(zip), slot_override, skip_secondary, false, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001883 tool.Flash();
1884
1885 CloseArchive(zip);
1886}
1887
1888class LocalImageSource final : public ImageSource {
1889 public:
Tom Cherrydfd85df2018-09-20 14:45:05 -07001890 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001891 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001892};
1893
Tom Cherrydfd85df2018-09-20 14:45:05 -07001894bool LocalImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
David Andersoncf444f32018-08-29 14:15:49 -07001895 auto path = find_item_given_name(name);
1896 if (path.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001897 return false;
David Andersoncf444f32018-08-29 14:15:49 -07001898 }
Tom Cherrydfd85df2018-09-20 14:45:05 -07001899 return ReadFileToVector(path, out);
David Andersoncf444f32018-08-29 14:15:49 -07001900}
1901
Yifan Hongb10d0672021-02-22 15:06:27 -08001902unique_fd LocalImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001903 auto path = find_item_given_name(name);
Yifan Hongb10d0672021-02-22 15:06:27 -08001904 return unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
David Andersoncf444f32018-08-29 14:15:49 -07001905}
1906
Andrew Chantd64b9882021-04-06 12:48:27 -07001907static void do_flashall(const std::string& slot_override, bool skip_secondary, bool wipe,
1908 bool force_flash) {
1909 FlashAllTool tool(LocalImageSource(), slot_override, skip_secondary, wipe, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001910 tool.Flash();
1911}
1912
Elliott Hughesd6365a72017-05-08 18:04:49 -07001913static std::string next_arg(std::vector<std::string>* args) {
1914 if (args->empty()) syntax_error("expected argument");
1915 std::string result = args->front();
1916 args->erase(args->begin());
1917 return result;
Patrick Tjin51e8b032015-09-01 08:15:23 -07001918}
1919
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001920static void do_oem_command(const std::string& cmd, std::vector<std::string>* args) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07001921 if (args->empty()) syntax_error("empty oem command");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08001922
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001923 std::string command(cmd);
Elliott Hughesd6365a72017-05-08 18:04:49 -07001924 while (!args->empty()) {
Elliott Hughes29d5d7d2017-05-11 15:05:13 -07001925 command += " " + next_arg(args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001926 }
Tom Cherry9027af02018-09-24 15:48:09 -07001927 fb->RawCommand(command, "");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001928}
1929
Aaron Wisnerdb511202018-06-26 15:38:35 -05001930static unsigned fb_get_flash_block_size(std::string name) {
Connor O'Brience16a8a2017-02-06 14:39:31 -08001931 std::string sizeString;
Tom Cherry9027af02018-09-24 15:48:09 -07001932 if (fb->GetVar(name, &sizeString) != fastboot::SUCCESS || sizeString.empty()) {
Elliott Hughes5620d222018-03-28 08:20:00 -07001933 // This device does not report flash block sizes, so return 0.
Connor O'Brience16a8a2017-02-06 14:39:31 -08001934 return 0;
1935 }
1936 sizeString = fb_fix_numeric_var(sizeString);
1937
1938 unsigned size;
1939 if (!android::base::ParseUint(sizeString, &size)) {
1940 fprintf(stderr, "Couldn't parse %s '%s'.\n", name.c_str(), sizeString.c_str());
1941 return 0;
1942 }
Connor O'Brien6ef5c242017-11-01 17:37:32 -07001943 if ((size & (size - 1)) != 0) {
1944 fprintf(stderr, "Invalid %s %u: must be a power of 2.\n", name.c_str(), size);
Connor O'Brience16a8a2017-02-06 14:39:31 -08001945 return 0;
1946 }
1947 return size;
1948}
1949
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001950static void fb_perform_format(const std::string& partition, int skip_if_not_supported,
Elliott Hughesd6365a72017-05-08 18:04:49 -07001951 const std::string& type_override, const std::string& size_override,
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001952 const unsigned fs_options) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001953 std::string partition_type, partition_size;
1954
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001955 struct fastboot_buffer buf;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001956 const char* errMsg = nullptr;
1957 const struct fs_generator* gen = nullptr;
Jin Qian4a335822017-04-18 16:23:18 -07001958 TemporaryFile output;
1959 unique_fd fd;
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001960
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001961 unsigned int limit = INT_MAX;
1962 if (target_sparse_limit > 0 && target_sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001963 limit = target_sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001964 }
1965 if (sparse_limit > 0 && sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001966 limit = sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001967 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001968
Tom Cherry9027af02018-09-24 15:48:09 -07001969 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001970 errMsg = "Can't determine partition type.\n";
1971 goto failed;
1972 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001973 if (!type_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001974 if (partition_type != type_override) {
1975 fprintf(stderr, "Warning: %s type is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001976 partition.c_str(), partition_type.c_str(), type_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001977 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001978 partition_type = type_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001979 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001980
Tom Cherry9027af02018-09-24 15:48:09 -07001981 if (fb->GetVar("partition-size:" + partition, &partition_size) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001982 errMsg = "Unable to get partition size\n";
1983 goto failed;
1984 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001985 if (!size_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001986 if (partition_size != size_override) {
1987 fprintf(stderr, "Warning: %s size is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001988 partition.c_str(), partition_size.c_str(), size_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001989 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001990 partition_size = size_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001991 }
Connor O'Brience16a8a2017-02-06 14:39:31 -08001992 partition_size = fb_fix_numeric_var(partition_size);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001993
Elliott Hughes8ab9a322015-11-02 14:05:57 -08001994 gen = fs_get_generator(partition_type);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001995 if (!gen) {
1996 if (skip_if_not_supported) {
1997 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001998 fprintf(stderr, "File system type %s not supported.\n", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001999 return;
2000 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002001 die("Formatting is not supported for file system with type '%s'.", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002002 }
2003
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002004 int64_t size;
Elliott Hughesda46b392016-10-11 17:09:00 -07002005 if (!android::base::ParseInt(partition_size, &size)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002006 die("Couldn't parse partition size '%s'.", partition_size.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002007 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002008
Connor O'Brience16a8a2017-02-06 14:39:31 -08002009 unsigned eraseBlkSize, logicalBlkSize;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002010 eraseBlkSize = fb_get_flash_block_size("erase-block-size");
2011 logicalBlkSize = fb_get_flash_block_size("logical-block-size");
Connor O'Brience16a8a2017-02-06 14:39:31 -08002012
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002013 if (fs_generator_generate(gen, output.path, size, eraseBlkSize, logicalBlkSize, fs_options)) {
Elliott Hughes5620d222018-03-28 08:20:00 -07002014 die("Cannot generate image for %s", partition.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002015 }
2016
Jin Qian4a335822017-04-18 16:23:18 -07002017 fd.reset(open(output.path, O_RDONLY));
2018 if (fd == -1) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002019 die("Cannot open generated image: %s", strerror(errno));
Jin Qian4a335822017-04-18 16:23:18 -07002020 }
Yifan Hongb10d0672021-02-22 15:06:27 -08002021 if (!load_buf_fd(std::move(fd), &buf)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002022 die("Cannot read image: %s", strerror(errno));
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002023 }
2024 flash_buf(partition, &buf);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002025 return;
2026
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002027failed:
2028 if (skip_if_not_supported) {
2029 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002030 if (errMsg) fprintf(stderr, "%s", errMsg);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002031 }
Tom Cherry9027af02018-09-24 15:48:09 -07002032 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
Mark Salyzyna30b6962018-11-20 11:04:15 -08002033 if (!skip_if_not_supported) {
2034 die("Command failed");
2035 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002036}
2037
Daniel Zheng0d307182023-01-31 21:07:53 +00002038bool should_flash_in_userspace(const std::string& partition_name) {
David Andersone0e693c2018-11-27 20:19:26 -08002039 if (!get_android_product_out()) {
2040 return false;
2041 }
David Anderson89569642018-11-16 15:53:35 -08002042 auto path = find_item_given_name("super_empty.img");
David Anderson00475802018-12-04 17:05:47 -08002043 if (path.empty() || access(path.c_str(), R_OK)) {
David Anderson89569642018-11-16 15:53:35 -08002044 return false;
2045 }
2046 auto metadata = android::fs_mgr::ReadFromImageFile(path);
2047 if (!metadata) {
2048 return false;
2049 }
David Andersonaa87dc52023-01-27 20:39:06 -08002050 return should_flash_in_userspace(*metadata.get(), partition_name);
David Anderson89569642018-11-16 15:53:35 -08002051}
2052
David Anderson7c84b9f2019-06-27 22:15:29 -07002053static bool wipe_super(const android::fs_mgr::LpMetadata& metadata, const std::string& slot,
2054 std::string* message) {
2055 auto super_device = GetMetadataSuperBlockDevice(metadata);
2056 auto block_size = metadata.geometry.logical_block_size;
2057 auto super_bdev_name = android::fs_mgr::GetBlockDevicePartitionName(*super_device);
2058
2059 if (super_bdev_name != "super") {
2060 // retrofit devices do not allow flashing to the retrofit partitions,
2061 // so enable it if we can.
2062 fb->RawCommand("oem allow-flash-super");
2063 }
2064
2065 // Note: do not use die() in here, since we want TemporaryDir's destructor
2066 // to be called.
2067 TemporaryDir temp_dir;
2068
2069 bool ok;
2070 if (metadata.block_devices.size() > 1) {
2071 ok = WriteSplitImageFiles(temp_dir.path, metadata, block_size, {}, true);
2072 } else {
2073 auto image_path = temp_dir.path + "/"s + super_bdev_name + ".img";
2074 ok = WriteToImageFile(image_path, metadata, block_size, {}, true);
2075 }
2076 if (!ok) {
2077 *message = "Could not generate a flashable super image file";
2078 return false;
2079 }
2080
2081 for (const auto& block_device : metadata.block_devices) {
2082 auto partition = android::fs_mgr::GetBlockDevicePartitionName(block_device);
2083 bool force_slot = !!(block_device.flags & LP_BLOCK_DEVICE_SLOT_SUFFIXED);
2084
2085 std::string image_name;
2086 if (metadata.block_devices.size() > 1) {
2087 image_name = "super_" + partition + ".img";
2088 } else {
2089 image_name = partition + ".img";
2090 }
2091
2092 auto image_path = temp_dir.path + "/"s + image_name;
2093 auto flash = [&](const std::string& partition_name) {
2094 do_flash(partition_name.c_str(), image_path.c_str());
2095 };
2096 do_for_partitions(partition, slot, flash, force_slot);
2097
2098 unlink(image_path.c_str());
2099 }
2100 return true;
2101}
2102
2103static void do_wipe_super(const std::string& image, const std::string& slot_override) {
2104 if (access(image.c_str(), R_OK) != 0) {
2105 die("Could not read image: %s", image.c_str());
2106 }
2107 auto metadata = android::fs_mgr::ReadFromImageFile(image);
2108 if (!metadata) {
2109 die("Could not parse image: %s", image.c_str());
2110 }
2111
2112 auto slot = slot_override;
2113 if (slot.empty()) {
2114 slot = get_current_slot();
2115 }
2116
2117 std::string message;
2118 if (!wipe_super(*metadata.get(), slot, &message)) {
2119 die(message);
2120 }
2121}
2122
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002123static void FastbootLogger(android::base::LogId /* id */, android::base::LogSeverity severity,
David Andersona67fc322023-01-27 16:15:52 -08002124 const char* /* tag */, const char* /* file */, unsigned int /* line */,
2125 const char* message) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002126 switch (severity) {
2127 case android::base::INFO:
2128 fprintf(stdout, "%s\n", message);
2129 break;
2130 case android::base::ERROR:
2131 fprintf(stderr, "%s\n", message);
2132 break;
2133 default:
2134 verbose("%s\n", message);
2135 }
David Andersona67fc322023-01-27 16:15:52 -08002136}
2137
2138static void FastbootAborter(const char* message) {
2139 die("%s", message);
2140}
2141
Aaron Wisnerdb511202018-06-26 15:38:35 -05002142int FastBootTool::Main(int argc, char* argv[]) {
David Andersona67fc322023-01-27 16:15:52 -08002143 android::base::InitLogging(argv, FastbootLogger, FastbootAborter);
2144
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002145 bool wants_wipe = false;
2146 bool wants_reboot = false;
2147 bool wants_reboot_bootloader = false;
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002148 bool wants_reboot_recovery = false;
2149 bool wants_reboot_fastboot = false;
Mitchell Wills31dce302016-09-26 10:26:21 -07002150 bool skip_reboot = false;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002151 bool wants_set_active = false;
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002152 bool skip_secondary = false;
David Anderson89569642018-11-16 15:53:35 -08002153 bool force_flash = false;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002154 unsigned fs_options = 0;
Florian BƤuerle27ded482014-11-24 11:29:34 +01002155 int longindex;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002156 std::string slot_override;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002157 std::string next_active;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002158
Elliott Hughes577e8b42018-04-05 16:12:47 -07002159 g_boot_img_hdr.kernel_addr = 0x00008000;
2160 g_boot_img_hdr.ramdisk_addr = 0x01000000;
2161 g_boot_img_hdr.second_addr = 0x00f00000;
2162 g_boot_img_hdr.tags_addr = 0x00000100;
2163 g_boot_img_hdr.page_size = 2048;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002164 g_boot_img_hdr.dtb_addr = 0x01100000;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002165
Daniel Zheng65452d02022-11-30 02:25:31 +00002166 const struct option longopts[] = {{"base", required_argument, 0, 0},
2167 {"cmdline", required_argument, 0, 0},
2168 {"disable-verification", no_argument, 0, 0},
2169 {"disable-verity", no_argument, 0, 0},
2170 {"force", no_argument, 0, 0},
2171 {"fs-options", required_argument, 0, 0},
2172 {"header-version", required_argument, 0, 0},
2173 {"help", no_argument, 0, 'h'},
2174 {"kernel-offset", required_argument, 0, 0},
2175 {"os-patch-level", required_argument, 0, 0},
2176 {"os-version", required_argument, 0, 0},
2177 {"page-size", required_argument, 0, 0},
2178 {"ramdisk-offset", required_argument, 0, 0},
2179 {"set-active", optional_argument, 0, 'a'},
2180 {"skip-reboot", no_argument, 0, 0},
2181 {"skip-secondary", no_argument, 0, 0},
2182 {"slot", required_argument, 0, 0},
2183 {"tags-offset", required_argument, 0, 0},
2184 {"dtb", required_argument, 0, 0},
2185 {"dtb-offset", required_argument, 0, 0},
2186 {"unbuffered", no_argument, 0, 0},
2187 {"verbose", no_argument, 0, 'v'},
2188 {"version", no_argument, 0, 0},
2189 {0, 0, 0, 0}};
Colin Cross8879f982012-05-22 17:53:34 -07002190
2191 serial = getenv("ANDROID_SERIAL");
2192
Elliott Hughes577e8b42018-04-05 16:12:47 -07002193 int c;
Elliott Hughesf3192bd2018-04-10 15:38:08 -07002194 while ((c = getopt_long(argc, argv, "a::hls:S:vw", longopts, &longindex)) != -1) {
Elliott Hughes577e8b42018-04-05 16:12:47 -07002195 if (c == 0) {
2196 std::string name{longopts[longindex].name};
2197 if (name == "base") {
2198 g_base_addr = strtoul(optarg, 0, 16);
2199 } else if (name == "cmdline") {
2200 g_cmdline = optarg;
2201 } else if (name == "disable-verification") {
2202 g_disable_verification = true;
2203 } else if (name == "disable-verity") {
2204 g_disable_verity = true;
David Anderson89569642018-11-16 15:53:35 -08002205 } else if (name == "force") {
2206 force_flash = true;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002207 } else if (name == "fs-options") {
2208 fs_options = ParseFsOption(optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002209 } else if (name == "header-version") {
2210 g_boot_img_hdr.header_version = strtoul(optarg, nullptr, 0);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002211 } else if (name == "dtb") {
2212 g_dtb_path = optarg;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002213 } else if (name == "kernel-offset") {
2214 g_boot_img_hdr.kernel_addr = strtoul(optarg, 0, 16);
2215 } else if (name == "os-patch-level") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002216 ParseOsPatchLevel(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002217 } else if (name == "os-version") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002218 ParseOsVersion(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002219 } else if (name == "page-size") {
2220 g_boot_img_hdr.page_size = strtoul(optarg, nullptr, 0);
2221 if (g_boot_img_hdr.page_size == 0) die("invalid page size");
2222 } else if (name == "ramdisk-offset") {
2223 g_boot_img_hdr.ramdisk_addr = strtoul(optarg, 0, 16);
2224 } else if (name == "skip-reboot") {
2225 skip_reboot = true;
2226 } else if (name == "skip-secondary") {
2227 skip_secondary = true;
2228 } else if (name == "slot") {
2229 slot_override = optarg;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002230 } else if (name == "dtb-offset") {
2231 g_boot_img_hdr.dtb_addr = strtoul(optarg, 0, 16);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002232 } else if (name == "tags-offset") {
2233 g_boot_img_hdr.tags_addr = strtoul(optarg, 0, 16);
2234 } else if (name == "unbuffered") {
Elliott Hughesfc797672015-04-07 20:12:50 -07002235 setvbuf(stdout, nullptr, _IONBF, 0);
2236 setvbuf(stderr, nullptr, _IONBF, 0);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002237 } else if (name == "version") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002238 fprintf(stdout, "fastboot version %s-%s\n", PLATFORM_TOOLS_VERSION,
2239 android::build::GetBuildNumber().c_str());
Elliott Hughes1fd46df2017-03-30 15:08:28 -07002240 fprintf(stdout, "Installed as %s\n", android::base::GetExecutablePath().c_str());
Elliott Hughes379646b2015-06-02 13:50:00 -07002241 return 0;
Paul Crowley8f7f56e2015-11-27 09:29:37 +00002242 } else {
Elliott Hughes855cdf82018-04-02 14:24:03 -07002243 die("unknown option %s", longopts[longindex].name);
Florian BƤuerle27ded482014-11-24 11:29:34 +01002244 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002245 } else {
2246 switch (c) {
2247 case 'a':
2248 wants_set_active = true;
2249 if (optarg) next_active = optarg;
2250 break;
2251 case 'h':
2252 return show_help();
Elliott Hughes577e8b42018-04-05 16:12:47 -07002253 case 'l':
2254 g_long_listing = true;
2255 break;
2256 case 's':
2257 serial = optarg;
2258 break;
2259 case 'S':
Elliott Hughes542370d2018-04-19 19:49:44 -07002260 if (!android::base::ParseByteCount(optarg, &sparse_limit)) {
2261 die("invalid sparse limit %s", optarg);
2262 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002263 break;
2264 case 'v':
2265 set_verbose();
2266 break;
2267 case 'w':
2268 wants_wipe = true;
2269 break;
2270 case '?':
2271 return 1;
2272 default:
2273 abort();
2274 }
Colin Cross8879f982012-05-22 17:53:34 -07002275 }
2276 }
2277
2278 argc -= optind;
2279 argv += optind;
2280
Elliott Hughesd6365a72017-05-08 18:04:49 -07002281 if (argc == 0 && !wants_wipe && !wants_set_active) syntax_error("no command");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002282
Colin Cross8fb6e062012-07-24 16:36:41 -07002283 if (argc > 0 && !strcmp(*argv, "devices")) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002284 list_devices();
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08002285 return 0;
2286 }
2287
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002288 if (argc > 0 && !strcmp(*argv, "connect")) {
2289 argc -= optind;
2290 argv += optind;
2291 return Connect(argc, argv);
2292 }
2293
2294 if (argc > 0 && !strcmp(*argv, "disconnect")) {
2295 argc -= optind;
2296 argv += optind;
2297 return Disconnect(argc, argv);
2298 }
2299
Colin Crossc7b75dc2012-08-29 18:17:06 -07002300 if (argc > 0 && !strcmp(*argv, "help")) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002301 return show_help();
Colin Crossc7b75dc2012-08-29 18:17:06 -07002302 }
2303
David Pursell0b156632015-10-30 11:22:01 -07002304 Transport* transport = open_device();
David Pursell2ec418a2016-01-20 08:32:08 -08002305 if (transport == nullptr) {
2306 return 1;
2307 }
Tom Cherry9027af02018-09-24 15:48:09 -07002308 fastboot::DriverCallbacks driver_callbacks = {
Daniel Zheng65452d02022-11-30 02:25:31 +00002309 .prolog = Status,
2310 .epilog = Epilog,
2311 .info = InfoMessage,
Raphael Herouart99097cc2022-12-30 11:51:54 +00002312 .text = TextMessage,
Tom Cherry9027af02018-09-24 15:48:09 -07002313 };
Raphael Herouart99097cc2022-12-30 11:51:54 +00002314
Tom Cherry9027af02018-09-24 15:48:09 -07002315 fastboot::FastBootDriver fastboot_driver(transport, driver_callbacks, false);
2316 fb = &fastboot_driver;
David Pursell2ec418a2016-01-20 08:32:08 -08002317
Elliott Hughes5620d222018-03-28 08:20:00 -07002318 const double start = now();
2319
Aaron Wisnerdb511202018-06-26 15:38:35 -05002320 if (slot_override != "") slot_override = verify_slot(slot_override);
2321 if (next_active != "") next_active = verify_slot(next_active, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002322
2323 if (wants_set_active) {
2324 if (next_active == "") {
2325 if (slot_override == "") {
Daniel Rosenberg13454092016-06-27 19:43:11 -07002326 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07002327 if (fb->GetVar("current-slot", &current_slot) == fastboot::SUCCESS) {
LuK1337dae48ef2020-04-06 14:38:58 +02002328 if (current_slot[0] == '_') current_slot.erase(0, 1);
Aaron Wisnerdb511202018-06-26 15:38:35 -05002329 next_active = verify_slot(current_slot, false);
Daniel Rosenberg13454092016-06-27 19:43:11 -07002330 } else {
2331 wants_set_active = false;
2332 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002333 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002334 next_active = verify_slot(slot_override, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002335 }
2336 }
2337 }
Elliott Hughes31dbed72009-10-07 15:38:53 -07002338
Elliott Hughesd6365a72017-05-08 18:04:49 -07002339 std::vector<std::string> args(argv, argv + argc);
2340 while (!args.empty()) {
2341 std::string command = next_arg(&args);
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002342
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002343 if (command == FB_CMD_GETVAR) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002344 std::string variable = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002345 DisplayVarOrError(variable, variable);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002346 } else if (command == FB_CMD_ERASE) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002347 std::string partition = next_arg(&args);
2348 auto erase = [&](const std::string& partition) {
David Pursell0b156632015-10-30 11:22:01 -07002349 std::string partition_type;
Daniel Zheng65452d02022-11-30 02:25:31 +00002350 if (fb->GetVar("partition-type:" + partition, &partition_type) ==
2351 fastboot::SUCCESS &&
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002352 fs_get_generator(partition_type) != nullptr) {
2353 fprintf(stderr, "******** Did you mean to fastboot format this %s partition?\n",
2354 partition_type.c_str());
2355 }
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002356
Tom Cherry9027af02018-09-24 15:48:09 -07002357 fb->Erase(partition);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002358 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002359 do_for_partitions(partition, slot_override, erase, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002360 } else if (android::base::StartsWith(command, "format")) {
2361 // Parsing for: "format[:[type][:[size]]]"
2362 // Some valid things:
2363 // - select only the size, and leave default fs type:
2364 // format::0x4000000 userdata
2365 // - default fs type and size:
2366 // format userdata
2367 // format:: userdata
2368 std::vector<std::string> pieces = android::base::Split(command, ":");
2369 std::string type_override;
2370 if (pieces.size() > 1) type_override = pieces[1].c_str();
2371 std::string size_override;
2372 if (pieces.size() > 2) size_override = pieces[2].c_str();
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002373
Elliott Hughesd6365a72017-05-08 18:04:49 -07002374 std::string partition = next_arg(&args);
2375
2376 auto format = [&](const std::string& partition) {
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002377 fb_perform_format(partition, 0, type_override, size_override, fs_options);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002378 };
Greg Kaiserb49d9e12019-03-26 12:04:05 -07002379 do_for_partitions(partition, slot_override, format, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002380 } else if (command == "signature") {
2381 std::string filename = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002382 std::vector<char> data;
2383 if (!ReadFileToVector(filename, &data)) {
2384 die("could not load '%s': %s", filename.c_str(), strerror(errno));
2385 }
2386 if (data.size() != 256) die("signature must be 256 bytes (got %zu)", data.size());
Tom Cherry9027af02018-09-24 15:48:09 -07002387 fb->Download("signature", data);
2388 fb->RawCommand("signature", "installing signature");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002389 } else if (command == FB_CMD_REBOOT) {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002390 wants_reboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002391
2392 if (args.size() == 1) {
2393 std::string what = next_arg(&args);
2394 if (what == "bootloader") {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002395 wants_reboot = false;
2396 wants_reboot_bootloader = true;
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002397 } else if (what == "recovery") {
2398 wants_reboot = false;
2399 wants_reboot_recovery = true;
2400 } else if (what == "fastboot") {
2401 wants_reboot = false;
2402 wants_reboot_fastboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002403 } else {
2404 syntax_error("unknown reboot target %s", what.c_str());
Alexey Polyudove0bfb752017-01-03 19:39:13 -08002405 }
Elliott Hughesca85df02015-02-25 10:02:00 -08002406 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002407 if (!args.empty()) syntax_error("junk after reboot command");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002408 } else if (command == FB_CMD_REBOOT_BOOTLOADER) {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002409 wants_reboot_bootloader = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002410 } else if (command == FB_CMD_REBOOT_RECOVERY) {
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002411 wants_reboot_recovery = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002412 } else if (command == FB_CMD_REBOOT_FASTBOOT) {
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002413 wants_reboot_fastboot = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002414 } else if (command == FB_CMD_CONTINUE) {
Tom Cherry9027af02018-09-24 15:48:09 -07002415 fb->Continue();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002416 } else if (command == FB_CMD_BOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002417 std::string kernel = next_arg(&args);
2418 std::string ramdisk;
2419 if (!args.empty()) ramdisk = next_arg(&args);
2420 std::string second_stage;
2421 if (!args.empty()) second_stage = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002422 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
Tom Cherry9027af02018-09-24 15:48:09 -07002423 fb->Download("boot.img", data);
2424 fb->Boot();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002425 } else if (command == FB_CMD_FLASH) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002426 std::string pname = next_arg(&args);
Elliott Hughes2810d002016-04-25 14:31:18 -07002427 std::string fname;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002428 if (!args.empty()) {
2429 fname = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002430 } else {
Elliott Hughes45964a82017-05-03 22:43:23 -07002431 fname = find_item(pname);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002432 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002433 if (fname.empty()) die("cannot determine image filename for '%s'", pname.c_str());
Daniel Zheng0d307182023-01-31 21:07:53 +00002434 FlashTask task(slot_override, force_flash, pname, fname);
2435 task.Run();
Elliott Hughesd6365a72017-05-08 18:04:49 -07002436 } else if (command == "flash:raw") {
2437 std::string partition = next_arg(&args);
2438 std::string kernel = next_arg(&args);
2439 std::string ramdisk;
2440 if (!args.empty()) ramdisk = next_arg(&args);
2441 std::string second_stage;
2442 if (!args.empty()) second_stage = next_arg(&args);
2443
Tom Cherrydfd85df2018-09-20 14:45:05 -07002444 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2445 auto flashraw = [&data](const std::string& partition) {
Tom Cherry9027af02018-09-24 15:48:09 -07002446 fb->FlashPartition(partition, data);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002447 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002448 do_for_partitions(partition, slot_override, flashraw, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002449 } else if (command == "flashall") {
Alex Lightbb9b8a52016-06-29 09:26:44 -07002450 if (slot_override == "all") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002451 fprintf(stderr,
2452 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Andrew Chantd64b9882021-04-06 12:48:27 -07002453 do_flashall(slot_override, true, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002454 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -07002455 do_flashall(slot_override, skip_secondary, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002456 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002457 wants_reboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002458 } else if (command == "update") {
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002459 bool slot_all = (slot_override == "all");
2460 if (slot_all) {
Daniel Zheng65452d02022-11-30 02:25:31 +00002461 fprintf(stderr,
2462 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002463 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002464 std::string filename = "update.zip";
2465 if (!args.empty()) {
2466 filename = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002467 }
Andrew Chantd64b9882021-04-06 12:48:27 -07002468 do_update(filename.c_str(), slot_override, skip_secondary || slot_all, force_flash);
Mitchell Wills31dce302016-09-26 10:26:21 -07002469 wants_reboot = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002470 } else if (command == FB_CMD_SET_ACTIVE) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002471 std::string slot = verify_slot(next_arg(&args), false);
Tom Cherry9027af02018-09-24 15:48:09 -07002472 fb->SetActive(slot);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002473 } else if (command == "stage") {
2474 std::string filename = next_arg(&args);
2475
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002476 struct fastboot_buffer buf;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002477 if (!load_buf(filename.c_str(), &buf) || buf.type != FB_BUFFER_FD) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002478 die("cannot load '%s'", filename.c_str());
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002479 }
Yifan Hong58532df2021-03-22 16:39:13 -07002480 fb->Download(filename, buf.fd.get(), buf.sz);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002481 } else if (command == "get_staged") {
2482 std::string filename = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002483 fb->Upload(filename);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002484 } else if (command == FB_CMD_OEM) {
2485 do_oem_command(FB_CMD_OEM, &args);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002486 } else if (command == "flashing") {
2487 if (args.empty()) {
2488 syntax_error("missing 'flashing' command");
Daniel Zheng65452d02022-11-30 02:25:31 +00002489 } else if (args.size() == 1 &&
2490 (args[0] == "unlock" || args[0] == "lock" || args[0] == "unlock_critical" ||
2491 args[0] == "lock_critical" || args[0] == "get_unlock_ability")) {
Elliott Hughes1eec97a2017-05-15 16:53:53 -07002492 do_oem_command("flashing", &args);
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002493 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002494 syntax_error("unknown 'flashing' command %s", args[0].c_str());
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002495 }
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002496 } else if (command == FB_CMD_CREATE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002497 std::string partition = next_arg(&args);
2498 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002499 fb->CreatePartition(partition, size);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002500 } else if (command == FB_CMD_DELETE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002501 std::string partition = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002502 fb->DeletePartition(partition);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002503 } else if (command == FB_CMD_RESIZE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002504 std::string partition = next_arg(&args);
2505 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002506 fb->ResizePartition(partition, size);
David Anderson1d504e32019-01-15 14:38:20 -08002507 } else if (command == "gsi") {
David Anderson3d782d52019-01-29 13:09:49 -08002508 std::string arg = next_arg(&args);
2509 if (arg == "wipe") {
David Anderson1d504e32019-01-15 14:38:20 -08002510 fb->RawCommand("gsi:wipe", "wiping GSI");
David Anderson3d782d52019-01-29 13:09:49 -08002511 } else if (arg == "disable") {
David Anderson1d504e32019-01-15 14:38:20 -08002512 fb->RawCommand("gsi:disable", "disabling GSI");
2513 } else {
2514 syntax_error("expected 'wipe' or 'disable'");
2515 }
David Anderson7c84b9f2019-06-27 22:15:29 -07002516 } else if (command == "wipe-super") {
2517 std::string image;
2518 if (args.empty()) {
2519 image = find_item_given_name("super_empty.img");
2520 } else {
2521 image = next_arg(&args);
2522 }
2523 do_wipe_super(image, slot_override);
David Andersonab8f4662019-10-21 16:45:59 -07002524 } else if (command == "snapshot-update") {
2525 std::string arg;
2526 if (!args.empty()) {
2527 arg = next_arg(&args);
2528 }
David Anderson220ddb12019-10-31 18:02:41 -07002529 if (!arg.empty() && (arg != "cancel" && arg != "merge")) {
2530 syntax_error("expected: snapshot-update [cancel|merge]");
David Andersonab8f4662019-10-21 16:45:59 -07002531 }
2532 fb->SnapshotUpdateCommand(arg);
Yifan Hongbcd27702021-02-16 19:37:32 -08002533 } else if (command == FB_CMD_FETCH) {
2534 std::string partition = next_arg(&args);
2535 std::string outfile = next_arg(&args);
2536 do_fetch(partition, slot_override, outfile);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002537 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002538 syntax_error("unknown command %s", command.c_str());
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002539 }
2540 }
2541
2542 if (wants_wipe) {
David Andersonab8f4662019-10-21 16:45:59 -07002543 if (force_flash) {
2544 CancelSnapshotIfNeeded();
2545 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002546 std::vector<std::string> partitions = {"userdata", "cache", "metadata"};
Paul Crowley4d170062018-04-24 17:06:30 -07002547 for (const auto& partition : partitions) {
2548 std::string partition_type;
Tom Cherry9027af02018-09-24 15:48:09 -07002549 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
2550 continue;
2551 }
Paul Crowley4d170062018-04-24 17:06:30 -07002552 if (partition_type.empty()) continue;
Tom Cherry9027af02018-09-24 15:48:09 -07002553 fb->Erase(partition);
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002554 fb_perform_format(partition, 1, partition_type, "", fs_options);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002555 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002556 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002557 if (wants_set_active) {
Tom Cherry9027af02018-09-24 15:48:09 -07002558 fb->SetActive(next_active);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002559 }
Mitchell Wills31dce302016-09-26 10:26:21 -07002560 if (wants_reboot && !skip_reboot) {
Tom Cherry9027af02018-09-24 15:48:09 -07002561 fb->Reboot();
2562 fb->WaitForDisconnect();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002563 } else if (wants_reboot_bootloader) {
Tom Cherry9027af02018-09-24 15:48:09 -07002564 fb->RebootTo("bootloader");
2565 fb->WaitForDisconnect();
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002566 } else if (wants_reboot_recovery) {
Tom Cherry9027af02018-09-24 15:48:09 -07002567 fb->RebootTo("recovery");
2568 fb->WaitForDisconnect();
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002569 } else if (wants_reboot_fastboot) {
David Anderson11d6d272018-12-07 16:39:07 -08002570 reboot_to_userspace_fastboot();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002571 }
2572
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}