blob: 5172530782ad6ca429ea48fabd00f2cf629e0971 [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) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00001102 auto path = find_item_given_name(fname);
1103 fd = unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
1104 if (fd == -1) return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001105 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001106
1107 struct stat s;
Yifan Hong58532df2021-03-22 16:39:13 -07001108 if (fstat(fd.get(), &s)) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001109 return false;
1110 }
1111 if (!S_ISREG(s.st_mode)) {
1112 errno = S_ISDIR(s.st_mode) ? EISDIR : EINVAL;
1113 return false;
1114 }
1115
Yifan Hongb10d0672021-02-22 15:06:27 -08001116 return load_buf_fd(std::move(fd), buf);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001117}
1118
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001119static void rewrite_vbmeta_buffer(struct fastboot_buffer* buf, bool vbmeta_in_boot) {
David Zeuthenb6ea4352017-08-07 14:29:26 -04001120 // Buffer needs to be at least the size of the VBMeta struct which
1121 // is 256 bytes.
1122 if (buf->sz < 256) {
1123 return;
1124 }
1125
David Zeuthenb6ea4352017-08-07 14:29:26 -04001126 std::string data;
1127 if (!android::base::ReadFdToString(buf->fd, &data)) {
1128 die("Failed reading from vbmeta");
1129 }
1130
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001131 uint64_t vbmeta_offset = 0;
1132 if (vbmeta_in_boot) {
1133 // Tries to locate top-level vbmeta from boot.img footer.
1134 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1135 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001136 die("Failed to find AVB_FOOTER at offset: %" PRId64 ", is BOARD_AVB_ENABLE true?",
1137 footer_offset);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001138 }
1139 const AvbFooter* footer = reinterpret_cast<const AvbFooter*>(data.c_str() + footer_offset);
1140 vbmeta_offset = be64toh(footer->vbmeta_offset);
1141 }
1142 // Ensures there is AVB_MAGIC at vbmeta_offset.
1143 if (0 != data.compare(vbmeta_offset, AVB_MAGIC_LEN, AVB_MAGIC)) {
1144 die("Failed to find AVB_MAGIC at offset: %" PRId64, vbmeta_offset);
1145 }
1146
1147 fprintf(stderr, "Rewriting vbmeta struct at offset: %" PRId64 "\n", vbmeta_offset);
1148
David Zeuthenb6ea4352017-08-07 14:29:26 -04001149 // There's a 32-bit big endian |flags| field at offset 120 where
1150 // bit 0 corresponds to disable-verity and bit 1 corresponds to
1151 // disable-verification.
1152 //
1153 // See external/avb/libavb/avb_vbmeta_image.h for the layout of
1154 // the VBMeta struct.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001155 uint64_t flags_offset = 123 + vbmeta_offset;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001156 if (g_disable_verity) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001157 data[flags_offset] |= 0x01;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001158 }
1159 if (g_disable_verification) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001160 data[flags_offset] |= 0x02;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001161 }
1162
Yifan Hongb10d0672021-02-22 15:06:27 -08001163 unique_fd fd(make_temporary_fd("vbmeta rewriting"));
David Zeuthenb6ea4352017-08-07 14:29:26 -04001164 if (!android::base::WriteStringToFd(data, fd)) {
1165 die("Failed writing to modified vbmeta");
1166 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001167 buf->fd = std::move(fd);
Yifan Hong58532df2021-03-22 16:39:13 -07001168 lseek(buf->fd.get(), 0, SEEK_SET);
David Zeuthenb6ea4352017-08-07 14:29:26 -04001169}
1170
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001171static bool has_vbmeta_partition() {
1172 std::string partition_type;
1173 return fb->GetVar("partition-type:vbmeta", &partition_type) == fastboot::SUCCESS ||
1174 fb->GetVar("partition-type:vbmeta_a", &partition_type) == fastboot::SUCCESS ||
1175 fb->GetVar("partition-type:vbmeta_b", &partition_type) == fastboot::SUCCESS;
1176}
1177
David Andersonaa87dc52023-01-27 20:39:06 -08001178// Note: this only works in userspace fastboot. In the bootloader, use
1179// should_flash_in_userspace().
Michael Bestasa495be72020-11-06 17:58:28 +02001180static bool is_logical(const std::string& partition) {
1181 std::string value;
1182 return fb->GetVar("is-logical:" + partition, &value) == fastboot::SUCCESS && value == "yes";
1183}
1184
Steve Muckle3af575b2020-06-18 17:02:15 -07001185static std::string fb_fix_numeric_var(std::string var) {
1186 // Some bootloaders (angler, for example), send spurious leading whitespace.
1187 var = android::base::Trim(var);
1188 // Some bootloaders (hammerhead, for example) use implicit hex.
1189 // This code used to use strtol with base 16.
1190 if (!android::base::StartsWith(var, "0x")) var = "0x" + var;
1191 return var;
1192}
1193
Yifan Hongbcd27702021-02-16 19:37:32 -08001194static uint64_t get_partition_size(const std::string& partition) {
Steve Muckle3af575b2020-06-18 17:02:15 -07001195 std::string partition_size_str;
1196 if (fb->GetVar("partition-size:" + partition, &partition_size_str) != fastboot::SUCCESS) {
Michael Bestasa495be72020-11-06 17:58:28 +02001197 if (!is_logical(partition)) {
1198 return 0;
1199 }
Yifan Hong60de9692021-02-17 13:51:54 -08001200 die("cannot get partition size for %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001201 }
1202
1203 partition_size_str = fb_fix_numeric_var(partition_size_str);
Yifan Hongbcd27702021-02-16 19:37:32 -08001204 uint64_t partition_size;
1205 if (!android::base::ParseUint(partition_size_str, &partition_size)) {
Michael Bestasa495be72020-11-06 17:58:28 +02001206 if (!is_logical(partition)) {
1207 return 0;
1208 }
Steve Muckle3af575b2020-06-18 17:02:15 -07001209 die("Couldn't parse partition size '%s'.", partition_size_str.c_str());
1210 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001211 return partition_size;
1212}
1213
Devin Moorecb5098f2022-01-07 16:33:46 +00001214static void copy_avb_footer(const std::string& partition, struct fastboot_buffer* buf) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001215 if (buf->sz < AVB_FOOTER_SIZE) {
1216 return;
1217 }
1218
Bowgo Tsai671249a2021-08-10 16:32:37 +08001219 // If overflows and negative, it should be < buf->sz.
1220 int64_t partition_size = static_cast<int64_t>(get_partition_size(partition));
1221
1222 if (partition_size == buf->sz) {
1223 return;
1224 }
1225 // Some device bootloaders might not implement `fastboot getvar partition-size:boot[_a|_b]`.
1226 // In this case, partition_size will be zero.
1227 if (partition_size < buf->sz) {
1228 fprintf(stderr,
Devin Moorecb5098f2022-01-07 16:33:46 +00001229 "Warning: skip copying %s image avb footer"
1230 " (%s partition size: %" PRId64 ", %s image size: %" PRId64 ").\n",
1231 partition.c_str(), partition.c_str(), partition_size, partition.c_str(), buf->sz);
Bowgo Tsai671249a2021-08-10 16:32:37 +08001232 return;
1233 }
1234
1235 // IMPORTANT: after the following read, we need to reset buf->fd before return (if not die).
1236 // Because buf->fd will still be used afterwards.
Steve Muckle3af575b2020-06-18 17:02:15 -07001237 std::string data;
1238 if (!android::base::ReadFdToString(buf->fd, &data)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001239 die("Failed reading from %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001240 }
1241
1242 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1243 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001244 lseek(buf->fd.get(), 0, SEEK_SET); // IMPORTANT: resets buf->fd before return.
Steve Muckle3af575b2020-06-18 17:02:15 -07001245 return;
1246 }
1247
Devin Moorecb5098f2022-01-07 16:33:46 +00001248 const std::string tmp_fd_template = partition + " rewriting";
1249 unique_fd fd(make_temporary_fd(tmp_fd_template.c_str()));
Steve Muckle3af575b2020-06-18 17:02:15 -07001250 if (!android::base::WriteStringToFd(data, fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001251 die("Failed writing to modified %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001252 }
Yifan Hong58532df2021-03-22 16:39:13 -07001253 lseek(fd.get(), partition_size - AVB_FOOTER_SIZE, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001254 if (!android::base::WriteStringToFd(data.substr(footer_offset), fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001255 die("Failed copying AVB footer in %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001256 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001257 buf->fd = std::move(fd);
Steve Muckle3af575b2020-06-18 17:02:15 -07001258 buf->sz = partition_size;
Yifan Hong58532df2021-03-22 16:39:13 -07001259 lseek(buf->fd.get(), 0, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001260}
1261
David Andersonaa87dc52023-01-27 20:39:06 -08001262static void flash_partition_files(const std::string& partition,
1263 const std::vector<SparsePtr>& files) {
1264 for (size_t i = 0; i < files.size(); i++) {
1265 sparse_file* s = files[i].get();
1266 int64_t sz = sparse_file_len(s, true, false);
1267 fb->FlashPartition(partition, s, sz, i + 1, files.size());
1268 }
1269}
1270
Daniel Zheng65452d02022-11-30 02:25:31 +00001271static void flash_buf(const std::string& partition, struct fastboot_buffer* buf) {
Devin Moore1af12022022-01-06 01:11:23 +00001272 if (partition == "boot" || partition == "boot_a" || partition == "boot_b" ||
Isaac J. Manjarresacb49522023-01-12 14:28:29 -08001273 partition == "init_boot" || partition == "init_boot_a" || partition == "init_boot_b" ||
1274 partition == "recovery" || partition == "recovery_a" || partition == "recovery_b") {
Devin Moorecb5098f2022-01-07 16:33:46 +00001275 copy_avb_footer(partition, buf);
Steve Muckle3af575b2020-06-18 17:02:15 -07001276 }
1277
David Zeuthenb6ea4352017-08-07 14:29:26 -04001278 // Rewrite vbmeta if that's what we're flashing and modification has been requested.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001279 if (g_disable_verity || g_disable_verification) {
Paweł Grabasff9cfac2021-03-04 13:11:25 +01001280 // The vbmeta partition might have additional prefix if running in virtual machine
1281 // e.g., guest_vbmeta_a.
1282 if (android::base::EndsWith(partition, "vbmeta") ||
1283 android::base::EndsWith(partition, "vbmeta_a") ||
1284 android::base::EndsWith(partition, "vbmeta_b")) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001285 rewrite_vbmeta_buffer(buf, false /* vbmeta_in_boot */);
1286 } else if (!has_vbmeta_partition() &&
1287 (partition == "boot" || partition == "boot_a" || partition == "boot_b")) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001288 rewrite_vbmeta_buffer(buf, true /* vbmeta_in_boot */);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001289 }
David Zeuthenb6ea4352017-08-07 14:29:26 -04001290 }
1291
Rom Lemarchand622810c2013-06-28 09:54:59 -07001292 switch (buf->type) {
Josh Gao9da9ac52016-01-19 14:50:18 -08001293 case FB_BUFFER_SPARSE: {
David Andersonaa87dc52023-01-27 20:39:06 -08001294 flash_partition_files(partition, buf->files);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001295 break;
Josh Gao9da9ac52016-01-19 14:50:18 -08001296 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001297 case FB_BUFFER_FD:
Tom Cherry9027af02018-09-24 15:48:09 -07001298 fb->FlashPartition(partition, buf->fd, buf->sz);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001299 break;
1300 default:
1301 die("unknown buffer type: %d", buf->type);
1302 }
1303}
1304
Aaron Wisnerdb511202018-06-26 15:38:35 -05001305static std::string get_current_slot() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001306 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07001307 if (fb->GetVar("current-slot", &current_slot) != fastboot::SUCCESS) return "";
LuK1337dae48ef2020-04-06 14:38:58 +02001308 if (current_slot[0] == '_') current_slot.erase(0, 1);
Elliott Hughes42b18a52018-04-10 15:32:21 -07001309 return current_slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001310}
1311
Aaron Wisnerdb511202018-06-26 15:38:35 -05001312static int get_slot_count() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001313 std::string var;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001314 int count = 0;
Tom Cherry9027af02018-09-24 15:48:09 -07001315 if (fb->GetVar("slot-count", &var) != fastboot::SUCCESS ||
1316 !android::base::ParseInt(var, &count)) {
Elliott Hughes42b18a52018-04-10 15:32:21 -07001317 return 0;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001318 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001319 return count;
1320}
1321
Aaron Wisnerdb511202018-06-26 15:38:35 -05001322static bool supports_AB() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001323 return get_slot_count() >= 2;
Alex Lightbb9b8a52016-06-29 09:26:44 -07001324}
1325
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001326// Given a current slot, this returns what the 'other' slot is.
Daniel Rosenberg80919472016-06-30 19:25:31 -07001327static std::string get_other_slot(const std::string& current_slot, int count) {
1328 if (count == 0) return "";
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001329
Daniel Zheng65452d02022-11-30 02:25:31 +00001330 char next = (current_slot[0] - 'a' + 1) % count + 'a';
Daniel Rosenberg80919472016-06-30 19:25:31 -07001331 return std::string(1, next);
1332}
1333
Aaron Wisnerdb511202018-06-26 15:38:35 -05001334static std::string get_other_slot(const std::string& current_slot) {
1335 return get_other_slot(current_slot, get_slot_count());
Daniel Rosenberg80919472016-06-30 19:25:31 -07001336}
1337
Aaron Wisnerdb511202018-06-26 15:38:35 -05001338static std::string get_other_slot(int count) {
1339 return get_other_slot(get_current_slot(), count);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001340}
1341
Aaron Wisnerdb511202018-06-26 15:38:35 -05001342static std::string get_other_slot() {
1343 return get_other_slot(get_current_slot(), get_slot_count());
Alex Lightbb9b8a52016-06-29 09:26:44 -07001344}
1345
Aaron Wisnerdb511202018-06-26 15:38:35 -05001346static std::string verify_slot(const std::string& slot_name, bool allow_all) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001347 std::string slot = slot_name;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001348 if (slot == "all") {
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001349 if (allow_all) {
1350 return "all";
1351 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001352 int count = get_slot_count();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001353 if (count > 0) {
1354 return "a";
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001355 } else {
Elliott Hughes4089d342017-10-27 14:21:12 -07001356 die("No known slots");
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001357 }
1358 }
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001359 }
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001360
Aaron Wisnerdb511202018-06-26 15:38:35 -05001361 int count = get_slot_count();
Elliott Hughes4089d342017-10-27 14:21:12 -07001362 if (count == 0) die("Device does not support slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001363
Daniel Rosenberg80919472016-06-30 19:25:31 -07001364 if (slot == "other") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001365 std::string other = get_other_slot(count);
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001366 if (other == "") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001367 die("No known slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001368 }
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001369 return other;
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001370 }
1371
Daniel Zheng65452d02022-11-30 02:25:31 +00001372 if (slot.size() == 1 && (slot[0] - 'a' >= 0 && slot[0] - 'a' < count)) return slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001373
1374 fprintf(stderr, "Slot %s does not exist. supported slots are:\n", slot.c_str());
Daniel Zheng65452d02022-11-30 02:25:31 +00001375 for (int i = 0; i < count; i++) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001376 fprintf(stderr, "%c\n", (char)(i + 'a'));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001377 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001378
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001379 exit(1);
1380}
1381
Aaron Wisnerdb511202018-06-26 15:38:35 -05001382static std::string verify_slot(const std::string& slot) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001383 return verify_slot(slot, true);
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001384}
1385
Aaron Wisnerdb511202018-06-26 15:38:35 -05001386static void do_for_partition(const std::string& part, const std::string& slot,
Chih-Hung Hsieh8f7b9e32016-07-27 16:25:51 -07001387 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001388 std::string has_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001389 std::string current_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001390 // |part| can be vendor_boot:default. Append slot to the first token.
1391 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001392
Yifan Hong6d7da632021-02-23 12:15:51 -08001393 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001394 /* If has-slot is not supported, the answer is no. */
1395 has_slot = "no";
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001396 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001397 if (has_slot == "yes") {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001398 if (slot == "") {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001399 current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001400 if (current_slot == "") {
Elliott Hughes4089d342017-10-27 14:21:12 -07001401 die("Failed to identify current slot");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001402 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001403 part_tokens[0] += "_" + current_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001404 } else {
Yifan Hong6d7da632021-02-23 12:15:51 -08001405 part_tokens[0] += "_" + slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001406 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001407 func(android::base::Join(part_tokens, ":"));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001408 } else {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001409 if (force_slot && slot != "") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001410 fprintf(stderr, "Warning: %s does not support slots, and slot %s was requested.\n",
1411 part_tokens[0].c_str(), slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001412 }
1413 func(part);
1414 }
1415}
1416
David Pursell0b156632015-10-30 11:22:01 -07001417/* This function will find the real partition name given a base name, and a slot. If slot is NULL or
1418 * empty, it will use the current slot. If slot is "all", it will return a list of all possible
1419 * partition names. If force_slot is true, it will fail if a slot is specified, and the given
1420 * partition does not support slots.
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001421 */
Daniel Zheng0d307182023-01-31 21:07:53 +00001422void do_for_partitions(const std::string& part, const std::string& slot,
1423 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001424 std::string has_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001425 // |part| can be vendor_boot:default. Query has-slot on the first token only.
1426 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001427
Daniel Rosenberg80919472016-06-30 19:25:31 -07001428 if (slot == "all") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001429 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1430 die("Could not check if partition %s has slot %s", part_tokens[0].c_str(),
1431 slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001432 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001433 if (has_slot == "yes") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001434 for (int i = 0; i < get_slot_count(); i++) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001435 do_for_partition(part, std::string(1, (char)(i + 'a')), func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001436 }
1437 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001438 do_for_partition(part, "", func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001439 }
1440 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001441 do_for_partition(part, slot, func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001442 }
1443}
1444
David Anderson0c732342018-11-28 17:10:42 -08001445static bool is_retrofit_device() {
1446 std::string value;
1447 if (fb->GetVar("super-partition-name", &value) != fastboot::SUCCESS) {
1448 return false;
1449 }
1450 return android::base::StartsWith(value, "system_");
1451}
1452
Yifan Hongbcd27702021-02-16 19:37:32 -08001453// Fetch a partition from the device to a given fd. This is a wrapper over FetchToFd to fetch
1454// the full image.
1455static uint64_t fetch_partition(const std::string& partition, borrowed_fd fd) {
1456 uint64_t fetch_size = get_uint_var(FB_VAR_MAX_FETCH_SIZE);
1457 if (fetch_size == 0) {
1458 die("Unable to get %s. Device does not support fetch command.", FB_VAR_MAX_FETCH_SIZE);
1459 }
1460 uint64_t partition_size = get_partition_size(partition);
1461 if (partition_size <= 0) {
1462 die("Invalid partition size for partition %s: %" PRId64, partition.c_str(), partition_size);
1463 }
1464
1465 uint64_t offset = 0;
1466 while (offset < partition_size) {
1467 uint64_t chunk_size = std::min(fetch_size, partition_size - offset);
1468 if (fb->FetchToFd(partition, fd, offset, chunk_size) != fastboot::RetCode::SUCCESS) {
1469 die("Unable to fetch %s (offset=%" PRIx64 ", size=%" PRIx64 ")", partition.c_str(),
1470 offset, chunk_size);
1471 }
1472 offset += chunk_size;
1473 }
1474 return partition_size;
1475}
1476
1477static void do_fetch(const std::string& partition, const std::string& slot_override,
1478 const std::string& outfile) {
1479 unique_fd fd(TEMP_FAILURE_RETRY(
1480 open(outfile.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0644)));
1481 auto fetch = std::bind(fetch_partition, _1, borrowed_fd(fd));
1482 do_for_partitions(partition, slot_override, fetch, false /* force slot */);
1483}
1484
Yifan Honge71fe242021-02-22 15:00:15 -08001485// Return immediately if not flashing a vendor boot image. If flashing a vendor boot image,
1486// repack vendor_boot image with an updated ramdisk. After execution, buf is set
1487// to the new image to flash, and return value is the real partition name to flash.
1488static std::string repack_ramdisk(const char* pname, struct fastboot_buffer* buf) {
1489 std::string_view pname_sv{pname};
1490
1491 if (!android::base::StartsWith(pname_sv, "vendor_boot:") &&
1492 !android::base::StartsWith(pname_sv, "vendor_boot_a:") &&
1493 !android::base::StartsWith(pname_sv, "vendor_boot_b:")) {
1494 return std::string(pname_sv);
1495 }
1496 if (buf->type != FB_BUFFER_FD) {
1497 die("Flashing sparse vendor ramdisk image is not supported.");
1498 }
1499 if (buf->sz <= 0) {
1500 die("repack_ramdisk() sees negative size: %" PRId64, buf->sz);
1501 }
1502 std::string partition(pname_sv.substr(0, pname_sv.find(':')));
1503 std::string ramdisk(pname_sv.substr(pname_sv.find(':') + 1));
1504
1505 unique_fd vendor_boot(make_temporary_fd("vendor boot repack"));
1506 uint64_t vendor_boot_size = fetch_partition(partition, vendor_boot);
1507 auto repack_res = replace_vendor_ramdisk(vendor_boot, vendor_boot_size, ramdisk, buf->fd,
1508 static_cast<uint64_t>(buf->sz));
1509 if (!repack_res.ok()) {
1510 die("%s", repack_res.error().message().c_str());
1511 }
1512
1513 buf->fd = std::move(vendor_boot);
1514 buf->sz = vendor_boot_size;
1515 buf->image_size = vendor_boot_size;
1516 return partition;
1517}
1518
Daniel Zheng0d307182023-01-31 21:07:53 +00001519void do_flash(const char* pname, const char* fname) {
Yifan Hong6d7da632021-02-23 12:15:51 -08001520 verbose("Do flash %s %s", pname, fname);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001521 struct fastboot_buffer buf;
1522
Aaron Wisnerdb511202018-06-26 15:38:35 -05001523 if (!load_buf(fname, &buf)) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001524 die("cannot load '%s': %s", fname, strerror(errno));
Rom Lemarchand622810c2013-06-28 09:54:59 -07001525 }
David Anderson629e51c2018-10-25 12:51:25 -07001526 if (is_logical(pname)) {
1527 fb->ResizePartition(pname, std::to_string(buf.image_size));
1528 }
Yifan Honge71fe242021-02-22 15:00:15 -08001529 std::string flash_pname = repack_ramdisk(pname, &buf);
1530 flash_buf(flash_pname, &buf);
Colin Crossf8387882012-05-24 17:18:41 -07001531}
1532
Daniel Rosenberg13454092016-06-27 19:43:11 -07001533// Sets slot_override as the active slot. If slot_override is blank,
1534// set current slot as active instead. This clears slot-unbootable.
Aaron Wisnerdb511202018-06-26 15:38:35 -05001535static void set_active(const std::string& slot_override) {
1536 if (!supports_AB()) return;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001537
Daniel Rosenberg80919472016-06-30 19:25:31 -07001538 if (slot_override != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001539 fb->SetActive(slot_override);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001540 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001541 std::string current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001542 if (current_slot != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001543 fb->SetActive(current_slot);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001544 }
1545 }
1546}
1547
Daniel Zheng0d307182023-01-31 21:07:53 +00001548bool is_userspace_fastboot() {
David Anderson32e376f2018-08-16 13:43:11 -07001549 std::string value;
Tom Cherry9027af02018-09-24 15:48:09 -07001550 return fb->GetVar("is-userspace", &value) == fastboot::SUCCESS && value == "yes";
David Anderson32e376f2018-08-16 13:43:11 -07001551}
1552
Daniel Zheng0d307182023-01-31 21:07:53 +00001553void reboot_to_userspace_fastboot() {
Tom Cherry9027af02018-09-24 15:48:09 -07001554 fb->RebootTo("fastboot");
1555
1556 auto* old_transport = fb->set_transport(nullptr);
1557 delete old_transport;
David Anderson1d887432018-08-27 16:47:32 -07001558
1559 // Give the current connection time to close.
1560 std::this_thread::sleep_for(std::chrono::milliseconds(1000));
1561
Tom Cherry9027af02018-09-24 15:48:09 -07001562 fb->set_transport(open_device());
David Anderson11d6d272018-12-07 16:39:07 -08001563
1564 if (!is_userspace_fastboot()) {
1565 die("Failed to boot into userspace fastboot; one or more components might be unbootable.");
1566 }
Hridya Valsaraju83d856e2019-05-17 14:24:19 -07001567
1568 // Reset target_sparse_limit after reboot to userspace fastboot. Max
1569 // download sizes may differ in bootloader and fastbootd.
1570 target_sparse_limit = -1;
David Anderson1d887432018-08-27 16:47:32 -07001571}
1572
David Andersonab8f4662019-10-21 16:45:59 -07001573static void CancelSnapshotIfNeeded() {
1574 std::string merge_status = "none";
1575 if (fb->GetVar(FB_VAR_SNAPSHOT_UPDATE_STATUS, &merge_status) == fastboot::SUCCESS &&
Elliott Hughes6a7ff582020-06-05 14:06:15 -07001576 !merge_status.empty() && merge_status != "none") {
Yifan Hong712c32b2019-12-10 18:11:13 -08001577 fb->SnapshotUpdateCommand("cancel");
David Andersonab8f4662019-10-21 16:45:59 -07001578 }
1579}
1580
David Andersoncf444f32018-08-29 14:15:49 -07001581class FlashAllTool {
1582 public:
Andrew Chantd64b9882021-04-06 12:48:27 -07001583 FlashAllTool(const ImageSource& source, const std::string& slot_override, bool skip_secondary,
1584 bool wipe, bool force_flash);
David Anderson32e376f2018-08-16 13:43:11 -07001585
David Andersoncf444f32018-08-29 14:15:49 -07001586 void Flash();
David Anderson32e376f2018-08-16 13:43:11 -07001587
David Andersoncf444f32018-08-29 14:15:49 -07001588 private:
1589 void CheckRequirements();
David Anderson667b1ef2023-01-27 21:11:11 -08001590 void DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001591 void CollectImages();
1592 void FlashImages(const std::vector<std::pair<const Image*, std::string>>& images);
1593 void FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf);
1594 void UpdateSuperPartition();
David Anderson667b1ef2023-01-27 21:11:11 -08001595 bool OptimizedFlashSuper();
1596
1597 // If the image uses the default slot, or the user specified "all", then
1598 // the paired string will be empty. If the image requests a specific slot
1599 // (for example, system_other) it is specified instead.
1600 using ImageEntry = std::pair<const Image*, std::string>;
1601
1602 std::string GetPartitionName(const ImageEntry& entry);
David Anderson32e376f2018-08-16 13:43:11 -07001603
David Andersoncf444f32018-08-29 14:15:49 -07001604 const ImageSource& source_;
1605 std::string slot_override_;
1606 bool skip_secondary_;
1607 bool wipe_;
Andrew Chantd64b9882021-04-06 12:48:27 -07001608 bool force_flash_;
David Anderson667b1ef2023-01-27 21:11:11 -08001609 std::string current_slot_;
David Andersoncf444f32018-08-29 14:15:49 -07001610 std::string secondary_slot_;
David Anderson667b1ef2023-01-27 21:11:11 -08001611
1612 std::vector<ImageEntry> boot_images_;
1613 std::vector<ImageEntry> os_images_;
David Andersoncf444f32018-08-29 14:15:49 -07001614};
1615
Andrew Chantd64b9882021-04-06 12:48:27 -07001616FlashAllTool::FlashAllTool(const ImageSource& source, const std::string& slot_override,
1617 bool skip_secondary, bool wipe, bool force_flash)
Daniel Zheng65452d02022-11-30 02:25:31 +00001618 : source_(source),
1619 slot_override_(slot_override),
1620 skip_secondary_(skip_secondary),
1621 wipe_(wipe),
1622 force_flash_(force_flash) {}
David Anderson32e376f2018-08-16 13:43:11 -07001623
David Andersoncf444f32018-08-29 14:15:49 -07001624void FlashAllTool::Flash() {
Tom Cherry9027af02018-09-24 15:48:09 -07001625 DumpInfo();
David Andersoncf444f32018-08-29 14:15:49 -07001626 CheckRequirements();
David Anderson96a9fd42018-11-05 15:21:44 -08001627
1628 // Change the slot first, so we boot into the correct recovery image when
1629 // using fastbootd.
1630 if (slot_override_ == "all") {
1631 set_active("a");
1632 } else {
1633 set_active(slot_override_);
1634 }
1635
David Anderson667b1ef2023-01-27 21:11:11 -08001636 DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001637 CollectImages();
David Anderson32e376f2018-08-16 13:43:11 -07001638
David Andersonab8f4662019-10-21 16:45:59 -07001639 CancelSnapshotIfNeeded();
1640
David Anderson95d40932018-08-28 12:14:33 -07001641 // First flash boot partitions. We allow this to happen either in userspace
1642 // or in bootloader fastboot.
David Andersoncf444f32018-08-29 14:15:49 -07001643 FlashImages(boot_images_);
David Anderson95d40932018-08-28 12:14:33 -07001644
David Anderson667b1ef2023-01-27 21:11:11 -08001645 if (!OptimizedFlashSuper()) {
1646 // Sync the super partition. This will reboot to userspace fastboot if needed.
1647 UpdateSuperPartition();
David Anderson95d40932018-08-28 12:14:33 -07001648
David Anderson667b1ef2023-01-27 21:11:11 -08001649 // Resize any logical partition to 0, so each partition is reset to 0
1650 // extents, and will achieve more optimal allocation.
1651 for (const auto& [image, slot] : os_images_) {
1652 auto resize_partition = [](const std::string& partition) -> void {
1653 if (is_logical(partition)) {
1654 fb->ResizePartition(partition, "0");
1655 }
1656 };
1657 do_for_partitions(image->part_name, slot, resize_partition, false);
1658 }
David Anderson32e376f2018-08-16 13:43:11 -07001659 }
1660
David Anderson95d40932018-08-28 12:14:33 -07001661 // Flash OS images, resizing logical partitions as needed.
David Andersoncf444f32018-08-29 14:15:49 -07001662 FlashImages(os_images_);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001663}
1664
David Anderson667b1ef2023-01-27 21:11:11 -08001665bool FlashAllTool::OptimizedFlashSuper() {
1666 if (!supports_AB()) {
1667 LOG(VERBOSE) << "Cannot optimize flashing super on non-AB device";
1668 return false;
1669 }
1670 if (slot_override_ == "all") {
1671 LOG(VERBOSE) << "Cannot optimize flashing super for all slots";
1672 return false;
1673 }
1674
1675 // Does this device use dynamic partitions at all?
1676 unique_fd fd = source_.OpenFile("super_empty.img");
1677 if (fd < 0) {
1678 LOG(VERBOSE) << "could not open super_empty.img";
1679 return false;
1680 }
1681
1682 // Try to find whether there is a super partition.
1683 std::string super_name;
1684 if (fb->GetVar("super-partition-name", &super_name) != fastboot::SUCCESS) {
1685 super_name = "super";
1686 }
1687 std::string partition_size_str;
1688 if (fb->GetVar("partition-size:" + super_name, &partition_size_str) != fastboot::SUCCESS) {
1689 LOG(VERBOSE) << "Cannot optimize super flashing: could not determine super partition";
1690 return false;
1691 }
1692
1693 SuperFlashHelper helper(source_);
1694 if (!helper.Open(fd)) {
1695 return false;
1696 }
1697
1698 for (const auto& entry : os_images_) {
1699 auto partition = GetPartitionName(entry);
1700 auto image = entry.first;
1701
1702 if (!helper.AddPartition(partition, image->img_name, image->optional_if_no_image)) {
1703 return false;
1704 }
1705 }
1706
1707 auto s = helper.GetSparseLayout();
1708 if (!s) {
1709 return false;
1710 }
1711
1712 std::vector<SparsePtr> files;
1713 if (int limit = get_sparse_limit(sparse_file_len(s.get(), false, false))) {
1714 files = resparse_file(s.get(), limit);
1715 } else {
1716 files.emplace_back(std::move(s));
1717 }
1718
1719 // Send the data to the device.
1720 flash_partition_files(super_name, files);
1721
1722 // Remove images that we already flashed, just in case we have non-dynamic OS images.
1723 auto remove_if_callback = [&, this](const ImageEntry& entry) -> bool {
1724 return helper.WillFlash(GetPartitionName(entry));
1725 };
1726 os_images_.erase(std::remove_if(os_images_.begin(), os_images_.end(), remove_if_callback),
1727 os_images_.end());
1728 return true;
1729}
1730
David Andersoncf444f32018-08-29 14:15:49 -07001731void FlashAllTool::CheckRequirements() {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001732 std::vector<char> contents;
1733 if (!source_.ReadFile("android-info.txt", &contents)) {
David Andersoncf444f32018-08-29 14:15:49 -07001734 die("could not read android-info.txt");
1735 }
Andrew Chantd64b9882021-04-06 12:48:27 -07001736 ::CheckRequirements({contents.data(), contents.size()}, force_flash_);
David Andersoncf444f32018-08-29 14:15:49 -07001737}
1738
David Anderson667b1ef2023-01-27 21:11:11 -08001739void FlashAllTool::DetermineSlot() {
1740 if (slot_override_.empty()) {
1741 current_slot_ = get_current_slot();
1742 } else {
1743 current_slot_ = slot_override_;
1744 }
1745
David Andersoncf444f32018-08-29 14:15:49 -07001746 if (skip_secondary_) {
1747 return;
1748 }
David Anderson96a9fd42018-11-05 15:21:44 -08001749 if (slot_override_ != "" && slot_override_ != "all") {
David Andersoncf444f32018-08-29 14:15:49 -07001750 secondary_slot_ = get_other_slot(slot_override_);
1751 } else {
1752 secondary_slot_ = get_other_slot();
1753 }
1754 if (secondary_slot_ == "") {
1755 if (supports_AB()) {
1756 fprintf(stderr, "Warning: Could not determine slot for secondary images. Ignoring.\n");
1757 }
1758 skip_secondary_ = true;
1759 }
1760}
1761
1762void FlashAllTool::CollectImages() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001763 for (size_t i = 0; i < images.size(); ++i) {
David Andersoncf444f32018-08-29 14:15:49 -07001764 std::string slot = slot_override_;
1765 if (images[i].IsSecondary()) {
1766 if (skip_secondary_) {
1767 continue;
1768 }
1769 slot = secondary_slot_;
1770 }
1771 if (images[i].type == ImageType::BootCritical) {
1772 boot_images_.emplace_back(&images[i], slot);
1773 } else if (images[i].type == ImageType::Normal) {
1774 os_images_.emplace_back(&images[i], slot);
1775 }
1776 }
1777}
1778
1779void FlashAllTool::FlashImages(const std::vector<std::pair<const Image*, std::string>>& images) {
1780 for (const auto& [image, slot] : images) {
1781 fastboot_buffer buf;
Yifan Hongb10d0672021-02-22 15:06:27 -08001782 unique_fd fd = source_.OpenFile(image->img_name);
1783 if (fd < 0 || !load_buf_fd(std::move(fd), &buf)) {
David Andersoncf444f32018-08-29 14:15:49 -07001784 if (image->optional_if_no_image) {
1785 continue;
1786 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001787 die("could not load '%s': %s", image->img_name.c_str(), strerror(errno));
David Andersoncf444f32018-08-29 14:15:49 -07001788 }
1789 FlashImage(*image, slot, &buf);
1790 }
1791}
1792
1793void FlashAllTool::FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf) {
1794 auto flash = [&, this](const std::string& partition_name) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001795 std::vector<char> signature_data;
1796 if (source_.ReadFile(image.sig_name, &signature_data)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001797 fb->Download("signature", signature_data);
1798 fb->RawCommand("signature", "installing signature");
David Andersoncf444f32018-08-29 14:15:49 -07001799 }
1800
1801 if (is_logical(partition_name)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001802 fb->ResizePartition(partition_name, std::to_string(buf->image_size));
David Andersoncf444f32018-08-29 14:15:49 -07001803 }
1804 flash_buf(partition_name.c_str(), buf);
1805 };
1806 do_for_partitions(image.part_name, slot, flash, false);
1807}
1808
1809void FlashAllTool::UpdateSuperPartition() {
Yifan Hong58532df2021-03-22 16:39:13 -07001810 unique_fd fd = source_.OpenFile("super_empty.img");
David Andersoncf444f32018-08-29 14:15:49 -07001811 if (fd < 0) {
1812 return;
1813 }
1814 if (!is_userspace_fastboot()) {
1815 reboot_to_userspace_fastboot();
1816 }
David Andersoncf444f32018-08-29 14:15:49 -07001817
David Anderson90fe0a42018-11-05 18:01:32 -08001818 std::string super_name;
1819 if (fb->GetVar("super-partition-name", &super_name) != fastboot::RetCode::SUCCESS) {
1820 super_name = "super";
1821 }
1822 fb->Download(super_name, fd, get_file_size(fd));
1823
1824 std::string command = "update-super:" + super_name;
David Andersoncf444f32018-08-29 14:15:49 -07001825 if (wipe_) {
1826 command += ":wipe";
1827 }
Tom Cherry9027af02018-09-24 15:48:09 -07001828 fb->RawCommand(command, "Updating super partition");
David Anderson0c732342018-11-28 17:10:42 -08001829
1830 // Retrofit devices have two super partitions, named super_a and super_b.
1831 // On these devices, secondary slots must be flashed as physical
1832 // partitions (otherwise they would not mount on first boot). To enforce
1833 // this, we delete any logical partitions for the "other" slot.
1834 if (is_retrofit_device()) {
1835 for (const auto& [image, slot] : os_images_) {
1836 std::string partition_name = image->part_name + "_"s + slot;
1837 if (image->IsSecondary() && is_logical(partition_name)) {
1838 fb->DeletePartition(partition_name);
1839 }
1840 }
1841 }
David Andersoncf444f32018-08-29 14:15:49 -07001842}
1843
David Anderson667b1ef2023-01-27 21:11:11 -08001844std::string FlashAllTool::GetPartitionName(const ImageEntry& entry) {
1845 auto slot = entry.second;
1846 if (slot.empty()) {
1847 slot = current_slot_;
1848 }
1849 if (slot.empty()) {
1850 return entry.first->part_name;
1851 }
1852 if (slot == "all") {
1853 LOG(FATAL) << "Cannot retrieve a singular name when using all slots";
1854 }
1855 return entry.first->part_name + "_" + slot;
1856}
1857
David Andersoncf444f32018-08-29 14:15:49 -07001858class ZipImageSource final : public ImageSource {
1859 public:
1860 explicit ZipImageSource(ZipArchiveHandle zip) : zip_(zip) {}
Tom Cherrydfd85df2018-09-20 14:45:05 -07001861 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001862 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001863
1864 private:
1865 ZipArchiveHandle zip_;
1866};
1867
Tom Cherrydfd85df2018-09-20 14:45:05 -07001868bool ZipImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1869 return UnzipToMemory(zip_, name, out);
David Andersoncf444f32018-08-29 14:15:49 -07001870}
1871
Yifan Hongb10d0672021-02-22 15:06:27 -08001872unique_fd ZipImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001873 return unzip_to_file(zip_, name.c_str());
1874}
1875
Andrew Chantd64b9882021-04-06 12:48:27 -07001876static void do_update(const char* filename, const std::string& slot_override, bool skip_secondary,
1877 bool force_flash) {
David Andersoncf444f32018-08-29 14:15:49 -07001878 ZipArchiveHandle zip;
1879 int error = OpenArchive(filename, &zip);
1880 if (error != 0) {
1881 die("failed to open zip file '%s': %s", filename, ErrorCodeString(error));
1882 }
1883
Andrew Chantd64b9882021-04-06 12:48:27 -07001884 FlashAllTool tool(ZipImageSource(zip), slot_override, skip_secondary, false, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001885 tool.Flash();
1886
1887 CloseArchive(zip);
1888}
1889
1890class LocalImageSource final : public ImageSource {
1891 public:
Tom Cherrydfd85df2018-09-20 14:45:05 -07001892 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001893 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001894};
1895
Tom Cherrydfd85df2018-09-20 14:45:05 -07001896bool LocalImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
David Andersoncf444f32018-08-29 14:15:49 -07001897 auto path = find_item_given_name(name);
1898 if (path.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001899 return false;
David Andersoncf444f32018-08-29 14:15:49 -07001900 }
Tom Cherrydfd85df2018-09-20 14:45:05 -07001901 return ReadFileToVector(path, out);
David Andersoncf444f32018-08-29 14:15:49 -07001902}
1903
Yifan Hongb10d0672021-02-22 15:06:27 -08001904unique_fd LocalImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001905 auto path = find_item_given_name(name);
Yifan Hongb10d0672021-02-22 15:06:27 -08001906 return unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
David Andersoncf444f32018-08-29 14:15:49 -07001907}
1908
Andrew Chantd64b9882021-04-06 12:48:27 -07001909static void do_flashall(const std::string& slot_override, bool skip_secondary, bool wipe,
1910 bool force_flash) {
1911 FlashAllTool tool(LocalImageSource(), slot_override, skip_secondary, wipe, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001912 tool.Flash();
1913}
1914
Elliott Hughesd6365a72017-05-08 18:04:49 -07001915static std::string next_arg(std::vector<std::string>* args) {
1916 if (args->empty()) syntax_error("expected argument");
1917 std::string result = args->front();
1918 args->erase(args->begin());
1919 return result;
Patrick Tjin51e8b032015-09-01 08:15:23 -07001920}
1921
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001922static void do_oem_command(const std::string& cmd, std::vector<std::string>* args) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07001923 if (args->empty()) syntax_error("empty oem command");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08001924
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001925 std::string command(cmd);
Elliott Hughesd6365a72017-05-08 18:04:49 -07001926 while (!args->empty()) {
Elliott Hughes29d5d7d2017-05-11 15:05:13 -07001927 command += " " + next_arg(args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001928 }
Tom Cherry9027af02018-09-24 15:48:09 -07001929 fb->RawCommand(command, "");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001930}
1931
Aaron Wisnerdb511202018-06-26 15:38:35 -05001932static unsigned fb_get_flash_block_size(std::string name) {
Connor O'Brience16a8a2017-02-06 14:39:31 -08001933 std::string sizeString;
Tom Cherry9027af02018-09-24 15:48:09 -07001934 if (fb->GetVar(name, &sizeString) != fastboot::SUCCESS || sizeString.empty()) {
Elliott Hughes5620d222018-03-28 08:20:00 -07001935 // This device does not report flash block sizes, so return 0.
Connor O'Brience16a8a2017-02-06 14:39:31 -08001936 return 0;
1937 }
1938 sizeString = fb_fix_numeric_var(sizeString);
1939
1940 unsigned size;
1941 if (!android::base::ParseUint(sizeString, &size)) {
1942 fprintf(stderr, "Couldn't parse %s '%s'.\n", name.c_str(), sizeString.c_str());
1943 return 0;
1944 }
Connor O'Brien6ef5c242017-11-01 17:37:32 -07001945 if ((size & (size - 1)) != 0) {
1946 fprintf(stderr, "Invalid %s %u: must be a power of 2.\n", name.c_str(), size);
Connor O'Brience16a8a2017-02-06 14:39:31 -08001947 return 0;
1948 }
1949 return size;
1950}
1951
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001952static void fb_perform_format(const std::string& partition, int skip_if_not_supported,
Elliott Hughesd6365a72017-05-08 18:04:49 -07001953 const std::string& type_override, const std::string& size_override,
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001954 const unsigned fs_options) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001955 std::string partition_type, partition_size;
1956
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001957 struct fastboot_buffer buf;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001958 const char* errMsg = nullptr;
1959 const struct fs_generator* gen = nullptr;
Jin Qian4a335822017-04-18 16:23:18 -07001960 TemporaryFile output;
1961 unique_fd fd;
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001962
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001963 unsigned int limit = INT_MAX;
1964 if (target_sparse_limit > 0 && target_sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001965 limit = target_sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001966 }
1967 if (sparse_limit > 0 && sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001968 limit = sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001969 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001970
Tom Cherry9027af02018-09-24 15:48:09 -07001971 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001972 errMsg = "Can't determine partition type.\n";
1973 goto failed;
1974 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001975 if (!type_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001976 if (partition_type != type_override) {
1977 fprintf(stderr, "Warning: %s type is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001978 partition.c_str(), partition_type.c_str(), type_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001979 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001980 partition_type = type_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001981 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001982
Tom Cherry9027af02018-09-24 15:48:09 -07001983 if (fb->GetVar("partition-size:" + partition, &partition_size) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001984 errMsg = "Unable to get partition size\n";
1985 goto failed;
1986 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001987 if (!size_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001988 if (partition_size != size_override) {
1989 fprintf(stderr, "Warning: %s size is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001990 partition.c_str(), partition_size.c_str(), size_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001991 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001992 partition_size = size_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001993 }
Connor O'Brience16a8a2017-02-06 14:39:31 -08001994 partition_size = fb_fix_numeric_var(partition_size);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001995
Elliott Hughes8ab9a322015-11-02 14:05:57 -08001996 gen = fs_get_generator(partition_type);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001997 if (!gen) {
1998 if (skip_if_not_supported) {
1999 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002000 fprintf(stderr, "File system type %s not supported.\n", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002001 return;
2002 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002003 die("Formatting is not supported for file system with type '%s'.", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002004 }
2005
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002006 int64_t size;
Elliott Hughesda46b392016-10-11 17:09:00 -07002007 if (!android::base::ParseInt(partition_size, &size)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002008 die("Couldn't parse partition size '%s'.", partition_size.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002009 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002010
Connor O'Brience16a8a2017-02-06 14:39:31 -08002011 unsigned eraseBlkSize, logicalBlkSize;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002012 eraseBlkSize = fb_get_flash_block_size("erase-block-size");
2013 logicalBlkSize = fb_get_flash_block_size("logical-block-size");
Connor O'Brience16a8a2017-02-06 14:39:31 -08002014
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002015 if (fs_generator_generate(gen, output.path, size, eraseBlkSize, logicalBlkSize, fs_options)) {
Elliott Hughes5620d222018-03-28 08:20:00 -07002016 die("Cannot generate image for %s", partition.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002017 }
2018
Jin Qian4a335822017-04-18 16:23:18 -07002019 fd.reset(open(output.path, O_RDONLY));
2020 if (fd == -1) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002021 die("Cannot open generated image: %s", strerror(errno));
Jin Qian4a335822017-04-18 16:23:18 -07002022 }
Yifan Hongb10d0672021-02-22 15:06:27 -08002023 if (!load_buf_fd(std::move(fd), &buf)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002024 die("Cannot read image: %s", strerror(errno));
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002025 }
2026 flash_buf(partition, &buf);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002027 return;
2028
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002029failed:
2030 if (skip_if_not_supported) {
2031 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002032 if (errMsg) fprintf(stderr, "%s", errMsg);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002033 }
Tom Cherry9027af02018-09-24 15:48:09 -07002034 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
Mark Salyzyna30b6962018-11-20 11:04:15 -08002035 if (!skip_if_not_supported) {
2036 die("Command failed");
2037 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002038}
2039
Daniel Zheng0d307182023-01-31 21:07:53 +00002040bool should_flash_in_userspace(const std::string& partition_name) {
David Andersone0e693c2018-11-27 20:19:26 -08002041 if (!get_android_product_out()) {
2042 return false;
2043 }
David Anderson89569642018-11-16 15:53:35 -08002044 auto path = find_item_given_name("super_empty.img");
David Anderson00475802018-12-04 17:05:47 -08002045 if (path.empty() || access(path.c_str(), R_OK)) {
David Anderson89569642018-11-16 15:53:35 -08002046 return false;
2047 }
2048 auto metadata = android::fs_mgr::ReadFromImageFile(path);
2049 if (!metadata) {
2050 return false;
2051 }
David Andersonaa87dc52023-01-27 20:39:06 -08002052 return should_flash_in_userspace(*metadata.get(), partition_name);
David Anderson89569642018-11-16 15:53:35 -08002053}
2054
David Anderson7c84b9f2019-06-27 22:15:29 -07002055static bool wipe_super(const android::fs_mgr::LpMetadata& metadata, const std::string& slot,
2056 std::string* message) {
2057 auto super_device = GetMetadataSuperBlockDevice(metadata);
2058 auto block_size = metadata.geometry.logical_block_size;
2059 auto super_bdev_name = android::fs_mgr::GetBlockDevicePartitionName(*super_device);
2060
2061 if (super_bdev_name != "super") {
2062 // retrofit devices do not allow flashing to the retrofit partitions,
2063 // so enable it if we can.
2064 fb->RawCommand("oem allow-flash-super");
2065 }
2066
2067 // Note: do not use die() in here, since we want TemporaryDir's destructor
2068 // to be called.
2069 TemporaryDir temp_dir;
2070
2071 bool ok;
2072 if (metadata.block_devices.size() > 1) {
2073 ok = WriteSplitImageFiles(temp_dir.path, metadata, block_size, {}, true);
2074 } else {
2075 auto image_path = temp_dir.path + "/"s + super_bdev_name + ".img";
2076 ok = WriteToImageFile(image_path, metadata, block_size, {}, true);
2077 }
2078 if (!ok) {
2079 *message = "Could not generate a flashable super image file";
2080 return false;
2081 }
2082
2083 for (const auto& block_device : metadata.block_devices) {
2084 auto partition = android::fs_mgr::GetBlockDevicePartitionName(block_device);
2085 bool force_slot = !!(block_device.flags & LP_BLOCK_DEVICE_SLOT_SUFFIXED);
2086
2087 std::string image_name;
2088 if (metadata.block_devices.size() > 1) {
2089 image_name = "super_" + partition + ".img";
2090 } else {
2091 image_name = partition + ".img";
2092 }
2093
2094 auto image_path = temp_dir.path + "/"s + image_name;
2095 auto flash = [&](const std::string& partition_name) {
2096 do_flash(partition_name.c_str(), image_path.c_str());
2097 };
2098 do_for_partitions(partition, slot, flash, force_slot);
2099
2100 unlink(image_path.c_str());
2101 }
2102 return true;
2103}
2104
2105static void do_wipe_super(const std::string& image, const std::string& slot_override) {
2106 if (access(image.c_str(), R_OK) != 0) {
2107 die("Could not read image: %s", image.c_str());
2108 }
2109 auto metadata = android::fs_mgr::ReadFromImageFile(image);
2110 if (!metadata) {
2111 die("Could not parse image: %s", image.c_str());
2112 }
2113
2114 auto slot = slot_override;
2115 if (slot.empty()) {
2116 slot = get_current_slot();
2117 }
2118
2119 std::string message;
2120 if (!wipe_super(*metadata.get(), slot, &message)) {
2121 die(message);
2122 }
2123}
2124
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002125static void FastbootLogger(android::base::LogId /* id */, android::base::LogSeverity severity,
David Andersona67fc322023-01-27 16:15:52 -08002126 const char* /* tag */, const char* /* file */, unsigned int /* line */,
2127 const char* message) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002128 switch (severity) {
2129 case android::base::INFO:
2130 fprintf(stdout, "%s\n", message);
2131 break;
2132 case android::base::ERROR:
2133 fprintf(stderr, "%s\n", message);
2134 break;
2135 default:
2136 verbose("%s\n", message);
2137 }
David Andersona67fc322023-01-27 16:15:52 -08002138}
2139
2140static void FastbootAborter(const char* message) {
2141 die("%s", message);
2142}
2143
Aaron Wisnerdb511202018-06-26 15:38:35 -05002144int FastBootTool::Main(int argc, char* argv[]) {
David Andersona67fc322023-01-27 16:15:52 -08002145 android::base::InitLogging(argv, FastbootLogger, FastbootAborter);
2146
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002147 bool wants_wipe = false;
Mitchell Wills31dce302016-09-26 10:26:21 -07002148 bool skip_reboot = false;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002149 bool wants_set_active = false;
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002150 bool skip_secondary = false;
David Anderson89569642018-11-16 15:53:35 -08002151 bool force_flash = false;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002152 unsigned fs_options = 0;
Florian BƤuerle27ded482014-11-24 11:29:34 +01002153 int longindex;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002154 std::string slot_override;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002155 std::string next_active;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002156
Elliott Hughes577e8b42018-04-05 16:12:47 -07002157 g_boot_img_hdr.kernel_addr = 0x00008000;
2158 g_boot_img_hdr.ramdisk_addr = 0x01000000;
2159 g_boot_img_hdr.second_addr = 0x00f00000;
2160 g_boot_img_hdr.tags_addr = 0x00000100;
2161 g_boot_img_hdr.page_size = 2048;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002162 g_boot_img_hdr.dtb_addr = 0x01100000;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002163
Daniel Zheng65452d02022-11-30 02:25:31 +00002164 const struct option longopts[] = {{"base", required_argument, 0, 0},
2165 {"cmdline", required_argument, 0, 0},
2166 {"disable-verification", no_argument, 0, 0},
2167 {"disable-verity", no_argument, 0, 0},
2168 {"force", no_argument, 0, 0},
2169 {"fs-options", required_argument, 0, 0},
2170 {"header-version", required_argument, 0, 0},
2171 {"help", no_argument, 0, 'h'},
2172 {"kernel-offset", required_argument, 0, 0},
2173 {"os-patch-level", required_argument, 0, 0},
2174 {"os-version", required_argument, 0, 0},
2175 {"page-size", required_argument, 0, 0},
2176 {"ramdisk-offset", required_argument, 0, 0},
2177 {"set-active", optional_argument, 0, 'a'},
2178 {"skip-reboot", no_argument, 0, 0},
2179 {"skip-secondary", no_argument, 0, 0},
2180 {"slot", required_argument, 0, 0},
2181 {"tags-offset", required_argument, 0, 0},
2182 {"dtb", required_argument, 0, 0},
2183 {"dtb-offset", required_argument, 0, 0},
2184 {"unbuffered", no_argument, 0, 0},
2185 {"verbose", no_argument, 0, 'v'},
2186 {"version", no_argument, 0, 0},
2187 {0, 0, 0, 0}};
Colin Cross8879f982012-05-22 17:53:34 -07002188
2189 serial = getenv("ANDROID_SERIAL");
2190
Elliott Hughes577e8b42018-04-05 16:12:47 -07002191 int c;
Elliott Hughesf3192bd2018-04-10 15:38:08 -07002192 while ((c = getopt_long(argc, argv, "a::hls:S:vw", longopts, &longindex)) != -1) {
Elliott Hughes577e8b42018-04-05 16:12:47 -07002193 if (c == 0) {
2194 std::string name{longopts[longindex].name};
2195 if (name == "base") {
2196 g_base_addr = strtoul(optarg, 0, 16);
2197 } else if (name == "cmdline") {
2198 g_cmdline = optarg;
2199 } else if (name == "disable-verification") {
2200 g_disable_verification = true;
2201 } else if (name == "disable-verity") {
2202 g_disable_verity = true;
David Anderson89569642018-11-16 15:53:35 -08002203 } else if (name == "force") {
2204 force_flash = true;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002205 } else if (name == "fs-options") {
2206 fs_options = ParseFsOption(optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002207 } else if (name == "header-version") {
2208 g_boot_img_hdr.header_version = strtoul(optarg, nullptr, 0);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002209 } else if (name == "dtb") {
2210 g_dtb_path = optarg;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002211 } else if (name == "kernel-offset") {
2212 g_boot_img_hdr.kernel_addr = strtoul(optarg, 0, 16);
2213 } else if (name == "os-patch-level") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002214 ParseOsPatchLevel(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002215 } else if (name == "os-version") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002216 ParseOsVersion(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002217 } else if (name == "page-size") {
2218 g_boot_img_hdr.page_size = strtoul(optarg, nullptr, 0);
2219 if (g_boot_img_hdr.page_size == 0) die("invalid page size");
2220 } else if (name == "ramdisk-offset") {
2221 g_boot_img_hdr.ramdisk_addr = strtoul(optarg, 0, 16);
2222 } else if (name == "skip-reboot") {
2223 skip_reboot = true;
2224 } else if (name == "skip-secondary") {
2225 skip_secondary = true;
2226 } else if (name == "slot") {
2227 slot_override = optarg;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002228 } else if (name == "dtb-offset") {
2229 g_boot_img_hdr.dtb_addr = strtoul(optarg, 0, 16);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002230 } else if (name == "tags-offset") {
2231 g_boot_img_hdr.tags_addr = strtoul(optarg, 0, 16);
2232 } else if (name == "unbuffered") {
Elliott Hughesfc797672015-04-07 20:12:50 -07002233 setvbuf(stdout, nullptr, _IONBF, 0);
2234 setvbuf(stderr, nullptr, _IONBF, 0);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002235 } else if (name == "version") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002236 fprintf(stdout, "fastboot version %s-%s\n", PLATFORM_TOOLS_VERSION,
2237 android::build::GetBuildNumber().c_str());
Elliott Hughes1fd46df2017-03-30 15:08:28 -07002238 fprintf(stdout, "Installed as %s\n", android::base::GetExecutablePath().c_str());
Elliott Hughes379646b2015-06-02 13:50:00 -07002239 return 0;
Paul Crowley8f7f56e2015-11-27 09:29:37 +00002240 } else {
Elliott Hughes855cdf82018-04-02 14:24:03 -07002241 die("unknown option %s", longopts[longindex].name);
Florian BƤuerle27ded482014-11-24 11:29:34 +01002242 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002243 } else {
2244 switch (c) {
2245 case 'a':
2246 wants_set_active = true;
2247 if (optarg) next_active = optarg;
2248 break;
2249 case 'h':
2250 return show_help();
Elliott Hughes577e8b42018-04-05 16:12:47 -07002251 case 'l':
2252 g_long_listing = true;
2253 break;
2254 case 's':
2255 serial = optarg;
2256 break;
2257 case 'S':
Elliott Hughes542370d2018-04-19 19:49:44 -07002258 if (!android::base::ParseByteCount(optarg, &sparse_limit)) {
2259 die("invalid sparse limit %s", optarg);
2260 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002261 break;
2262 case 'v':
2263 set_verbose();
2264 break;
2265 case 'w':
2266 wants_wipe = true;
2267 break;
2268 case '?':
2269 return 1;
2270 default:
2271 abort();
2272 }
Colin Cross8879f982012-05-22 17:53:34 -07002273 }
2274 }
2275
2276 argc -= optind;
2277 argv += optind;
2278
Elliott Hughesd6365a72017-05-08 18:04:49 -07002279 if (argc == 0 && !wants_wipe && !wants_set_active) syntax_error("no command");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002280
Colin Cross8fb6e062012-07-24 16:36:41 -07002281 if (argc > 0 && !strcmp(*argv, "devices")) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002282 list_devices();
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08002283 return 0;
2284 }
2285
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002286 if (argc > 0 && !strcmp(*argv, "connect")) {
2287 argc -= optind;
2288 argv += optind;
2289 return Connect(argc, argv);
2290 }
2291
2292 if (argc > 0 && !strcmp(*argv, "disconnect")) {
2293 argc -= optind;
2294 argv += optind;
2295 return Disconnect(argc, argv);
2296 }
2297
Colin Crossc7b75dc2012-08-29 18:17:06 -07002298 if (argc > 0 && !strcmp(*argv, "help")) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002299 return show_help();
Colin Crossc7b75dc2012-08-29 18:17:06 -07002300 }
2301
David Pursell0b156632015-10-30 11:22:01 -07002302 Transport* transport = open_device();
David Pursell2ec418a2016-01-20 08:32:08 -08002303 if (transport == nullptr) {
2304 return 1;
2305 }
Tom Cherry9027af02018-09-24 15:48:09 -07002306 fastboot::DriverCallbacks driver_callbacks = {
Daniel Zheng65452d02022-11-30 02:25:31 +00002307 .prolog = Status,
2308 .epilog = Epilog,
2309 .info = InfoMessage,
Raphael Herouart99097cc2022-12-30 11:51:54 +00002310 .text = TextMessage,
Tom Cherry9027af02018-09-24 15:48:09 -07002311 };
Raphael Herouart99097cc2022-12-30 11:51:54 +00002312
Tom Cherry9027af02018-09-24 15:48:09 -07002313 fastboot::FastBootDriver fastboot_driver(transport, driver_callbacks, false);
2314 fb = &fastboot_driver;
David Pursell2ec418a2016-01-20 08:32:08 -08002315
Elliott Hughes5620d222018-03-28 08:20:00 -07002316 const double start = now();
2317
Aaron Wisnerdb511202018-06-26 15:38:35 -05002318 if (slot_override != "") slot_override = verify_slot(slot_override);
2319 if (next_active != "") next_active = verify_slot(next_active, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002320
2321 if (wants_set_active) {
2322 if (next_active == "") {
2323 if (slot_override == "") {
Daniel Rosenberg13454092016-06-27 19:43:11 -07002324 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07002325 if (fb->GetVar("current-slot", &current_slot) == fastboot::SUCCESS) {
LuK1337dae48ef2020-04-06 14:38:58 +02002326 if (current_slot[0] == '_') current_slot.erase(0, 1);
Aaron Wisnerdb511202018-06-26 15:38:35 -05002327 next_active = verify_slot(current_slot, false);
Daniel Rosenberg13454092016-06-27 19:43:11 -07002328 } else {
2329 wants_set_active = false;
2330 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002331 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002332 next_active = verify_slot(slot_override, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002333 }
2334 }
2335 }
Daniel Zheng71b3b432023-01-30 17:43:00 +00002336 std::unique_ptr<Task> reboot_task = nullptr;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002337 std::vector<std::string> args(argv, argv + argc);
2338 while (!args.empty()) {
2339 std::string command = next_arg(&args);
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002340
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002341 if (command == FB_CMD_GETVAR) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002342 std::string variable = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002343 DisplayVarOrError(variable, variable);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002344 } else if (command == FB_CMD_ERASE) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002345 std::string partition = next_arg(&args);
2346 auto erase = [&](const std::string& partition) {
David Pursell0b156632015-10-30 11:22:01 -07002347 std::string partition_type;
Daniel Zheng65452d02022-11-30 02:25:31 +00002348 if (fb->GetVar("partition-type:" + partition, &partition_type) ==
2349 fastboot::SUCCESS &&
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002350 fs_get_generator(partition_type) != nullptr) {
2351 fprintf(stderr, "******** Did you mean to fastboot format this %s partition?\n",
2352 partition_type.c_str());
2353 }
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002354
Tom Cherry9027af02018-09-24 15:48:09 -07002355 fb->Erase(partition);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002356 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002357 do_for_partitions(partition, slot_override, erase, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002358 } else if (android::base::StartsWith(command, "format")) {
2359 // Parsing for: "format[:[type][:[size]]]"
2360 // Some valid things:
2361 // - select only the size, and leave default fs type:
2362 // format::0x4000000 userdata
2363 // - default fs type and size:
2364 // format userdata
2365 // format:: userdata
2366 std::vector<std::string> pieces = android::base::Split(command, ":");
2367 std::string type_override;
2368 if (pieces.size() > 1) type_override = pieces[1].c_str();
2369 std::string size_override;
2370 if (pieces.size() > 2) size_override = pieces[2].c_str();
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002371
Elliott Hughesd6365a72017-05-08 18:04:49 -07002372 std::string partition = next_arg(&args);
2373
2374 auto format = [&](const std::string& partition) {
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002375 fb_perform_format(partition, 0, type_override, size_override, fs_options);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002376 };
Greg Kaiserb49d9e12019-03-26 12:04:05 -07002377 do_for_partitions(partition, slot_override, format, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002378 } else if (command == "signature") {
2379 std::string filename = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002380 std::vector<char> data;
2381 if (!ReadFileToVector(filename, &data)) {
2382 die("could not load '%s': %s", filename.c_str(), strerror(errno));
2383 }
2384 if (data.size() != 256) die("signature must be 256 bytes (got %zu)", data.size());
Tom Cherry9027af02018-09-24 15:48:09 -07002385 fb->Download("signature", data);
2386 fb->RawCommand("signature", "installing signature");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002387 } else if (command == FB_CMD_REBOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002388 if (args.size() == 1) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002389 std::string reboot_target = next_arg(&args);
2390 reboot_task = std::make_unique<RebootTask>(fb, reboot_target);
2391 } else {
2392 reboot_task = std::make_unique<RebootTask>(fb);
Elliott Hughesca85df02015-02-25 10:02:00 -08002393 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002394 if (!args.empty()) syntax_error("junk after reboot command");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002395 } else if (command == FB_CMD_REBOOT_BOOTLOADER) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002396 reboot_task = std::make_unique<RebootTask>(fb, "bootloader");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002397 } else if (command == FB_CMD_REBOOT_RECOVERY) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002398 reboot_task = std::make_unique<RebootTask>(fb, "recovery");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002399 } else if (command == FB_CMD_REBOOT_FASTBOOT) {
Daniel Zheng71b3b432023-01-30 17:43:00 +00002400 reboot_task = std::make_unique<RebootTask>(fb, "fastboot");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002401 } else if (command == FB_CMD_CONTINUE) {
Tom Cherry9027af02018-09-24 15:48:09 -07002402 fb->Continue();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002403 } else if (command == FB_CMD_BOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002404 std::string kernel = next_arg(&args);
2405 std::string ramdisk;
2406 if (!args.empty()) ramdisk = next_arg(&args);
2407 std::string second_stage;
2408 if (!args.empty()) second_stage = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002409 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
Tom Cherry9027af02018-09-24 15:48:09 -07002410 fb->Download("boot.img", data);
2411 fb->Boot();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002412 } else if (command == FB_CMD_FLASH) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002413 std::string pname = next_arg(&args);
Elliott Hughes2810d002016-04-25 14:31:18 -07002414 std::string fname;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002415 if (!args.empty()) {
2416 fname = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002417 } else {
Elliott Hughes45964a82017-05-03 22:43:23 -07002418 fname = find_item(pname);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002419 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002420 if (fname.empty()) die("cannot determine image filename for '%s'", pname.c_str());
Daniel Zheng0d307182023-01-31 21:07:53 +00002421 FlashTask task(slot_override, force_flash, pname, fname);
2422 task.Run();
Elliott Hughesd6365a72017-05-08 18:04:49 -07002423 } else if (command == "flash:raw") {
2424 std::string partition = next_arg(&args);
2425 std::string kernel = next_arg(&args);
2426 std::string ramdisk;
2427 if (!args.empty()) ramdisk = next_arg(&args);
2428 std::string second_stage;
2429 if (!args.empty()) second_stage = next_arg(&args);
2430
Tom Cherrydfd85df2018-09-20 14:45:05 -07002431 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2432 auto flashraw = [&data](const std::string& partition) {
Tom Cherry9027af02018-09-24 15:48:09 -07002433 fb->FlashPartition(partition, data);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002434 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002435 do_for_partitions(partition, slot_override, flashraw, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002436 } else if (command == "flashall") {
Alex Lightbb9b8a52016-06-29 09:26:44 -07002437 if (slot_override == "all") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002438 fprintf(stderr,
2439 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Andrew Chantd64b9882021-04-06 12:48:27 -07002440 do_flashall(slot_override, true, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002441 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -07002442 do_flashall(slot_override, skip_secondary, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002443 }
Daniel Zheng71b3b432023-01-30 17:43:00 +00002444 reboot_task = std::make_unique<RebootTask>(fb);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002445 } else if (command == "update") {
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002446 bool slot_all = (slot_override == "all");
2447 if (slot_all) {
Daniel Zheng65452d02022-11-30 02:25:31 +00002448 fprintf(stderr,
2449 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002450 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002451 std::string filename = "update.zip";
2452 if (!args.empty()) {
2453 filename = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002454 }
Andrew Chantd64b9882021-04-06 12:48:27 -07002455 do_update(filename.c_str(), slot_override, skip_secondary || slot_all, force_flash);
Daniel Zheng71b3b432023-01-30 17:43:00 +00002456 reboot_task = std::make_unique<RebootTask>(fb);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002457 } else if (command == FB_CMD_SET_ACTIVE) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002458 std::string slot = verify_slot(next_arg(&args), false);
Tom Cherry9027af02018-09-24 15:48:09 -07002459 fb->SetActive(slot);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002460 } else if (command == "stage") {
2461 std::string filename = next_arg(&args);
2462
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002463 struct fastboot_buffer buf;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002464 if (!load_buf(filename.c_str(), &buf) || buf.type != FB_BUFFER_FD) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002465 die("cannot load '%s'", filename.c_str());
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002466 }
Yifan Hong58532df2021-03-22 16:39:13 -07002467 fb->Download(filename, buf.fd.get(), buf.sz);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002468 } else if (command == "get_staged") {
2469 std::string filename = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002470 fb->Upload(filename);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002471 } else if (command == FB_CMD_OEM) {
2472 do_oem_command(FB_CMD_OEM, &args);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002473 } else if (command == "flashing") {
2474 if (args.empty()) {
2475 syntax_error("missing 'flashing' command");
Daniel Zheng65452d02022-11-30 02:25:31 +00002476 } else if (args.size() == 1 &&
2477 (args[0] == "unlock" || args[0] == "lock" || args[0] == "unlock_critical" ||
2478 args[0] == "lock_critical" || args[0] == "get_unlock_ability")) {
Elliott Hughes1eec97a2017-05-15 16:53:53 -07002479 do_oem_command("flashing", &args);
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002480 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002481 syntax_error("unknown 'flashing' command %s", args[0].c_str());
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002482 }
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002483 } else if (command == FB_CMD_CREATE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002484 std::string partition = next_arg(&args);
2485 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002486 fb->CreatePartition(partition, size);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002487 } else if (command == FB_CMD_DELETE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002488 std::string partition = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002489 fb->DeletePartition(partition);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002490 } else if (command == FB_CMD_RESIZE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002491 std::string partition = next_arg(&args);
2492 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002493 fb->ResizePartition(partition, size);
David Anderson1d504e32019-01-15 14:38:20 -08002494 } else if (command == "gsi") {
David Anderson3d782d52019-01-29 13:09:49 -08002495 std::string arg = next_arg(&args);
2496 if (arg == "wipe") {
David Anderson1d504e32019-01-15 14:38:20 -08002497 fb->RawCommand("gsi:wipe", "wiping GSI");
David Anderson3d782d52019-01-29 13:09:49 -08002498 } else if (arg == "disable") {
David Anderson1d504e32019-01-15 14:38:20 -08002499 fb->RawCommand("gsi:disable", "disabling GSI");
2500 } else {
2501 syntax_error("expected 'wipe' or 'disable'");
2502 }
David Anderson7c84b9f2019-06-27 22:15:29 -07002503 } else if (command == "wipe-super") {
2504 std::string image;
2505 if (args.empty()) {
2506 image = find_item_given_name("super_empty.img");
2507 } else {
2508 image = next_arg(&args);
2509 }
2510 do_wipe_super(image, slot_override);
David Andersonab8f4662019-10-21 16:45:59 -07002511 } else if (command == "snapshot-update") {
2512 std::string arg;
2513 if (!args.empty()) {
2514 arg = next_arg(&args);
2515 }
David Anderson220ddb12019-10-31 18:02:41 -07002516 if (!arg.empty() && (arg != "cancel" && arg != "merge")) {
2517 syntax_error("expected: snapshot-update [cancel|merge]");
David Andersonab8f4662019-10-21 16:45:59 -07002518 }
2519 fb->SnapshotUpdateCommand(arg);
Yifan Hongbcd27702021-02-16 19:37:32 -08002520 } else if (command == FB_CMD_FETCH) {
2521 std::string partition = next_arg(&args);
2522 std::string outfile = next_arg(&args);
2523 do_fetch(partition, slot_override, outfile);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002524 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002525 syntax_error("unknown command %s", command.c_str());
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002526 }
2527 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002528 if (wants_wipe) {
David Andersonab8f4662019-10-21 16:45:59 -07002529 if (force_flash) {
2530 CancelSnapshotIfNeeded();
2531 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002532 std::vector<std::string> partitions = {"userdata", "cache", "metadata"};
Paul Crowley4d170062018-04-24 17:06:30 -07002533 for (const auto& partition : partitions) {
2534 std::string partition_type;
Tom Cherry9027af02018-09-24 15:48:09 -07002535 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
2536 continue;
2537 }
Paul Crowley4d170062018-04-24 17:06:30 -07002538 if (partition_type.empty()) continue;
Tom Cherry9027af02018-09-24 15:48:09 -07002539 fb->Erase(partition);
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002540 fb_perform_format(partition, 1, partition_type, "", fs_options);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002541 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002542 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002543 if (wants_set_active) {
Tom Cherry9027af02018-09-24 15:48:09 -07002544 fb->SetActive(next_active);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002545 }
Daniel Zheng71b3b432023-01-30 17:43:00 +00002546 if (reboot_task && !skip_reboot) {
2547 reboot_task->Run();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002548 }
Elliott Hughes5620d222018-03-28 08:20:00 -07002549 fprintf(stderr, "Finished. Total time: %.3fs\n", (now() - start));
David Anderson03de6452018-09-04 14:32:54 -07002550
Tom Cherry9027af02018-09-24 15:48:09 -07002551 auto* old_transport = fb->set_transport(nullptr);
2552 delete old_transport;
2553
Tom Cherry11f12092018-08-29 21:36:28 -07002554 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002555}
Elliott Hughes6ebec932018-04-10 14:22:13 -07002556
Aaron Wisnerdb511202018-06-26 15:38:35 -05002557void FastBootTool::ParseOsPatchLevel(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002558 unsigned year, month, day;
2559 if (sscanf(arg, "%u-%u-%u", &year, &month, &day) != 3) {
2560 syntax_error("OS patch level should be YYYY-MM-DD: %s", arg);
2561 }
2562 if (year < 2000 || year >= 2128) syntax_error("year out of range: %d", year);
2563 if (month < 1 || month > 12) syntax_error("month out of range: %d", month);
2564 hdr->SetOsPatchLevel(year, month);
2565}
2566
Aaron Wisnerdb511202018-06-26 15:38:35 -05002567void FastBootTool::ParseOsVersion(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002568 unsigned major = 0, minor = 0, patch = 0;
2569 std::vector<std::string> versions = android::base::Split(arg, ".");
2570 if (versions.size() < 1 || versions.size() > 3 ||
2571 (versions.size() >= 1 && !android::base::ParseUint(versions[0], &major)) ||
2572 (versions.size() >= 2 && !android::base::ParseUint(versions[1], &minor)) ||
2573 (versions.size() == 3 && !android::base::ParseUint(versions[2], &patch)) ||
2574 (major > 0x7f || minor > 0x7f || patch > 0x7f)) {
2575 syntax_error("bad OS version: %s", arg);
2576 }
2577 hdr->SetOsVersion(major, minor, patch);
2578}
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002579
2580unsigned FastBootTool::ParseFsOption(const char* arg) {
2581 unsigned fsOptions = 0;
2582
2583 std::vector<std::string> options = android::base::Split(arg, ",");
Daniel Zheng65452d02022-11-30 02:25:31 +00002584 if (options.size() < 1) syntax_error("bad options: %s", arg);
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002585
2586 for (size_t i = 0; i < options.size(); ++i) {
2587 if (options[i] == "casefold")
2588 fsOptions |= (1 << FS_OPT_CASEFOLD);
2589 else if (options[i] == "projid")
2590 fsOptions |= (1 << FS_OPT_PROJID);
2591 else if (options[i] == "compress")
2592 fsOptions |= (1 << FS_OPT_COMPRESS);
2593 else
2594 syntax_error("unsupported options: %s", options[i].c_str());
2595 }
2596 return fsOptions;
2597}