blob: c9cb228bb62f8a1875ddd537c1533fce78097e39 [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
Tom Cherrydfd85df2018-09-20 14:45:05 -0700258bool ReadFileToVector(const std::string& file, std::vector<char>* out) {
259 out->clear();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800260
Tom Cherrydfd85df2018-09-20 14:45:05 -0700261 unique_fd fd(TEMP_FAILURE_RETRY(open(file.c_str(), O_RDONLY | O_CLOEXEC | O_BINARY)));
262 if (fd == -1) {
263 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700264 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800265
Tom Cherrydfd85df2018-09-20 14:45:05 -0700266 out->resize(get_file_size(fd));
267 return ReadFully(fd, out->data(), out->size());
Rom Lemarchand622810c2013-06-28 09:54:59 -0700268}
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800269
Elliott Hughesfc797672015-04-07 20:12:50 -0700270static int match_fastboot_with_serial(usb_ifc_info* info, const char* local_serial) {
Elliott Hughese1746fd2015-08-10 15:30:54 -0700271 if (info->ifc_class != 0xff || info->ifc_subclass != 0x42 || info->ifc_protocol != 0x03) {
272 return -1;
273 }
274
Scott Anderson13081c62012-04-06 12:39:30 -0700275 // require matching serial number or device path if requested
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800276 // at the command line with the -s option.
JP Abgralla032ded2012-06-06 11:53:33 -0700277 if (local_serial && (strcmp(local_serial, info->serial_number) != 0 &&
Daniel Zheng65452d02022-11-30 02:25:31 +0000278 strcmp(local_serial, info->device_path) != 0))
279 return -1;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800280 return 0;
281}
282
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000283static ifc_match_func match_fastboot(const char* local_serial = serial) {
284 return [local_serial](usb_ifc_info* info) -> int {
285 return match_fastboot_with_serial(info, local_serial);
286 };
287}
288
289// output compatible with "adb devices"
290static void PrintDevice(const char* local_serial, const char* status = nullptr,
291 const char* details = nullptr) {
292 if (local_serial == nullptr || strlen(local_serial) == 0) {
293 return;
294 }
295
296 if (g_long_listing) {
297 printf("%-22s", local_serial);
298 } else {
299 printf("%s\t", local_serial);
300 }
301
302 if (status != nullptr && strlen(status) > 0) {
303 printf(" %s", status);
304 }
305
306 if (g_long_listing) {
307 if (details != nullptr && strlen(details) > 0) {
308 printf(" %s", details);
309 }
310 }
311
312 putchar('\n');
JP Abgrall7b8970c2013-03-07 17:06:41 -0800313}
314
Elliott Hughesfc797672015-04-07 20:12:50 -0700315static int list_devices_callback(usb_ifc_info* info) {
316 if (match_fastboot_with_serial(info, nullptr) == 0) {
Elliott Hughes1b708d32015-12-11 19:07:01 -0800317 std::string serial = info->serial_number;
David Anderson4e058ca2020-05-28 04:39:37 +0000318 std::string interface = info->interface;
319 if (interface.empty()) {
320 interface = "fastboot";
321 }
Elliott Hughesb4add9b2009-10-06 18:07:49 -0700322 if (!info->writable) {
Elliott Hughes1b708d32015-12-11 19:07:01 -0800323 serial = UsbNoPermissionsShortHelpText();
Elliott Hughesb4add9b2009-10-06 18:07:49 -0700324 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800325 if (!serial[0]) {
326 serial = "????????????";
327 }
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000328
329 PrintDevice(serial.c_str(), interface.c_str(), info->device_path);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800330 }
331
332 return -1;
333}
334
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000335struct NetworkSerial {
336 Socket::Protocol protocol;
337 std::string address;
338 int port;
339};
340
341static Result<NetworkSerial> ParseNetworkSerial(const std::string& serial) {
342 const auto serial_parsed = android::base::Tokenize(serial, ":");
343 const auto parsed_segments_count = serial_parsed.size();
344 if (parsed_segments_count != 2 && parsed_segments_count != 3) {
345 return Error() << "invalid network address: " << serial << ". Expected format:\n"
346 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
347 }
348
349 Socket::Protocol protocol;
350 if (serial_parsed[0] == "tcp") {
351 protocol = Socket::Protocol::kTcp;
352 } else if (serial_parsed[0] == "udp") {
353 protocol = Socket::Protocol::kUdp;
354 } else {
355 return Error() << "invalid network address: " << serial << ". Expected format:\n"
356 << "<protocol>:<address>:<port> (tcp:localhost:5554)";
357 }
358
359 int port = 5554;
360 if (parsed_segments_count == 3) {
361 android::base::ParseInt(serial_parsed[2], &port, 5554);
362 }
363
364 return NetworkSerial{protocol, serial_parsed[1], port};
365}
366
367// Opens a new Transport connected to the particular device.
368// arguments:
David Pursell2ec418a2016-01-20 08:32:08 -0800369//
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000370// local_serial - device to connect (can be a network or usb serial name)
371// wait_for_device - flag indicates whether we need to wait for device
372// announce - flag indicates whether we need to print error to stdout in case
373// we cannot connect to the device
David Pursell2ec418a2016-01-20 08:32:08 -0800374//
375// The returned Transport is a singleton, so multiple calls to this function will return the same
376// object, and the caller should not attempt to delete the returned Transport.
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000377static Transport* open_device(const char* local_serial, bool wait_for_device = true,
378 bool announce = true) {
379 const Result<NetworkSerial> network_serial = ParseNetworkSerial(local_serial);
David Pursell2ec418a2016-01-20 08:32:08 -0800380
David Anderson1d887432018-08-27 16:47:32 -0700381 Transport* transport = nullptr;
David Pursell2ec418a2016-01-20 08:32:08 -0800382 while (true) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000383 if (network_serial.ok()) {
David Pursell2ec418a2016-01-20 08:32:08 -0800384 std::string error;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000385 if (network_serial->protocol == Socket::Protocol::kTcp) {
386 transport = tcp::Connect(network_serial->address, network_serial->port, &error)
387 .release();
388 } else if (network_serial->protocol == Socket::Protocol::kUdp) {
389 transport = udp::Connect(network_serial->address, network_serial->port, &error)
390 .release();
David Pursell4601c972016-02-05 15:35:09 -0800391 }
392
David Pursell2ec418a2016-01-20 08:32:08 -0800393 if (transport == nullptr && announce) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000394 LOG(ERROR) << "error: " << error;
David Pursell2ec418a2016-01-20 08:32:08 -0800395 }
396 } else {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000397 transport = usb_open(match_fastboot(local_serial));
David Pursell2ec418a2016-01-20 08:32:08 -0800398 }
399
400 if (transport != nullptr) {
401 return transport;
402 }
403
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000404 if (!wait_for_device) {
405 return nullptr;
406 }
407
David Pursell0b156632015-10-30 11:22:01 -0700408 if (announce) {
David Pursell2ec418a2016-01-20 08:32:08 -0800409 announce = false;
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000410 LOG(ERROR) << "< waiting for " << local_serial << ">";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800411 }
Elliott Hughes290a2282016-11-14 17:08:47 -0800412 std::this_thread::sleep_for(std::chrono::milliseconds(1));
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800413 }
414}
415
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000416static Transport* NetworkDeviceConnected(bool print = false) {
417 Transport* transport = nullptr;
418 Transport* result = nullptr;
419
420 ConnectedDevicesStorage storage;
421 std::set<std::string> devices;
422 {
423 FileLock lock = storage.Lock();
424 devices = storage.ReadDevices(lock);
425 }
426
427 for (const std::string& device : devices) {
428 transport = open_device(device.c_str(), false, false);
429
430 if (print) {
431 PrintDevice(device.c_str(), transport == nullptr ? "offline" : "device");
432 }
433
434 if (transport != nullptr) {
435 result = transport;
436 }
437 }
438
439 return result;
440}
441
442// Detects the fastboot connected device to open a new Transport.
443// Detecting logic:
444//
445// if serial is provided - try to connect to this particular usb/network device
446// othervise:
447// 1. Check connected usb devices and return the last connected one
448// 2. Check connected network devices and return the last connected one
449// 2. If nothing is connected - wait for any device by repeating p. 1 and 2
450//
451// The returned Transport is a singleton, so multiple calls to this function will return the same
452// object, and the caller should not attempt to delete the returned Transport.
453static Transport* open_device() {
454 if (serial != nullptr) {
455 return open_device(serial);
456 }
457
458 bool announce = true;
459 Transport* transport = nullptr;
460 while (true) {
461 transport = usb_open(match_fastboot(nullptr));
462 if (transport != nullptr) {
463 return transport;
464 }
465
466 transport = NetworkDeviceConnected();
467 if (transport != nullptr) {
468 return transport;
469 }
470
471 if (announce) {
472 announce = false;
473 LOG(ERROR) << "< waiting for any device >";
474 }
475 std::this_thread::sleep_for(std::chrono::milliseconds(1));
476 }
477}
478
479static int Connect(int argc, char* argv[]) {
480 if (argc != 1) {
481 LOG(FATAL) << "connect command requires to receive only 1 argument. Usage:" << std::endl
482 << "fastboot connect [tcp:|udp:host:port]";
483 }
484
485 const char* local_serial = *argv;
486 EXPECT(ParseNetworkSerial(local_serial));
487
488 const Transport* transport = open_device(local_serial, false);
489 if (transport == nullptr) {
490 return 1;
491 }
492
493 ConnectedDevicesStorage storage;
494 {
495 FileLock lock = storage.Lock();
496 std::set<std::string> devices = storage.ReadDevices(lock);
497 devices.insert(local_serial);
498 storage.WriteDevices(lock, devices);
499 }
500
501 return 0;
502}
503
504static int Disconnect(const char* local_serial) {
505 EXPECT(ParseNetworkSerial(local_serial));
506
507 ConnectedDevicesStorage storage;
508 {
509 FileLock lock = storage.Lock();
510 std::set<std::string> devices = storage.ReadDevices(lock);
511 devices.erase(local_serial);
512 storage.WriteDevices(lock, devices);
513 }
514
515 return 0;
516}
517
518static int Disconnect() {
519 ConnectedDevicesStorage storage;
520 {
521 FileLock lock = storage.Lock();
522 storage.Clear(lock);
523 }
524
525 return 0;
526}
527
528static int Disconnect(int argc, char* argv[]) {
529 switch (argc) {
530 case 0: {
531 return Disconnect();
532 }
533 case 1: {
534 return Disconnect(*argv);
535 }
536 default:
537 LOG(FATAL) << "disconnect command can receive only 0 or 1 arguments. Usage:"
538 << std::endl
539 << "fastboot disconnect # disconnect all devices" << std::endl
540 << "fastboot disconnect [tcp:|udp:host:port] # disconnect device";
541 }
542
543 return 0;
544}
545
Elliott Hughesfc797672015-04-07 20:12:50 -0700546static void list_devices() {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800547 // We don't actually open a USB device here,
548 // just getting our callback called so we can
549 // list all the connected devices.
550 usb_open(list_devices_callback);
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +0000551 NetworkDeviceConnected(/* print */ true);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800552}
Daniel Zheng0d307182023-01-31 21:07:53 +0000553void syntax_error(const char* fmt, ...) {
Elliott Hughesd6365a72017-05-08 18:04:49 -0700554 fprintf(stderr, "fastboot: usage: ");
555
556 va_list ap;
557 va_start(ap, fmt);
558 vfprintf(stderr, fmt, ap);
559 va_end(ap);
560
561 fprintf(stderr, "\n");
562 exit(1);
563}
564
565static int show_help() {
566 // clang-format off
567 fprintf(stdout,
Elliott Hughes07fc6822018-05-24 16:36:05 -0700568// 1 2 3 4 5 6 7 8
569// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
Elliott Hughesb76188f2018-04-03 13:30:18 -0700570 "usage: fastboot [OPTION...] COMMAND...\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800571 "\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700572 "flashing:\n"
573 " update ZIP Flash all partitions from an update.zip package.\n"
574 " flashall Flash all partitions from $ANDROID_PRODUCT_OUT.\n"
575 " On A/B devices, flashed slot is set as active.\n"
576 " Secondary images may be flashed to inactive slot.\n"
Elliott Hughes07fc6822018-05-24 16:36:05 -0700577 " flash PARTITION [FILENAME] Flash given partition, using the image from\n"
578 " $ANDROID_PRODUCT_OUT if no filename is given.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700579 "\n"
580 "basics:\n"
581 " devices [-l] List devices in bootloader (-l: with device paths).\n"
582 " getvar NAME Display given bootloader variable.\n"
583 " reboot [bootloader] Reboot device.\n"
584 "\n"
585 "locking/unlocking:\n"
586 " flashing lock|unlock Lock/unlock partitions for flashing\n"
587 " flashing lock_critical|unlock_critical\n"
588 " Lock/unlock 'critical' bootloader partitions.\n"
589 " flashing get_unlock_ability\n"
590 " Check whether unlocking is allowed (1) or not(0).\n"
591 "\n"
592 "advanced:\n"
593 " erase PARTITION Erase a flash partition.\n"
594 " format[:FS_TYPE[:SIZE]] PARTITION\n"
595 " Format a flash partition.\n"
596 " set_active SLOT Set the active slot.\n"
597 " oem [COMMAND...] Execute OEM-specific command.\n"
David Anderson1d504e32019-01-15 14:38:20 -0800598 " gsi wipe|disable Wipe or disable a GSI installation (fastbootd only).\n"
David Anderson7c84b9f2019-06-27 22:15:29 -0700599 " wipe-super [SUPER_EMPTY] Wipe the super partition. This will reset it to\n"
600 " contain an empty set of default dynamic partitions.\n"
Luca Stefani173667b2021-04-12 19:16:43 +0200601 " create-logical-partition NAME SIZE\n"
602 " Create a logical partition with the given name and\n"
603 " size, in the super partition.\n"
604 " delete-logical-partition NAME\n"
605 " Delete a logical partition with the given name.\n"
606 " resize-logical-partition NAME SIZE\n"
607 " Change the size of the named logical partition.\n"
David Andersonab8f4662019-10-21 16:45:59 -0700608 " snapshot-update cancel On devices that support snapshot-based updates, cancel\n"
609 " an in-progress update. This may make the device\n"
610 " unbootable until it is reflashed.\n"
David Anderson220ddb12019-10-31 18:02:41 -0700611 " snapshot-update merge On devices that support snapshot-based updates, finish\n"
612 " an in-progress update if it is in the \"merging\"\n"
613 " phase.\n"
Pierre-ClƩment Tosi96941a02021-06-14 12:16:06 +0000614 " fetch PARTITION OUT_FILE Fetch a partition image from the device."
Elliott Hughesb76188f2018-04-03 13:30:18 -0700615 "\n"
616 "boot image:\n"
617 " boot KERNEL [RAMDISK [SECOND]]\n"
618 " Download and boot kernel from RAM.\n"
619 " flash:raw PARTITION KERNEL [RAMDISK [SECOND]]\n"
620 " Create boot image and flash it.\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800621 " --dtb DTB Specify path to DTB for boot image header version 2.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700622 " --cmdline CMDLINE Override kernel command line.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700623 " --base ADDRESS Set kernel base address (default: 0x10000000).\n"
624 " --kernel-offset Set kernel offset (default: 0x00008000).\n"
625 " --ramdisk-offset Set ramdisk offset (default: 0x01000000).\n"
626 " --tags-offset Set tags offset (default: 0x00000100).\n"
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800627 " --dtb-offset Set dtb offset (default: 0x01100000).\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700628 " --page-size BYTES Set flash page size (default: 2048).\n"
629 " --header-version VERSION Set boot image header version.\n"
Elliott Hughes577e8b42018-04-05 16:12:47 -0700630 " --os-version MAJOR[.MINOR[.PATCH]]\n"
631 " Set boot image OS version (default: 0.0.0).\n"
632 " --os-patch-level YYYY-MM-DD\n"
633 " Set boot image OS security patch level.\n"
634 // TODO: still missing: `second_addr`, `name`, `id`, `recovery_dtbo_*`.
Elliott Hughesb76188f2018-04-03 13:30:18 -0700635 "\n"
Elliott Hughes2e9b7792018-04-04 13:36:44 -0700636 // TODO: what device(s) used this? is there any documentation?
Elliott Hughesb76188f2018-04-03 13:30:18 -0700637 //" continue Continue with autoboot.\n"
638 //"\n"
639 "Android Things:\n"
640 " stage IN_FILE Sends given file to stage for the next command.\n"
641 " 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 -0800642 "\n"
643 "options:\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700644 " -w Wipe userdata.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700645 " -s SERIAL Specify a USB device.\n"
646 " -s tcp|udp:HOST[:PORT] Specify a network device.\n"
Elliott Hughes542370d2018-04-19 19:49:44 -0700647 " -S SIZE[K|M|G] Break into sparse files no larger than SIZE.\n"
David Anderson89569642018-11-16 15:53:35 -0800648 " --force Force a flash operation that may be unsafe.\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700649 " --slot SLOT Use SLOT; 'all' for both slots, 'other' for\n"
650 " non-current slot (default: current active slot).\n"
651 " --set-active[=SLOT] Sets the active slot before rebooting.\n"
652 " --skip-secondary Don't flash secondary slots in flashall/update.\n"
653 " --skip-reboot Don't reboot device after flashing.\n"
654 " --disable-verity Sets disable-verity when flashing vbmeta.\n"
655 " --disable-verification Sets disable-verification when flashing vbmeta.\n"
Jaegeuk Kim638d05e2020-11-09 08:54:13 -0800656 " --fs-options=OPTION[,OPTION]\n"
657 " Enable filesystem features. OPTION supports casefold, projid, compress\n"
Elliott Hughesb76188f2018-04-03 13:30:18 -0700658 // TODO: remove --unbuffered?
659 " --unbuffered Don't buffer input or output.\n"
660 " --verbose, -v Verbose output.\n"
661 " --version Display version.\n"
662 " --help, -h Show this message.\n"
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800663 );
Yifan Hongbcd27702021-02-16 19:37:32 -0800664 // clang-format on
Elliott Hughesd6365a72017-05-08 18:04:49 -0700665 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800666}
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000667
Tom Cherrydfd85df2018-09-20 14:45:05 -0700668static std::vector<char> LoadBootableImage(const std::string& kernel, const std::string& ramdisk,
669 const std::string& second_stage) {
670 std::vector<char> kernel_data;
671 if (!ReadFileToVector(kernel, &kernel_data)) {
672 die("cannot load '%s': %s", kernel.c_str(), strerror(errno));
673 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800674
Elliott Hughesfc797672015-04-07 20:12:50 -0700675 // Is this actually a boot image?
Steve Muckle15303f22020-03-18 14:55:06 -0700676 if (kernel_data.size() < sizeof(boot_img_hdr_v3)) {
Elliott Hughesaaa3b6b2018-01-18 16:08:24 -0800677 die("cannot load '%s': too short", kernel.c_str());
678 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700679 if (!memcmp(kernel_data.data(), BOOT_MAGIC, BOOT_MAGIC_SIZE)) {
Elliott Hughes577e8b42018-04-05 16:12:47 -0700680 if (!g_cmdline.empty()) {
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800681 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(kernel_data.data()), g_cmdline);
Elliott Hughes577e8b42018-04-05 16:12:47 -0700682 }
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800683
Elliott Hughes4089d342017-10-27 14:21:12 -0700684 if (!ramdisk.empty()) die("cannot boot a boot.img *and* ramdisk");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800685
Tom Cherrydfd85df2018-09-20 14:45:05 -0700686 return kernel_data;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800687 }
688
Tom Cherrydfd85df2018-09-20 14:45:05 -0700689 std::vector<char> ramdisk_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700690 if (!ramdisk.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700691 if (!ReadFileToVector(ramdisk, &ramdisk_data)) {
692 die("cannot load '%s': %s", ramdisk.c_str(), strerror(errno));
693 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800694 }
695
Tom Cherrydfd85df2018-09-20 14:45:05 -0700696 std::vector<char> second_stage_data;
Elliott Hughesd6365a72017-05-08 18:04:49 -0700697 if (!second_stage.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700698 if (!ReadFileToVector(second_stage, &second_stage_data)) {
699 die("cannot load '%s': %s", second_stage.c_str(), strerror(errno));
700 }
Jeremy Compostellaa42adff2014-07-17 17:17:54 +0200701 }
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800702
703 std::vector<char> dtb_data;
704 if (!g_dtb_path.empty()) {
Steve Muckle15303f22020-03-18 14:55:06 -0700705 if (g_boot_img_hdr.header_version != 2) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000706 die("Argument dtb not supported for boot image header version %d\n",
707 g_boot_img_hdr.header_version);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -0800708 }
709 if (!ReadFileToVector(g_dtb_path, &dtb_data)) {
710 die("cannot load '%s': %s", g_dtb_path.c_str(), strerror(errno));
711 }
712 }
713
Daniel Zheng65452d02022-11-30 02:25:31 +0000714 fprintf(stderr, "creating boot image...\n");
Elliott Hughesd6365a72017-05-08 18:04:49 -0700715
Tom Cherrydfd85df2018-09-20 14:45:05 -0700716 std::vector<char> out;
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800717 mkbootimg(kernel_data, ramdisk_data, second_stage_data, dtb_data, g_base_addr, g_boot_img_hdr,
718 &out);
Tsu Chiang Chuangee520552011-02-25 18:38:53 -0800719
Yi-Yo Chiangac4a1362021-03-25 01:14:52 +0800720 if (!g_cmdline.empty()) {
721 bootimg_set_cmdline(reinterpret_cast<boot_img_hdr_v2*>(out.data()), g_cmdline);
722 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700723 fprintf(stderr, "creating boot image - %zu bytes\n", out.size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700724 return out;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800725}
726
Tom Cherrydfd85df2018-09-20 14:45:05 -0700727static bool UnzipToMemory(ZipArchiveHandle zip, const std::string& entry_name,
728 std::vector<char>* out) {
Elliott Hughesb4074142020-09-15 14:26:17 -0700729 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700730 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Tom Cherrydfd85df2018-09-20 14:45:05 -0700731 fprintf(stderr, "archive does not contain '%s'\n", entry_name.c_str());
732 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800733 }
734
Elliott Hughesb4074142020-09-15 14:26:17 -0700735 if (zip_entry.uncompressed_length > std::numeric_limits<size_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000736 die("entry '%s' is too large: %" PRIu64, entry_name.c_str(), zip_entry.uncompressed_length);
Elliott Hughesb4074142020-09-15 14:26:17 -0700737 }
Tom Cherrydfd85df2018-09-20 14:45:05 -0700738 out->resize(zip_entry.uncompressed_length);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800739
Tom Cherrydfd85df2018-09-20 14:45:05 -0700740 fprintf(stderr, "extracting %s (%zu MB) to RAM...\n", entry_name.c_str(),
741 out->size() / 1024 / 1024);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800742
Daniel Zheng65452d02022-11-30 02:25:31 +0000743 int error =
744 ExtractToMemory(zip, &zip_entry, reinterpret_cast<uint8_t*>(out->data()), out->size());
Tom Cherrydfd85df2018-09-20 14:45:05 -0700745 if (error != 0) die("failed to extract '%s': %s", entry_name.c_str(), ErrorCodeString(error));
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000746
Tom Cherrydfd85df2018-09-20 14:45:05 -0700747 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800748}
749
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700750#if defined(_WIN32)
751
752// TODO: move this to somewhere it can be shared.
753
754#include <windows.h>
755
756// Windows' tmpfile(3) requires administrator rights because
757// it creates temporary files in the root directory.
758static FILE* win32_tmpfile() {
759 char temp_path[PATH_MAX];
760 DWORD nchars = GetTempPath(sizeof(temp_path), temp_path);
761 if (nchars == 0 || nchars >= sizeof(temp_path)) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700762 die("GetTempPath failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700763 }
764
765 char filename[PATH_MAX];
766 if (GetTempFileName(temp_path, "fastboot", 0, filename) == 0) {
Elliott Hughes4089d342017-10-27 14:21:12 -0700767 die("GetTempFileName failed, error %ld", GetLastError());
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700768 }
769
770 return fopen(filename, "w+bTD");
771}
772
773#define tmpfile win32_tmpfile
774
Elliott Hughes855cdf82018-04-02 14:24:03 -0700775static int make_temporary_fd(const char* /*what*/) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700776 // TODO: reimplement to avoid leaking a FILE*.
777 return fileno(tmpfile());
778}
779
Paul Crowley8f7f56e2015-11-27 09:29:37 +0000780#else
781
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700782static std::string make_temporary_template() {
783 const char* tmpdir = getenv("TMPDIR");
784 if (tmpdir == nullptr) tmpdir = P_tmpdir;
785 return std::string(tmpdir) + "/fastboot_userdata_XXXXXX";
786}
787
Elliott Hughes855cdf82018-04-02 14:24:03 -0700788static int make_temporary_fd(const char* what) {
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700789 std::string path_template(make_temporary_template());
790 int fd = mkstemp(&path_template[0]);
791 if (fd == -1) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000792 die("failed to create temporary file for %s with template %s: %s\n", path_template.c_str(),
793 what, strerror(errno));
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700794 }
795 unlink(path_template.c_str());
796 return fd;
797}
798
Elliott Hughesa26fbee2015-06-03 15:22:11 -0700799#endif
800
Yifan Hongb10d0672021-02-22 15:06:27 -0800801static unique_fd unzip_to_file(ZipArchiveHandle zip, const char* entry_name) {
Elliott Hughes855cdf82018-04-02 14:24:03 -0700802 unique_fd fd(make_temporary_fd(entry_name));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700803
Elliott Hughesb4074142020-09-15 14:26:17 -0700804 ZipEntry64 zip_entry;
Elliott Hughesb17bf522019-05-03 22:38:44 -0700805 if (FindEntry(zip, entry_name, &zip_entry) != 0) {
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700806 fprintf(stderr, "archive does not contain '%s'\n", entry_name);
David Andersoncf444f32018-08-29 14:15:49 -0700807 errno = ENOENT;
Yifan Hongb10d0672021-02-22 15:06:27 -0800808 return unique_fd();
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +0000809 }
810
Elliott Hughesb4074142020-09-15 14:26:17 -0700811 fprintf(stderr, "extracting %s (%" PRIu64 " MB) to disk...", entry_name,
Elliott Hughesbbfc2812017-04-25 18:33:09 -0700812 zip_entry.uncompressed_length / 1024 / 1024);
Elliott Hughes23af1122017-11-10 08:42:17 -0800813 double start = now();
Yifan Hong58532df2021-03-22 16:39:13 -0700814 int error = ExtractEntryToFile(zip, &zip_entry, fd.get());
Elliott Hughesa82c89d2015-03-19 11:44:32 -0700815 if (error != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800816 die("\nfailed to extract '%s': %s", entry_name, ErrorCodeString(error));
Rom Lemarchand622810c2013-06-28 09:54:59 -0700817 }
818
Yifan Hong58532df2021-03-22 16:39:13 -0700819 if (lseek(fd.get(), 0, SEEK_SET) != 0) {
Elliott Hughes23af1122017-11-10 08:42:17 -0800820 die("\nlseek on extracted file '%s' failed: %s", entry_name, strerror(errno));
Elliott Hughes4089d342017-10-27 14:21:12 -0700821 }
822
Elliott Hughes23af1122017-11-10 08:42:17 -0800823 fprintf(stderr, " took %.3fs\n", now() - start);
824
Yifan Hongb10d0672021-02-22 15:06:27 -0800825 return fd;
Rom Lemarchand622810c2013-06-28 09:54:59 -0700826}
827
Andrew Chantd64b9882021-04-06 12:48:27 -0700828static bool CheckRequirement(const std::string& cur_product, const std::string& var,
Tom Cherry4aa60b32018-09-05 15:11:44 -0700829 const std::string& product, bool invert,
830 const std::vector<std::string>& options) {
831 Status("Checking '" + var + "'");
Elliott Hughes5620d222018-03-28 08:20:00 -0700832
Tom Cherry4aa60b32018-09-05 15:11:44 -0700833 double start = now();
834
835 if (!product.empty()) {
836 if (product != cur_product) {
837 double split = now();
838 fprintf(stderr, "IGNORE, product is %s required only for %s [%7.3fs]\n",
839 cur_product.c_str(), product.c_str(), (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700840 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700841 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800842 }
Tom Cherry4aa60b32018-09-05 15:11:44 -0700843
844 std::string var_value;
Tom Cherry9027af02018-09-24 15:48:09 -0700845 if (fb->GetVar(var, &var_value) != fastboot::SUCCESS) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700846 fprintf(stderr, "FAILED\n\n");
Daniel Zheng65452d02022-11-30 02:25:31 +0000847 fprintf(stderr, "Could not getvar for '%s' (%s)\n\n", var.c_str(), fb->Error().c_str());
Andrew Chantd64b9882021-04-06 12:48:27 -0700848 return false;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700849 }
850
851 bool match = false;
852 for (const auto& option : options) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000853 if (option == var_value ||
854 (option.back() == '*' &&
855 !var_value.compare(0, option.length() - 1, option, 0, option.length() - 1))) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700856 match = true;
857 break;
858 }
859 }
860
861 if (invert) {
862 match = !match;
863 }
864
865 if (match) {
866 double split = now();
867 fprintf(stderr, "OKAY [%7.3fs]\n", (split - start));
Andrew Chantd64b9882021-04-06 12:48:27 -0700868 return true;
Tom Cherry4aa60b32018-09-05 15:11:44 -0700869 }
870
871 fprintf(stderr, "FAILED\n\n");
872 fprintf(stderr, "Device %s is '%s'.\n", var.c_str(), var_value.c_str());
873 fprintf(stderr, "Update %s '%s'", invert ? "rejects" : "requires", options[0].c_str());
874 for (auto it = std::next(options.begin()); it != options.end(); ++it) {
875 fprintf(stderr, " or '%s'", it->c_str());
876 }
877 fprintf(stderr, ".\n\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700878 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800879}
880
Tom Cherry4aa60b32018-09-05 15:11:44 -0700881bool ParseRequirementLine(const std::string& line, std::string* name, std::string* product,
882 bool* invert, std::vector<std::string>* options) {
Elliott Hughes5620d222018-03-28 08:20:00 -0700883 // "require product=alpha|beta|gamma"
884 // "require version-bootloader=1234"
885 // "require-for-product:gamma version-bootloader=istanbul|constantinople"
886 // "require partition-exists=vendor"
Tom Cherry4aa60b32018-09-05 15:11:44 -0700887 *product = "";
888 *invert = false;
Elliott Hughes5620d222018-03-28 08:20:00 -0700889
Tom Cherry4aa60b32018-09-05 15:11:44 -0700890 auto require_reject_regex = std::regex{"(require\\s+|reject\\s+)?\\s*(\\S+)\\s*=\\s*(.*)"};
891 auto require_product_regex =
892 std::regex{"require-for-product:\\s*(\\S+)\\s+(\\S+)\\s*=\\s*(.*)"};
893 std::smatch match_results;
894
895 if (std::regex_match(line, match_results, require_reject_regex)) {
896 *invert = Trim(match_results[1]) == "reject";
897 } else if (std::regex_match(line, match_results, require_product_regex)) {
898 *product = match_results[1];
899 } else {
900 return false;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800901 }
902
Tom Cherry4aa60b32018-09-05 15:11:44 -0700903 *name = match_results[2];
Elliott Hughes253c18d2015-03-18 22:47:09 -0700904 // Work around an unfortunate name mismatch.
Tom Cherry4aa60b32018-09-05 15:11:44 -0700905 if (*name == "board") {
906 *name = "product";
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800907 }
908
Tom Cherry4aa60b32018-09-05 15:11:44 -0700909 auto raw_options = Split(match_results[3], "|");
910 for (const auto& option : raw_options) {
911 auto trimmed_option = Trim(option);
912 options->emplace_back(trimmed_option);
913 }
914
915 return true;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800916}
917
Tom Cherry4aa60b32018-09-05 15:11:44 -0700918// "require partition-exists=x" is a special case, added because of the trouble we had when
919// Pixel 2 shipped with new partitions and users used old versions of fastboot to flash them,
920// missing out new partitions. A device with new partitions can use "partition-exists" to
921// override the fields `optional_if_no_image` in the `images` array.
922static void HandlePartitionExists(const std::vector<std::string>& options) {
923 const std::string& partition_name = options[0];
924 std::string has_slot;
Tom Cherry9027af02018-09-24 15:48:09 -0700925 if (fb->GetVar("has-slot:" + partition_name, &has_slot) != fastboot::SUCCESS ||
Tom Cherry4aa60b32018-09-05 15:11:44 -0700926 (has_slot != "yes" && has_slot != "no")) {
927 die("device doesn't have required partition %s!", partition_name.c_str());
928 }
929 bool known_partition = false;
Daniel Zheng65452d02022-11-30 02:25:31 +0000930 for (size_t i = 0; i < images.size(); ++i) {
931 if (!images[i].nickname.empty() && images[i].nickname == partition_name) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700932 images[i].optional_if_no_image = false;
933 known_partition = true;
934 }
935 }
936 if (!known_partition) {
937 die("device requires partition %s which is not known to this version of fastboot",
938 partition_name.c_str());
939 }
940}
941
Andrew Chantd64b9882021-04-06 12:48:27 -0700942static void CheckRequirements(const std::string& data, bool force_flash) {
Tom Cherry4aa60b32018-09-05 15:11:44 -0700943 std::string cur_product;
Tom Cherry9027af02018-09-24 15:48:09 -0700944 if (fb->GetVar("product", &cur_product) != fastboot::SUCCESS) {
945 fprintf(stderr, "getvar:product FAILED (%s)\n", fb->Error().c_str());
Tom Cherry4aa60b32018-09-05 15:11:44 -0700946 }
947
948 auto lines = Split(data, "\n");
949 for (const auto& line : lines) {
950 if (line.empty()) {
951 continue;
952 }
953
954 std::string name;
955 std::string product;
956 bool invert;
957 std::vector<std::string> options;
958
959 if (!ParseRequirementLine(line, &name, &product, &invert, &options)) {
960 fprintf(stderr, "android-info.txt syntax error: %s\n", line.c_str());
961 continue;
962 }
963 if (name == "partition-exists") {
964 HandlePartitionExists(options);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800965 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -0700966 bool met = CheckRequirement(cur_product, name, product, invert, options);
967 if (!met) {
968 if (!force_flash) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000969 die("requirements not met!");
Andrew Chantd64b9882021-04-06 12:48:27 -0700970 } else {
Daniel Zheng65452d02022-11-30 02:25:31 +0000971 fprintf(stderr, "requirements not met! but proceeding due to --force\n");
Andrew Chantd64b9882021-04-06 12:48:27 -0700972 }
973 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800974 }
975 }
976}
977
Tom Cherry9027af02018-09-24 15:48:09 -0700978static void DisplayVarOrError(const std::string& label, const std::string& var) {
979 std::string value;
980
981 if (fb->GetVar(var, &value) != fastboot::SUCCESS) {
982 Status("getvar:" + var);
983 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
984 return;
985 }
986 fprintf(stderr, "%s: %s\n", label.c_str(), value.c_str());
987}
988
989static void DumpInfo() {
990 fprintf(stderr, "--------------------------------------------\n");
991 DisplayVarOrError("Bootloader Version...", "version-bootloader");
992 DisplayVarOrError("Baseband Version.....", "version-baseband");
993 DisplayVarOrError("Serial Number........", "serialno");
994 fprintf(stderr, "--------------------------------------------\n");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -0800995}
996
David Andersonaa87dc52023-01-27 20:39:06 -0800997static std::vector<SparsePtr> resparse_file(sparse_file* s, int64_t max_size) {
Tao Bao41cf35f2018-04-24 10:54:21 -0700998 if (max_size <= 0 || max_size > std::numeric_limits<uint32_t>::max()) {
Daniel Zheng65452d02022-11-30 02:25:31 +0000999 die("invalid max size %" PRId64, max_size);
Tao Bao41cf35f2018-04-24 10:54:21 -07001000 }
1001
David Andersonaa87dc52023-01-27 20:39:06 -08001002 const int files = sparse_file_resparse(s, max_size, nullptr, 0);
Elliott Hughes4089d342017-10-27 14:21:12 -07001003 if (files < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001004
David Andersona1c983e2023-01-27 11:57:27 -08001005 auto temp = std::make_unique<sparse_file*[]>(files);
David Andersonaa87dc52023-01-27 20:39:06 -08001006 const int rv = sparse_file_resparse(s, max_size, temp.get(), files);
David Andersona1c983e2023-01-27 11:57:27 -08001007 if (rv < 0) die("Failed to resparse");
Colin Crossf8387882012-05-24 17:18:41 -07001008
David Andersona1c983e2023-01-27 11:57:27 -08001009 std::vector<SparsePtr> out_s;
1010 for (int i = 0; i < files; i++) {
1011 out_s.emplace_back(temp[i], sparse_file_destroy);
1012 }
Colin Crossf8387882012-05-24 17:18:41 -07001013 return out_s;
1014}
1015
David Andersonaa87dc52023-01-27 20:39:06 -08001016static std::vector<SparsePtr> load_sparse_files(int fd, int64_t max_size) {
1017 SparsePtr s(sparse_file_import_auto(fd, false, true), sparse_file_destroy);
1018 if (!s) die("cannot sparse read file");
1019
1020 return resparse_file(s.get(), max_size);
1021}
1022
Yifan Hongbcd27702021-02-16 19:37:32 -08001023static uint64_t get_uint_var(const char* var_name) {
1024 std::string value_str;
1025 if (fb->GetVar(var_name, &value_str) != fastboot::SUCCESS || value_str.empty()) {
1026 verbose("target didn't report %s", var_name);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001027 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001028 }
1029
Elliott Hughes77c0e662015-11-02 15:51:12 -08001030 // Some bootloaders (angler, for example) send spurious whitespace too.
Yifan Hongbcd27702021-02-16 19:37:32 -08001031 value_str = android::base::Trim(value_str);
Elliott Hughes77c0e662015-11-02 15:51:12 -08001032
Yifan Hongbcd27702021-02-16 19:37:32 -08001033 uint64_t value;
1034 if (!android::base::ParseUint(value_str, &value)) {
1035 fprintf(stderr, "couldn't parse %s '%s'\n", var_name, value_str.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001036 return 0;
1037 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001038 if (value > 0) verbose("target reported %s of %" PRId64 " bytes", var_name, value);
1039 return value;
Colin Crossf8387882012-05-24 17:18:41 -07001040}
1041
Aaron Wisnerdb511202018-06-26 15:38:35 -05001042static int64_t get_sparse_limit(int64_t size) {
Elliott Hughes542370d2018-04-19 19:49:44 -07001043 int64_t limit = sparse_limit;
1044 if (limit == 0) {
1045 // Unlimited, so see what the target device's limit is.
1046 // TODO: shouldn't we apply this limit even if you've used -S?
Colin Crossf8387882012-05-24 17:18:41 -07001047 if (target_sparse_limit == -1) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001048 target_sparse_limit = static_cast<int64_t>(get_uint_var("max-download-size"));
Colin Crossf8387882012-05-24 17:18:41 -07001049 }
1050 if (target_sparse_limit > 0) {
1051 limit = target_sparse_limit;
1052 } else {
Colin Cross0bbfb392012-07-24 18:05:21 -07001053 return 0;
Colin Crossf8387882012-05-24 17:18:41 -07001054 }
1055 }
1056
1057 if (size > limit) {
Chris Fries6a999712017-04-04 09:52:47 -05001058 return std::min(limit, RESPARSE_LIMIT);
Colin Crossf8387882012-05-24 17:18:41 -07001059 }
1060
1061 return 0;
1062}
1063
Yifan Hongb10d0672021-02-22 15:06:27 -08001064static bool load_buf_fd(unique_fd fd, struct fastboot_buffer* buf) {
Elliott Hughesfc797672015-04-07 20:12:50 -07001065 int64_t sz = get_file_size(fd);
1066 if (sz == -1) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001067 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001068 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001069
Yifan Hong58532df2021-03-22 16:39:13 -07001070 if (sparse_file* s = sparse_file_import(fd.get(), false, false)) {
David Anderson32e376f2018-08-16 13:43:11 -07001071 buf->image_size = sparse_file_len(s, false, false);
1072 sparse_file_destroy(s);
1073 } else {
1074 buf->image_size = sz;
1075 }
1076
Yifan Hong58532df2021-03-22 16:39:13 -07001077 lseek(fd.get(), 0, SEEK_SET);
Aaron Wisnerdb511202018-06-26 15:38:35 -05001078 int64_t limit = get_sparse_limit(sz);
Yifan Honge9f067b2021-03-22 16:55:39 -07001079 buf->fd = std::move(fd);
Colin Crossf8387882012-05-24 17:18:41 -07001080 if (limit) {
David Andersona1c983e2023-01-27 11:57:27 -08001081 buf->files = load_sparse_files(buf->fd.get(), limit);
1082 if (buf->files.empty()) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001083 return false;
Colin Crossf8387882012-05-24 17:18:41 -07001084 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001085 buf->type = FB_BUFFER_SPARSE;
Colin Crossf8387882012-05-24 17:18:41 -07001086 } else {
Chris Fries0ea946c2017-04-12 10:25:57 -05001087 buf->type = FB_BUFFER_FD;
Alexander Levitskiy8d7ddb32014-05-07 23:31:59 +00001088 buf->sz = sz;
Colin Crossf8387882012-05-24 17:18:41 -07001089 }
Rom Lemarchand622810c2013-06-28 09:54:59 -07001090
Elliott Hughes53ec4952016-05-11 12:39:27 -07001091 return true;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001092}
1093
Aaron Wisnerdb511202018-06-26 15:38:35 -05001094static bool load_buf(const char* fname, struct fastboot_buffer* buf) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001095 unique_fd fd(TEMP_FAILURE_RETRY(open(fname, O_RDONLY | O_BINARY)));
1096
Elliott Hughes53ec4952016-05-11 12:39:27 -07001097 if (fd == -1) {
1098 return false;
Rom Lemarchand622810c2013-06-28 09:54:59 -07001099 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001100
1101 struct stat s;
Yifan Hong58532df2021-03-22 16:39:13 -07001102 if (fstat(fd.get(), &s)) {
Chris Fries0ea946c2017-04-12 10:25:57 -05001103 return false;
1104 }
1105 if (!S_ISREG(s.st_mode)) {
1106 errno = S_ISDIR(s.st_mode) ? EISDIR : EINVAL;
1107 return false;
1108 }
1109
Yifan Hongb10d0672021-02-22 15:06:27 -08001110 return load_buf_fd(std::move(fd), buf);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001111}
1112
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001113static void rewrite_vbmeta_buffer(struct fastboot_buffer* buf, bool vbmeta_in_boot) {
David Zeuthenb6ea4352017-08-07 14:29:26 -04001114 // Buffer needs to be at least the size of the VBMeta struct which
1115 // is 256 bytes.
1116 if (buf->sz < 256) {
1117 return;
1118 }
1119
David Zeuthenb6ea4352017-08-07 14:29:26 -04001120 std::string data;
1121 if (!android::base::ReadFdToString(buf->fd, &data)) {
1122 die("Failed reading from vbmeta");
1123 }
1124
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001125 uint64_t vbmeta_offset = 0;
1126 if (vbmeta_in_boot) {
1127 // Tries to locate top-level vbmeta from boot.img footer.
1128 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1129 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001130 die("Failed to find AVB_FOOTER at offset: %" PRId64 ", is BOARD_AVB_ENABLE true?",
1131 footer_offset);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001132 }
1133 const AvbFooter* footer = reinterpret_cast<const AvbFooter*>(data.c_str() + footer_offset);
1134 vbmeta_offset = be64toh(footer->vbmeta_offset);
1135 }
1136 // Ensures there is AVB_MAGIC at vbmeta_offset.
1137 if (0 != data.compare(vbmeta_offset, AVB_MAGIC_LEN, AVB_MAGIC)) {
1138 die("Failed to find AVB_MAGIC at offset: %" PRId64, vbmeta_offset);
1139 }
1140
1141 fprintf(stderr, "Rewriting vbmeta struct at offset: %" PRId64 "\n", vbmeta_offset);
1142
David Zeuthenb6ea4352017-08-07 14:29:26 -04001143 // There's a 32-bit big endian |flags| field at offset 120 where
1144 // bit 0 corresponds to disable-verity and bit 1 corresponds to
1145 // disable-verification.
1146 //
1147 // See external/avb/libavb/avb_vbmeta_image.h for the layout of
1148 // the VBMeta struct.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001149 uint64_t flags_offset = 123 + vbmeta_offset;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001150 if (g_disable_verity) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001151 data[flags_offset] |= 0x01;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001152 }
1153 if (g_disable_verification) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001154 data[flags_offset] |= 0x02;
David Zeuthenb6ea4352017-08-07 14:29:26 -04001155 }
1156
Yifan Hongb10d0672021-02-22 15:06:27 -08001157 unique_fd fd(make_temporary_fd("vbmeta rewriting"));
David Zeuthenb6ea4352017-08-07 14:29:26 -04001158 if (!android::base::WriteStringToFd(data, fd)) {
1159 die("Failed writing to modified vbmeta");
1160 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001161 buf->fd = std::move(fd);
Yifan Hong58532df2021-03-22 16:39:13 -07001162 lseek(buf->fd.get(), 0, SEEK_SET);
David Zeuthenb6ea4352017-08-07 14:29:26 -04001163}
1164
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001165static bool has_vbmeta_partition() {
1166 std::string partition_type;
1167 return fb->GetVar("partition-type:vbmeta", &partition_type) == fastboot::SUCCESS ||
1168 fb->GetVar("partition-type:vbmeta_a", &partition_type) == fastboot::SUCCESS ||
1169 fb->GetVar("partition-type:vbmeta_b", &partition_type) == fastboot::SUCCESS;
1170}
1171
David Andersonaa87dc52023-01-27 20:39:06 -08001172// Note: this only works in userspace fastboot. In the bootloader, use
1173// should_flash_in_userspace().
Michael Bestasa495be72020-11-06 17:58:28 +02001174static bool is_logical(const std::string& partition) {
1175 std::string value;
1176 return fb->GetVar("is-logical:" + partition, &value) == fastboot::SUCCESS && value == "yes";
1177}
1178
Steve Muckle3af575b2020-06-18 17:02:15 -07001179static std::string fb_fix_numeric_var(std::string var) {
1180 // Some bootloaders (angler, for example), send spurious leading whitespace.
1181 var = android::base::Trim(var);
1182 // Some bootloaders (hammerhead, for example) use implicit hex.
1183 // This code used to use strtol with base 16.
1184 if (!android::base::StartsWith(var, "0x")) var = "0x" + var;
1185 return var;
1186}
1187
Yifan Hongbcd27702021-02-16 19:37:32 -08001188static uint64_t get_partition_size(const std::string& partition) {
Steve Muckle3af575b2020-06-18 17:02:15 -07001189 std::string partition_size_str;
1190 if (fb->GetVar("partition-size:" + partition, &partition_size_str) != fastboot::SUCCESS) {
Michael Bestasa495be72020-11-06 17:58:28 +02001191 if (!is_logical(partition)) {
1192 return 0;
1193 }
Yifan Hong60de9692021-02-17 13:51:54 -08001194 die("cannot get partition size for %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001195 }
1196
1197 partition_size_str = fb_fix_numeric_var(partition_size_str);
Yifan Hongbcd27702021-02-16 19:37:32 -08001198 uint64_t partition_size;
1199 if (!android::base::ParseUint(partition_size_str, &partition_size)) {
Michael Bestasa495be72020-11-06 17:58:28 +02001200 if (!is_logical(partition)) {
1201 return 0;
1202 }
Steve Muckle3af575b2020-06-18 17:02:15 -07001203 die("Couldn't parse partition size '%s'.", partition_size_str.c_str());
1204 }
Yifan Hongbcd27702021-02-16 19:37:32 -08001205 return partition_size;
1206}
1207
Devin Moorecb5098f2022-01-07 16:33:46 +00001208static void copy_avb_footer(const std::string& partition, struct fastboot_buffer* buf) {
Yifan Hongbcd27702021-02-16 19:37:32 -08001209 if (buf->sz < AVB_FOOTER_SIZE) {
1210 return;
1211 }
1212
Bowgo Tsai671249a2021-08-10 16:32:37 +08001213 // If overflows and negative, it should be < buf->sz.
1214 int64_t partition_size = static_cast<int64_t>(get_partition_size(partition));
1215
1216 if (partition_size == buf->sz) {
1217 return;
1218 }
1219 // Some device bootloaders might not implement `fastboot getvar partition-size:boot[_a|_b]`.
1220 // In this case, partition_size will be zero.
1221 if (partition_size < buf->sz) {
1222 fprintf(stderr,
Devin Moorecb5098f2022-01-07 16:33:46 +00001223 "Warning: skip copying %s image avb footer"
1224 " (%s partition size: %" PRId64 ", %s image size: %" PRId64 ").\n",
1225 partition.c_str(), partition.c_str(), partition_size, partition.c_str(), buf->sz);
Bowgo Tsai671249a2021-08-10 16:32:37 +08001226 return;
1227 }
1228
1229 // IMPORTANT: after the following read, we need to reset buf->fd before return (if not die).
1230 // Because buf->fd will still be used afterwards.
Steve Muckle3af575b2020-06-18 17:02:15 -07001231 std::string data;
1232 if (!android::base::ReadFdToString(buf->fd, &data)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001233 die("Failed reading from %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001234 }
1235
1236 uint64_t footer_offset = buf->sz - AVB_FOOTER_SIZE;
1237 if (0 != data.compare(footer_offset, AVB_FOOTER_MAGIC_LEN, AVB_FOOTER_MAGIC)) {
Bowgo Tsai671249a2021-08-10 16:32:37 +08001238 lseek(buf->fd.get(), 0, SEEK_SET); // IMPORTANT: resets buf->fd before return.
Steve Muckle3af575b2020-06-18 17:02:15 -07001239 return;
1240 }
1241
Devin Moorecb5098f2022-01-07 16:33:46 +00001242 const std::string tmp_fd_template = partition + " rewriting";
1243 unique_fd fd(make_temporary_fd(tmp_fd_template.c_str()));
Steve Muckle3af575b2020-06-18 17:02:15 -07001244 if (!android::base::WriteStringToFd(data, fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001245 die("Failed writing to modified %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001246 }
Yifan Hong58532df2021-03-22 16:39:13 -07001247 lseek(fd.get(), partition_size - AVB_FOOTER_SIZE, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001248 if (!android::base::WriteStringToFd(data.substr(footer_offset), fd)) {
Devin Moorecb5098f2022-01-07 16:33:46 +00001249 die("Failed copying AVB footer in %s", partition.c_str());
Steve Muckle3af575b2020-06-18 17:02:15 -07001250 }
Yifan Hongb10d0672021-02-22 15:06:27 -08001251 buf->fd = std::move(fd);
Steve Muckle3af575b2020-06-18 17:02:15 -07001252 buf->sz = partition_size;
Yifan Hong58532df2021-03-22 16:39:13 -07001253 lseek(buf->fd.get(), 0, SEEK_SET);
Steve Muckle3af575b2020-06-18 17:02:15 -07001254}
1255
David Andersonaa87dc52023-01-27 20:39:06 -08001256static void flash_partition_files(const std::string& partition,
1257 const std::vector<SparsePtr>& files) {
1258 for (size_t i = 0; i < files.size(); i++) {
1259 sparse_file* s = files[i].get();
1260 int64_t sz = sparse_file_len(s, true, false);
1261 fb->FlashPartition(partition, s, sz, i + 1, files.size());
1262 }
1263}
1264
Daniel Zheng65452d02022-11-30 02:25:31 +00001265static void flash_buf(const std::string& partition, struct fastboot_buffer* buf) {
Devin Moore1af12022022-01-06 01:11:23 +00001266 if (partition == "boot" || partition == "boot_a" || partition == "boot_b" ||
Isaac J. Manjarresacb49522023-01-12 14:28:29 -08001267 partition == "init_boot" || partition == "init_boot_a" || partition == "init_boot_b" ||
1268 partition == "recovery" || partition == "recovery_a" || partition == "recovery_b") {
Devin Moorecb5098f2022-01-07 16:33:46 +00001269 copy_avb_footer(partition, buf);
Steve Muckle3af575b2020-06-18 17:02:15 -07001270 }
1271
David Zeuthenb6ea4352017-08-07 14:29:26 -04001272 // Rewrite vbmeta if that's what we're flashing and modification has been requested.
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001273 if (g_disable_verity || g_disable_verification) {
Paweł Grabasff9cfac2021-03-04 13:11:25 +01001274 // The vbmeta partition might have additional prefix if running in virtual machine
1275 // e.g., guest_vbmeta_a.
1276 if (android::base::EndsWith(partition, "vbmeta") ||
1277 android::base::EndsWith(partition, "vbmeta_a") ||
1278 android::base::EndsWith(partition, "vbmeta_b")) {
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001279 rewrite_vbmeta_buffer(buf, false /* vbmeta_in_boot */);
1280 } else if (!has_vbmeta_partition() &&
1281 (partition == "boot" || partition == "boot_a" || partition == "boot_b")) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001282 rewrite_vbmeta_buffer(buf, true /* vbmeta_in_boot */);
Chin-Ting Kuodf6a7802019-09-16 11:23:55 +08001283 }
David Zeuthenb6ea4352017-08-07 14:29:26 -04001284 }
1285
Rom Lemarchand622810c2013-06-28 09:54:59 -07001286 switch (buf->type) {
Josh Gao9da9ac52016-01-19 14:50:18 -08001287 case FB_BUFFER_SPARSE: {
David Andersonaa87dc52023-01-27 20:39:06 -08001288 flash_partition_files(partition, buf->files);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001289 break;
Josh Gao9da9ac52016-01-19 14:50:18 -08001290 }
Chris Fries0ea946c2017-04-12 10:25:57 -05001291 case FB_BUFFER_FD:
Tom Cherry9027af02018-09-24 15:48:09 -07001292 fb->FlashPartition(partition, buf->fd, buf->sz);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001293 break;
1294 default:
1295 die("unknown buffer type: %d", buf->type);
1296 }
1297}
1298
Aaron Wisnerdb511202018-06-26 15:38:35 -05001299static std::string get_current_slot() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001300 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07001301 if (fb->GetVar("current-slot", &current_slot) != fastboot::SUCCESS) return "";
LuK1337dae48ef2020-04-06 14:38:58 +02001302 if (current_slot[0] == '_') current_slot.erase(0, 1);
Elliott Hughes42b18a52018-04-10 15:32:21 -07001303 return current_slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001304}
1305
Aaron Wisnerdb511202018-06-26 15:38:35 -05001306static int get_slot_count() {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001307 std::string var;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001308 int count = 0;
Tom Cherry9027af02018-09-24 15:48:09 -07001309 if (fb->GetVar("slot-count", &var) != fastboot::SUCCESS ||
1310 !android::base::ParseInt(var, &count)) {
Elliott Hughes42b18a52018-04-10 15:32:21 -07001311 return 0;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001312 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001313 return count;
1314}
1315
Aaron Wisnerdb511202018-06-26 15:38:35 -05001316static bool supports_AB() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001317 return get_slot_count() >= 2;
Alex Lightbb9b8a52016-06-29 09:26:44 -07001318}
1319
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001320// Given a current slot, this returns what the 'other' slot is.
Daniel Rosenberg80919472016-06-30 19:25:31 -07001321static std::string get_other_slot(const std::string& current_slot, int count) {
1322 if (count == 0) return "";
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001323
Daniel Zheng65452d02022-11-30 02:25:31 +00001324 char next = (current_slot[0] - 'a' + 1) % count + 'a';
Daniel Rosenberg80919472016-06-30 19:25:31 -07001325 return std::string(1, next);
1326}
1327
Aaron Wisnerdb511202018-06-26 15:38:35 -05001328static std::string get_other_slot(const std::string& current_slot) {
1329 return get_other_slot(current_slot, get_slot_count());
Daniel Rosenberg80919472016-06-30 19:25:31 -07001330}
1331
Aaron Wisnerdb511202018-06-26 15:38:35 -05001332static std::string get_other_slot(int count) {
1333 return get_other_slot(get_current_slot(), count);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001334}
1335
Aaron Wisnerdb511202018-06-26 15:38:35 -05001336static std::string get_other_slot() {
1337 return get_other_slot(get_current_slot(), get_slot_count());
Alex Lightbb9b8a52016-06-29 09:26:44 -07001338}
1339
Aaron Wisnerdb511202018-06-26 15:38:35 -05001340static std::string verify_slot(const std::string& slot_name, bool allow_all) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001341 std::string slot = slot_name;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001342 if (slot == "all") {
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001343 if (allow_all) {
1344 return "all";
1345 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001346 int count = get_slot_count();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001347 if (count > 0) {
1348 return "a";
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001349 } else {
Elliott Hughes4089d342017-10-27 14:21:12 -07001350 die("No known slots");
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001351 }
1352 }
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001353 }
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001354
Aaron Wisnerdb511202018-06-26 15:38:35 -05001355 int count = get_slot_count();
Elliott Hughes4089d342017-10-27 14:21:12 -07001356 if (count == 0) die("Device does not support slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001357
Daniel Rosenberg80919472016-06-30 19:25:31 -07001358 if (slot == "other") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001359 std::string other = get_other_slot(count);
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001360 if (other == "") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001361 die("No known slots");
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001362 }
Daniel Rosenbergad3d3c12016-06-27 23:03:48 -07001363 return other;
Daniel Rosenbergc1743ba2016-01-05 16:54:40 -08001364 }
1365
Daniel Zheng65452d02022-11-30 02:25:31 +00001366 if (slot.size() == 1 && (slot[0] - 'a' >= 0 && slot[0] - 'a' < count)) return slot;
Daniel Rosenberg80919472016-06-30 19:25:31 -07001367
1368 fprintf(stderr, "Slot %s does not exist. supported slots are:\n", slot.c_str());
Daniel Zheng65452d02022-11-30 02:25:31 +00001369 for (int i = 0; i < count; i++) {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001370 fprintf(stderr, "%c\n", (char)(i + 'a'));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001371 }
Daniel Rosenberg80919472016-06-30 19:25:31 -07001372
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001373 exit(1);
1374}
1375
Aaron Wisnerdb511202018-06-26 15:38:35 -05001376static std::string verify_slot(const std::string& slot) {
Daniel Zheng65452d02022-11-30 02:25:31 +00001377 return verify_slot(slot, true);
Daniel Rosenberg9b432052015-11-25 15:17:10 -08001378}
1379
Aaron Wisnerdb511202018-06-26 15:38:35 -05001380static void do_for_partition(const std::string& part, const std::string& slot,
Chih-Hung Hsieh8f7b9e32016-07-27 16:25:51 -07001381 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001382 std::string has_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001383 std::string current_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001384 // |part| can be vendor_boot:default. Append slot to the first token.
1385 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001386
Yifan Hong6d7da632021-02-23 12:15:51 -08001387 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001388 /* If has-slot is not supported, the answer is no. */
1389 has_slot = "no";
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001390 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001391 if (has_slot == "yes") {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001392 if (slot == "") {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001393 current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001394 if (current_slot == "") {
Elliott Hughes4089d342017-10-27 14:21:12 -07001395 die("Failed to identify current slot");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001396 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001397 part_tokens[0] += "_" + current_slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001398 } else {
Yifan Hong6d7da632021-02-23 12:15:51 -08001399 part_tokens[0] += "_" + slot;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001400 }
Yifan Hong6d7da632021-02-23 12:15:51 -08001401 func(android::base::Join(part_tokens, ":"));
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001402 } else {
Daniel Rosenberg80919472016-06-30 19:25:31 -07001403 if (force_slot && slot != "") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001404 fprintf(stderr, "Warning: %s does not support slots, and slot %s was requested.\n",
1405 part_tokens[0].c_str(), slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001406 }
1407 func(part);
1408 }
1409}
1410
David Pursell0b156632015-10-30 11:22:01 -07001411/* This function will find the real partition name given a base name, and a slot. If slot is NULL or
1412 * empty, it will use the current slot. If slot is "all", it will return a list of all possible
1413 * partition names. If force_slot is true, it will fail if a slot is specified, and the given
1414 * partition does not support slots.
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001415 */
Daniel Zheng0d307182023-01-31 21:07:53 +00001416void do_for_partitions(const std::string& part, const std::string& slot,
1417 const std::function<void(const std::string&)>& func, bool force_slot) {
Daniel Rosenberga7974792015-11-11 16:13:13 -08001418 std::string has_slot;
Yifan Hong6d7da632021-02-23 12:15:51 -08001419 // |part| can be vendor_boot:default. Query has-slot on the first token only.
1420 auto part_tokens = android::base::Split(part, ":");
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001421
Daniel Rosenberg80919472016-06-30 19:25:31 -07001422 if (slot == "all") {
Yifan Hong6d7da632021-02-23 12:15:51 -08001423 if (fb->GetVar("has-slot:" + part_tokens[0], &has_slot) != fastboot::SUCCESS) {
1424 die("Could not check if partition %s has slot %s", part_tokens[0].c_str(),
1425 slot.c_str());
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001426 }
Daniel Rosenberga7974792015-11-11 16:13:13 -08001427 if (has_slot == "yes") {
Daniel Zheng65452d02022-11-30 02:25:31 +00001428 for (int i = 0; i < get_slot_count(); i++) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001429 do_for_partition(part, std::string(1, (char)(i + 'a')), func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001430 }
1431 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001432 do_for_partition(part, "", func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001433 }
1434 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001435 do_for_partition(part, slot, func, force_slot);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07001436 }
1437}
1438
David Anderson0c732342018-11-28 17:10:42 -08001439static bool is_retrofit_device() {
1440 std::string value;
1441 if (fb->GetVar("super-partition-name", &value) != fastboot::SUCCESS) {
1442 return false;
1443 }
1444 return android::base::StartsWith(value, "system_");
1445}
1446
Yifan Hongbcd27702021-02-16 19:37:32 -08001447// Fetch a partition from the device to a given fd. This is a wrapper over FetchToFd to fetch
1448// the full image.
1449static uint64_t fetch_partition(const std::string& partition, borrowed_fd fd) {
1450 uint64_t fetch_size = get_uint_var(FB_VAR_MAX_FETCH_SIZE);
1451 if (fetch_size == 0) {
1452 die("Unable to get %s. Device does not support fetch command.", FB_VAR_MAX_FETCH_SIZE);
1453 }
1454 uint64_t partition_size = get_partition_size(partition);
1455 if (partition_size <= 0) {
1456 die("Invalid partition size for partition %s: %" PRId64, partition.c_str(), partition_size);
1457 }
1458
1459 uint64_t offset = 0;
1460 while (offset < partition_size) {
1461 uint64_t chunk_size = std::min(fetch_size, partition_size - offset);
1462 if (fb->FetchToFd(partition, fd, offset, chunk_size) != fastboot::RetCode::SUCCESS) {
1463 die("Unable to fetch %s (offset=%" PRIx64 ", size=%" PRIx64 ")", partition.c_str(),
1464 offset, chunk_size);
1465 }
1466 offset += chunk_size;
1467 }
1468 return partition_size;
1469}
1470
1471static void do_fetch(const std::string& partition, const std::string& slot_override,
1472 const std::string& outfile) {
1473 unique_fd fd(TEMP_FAILURE_RETRY(
1474 open(outfile.c_str(), O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC | O_BINARY, 0644)));
1475 auto fetch = std::bind(fetch_partition, _1, borrowed_fd(fd));
1476 do_for_partitions(partition, slot_override, fetch, false /* force slot */);
1477}
1478
Yifan Honge71fe242021-02-22 15:00:15 -08001479// Return immediately if not flashing a vendor boot image. If flashing a vendor boot image,
1480// repack vendor_boot image with an updated ramdisk. After execution, buf is set
1481// to the new image to flash, and return value is the real partition name to flash.
1482static std::string repack_ramdisk(const char* pname, struct fastboot_buffer* buf) {
1483 std::string_view pname_sv{pname};
1484
1485 if (!android::base::StartsWith(pname_sv, "vendor_boot:") &&
1486 !android::base::StartsWith(pname_sv, "vendor_boot_a:") &&
1487 !android::base::StartsWith(pname_sv, "vendor_boot_b:")) {
1488 return std::string(pname_sv);
1489 }
1490 if (buf->type != FB_BUFFER_FD) {
1491 die("Flashing sparse vendor ramdisk image is not supported.");
1492 }
1493 if (buf->sz <= 0) {
1494 die("repack_ramdisk() sees negative size: %" PRId64, buf->sz);
1495 }
1496 std::string partition(pname_sv.substr(0, pname_sv.find(':')));
1497 std::string ramdisk(pname_sv.substr(pname_sv.find(':') + 1));
1498
1499 unique_fd vendor_boot(make_temporary_fd("vendor boot repack"));
1500 uint64_t vendor_boot_size = fetch_partition(partition, vendor_boot);
1501 auto repack_res = replace_vendor_ramdisk(vendor_boot, vendor_boot_size, ramdisk, buf->fd,
1502 static_cast<uint64_t>(buf->sz));
1503 if (!repack_res.ok()) {
1504 die("%s", repack_res.error().message().c_str());
1505 }
1506
1507 buf->fd = std::move(vendor_boot);
1508 buf->sz = vendor_boot_size;
1509 buf->image_size = vendor_boot_size;
1510 return partition;
1511}
1512
Daniel Zheng0d307182023-01-31 21:07:53 +00001513void do_flash(const char* pname, const char* fname) {
Yifan Hong6d7da632021-02-23 12:15:51 -08001514 verbose("Do flash %s %s", pname, fname);
Rom Lemarchand622810c2013-06-28 09:54:59 -07001515 struct fastboot_buffer buf;
1516
Aaron Wisnerdb511202018-06-26 15:38:35 -05001517 if (!load_buf(fname, &buf)) {
Elliott Hughes53ec4952016-05-11 12:39:27 -07001518 die("cannot load '%s': %s", fname, strerror(errno));
Rom Lemarchand622810c2013-06-28 09:54:59 -07001519 }
David Anderson629e51c2018-10-25 12:51:25 -07001520 if (is_logical(pname)) {
1521 fb->ResizePartition(pname, std::to_string(buf.image_size));
1522 }
Yifan Honge71fe242021-02-22 15:00:15 -08001523 std::string flash_pname = repack_ramdisk(pname, &buf);
1524 flash_buf(flash_pname, &buf);
Colin Crossf8387882012-05-24 17:18:41 -07001525}
1526
Daniel Rosenberg13454092016-06-27 19:43:11 -07001527// Sets slot_override as the active slot. If slot_override is blank,
1528// set current slot as active instead. This clears slot-unbootable.
Aaron Wisnerdb511202018-06-26 15:38:35 -05001529static void set_active(const std::string& slot_override) {
1530 if (!supports_AB()) return;
Elliott Hughes42b18a52018-04-10 15:32:21 -07001531
Daniel Rosenberg80919472016-06-30 19:25:31 -07001532 if (slot_override != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001533 fb->SetActive(slot_override);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001534 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05001535 std::string current_slot = get_current_slot();
Daniel Rosenberg80919472016-06-30 19:25:31 -07001536 if (current_slot != "") {
Tom Cherry9027af02018-09-24 15:48:09 -07001537 fb->SetActive(current_slot);
Daniel Rosenberg13454092016-06-27 19:43:11 -07001538 }
1539 }
1540}
1541
Daniel Zheng0d307182023-01-31 21:07:53 +00001542bool is_userspace_fastboot() {
David Anderson32e376f2018-08-16 13:43:11 -07001543 std::string value;
Tom Cherry9027af02018-09-24 15:48:09 -07001544 return fb->GetVar("is-userspace", &value) == fastboot::SUCCESS && value == "yes";
David Anderson32e376f2018-08-16 13:43:11 -07001545}
1546
Daniel Zheng0d307182023-01-31 21:07:53 +00001547void reboot_to_userspace_fastboot() {
Tom Cherry9027af02018-09-24 15:48:09 -07001548 fb->RebootTo("fastboot");
1549
1550 auto* old_transport = fb->set_transport(nullptr);
1551 delete old_transport;
David Anderson1d887432018-08-27 16:47:32 -07001552
1553 // Give the current connection time to close.
1554 std::this_thread::sleep_for(std::chrono::milliseconds(1000));
1555
Tom Cherry9027af02018-09-24 15:48:09 -07001556 fb->set_transport(open_device());
David Anderson11d6d272018-12-07 16:39:07 -08001557
1558 if (!is_userspace_fastboot()) {
1559 die("Failed to boot into userspace fastboot; one or more components might be unbootable.");
1560 }
Hridya Valsaraju83d856e2019-05-17 14:24:19 -07001561
1562 // Reset target_sparse_limit after reboot to userspace fastboot. Max
1563 // download sizes may differ in bootloader and fastbootd.
1564 target_sparse_limit = -1;
David Anderson1d887432018-08-27 16:47:32 -07001565}
1566
David Andersonab8f4662019-10-21 16:45:59 -07001567static void CancelSnapshotIfNeeded() {
1568 std::string merge_status = "none";
1569 if (fb->GetVar(FB_VAR_SNAPSHOT_UPDATE_STATUS, &merge_status) == fastboot::SUCCESS &&
Elliott Hughes6a7ff582020-06-05 14:06:15 -07001570 !merge_status.empty() && merge_status != "none") {
Yifan Hong712c32b2019-12-10 18:11:13 -08001571 fb->SnapshotUpdateCommand("cancel");
David Andersonab8f4662019-10-21 16:45:59 -07001572 }
1573}
1574
David Andersoncf444f32018-08-29 14:15:49 -07001575class FlashAllTool {
1576 public:
Andrew Chantd64b9882021-04-06 12:48:27 -07001577 FlashAllTool(const ImageSource& source, const std::string& slot_override, bool skip_secondary,
1578 bool wipe, bool force_flash);
David Anderson32e376f2018-08-16 13:43:11 -07001579
David Andersoncf444f32018-08-29 14:15:49 -07001580 void Flash();
David Anderson32e376f2018-08-16 13:43:11 -07001581
David Andersoncf444f32018-08-29 14:15:49 -07001582 private:
1583 void CheckRequirements();
David Anderson667b1ef2023-01-27 21:11:11 -08001584 void DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001585 void CollectImages();
1586 void FlashImages(const std::vector<std::pair<const Image*, std::string>>& images);
1587 void FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf);
1588 void UpdateSuperPartition();
David Anderson667b1ef2023-01-27 21:11:11 -08001589 bool OptimizedFlashSuper();
1590
1591 // If the image uses the default slot, or the user specified "all", then
1592 // the paired string will be empty. If the image requests a specific slot
1593 // (for example, system_other) it is specified instead.
1594 using ImageEntry = std::pair<const Image*, std::string>;
1595
1596 std::string GetPartitionName(const ImageEntry& entry);
David Anderson32e376f2018-08-16 13:43:11 -07001597
David Andersoncf444f32018-08-29 14:15:49 -07001598 const ImageSource& source_;
1599 std::string slot_override_;
1600 bool skip_secondary_;
1601 bool wipe_;
Andrew Chantd64b9882021-04-06 12:48:27 -07001602 bool force_flash_;
David Anderson667b1ef2023-01-27 21:11:11 -08001603 std::string current_slot_;
David Andersoncf444f32018-08-29 14:15:49 -07001604 std::string secondary_slot_;
David Anderson667b1ef2023-01-27 21:11:11 -08001605
1606 std::vector<ImageEntry> boot_images_;
1607 std::vector<ImageEntry> os_images_;
David Andersoncf444f32018-08-29 14:15:49 -07001608};
1609
Andrew Chantd64b9882021-04-06 12:48:27 -07001610FlashAllTool::FlashAllTool(const ImageSource& source, const std::string& slot_override,
1611 bool skip_secondary, bool wipe, bool force_flash)
Daniel Zheng65452d02022-11-30 02:25:31 +00001612 : source_(source),
1613 slot_override_(slot_override),
1614 skip_secondary_(skip_secondary),
1615 wipe_(wipe),
1616 force_flash_(force_flash) {}
David Anderson32e376f2018-08-16 13:43:11 -07001617
David Andersoncf444f32018-08-29 14:15:49 -07001618void FlashAllTool::Flash() {
Tom Cherry9027af02018-09-24 15:48:09 -07001619 DumpInfo();
David Andersoncf444f32018-08-29 14:15:49 -07001620 CheckRequirements();
David Anderson96a9fd42018-11-05 15:21:44 -08001621
1622 // Change the slot first, so we boot into the correct recovery image when
1623 // using fastbootd.
1624 if (slot_override_ == "all") {
1625 set_active("a");
1626 } else {
1627 set_active(slot_override_);
1628 }
1629
David Anderson667b1ef2023-01-27 21:11:11 -08001630 DetermineSlot();
David Andersoncf444f32018-08-29 14:15:49 -07001631 CollectImages();
David Anderson32e376f2018-08-16 13:43:11 -07001632
David Andersonab8f4662019-10-21 16:45:59 -07001633 CancelSnapshotIfNeeded();
1634
David Anderson95d40932018-08-28 12:14:33 -07001635 // First flash boot partitions. We allow this to happen either in userspace
1636 // or in bootloader fastboot.
David Andersoncf444f32018-08-29 14:15:49 -07001637 FlashImages(boot_images_);
David Anderson95d40932018-08-28 12:14:33 -07001638
David Anderson667b1ef2023-01-27 21:11:11 -08001639 if (!OptimizedFlashSuper()) {
1640 // Sync the super partition. This will reboot to userspace fastboot if needed.
1641 UpdateSuperPartition();
David Anderson95d40932018-08-28 12:14:33 -07001642
David Anderson667b1ef2023-01-27 21:11:11 -08001643 // Resize any logical partition to 0, so each partition is reset to 0
1644 // extents, and will achieve more optimal allocation.
1645 for (const auto& [image, slot] : os_images_) {
1646 auto resize_partition = [](const std::string& partition) -> void {
1647 if (is_logical(partition)) {
1648 fb->ResizePartition(partition, "0");
1649 }
1650 };
1651 do_for_partitions(image->part_name, slot, resize_partition, false);
1652 }
David Anderson32e376f2018-08-16 13:43:11 -07001653 }
1654
David Anderson95d40932018-08-28 12:14:33 -07001655 // Flash OS images, resizing logical partitions as needed.
David Andersoncf444f32018-08-29 14:15:49 -07001656 FlashImages(os_images_);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001657}
1658
David Anderson667b1ef2023-01-27 21:11:11 -08001659bool FlashAllTool::OptimizedFlashSuper() {
1660 if (!supports_AB()) {
1661 LOG(VERBOSE) << "Cannot optimize flashing super on non-AB device";
1662 return false;
1663 }
1664 if (slot_override_ == "all") {
1665 LOG(VERBOSE) << "Cannot optimize flashing super for all slots";
1666 return false;
1667 }
1668
1669 // Does this device use dynamic partitions at all?
1670 unique_fd fd = source_.OpenFile("super_empty.img");
1671 if (fd < 0) {
1672 LOG(VERBOSE) << "could not open super_empty.img";
1673 return false;
1674 }
1675
1676 // Try to find whether there is a super partition.
1677 std::string super_name;
1678 if (fb->GetVar("super-partition-name", &super_name) != fastboot::SUCCESS) {
1679 super_name = "super";
1680 }
1681 std::string partition_size_str;
1682 if (fb->GetVar("partition-size:" + super_name, &partition_size_str) != fastboot::SUCCESS) {
1683 LOG(VERBOSE) << "Cannot optimize super flashing: could not determine super partition";
1684 return false;
1685 }
1686
1687 SuperFlashHelper helper(source_);
1688 if (!helper.Open(fd)) {
1689 return false;
1690 }
1691
1692 for (const auto& entry : os_images_) {
1693 auto partition = GetPartitionName(entry);
1694 auto image = entry.first;
1695
1696 if (!helper.AddPartition(partition, image->img_name, image->optional_if_no_image)) {
1697 return false;
1698 }
1699 }
1700
1701 auto s = helper.GetSparseLayout();
1702 if (!s) {
1703 return false;
1704 }
1705
1706 std::vector<SparsePtr> files;
1707 if (int limit = get_sparse_limit(sparse_file_len(s.get(), false, false))) {
1708 files = resparse_file(s.get(), limit);
1709 } else {
1710 files.emplace_back(std::move(s));
1711 }
1712
1713 // Send the data to the device.
1714 flash_partition_files(super_name, files);
1715
1716 // Remove images that we already flashed, just in case we have non-dynamic OS images.
1717 auto remove_if_callback = [&, this](const ImageEntry& entry) -> bool {
1718 return helper.WillFlash(GetPartitionName(entry));
1719 };
1720 os_images_.erase(std::remove_if(os_images_.begin(), os_images_.end(), remove_if_callback),
1721 os_images_.end());
1722 return true;
1723}
1724
David Andersoncf444f32018-08-29 14:15:49 -07001725void FlashAllTool::CheckRequirements() {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001726 std::vector<char> contents;
1727 if (!source_.ReadFile("android-info.txt", &contents)) {
David Andersoncf444f32018-08-29 14:15:49 -07001728 die("could not read android-info.txt");
1729 }
Andrew Chantd64b9882021-04-06 12:48:27 -07001730 ::CheckRequirements({contents.data(), contents.size()}, force_flash_);
David Andersoncf444f32018-08-29 14:15:49 -07001731}
1732
David Anderson667b1ef2023-01-27 21:11:11 -08001733void FlashAllTool::DetermineSlot() {
1734 if (slot_override_.empty()) {
1735 current_slot_ = get_current_slot();
1736 } else {
1737 current_slot_ = slot_override_;
1738 }
1739
David Andersoncf444f32018-08-29 14:15:49 -07001740 if (skip_secondary_) {
1741 return;
1742 }
David Anderson96a9fd42018-11-05 15:21:44 -08001743 if (slot_override_ != "" && slot_override_ != "all") {
David Andersoncf444f32018-08-29 14:15:49 -07001744 secondary_slot_ = get_other_slot(slot_override_);
1745 } else {
1746 secondary_slot_ = get_other_slot();
1747 }
1748 if (secondary_slot_ == "") {
1749 if (supports_AB()) {
1750 fprintf(stderr, "Warning: Could not determine slot for secondary images. Ignoring.\n");
1751 }
1752 skip_secondary_ = true;
1753 }
1754}
1755
1756void FlashAllTool::CollectImages() {
Daniel Zheng65452d02022-11-30 02:25:31 +00001757 for (size_t i = 0; i < images.size(); ++i) {
David Andersoncf444f32018-08-29 14:15:49 -07001758 std::string slot = slot_override_;
1759 if (images[i].IsSecondary()) {
1760 if (skip_secondary_) {
1761 continue;
1762 }
1763 slot = secondary_slot_;
1764 }
1765 if (images[i].type == ImageType::BootCritical) {
1766 boot_images_.emplace_back(&images[i], slot);
1767 } else if (images[i].type == ImageType::Normal) {
1768 os_images_.emplace_back(&images[i], slot);
1769 }
1770 }
1771}
1772
1773void FlashAllTool::FlashImages(const std::vector<std::pair<const Image*, std::string>>& images) {
1774 for (const auto& [image, slot] : images) {
1775 fastboot_buffer buf;
Yifan Hongb10d0672021-02-22 15:06:27 -08001776 unique_fd fd = source_.OpenFile(image->img_name);
1777 if (fd < 0 || !load_buf_fd(std::move(fd), &buf)) {
David Andersoncf444f32018-08-29 14:15:49 -07001778 if (image->optional_if_no_image) {
1779 continue;
1780 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001781 die("could not load '%s': %s", image->img_name.c_str(), strerror(errno));
David Andersoncf444f32018-08-29 14:15:49 -07001782 }
1783 FlashImage(*image, slot, &buf);
1784 }
1785}
1786
1787void FlashAllTool::FlashImage(const Image& image, const std::string& slot, fastboot_buffer* buf) {
1788 auto flash = [&, this](const std::string& partition_name) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001789 std::vector<char> signature_data;
1790 if (source_.ReadFile(image.sig_name, &signature_data)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001791 fb->Download("signature", signature_data);
1792 fb->RawCommand("signature", "installing signature");
David Andersoncf444f32018-08-29 14:15:49 -07001793 }
1794
1795 if (is_logical(partition_name)) {
Tom Cherry9027af02018-09-24 15:48:09 -07001796 fb->ResizePartition(partition_name, std::to_string(buf->image_size));
David Andersoncf444f32018-08-29 14:15:49 -07001797 }
1798 flash_buf(partition_name.c_str(), buf);
1799 };
1800 do_for_partitions(image.part_name, slot, flash, false);
1801}
1802
1803void FlashAllTool::UpdateSuperPartition() {
Yifan Hong58532df2021-03-22 16:39:13 -07001804 unique_fd fd = source_.OpenFile("super_empty.img");
David Andersoncf444f32018-08-29 14:15:49 -07001805 if (fd < 0) {
1806 return;
1807 }
1808 if (!is_userspace_fastboot()) {
1809 reboot_to_userspace_fastboot();
1810 }
David Andersoncf444f32018-08-29 14:15:49 -07001811
David Anderson90fe0a42018-11-05 18:01:32 -08001812 std::string super_name;
1813 if (fb->GetVar("super-partition-name", &super_name) != fastboot::RetCode::SUCCESS) {
1814 super_name = "super";
1815 }
1816 fb->Download(super_name, fd, get_file_size(fd));
1817
1818 std::string command = "update-super:" + super_name;
David Andersoncf444f32018-08-29 14:15:49 -07001819 if (wipe_) {
1820 command += ":wipe";
1821 }
Tom Cherry9027af02018-09-24 15:48:09 -07001822 fb->RawCommand(command, "Updating super partition");
David Anderson0c732342018-11-28 17:10:42 -08001823
1824 // Retrofit devices have two super partitions, named super_a and super_b.
1825 // On these devices, secondary slots must be flashed as physical
1826 // partitions (otherwise they would not mount on first boot). To enforce
1827 // this, we delete any logical partitions for the "other" slot.
1828 if (is_retrofit_device()) {
1829 for (const auto& [image, slot] : os_images_) {
1830 std::string partition_name = image->part_name + "_"s + slot;
1831 if (image->IsSecondary() && is_logical(partition_name)) {
1832 fb->DeletePartition(partition_name);
1833 }
1834 }
1835 }
David Andersoncf444f32018-08-29 14:15:49 -07001836}
1837
David Anderson667b1ef2023-01-27 21:11:11 -08001838std::string FlashAllTool::GetPartitionName(const ImageEntry& entry) {
1839 auto slot = entry.second;
1840 if (slot.empty()) {
1841 slot = current_slot_;
1842 }
1843 if (slot.empty()) {
1844 return entry.first->part_name;
1845 }
1846 if (slot == "all") {
1847 LOG(FATAL) << "Cannot retrieve a singular name when using all slots";
1848 }
1849 return entry.first->part_name + "_" + slot;
1850}
1851
David Andersoncf444f32018-08-29 14:15:49 -07001852class ZipImageSource final : public ImageSource {
1853 public:
1854 explicit ZipImageSource(ZipArchiveHandle zip) : zip_(zip) {}
Tom Cherrydfd85df2018-09-20 14:45:05 -07001855 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001856 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001857
1858 private:
1859 ZipArchiveHandle zip_;
1860};
1861
Tom Cherrydfd85df2018-09-20 14:45:05 -07001862bool ZipImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
1863 return UnzipToMemory(zip_, name, out);
David Andersoncf444f32018-08-29 14:15:49 -07001864}
1865
Yifan Hongb10d0672021-02-22 15:06:27 -08001866unique_fd ZipImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001867 return unzip_to_file(zip_, name.c_str());
1868}
1869
Andrew Chantd64b9882021-04-06 12:48:27 -07001870static void do_update(const char* filename, const std::string& slot_override, bool skip_secondary,
1871 bool force_flash) {
David Andersoncf444f32018-08-29 14:15:49 -07001872 ZipArchiveHandle zip;
1873 int error = OpenArchive(filename, &zip);
1874 if (error != 0) {
1875 die("failed to open zip file '%s': %s", filename, ErrorCodeString(error));
1876 }
1877
Andrew Chantd64b9882021-04-06 12:48:27 -07001878 FlashAllTool tool(ZipImageSource(zip), slot_override, skip_secondary, false, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001879 tool.Flash();
1880
1881 CloseArchive(zip);
1882}
1883
1884class LocalImageSource final : public ImageSource {
1885 public:
Tom Cherrydfd85df2018-09-20 14:45:05 -07001886 bool ReadFile(const std::string& name, std::vector<char>* out) const override;
Yifan Hongb10d0672021-02-22 15:06:27 -08001887 unique_fd OpenFile(const std::string& name) const override;
David Andersoncf444f32018-08-29 14:15:49 -07001888};
1889
Tom Cherrydfd85df2018-09-20 14:45:05 -07001890bool LocalImageSource::ReadFile(const std::string& name, std::vector<char>* out) const {
David Andersoncf444f32018-08-29 14:15:49 -07001891 auto path = find_item_given_name(name);
1892 if (path.empty()) {
Tom Cherrydfd85df2018-09-20 14:45:05 -07001893 return false;
David Andersoncf444f32018-08-29 14:15:49 -07001894 }
Tom Cherrydfd85df2018-09-20 14:45:05 -07001895 return ReadFileToVector(path, out);
David Andersoncf444f32018-08-29 14:15:49 -07001896}
1897
Yifan Hongb10d0672021-02-22 15:06:27 -08001898unique_fd LocalImageSource::OpenFile(const std::string& name) const {
David Andersoncf444f32018-08-29 14:15:49 -07001899 auto path = find_item_given_name(name);
Yifan Hongb10d0672021-02-22 15:06:27 -08001900 return unique_fd(TEMP_FAILURE_RETRY(open(path.c_str(), O_RDONLY | O_BINARY)));
David Andersoncf444f32018-08-29 14:15:49 -07001901}
1902
Andrew Chantd64b9882021-04-06 12:48:27 -07001903static void do_flashall(const std::string& slot_override, bool skip_secondary, bool wipe,
1904 bool force_flash) {
1905 FlashAllTool tool(LocalImageSource(), slot_override, skip_secondary, wipe, force_flash);
David Andersoncf444f32018-08-29 14:15:49 -07001906 tool.Flash();
1907}
1908
Elliott Hughesd6365a72017-05-08 18:04:49 -07001909static std::string next_arg(std::vector<std::string>* args) {
1910 if (args->empty()) syntax_error("expected argument");
1911 std::string result = args->front();
1912 args->erase(args->begin());
1913 return result;
Patrick Tjin51e8b032015-09-01 08:15:23 -07001914}
1915
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001916static void do_oem_command(const std::string& cmd, std::vector<std::string>* args) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07001917 if (args->empty()) syntax_error("empty oem command");
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08001918
Elliott Hughes1eec97a2017-05-15 16:53:53 -07001919 std::string command(cmd);
Elliott Hughesd6365a72017-05-08 18:04:49 -07001920 while (!args->empty()) {
Elliott Hughes29d5d7d2017-05-11 15:05:13 -07001921 command += " " + next_arg(args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001922 }
Tom Cherry9027af02018-09-24 15:48:09 -07001923 fb->RawCommand(command, "");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001924}
1925
Aaron Wisnerdb511202018-06-26 15:38:35 -05001926static unsigned fb_get_flash_block_size(std::string name) {
Connor O'Brience16a8a2017-02-06 14:39:31 -08001927 std::string sizeString;
Tom Cherry9027af02018-09-24 15:48:09 -07001928 if (fb->GetVar(name, &sizeString) != fastboot::SUCCESS || sizeString.empty()) {
Elliott Hughes5620d222018-03-28 08:20:00 -07001929 // This device does not report flash block sizes, so return 0.
Connor O'Brience16a8a2017-02-06 14:39:31 -08001930 return 0;
1931 }
1932 sizeString = fb_fix_numeric_var(sizeString);
1933
1934 unsigned size;
1935 if (!android::base::ParseUint(sizeString, &size)) {
1936 fprintf(stderr, "Couldn't parse %s '%s'.\n", name.c_str(), sizeString.c_str());
1937 return 0;
1938 }
Connor O'Brien6ef5c242017-11-01 17:37:32 -07001939 if ((size & (size - 1)) != 0) {
1940 fprintf(stderr, "Invalid %s %u: must be a power of 2.\n", name.c_str(), size);
Connor O'Brience16a8a2017-02-06 14:39:31 -08001941 return 0;
1942 }
1943 return size;
1944}
1945
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001946static void fb_perform_format(const std::string& partition, int skip_if_not_supported,
Elliott Hughesd6365a72017-05-08 18:04:49 -07001947 const std::string& type_override, const std::string& size_override,
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10001948 const unsigned fs_options) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001949 std::string partition_type, partition_size;
1950
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001951 struct fastboot_buffer buf;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001952 const char* errMsg = nullptr;
1953 const struct fs_generator* gen = nullptr;
Jin Qian4a335822017-04-18 16:23:18 -07001954 TemporaryFile output;
1955 unique_fd fd;
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001956
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001957 unsigned int limit = INT_MAX;
1958 if (target_sparse_limit > 0 && target_sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001959 limit = target_sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001960 }
1961 if (sparse_limit > 0 && sparse_limit < limit) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001962 limit = sparse_limit;
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001963 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001964
Tom Cherry9027af02018-09-24 15:48:09 -07001965 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001966 errMsg = "Can't determine partition type.\n";
1967 goto failed;
1968 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001969 if (!type_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001970 if (partition_type != type_override) {
1971 fprintf(stderr, "Warning: %s type is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001972 partition.c_str(), partition_type.c_str(), type_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001973 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001974 partition_type = type_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001975 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001976
Tom Cherry9027af02018-09-24 15:48:09 -07001977 if (fb->GetVar("partition-size:" + partition, &partition_size) != fastboot::SUCCESS) {
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001978 errMsg = "Unable to get partition size\n";
1979 goto failed;
1980 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07001981 if (!size_override.empty()) {
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001982 if (partition_size != size_override) {
1983 fprintf(stderr, "Warning: %s size is %s, but %s was requested for formatting.\n",
Elliott Hughes5620d222018-03-28 08:20:00 -07001984 partition.c_str(), partition_size.c_str(), size_override.c_str());
JP Abgrall7e859742014-05-06 15:14:15 -07001985 }
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001986 partition_size = size_override;
JP Abgrall7e859742014-05-06 15:14:15 -07001987 }
Connor O'Brience16a8a2017-02-06 14:39:31 -08001988 partition_size = fb_fix_numeric_var(partition_size);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001989
Elliott Hughes8ab9a322015-11-02 14:05:57 -08001990 gen = fs_get_generator(partition_type);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001991 if (!gen) {
1992 if (skip_if_not_supported) {
1993 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07001994 fprintf(stderr, "File system type %s not supported.\n", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001995 return;
1996 }
Daniel Zheng65452d02022-11-30 02:25:31 +00001997 die("Formatting is not supported for file system with type '%s'.", partition_type.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07001998 }
1999
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002000 int64_t size;
Elliott Hughesda46b392016-10-11 17:09:00 -07002001 if (!android::base::ParseInt(partition_size, &size)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002002 die("Couldn't parse partition size '%s'.", partition_size.c_str());
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002003 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002004
Connor O'Brience16a8a2017-02-06 14:39:31 -08002005 unsigned eraseBlkSize, logicalBlkSize;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002006 eraseBlkSize = fb_get_flash_block_size("erase-block-size");
2007 logicalBlkSize = fb_get_flash_block_size("logical-block-size");
Connor O'Brience16a8a2017-02-06 14:39:31 -08002008
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002009 if (fs_generator_generate(gen, output.path, size, eraseBlkSize, logicalBlkSize, fs_options)) {
Elliott Hughes5620d222018-03-28 08:20:00 -07002010 die("Cannot generate image for %s", partition.c_str());
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002011 }
2012
Jin Qian4a335822017-04-18 16:23:18 -07002013 fd.reset(open(output.path, O_RDONLY));
2014 if (fd == -1) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002015 die("Cannot open generated image: %s", strerror(errno));
Jin Qian4a335822017-04-18 16:23:18 -07002016 }
Yifan Hongb10d0672021-02-22 15:06:27 -08002017 if (!load_buf_fd(std::move(fd), &buf)) {
Mark Salyzyna30b6962018-11-20 11:04:15 -08002018 die("Cannot read image: %s", strerror(errno));
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002019 }
2020 flash_buf(partition, &buf);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002021 return;
2022
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002023failed:
2024 if (skip_if_not_supported) {
2025 fprintf(stderr, "Erase successful, but not automatically formatting.\n");
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002026 if (errMsg) fprintf(stderr, "%s", errMsg);
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002027 }
Tom Cherry9027af02018-09-24 15:48:09 -07002028 fprintf(stderr, "FAILED (%s)\n", fb->Error().c_str());
Mark Salyzyna30b6962018-11-20 11:04:15 -08002029 if (!skip_if_not_supported) {
2030 die("Command failed");
2031 }
Dmitry Grinberge6f3e9b2014-03-11 18:28:15 -07002032}
2033
Daniel Zheng0d307182023-01-31 21:07:53 +00002034bool should_flash_in_userspace(const std::string& partition_name) {
David Andersone0e693c2018-11-27 20:19:26 -08002035 if (!get_android_product_out()) {
2036 return false;
2037 }
David Anderson89569642018-11-16 15:53:35 -08002038 auto path = find_item_given_name("super_empty.img");
David Anderson00475802018-12-04 17:05:47 -08002039 if (path.empty() || access(path.c_str(), R_OK)) {
David Anderson89569642018-11-16 15:53:35 -08002040 return false;
2041 }
2042 auto metadata = android::fs_mgr::ReadFromImageFile(path);
2043 if (!metadata) {
2044 return false;
2045 }
David Andersonaa87dc52023-01-27 20:39:06 -08002046 return should_flash_in_userspace(*metadata.get(), partition_name);
David Anderson89569642018-11-16 15:53:35 -08002047}
2048
David Anderson7c84b9f2019-06-27 22:15:29 -07002049static bool wipe_super(const android::fs_mgr::LpMetadata& metadata, const std::string& slot,
2050 std::string* message) {
2051 auto super_device = GetMetadataSuperBlockDevice(metadata);
2052 auto block_size = metadata.geometry.logical_block_size;
2053 auto super_bdev_name = android::fs_mgr::GetBlockDevicePartitionName(*super_device);
2054
2055 if (super_bdev_name != "super") {
2056 // retrofit devices do not allow flashing to the retrofit partitions,
2057 // so enable it if we can.
2058 fb->RawCommand("oem allow-flash-super");
2059 }
2060
2061 // Note: do not use die() in here, since we want TemporaryDir's destructor
2062 // to be called.
2063 TemporaryDir temp_dir;
2064
2065 bool ok;
2066 if (metadata.block_devices.size() > 1) {
2067 ok = WriteSplitImageFiles(temp_dir.path, metadata, block_size, {}, true);
2068 } else {
2069 auto image_path = temp_dir.path + "/"s + super_bdev_name + ".img";
2070 ok = WriteToImageFile(image_path, metadata, block_size, {}, true);
2071 }
2072 if (!ok) {
2073 *message = "Could not generate a flashable super image file";
2074 return false;
2075 }
2076
2077 for (const auto& block_device : metadata.block_devices) {
2078 auto partition = android::fs_mgr::GetBlockDevicePartitionName(block_device);
2079 bool force_slot = !!(block_device.flags & LP_BLOCK_DEVICE_SLOT_SUFFIXED);
2080
2081 std::string image_name;
2082 if (metadata.block_devices.size() > 1) {
2083 image_name = "super_" + partition + ".img";
2084 } else {
2085 image_name = partition + ".img";
2086 }
2087
2088 auto image_path = temp_dir.path + "/"s + image_name;
2089 auto flash = [&](const std::string& partition_name) {
2090 do_flash(partition_name.c_str(), image_path.c_str());
2091 };
2092 do_for_partitions(partition, slot, flash, force_slot);
2093
2094 unlink(image_path.c_str());
2095 }
2096 return true;
2097}
2098
2099static void do_wipe_super(const std::string& image, const std::string& slot_override) {
2100 if (access(image.c_str(), R_OK) != 0) {
2101 die("Could not read image: %s", image.c_str());
2102 }
2103 auto metadata = android::fs_mgr::ReadFromImageFile(image);
2104 if (!metadata) {
2105 die("Could not parse image: %s", image.c_str());
2106 }
2107
2108 auto slot = slot_override;
2109 if (slot.empty()) {
2110 slot = get_current_slot();
2111 }
2112
2113 std::string message;
2114 if (!wipe_super(*metadata.get(), slot, &message)) {
2115 die(message);
2116 }
2117}
2118
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002119static void FastbootLogger(android::base::LogId /* id */, android::base::LogSeverity severity,
David Andersona67fc322023-01-27 16:15:52 -08002120 const char* /* tag */, const char* /* file */, unsigned int /* line */,
2121 const char* message) {
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002122 switch (severity) {
2123 case android::base::INFO:
2124 fprintf(stdout, "%s\n", message);
2125 break;
2126 case android::base::ERROR:
2127 fprintf(stderr, "%s\n", message);
2128 break;
2129 default:
2130 verbose("%s\n", message);
2131 }
David Andersona67fc322023-01-27 16:15:52 -08002132}
2133
2134static void FastbootAborter(const char* message) {
2135 die("%s", message);
2136}
2137
Aaron Wisnerdb511202018-06-26 15:38:35 -05002138int FastBootTool::Main(int argc, char* argv[]) {
David Andersona67fc322023-01-27 16:15:52 -08002139 android::base::InitLogging(argv, FastbootLogger, FastbootAborter);
2140
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002141 bool wants_wipe = false;
2142 bool wants_reboot = false;
2143 bool wants_reboot_bootloader = false;
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002144 bool wants_reboot_recovery = false;
2145 bool wants_reboot_fastboot = false;
Mitchell Wills31dce302016-09-26 10:26:21 -07002146 bool skip_reboot = false;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002147 bool wants_set_active = false;
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002148 bool skip_secondary = false;
David Anderson89569642018-11-16 15:53:35 -08002149 bool force_flash = false;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002150 unsigned fs_options = 0;
Florian BƤuerle27ded482014-11-24 11:29:34 +01002151 int longindex;
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002152 std::string slot_override;
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002153 std::string next_active;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002154
Elliott Hughes577e8b42018-04-05 16:12:47 -07002155 g_boot_img_hdr.kernel_addr = 0x00008000;
2156 g_boot_img_hdr.ramdisk_addr = 0x01000000;
2157 g_boot_img_hdr.second_addr = 0x00f00000;
2158 g_boot_img_hdr.tags_addr = 0x00000100;
2159 g_boot_img_hdr.page_size = 2048;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002160 g_boot_img_hdr.dtb_addr = 0x01100000;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002161
Daniel Zheng65452d02022-11-30 02:25:31 +00002162 const struct option longopts[] = {{"base", required_argument, 0, 0},
2163 {"cmdline", required_argument, 0, 0},
2164 {"disable-verification", no_argument, 0, 0},
2165 {"disable-verity", no_argument, 0, 0},
2166 {"force", no_argument, 0, 0},
2167 {"fs-options", required_argument, 0, 0},
2168 {"header-version", required_argument, 0, 0},
2169 {"help", no_argument, 0, 'h'},
2170 {"kernel-offset", required_argument, 0, 0},
2171 {"os-patch-level", required_argument, 0, 0},
2172 {"os-version", required_argument, 0, 0},
2173 {"page-size", required_argument, 0, 0},
2174 {"ramdisk-offset", required_argument, 0, 0},
2175 {"set-active", optional_argument, 0, 'a'},
2176 {"skip-reboot", no_argument, 0, 0},
2177 {"skip-secondary", no_argument, 0, 0},
2178 {"slot", required_argument, 0, 0},
2179 {"tags-offset", required_argument, 0, 0},
2180 {"dtb", required_argument, 0, 0},
2181 {"dtb-offset", required_argument, 0, 0},
2182 {"unbuffered", no_argument, 0, 0},
2183 {"verbose", no_argument, 0, 'v'},
2184 {"version", no_argument, 0, 0},
2185 {0, 0, 0, 0}};
Colin Cross8879f982012-05-22 17:53:34 -07002186
2187 serial = getenv("ANDROID_SERIAL");
2188
Elliott Hughes577e8b42018-04-05 16:12:47 -07002189 int c;
Elliott Hughesf3192bd2018-04-10 15:38:08 -07002190 while ((c = getopt_long(argc, argv, "a::hls:S:vw", longopts, &longindex)) != -1) {
Elliott Hughes577e8b42018-04-05 16:12:47 -07002191 if (c == 0) {
2192 std::string name{longopts[longindex].name};
2193 if (name == "base") {
2194 g_base_addr = strtoul(optarg, 0, 16);
2195 } else if (name == "cmdline") {
2196 g_cmdline = optarg;
2197 } else if (name == "disable-verification") {
2198 g_disable_verification = true;
2199 } else if (name == "disable-verity") {
2200 g_disable_verity = true;
David Anderson89569642018-11-16 15:53:35 -08002201 } else if (name == "force") {
2202 force_flash = true;
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002203 } else if (name == "fs-options") {
2204 fs_options = ParseFsOption(optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002205 } else if (name == "header-version") {
2206 g_boot_img_hdr.header_version = strtoul(optarg, nullptr, 0);
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002207 } else if (name == "dtb") {
2208 g_dtb_path = optarg;
Elliott Hughes577e8b42018-04-05 16:12:47 -07002209 } else if (name == "kernel-offset") {
2210 g_boot_img_hdr.kernel_addr = strtoul(optarg, 0, 16);
2211 } else if (name == "os-patch-level") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002212 ParseOsPatchLevel(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002213 } else if (name == "os-version") {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002214 ParseOsVersion(&g_boot_img_hdr, optarg);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002215 } else if (name == "page-size") {
2216 g_boot_img_hdr.page_size = strtoul(optarg, nullptr, 0);
2217 if (g_boot_img_hdr.page_size == 0) die("invalid page size");
2218 } else if (name == "ramdisk-offset") {
2219 g_boot_img_hdr.ramdisk_addr = strtoul(optarg, 0, 16);
2220 } else if (name == "skip-reboot") {
2221 skip_reboot = true;
2222 } else if (name == "skip-secondary") {
2223 skip_secondary = true;
2224 } else if (name == "slot") {
2225 slot_override = optarg;
Hridya Valsaraju6c8fca62019-01-24 12:47:08 -08002226 } else if (name == "dtb-offset") {
2227 g_boot_img_hdr.dtb_addr = strtoul(optarg, 0, 16);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002228 } else if (name == "tags-offset") {
2229 g_boot_img_hdr.tags_addr = strtoul(optarg, 0, 16);
2230 } else if (name == "unbuffered") {
Elliott Hughesfc797672015-04-07 20:12:50 -07002231 setvbuf(stdout, nullptr, _IONBF, 0);
2232 setvbuf(stderr, nullptr, _IONBF, 0);
Elliott Hughes577e8b42018-04-05 16:12:47 -07002233 } else if (name == "version") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002234 fprintf(stdout, "fastboot version %s-%s\n", PLATFORM_TOOLS_VERSION,
2235 android::build::GetBuildNumber().c_str());
Elliott Hughes1fd46df2017-03-30 15:08:28 -07002236 fprintf(stdout, "Installed as %s\n", android::base::GetExecutablePath().c_str());
Elliott Hughes379646b2015-06-02 13:50:00 -07002237 return 0;
Paul Crowley8f7f56e2015-11-27 09:29:37 +00002238 } else {
Elliott Hughes855cdf82018-04-02 14:24:03 -07002239 die("unknown option %s", longopts[longindex].name);
Florian BƤuerle27ded482014-11-24 11:29:34 +01002240 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002241 } else {
2242 switch (c) {
2243 case 'a':
2244 wants_set_active = true;
2245 if (optarg) next_active = optarg;
2246 break;
2247 case 'h':
2248 return show_help();
Elliott Hughes577e8b42018-04-05 16:12:47 -07002249 case 'l':
2250 g_long_listing = true;
2251 break;
2252 case 's':
2253 serial = optarg;
2254 break;
2255 case 'S':
Elliott Hughes542370d2018-04-19 19:49:44 -07002256 if (!android::base::ParseByteCount(optarg, &sparse_limit)) {
2257 die("invalid sparse limit %s", optarg);
2258 }
Elliott Hughes577e8b42018-04-05 16:12:47 -07002259 break;
2260 case 'v':
2261 set_verbose();
2262 break;
2263 case 'w':
2264 wants_wipe = true;
2265 break;
2266 case '?':
2267 return 1;
2268 default:
2269 abort();
2270 }
Colin Cross8879f982012-05-22 17:53:34 -07002271 }
2272 }
2273
2274 argc -= optind;
2275 argv += optind;
2276
Elliott Hughesd6365a72017-05-08 18:04:49 -07002277 if (argc == 0 && !wants_wipe && !wants_set_active) syntax_error("no command");
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002278
Colin Cross8fb6e062012-07-24 16:36:41 -07002279 if (argc > 0 && !strcmp(*argv, "devices")) {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002280 list_devices();
Tsu Chiang Chuangee520552011-02-25 18:38:53 -08002281 return 0;
2282 }
2283
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +00002284 if (argc > 0 && !strcmp(*argv, "connect")) {
2285 argc -= optind;
2286 argv += optind;
2287 return Connect(argc, argv);
2288 }
2289
2290 if (argc > 0 && !strcmp(*argv, "disconnect")) {
2291 argc -= optind;
2292 argv += optind;
2293 return Disconnect(argc, argv);
2294 }
2295
Colin Crossc7b75dc2012-08-29 18:17:06 -07002296 if (argc > 0 && !strcmp(*argv, "help")) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002297 return show_help();
Colin Crossc7b75dc2012-08-29 18:17:06 -07002298 }
2299
David Pursell0b156632015-10-30 11:22:01 -07002300 Transport* transport = open_device();
David Pursell2ec418a2016-01-20 08:32:08 -08002301 if (transport == nullptr) {
2302 return 1;
2303 }
Tom Cherry9027af02018-09-24 15:48:09 -07002304 fastboot::DriverCallbacks driver_callbacks = {
Daniel Zheng65452d02022-11-30 02:25:31 +00002305 .prolog = Status,
2306 .epilog = Epilog,
2307 .info = InfoMessage,
Tom Cherry9027af02018-09-24 15:48:09 -07002308 };
2309 fastboot::FastBootDriver fastboot_driver(transport, driver_callbacks, false);
2310 fb = &fastboot_driver;
David Pursell2ec418a2016-01-20 08:32:08 -08002311
Elliott Hughes5620d222018-03-28 08:20:00 -07002312 const double start = now();
2313
Aaron Wisnerdb511202018-06-26 15:38:35 -05002314 if (slot_override != "") slot_override = verify_slot(slot_override);
2315 if (next_active != "") next_active = verify_slot(next_active, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002316
2317 if (wants_set_active) {
2318 if (next_active == "") {
2319 if (slot_override == "") {
Daniel Rosenberg13454092016-06-27 19:43:11 -07002320 std::string current_slot;
Tom Cherry9027af02018-09-24 15:48:09 -07002321 if (fb->GetVar("current-slot", &current_slot) == fastboot::SUCCESS) {
LuK1337dae48ef2020-04-06 14:38:58 +02002322 if (current_slot[0] == '_') current_slot.erase(0, 1);
Aaron Wisnerdb511202018-06-26 15:38:35 -05002323 next_active = verify_slot(current_slot, false);
Daniel Rosenberg13454092016-06-27 19:43:11 -07002324 } else {
2325 wants_set_active = false;
2326 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002327 } else {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002328 next_active = verify_slot(slot_override, false);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002329 }
2330 }
2331 }
Elliott Hughes31dbed72009-10-07 15:38:53 -07002332
Elliott Hughesd6365a72017-05-08 18:04:49 -07002333 std::vector<std::string> args(argv, argv + argc);
2334 while (!args.empty()) {
2335 std::string command = next_arg(&args);
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002336
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002337 if (command == FB_CMD_GETVAR) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002338 std::string variable = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002339 DisplayVarOrError(variable, variable);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002340 } else if (command == FB_CMD_ERASE) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002341 std::string partition = next_arg(&args);
2342 auto erase = [&](const std::string& partition) {
David Pursell0b156632015-10-30 11:22:01 -07002343 std::string partition_type;
Daniel Zheng65452d02022-11-30 02:25:31 +00002344 if (fb->GetVar("partition-type:" + partition, &partition_type) ==
2345 fastboot::SUCCESS &&
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002346 fs_get_generator(partition_type) != nullptr) {
2347 fprintf(stderr, "******** Did you mean to fastboot format this %s partition?\n",
2348 partition_type.c_str());
2349 }
Ken Sumrall5ee5d382012-09-29 14:46:25 -07002350
Tom Cherry9027af02018-09-24 15:48:09 -07002351 fb->Erase(partition);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002352 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002353 do_for_partitions(partition, slot_override, erase, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002354 } else if (android::base::StartsWith(command, "format")) {
2355 // Parsing for: "format[:[type][:[size]]]"
2356 // Some valid things:
2357 // - select only the size, and leave default fs type:
2358 // format::0x4000000 userdata
2359 // - default fs type and size:
2360 // format userdata
2361 // format:: userdata
2362 std::vector<std::string> pieces = android::base::Split(command, ":");
2363 std::string type_override;
2364 if (pieces.size() > 1) type_override = pieces[1].c_str();
2365 std::string size_override;
2366 if (pieces.size() > 2) size_override = pieces[2].c_str();
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002367
Elliott Hughesd6365a72017-05-08 18:04:49 -07002368 std::string partition = next_arg(&args);
2369
2370 auto format = [&](const std::string& partition) {
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002371 fb_perform_format(partition, 0, type_override, size_override, fs_options);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002372 };
Greg Kaiserb49d9e12019-03-26 12:04:05 -07002373 do_for_partitions(partition, slot_override, format, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002374 } else if (command == "signature") {
2375 std::string filename = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002376 std::vector<char> data;
2377 if (!ReadFileToVector(filename, &data)) {
2378 die("could not load '%s': %s", filename.c_str(), strerror(errno));
2379 }
2380 if (data.size() != 256) die("signature must be 256 bytes (got %zu)", data.size());
Tom Cherry9027af02018-09-24 15:48:09 -07002381 fb->Download("signature", data);
2382 fb->RawCommand("signature", "installing signature");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002383 } else if (command == FB_CMD_REBOOT) {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002384 wants_reboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002385
2386 if (args.size() == 1) {
2387 std::string what = next_arg(&args);
2388 if (what == "bootloader") {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002389 wants_reboot = false;
2390 wants_reboot_bootloader = true;
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002391 } else if (what == "recovery") {
2392 wants_reboot = false;
2393 wants_reboot_recovery = true;
2394 } else if (what == "fastboot") {
2395 wants_reboot = false;
2396 wants_reboot_fastboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002397 } else {
2398 syntax_error("unknown reboot target %s", what.c_str());
Alexey Polyudove0bfb752017-01-03 19:39:13 -08002399 }
Elliott Hughesca85df02015-02-25 10:02:00 -08002400 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002401 if (!args.empty()) syntax_error("junk after reboot command");
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002402 } else if (command == FB_CMD_REBOOT_BOOTLOADER) {
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002403 wants_reboot_bootloader = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002404 } else if (command == FB_CMD_REBOOT_RECOVERY) {
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002405 wants_reboot_recovery = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002406 } else if (command == FB_CMD_REBOOT_FASTBOOT) {
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002407 wants_reboot_fastboot = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002408 } else if (command == FB_CMD_CONTINUE) {
Tom Cherry9027af02018-09-24 15:48:09 -07002409 fb->Continue();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002410 } else if (command == FB_CMD_BOOT) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002411 std::string kernel = next_arg(&args);
2412 std::string ramdisk;
2413 if (!args.empty()) ramdisk = next_arg(&args);
2414 std::string second_stage;
2415 if (!args.empty()) second_stage = next_arg(&args);
Tom Cherrydfd85df2018-09-20 14:45:05 -07002416 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
Tom Cherry9027af02018-09-24 15:48:09 -07002417 fb->Download("boot.img", data);
2418 fb->Boot();
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002419 } else if (command == FB_CMD_FLASH) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002420 std::string pname = next_arg(&args);
Elliott Hughes2810d002016-04-25 14:31:18 -07002421 std::string fname;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002422 if (!args.empty()) {
2423 fname = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002424 } else {
Elliott Hughes45964a82017-05-03 22:43:23 -07002425 fname = find_item(pname);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002426 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002427 if (fname.empty()) die("cannot determine image filename for '%s'", pname.c_str());
Daniel Zheng0d307182023-01-31 21:07:53 +00002428 FlashTask task(slot_override, force_flash, pname, fname);
2429 task.Run();
Elliott Hughesd6365a72017-05-08 18:04:49 -07002430 } else if (command == "flash:raw") {
2431 std::string partition = next_arg(&args);
2432 std::string kernel = next_arg(&args);
2433 std::string ramdisk;
2434 if (!args.empty()) ramdisk = next_arg(&args);
2435 std::string second_stage;
2436 if (!args.empty()) second_stage = next_arg(&args);
2437
Tom Cherrydfd85df2018-09-20 14:45:05 -07002438 auto data = LoadBootableImage(kernel, ramdisk, second_stage);
2439 auto flashraw = [&data](const std::string& partition) {
Tom Cherry9027af02018-09-24 15:48:09 -07002440 fb->FlashPartition(partition, data);
Daniel Rosenbergb7bd4ae2015-09-14 21:05:41 -07002441 };
Aaron Wisnerdb511202018-06-26 15:38:35 -05002442 do_for_partitions(partition, slot_override, flashraw, true);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002443 } else if (command == "flashall") {
Alex Lightbb9b8a52016-06-29 09:26:44 -07002444 if (slot_override == "all") {
Daniel Zheng65452d02022-11-30 02:25:31 +00002445 fprintf(stderr,
2446 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Andrew Chantd64b9882021-04-06 12:48:27 -07002447 do_flashall(slot_override, true, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002448 } else {
Andrew Chantd64b9882021-04-06 12:48:27 -07002449 do_flashall(slot_override, skip_secondary, wants_wipe, force_flash);
Alex Lightbb9b8a52016-06-29 09:26:44 -07002450 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002451 wants_reboot = true;
Elliott Hughesd6365a72017-05-08 18:04:49 -07002452 } else if (command == "update") {
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002453 bool slot_all = (slot_override == "all");
2454 if (slot_all) {
Daniel Zheng65452d02022-11-30 02:25:31 +00002455 fprintf(stderr,
2456 "Warning: slot set to 'all'. Secondary slots will not be flashed.\n");
Daniel Rosenberg92b44762016-07-13 20:03:25 -07002457 }
Elliott Hughesd6365a72017-05-08 18:04:49 -07002458 std::string filename = "update.zip";
2459 if (!args.empty()) {
2460 filename = next_arg(&args);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002461 }
Andrew Chantd64b9882021-04-06 12:48:27 -07002462 do_update(filename.c_str(), slot_override, skip_secondary || slot_all, force_flash);
Mitchell Wills31dce302016-09-26 10:26:21 -07002463 wants_reboot = true;
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002464 } else if (command == FB_CMD_SET_ACTIVE) {
Aaron Wisnerdb511202018-06-26 15:38:35 -05002465 std::string slot = verify_slot(next_arg(&args), false);
Tom Cherry9027af02018-09-24 15:48:09 -07002466 fb->SetActive(slot);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002467 } else if (command == "stage") {
2468 std::string filename = next_arg(&args);
2469
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002470 struct fastboot_buffer buf;
Aaron Wisnerdb511202018-06-26 15:38:35 -05002471 if (!load_buf(filename.c_str(), &buf) || buf.type != FB_BUFFER_FD) {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002472 die("cannot load '%s'", filename.c_str());
Jocelyn Bohr98cc2832017-01-26 19:20:53 -08002473 }
Yifan Hong58532df2021-03-22 16:39:13 -07002474 fb->Download(filename, buf.fd.get(), buf.sz);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002475 } else if (command == "get_staged") {
2476 std::string filename = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002477 fb->Upload(filename);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002478 } else if (command == FB_CMD_OEM) {
2479 do_oem_command(FB_CMD_OEM, &args);
Elliott Hughesd6365a72017-05-08 18:04:49 -07002480 } else if (command == "flashing") {
2481 if (args.empty()) {
2482 syntax_error("missing 'flashing' command");
Daniel Zheng65452d02022-11-30 02:25:31 +00002483 } else if (args.size() == 1 &&
2484 (args[0] == "unlock" || args[0] == "lock" || args[0] == "unlock_critical" ||
2485 args[0] == "lock_critical" || args[0] == "get_unlock_ability")) {
Elliott Hughes1eec97a2017-05-15 16:53:53 -07002486 do_oem_command("flashing", &args);
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002487 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002488 syntax_error("unknown 'flashing' command %s", args[0].c_str());
Badhri Jagan Sridharanbf110952015-05-15 16:43:47 -07002489 }
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002490 } else if (command == FB_CMD_CREATE_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->CreatePartition(partition, size);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002494 } else if (command == FB_CMD_DELETE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002495 std::string partition = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002496 fb->DeletePartition(partition);
Mark Salyzyn8e7e9cb2018-08-29 10:44:33 -07002497 } else if (command == FB_CMD_RESIZE_PARTITION) {
David Anderson0d4277d2018-07-31 13:27:37 -07002498 std::string partition = next_arg(&args);
2499 std::string size = next_arg(&args);
Tom Cherry9027af02018-09-24 15:48:09 -07002500 fb->ResizePartition(partition, size);
David Anderson1d504e32019-01-15 14:38:20 -08002501 } else if (command == "gsi") {
David Anderson3d782d52019-01-29 13:09:49 -08002502 std::string arg = next_arg(&args);
2503 if (arg == "wipe") {
David Anderson1d504e32019-01-15 14:38:20 -08002504 fb->RawCommand("gsi:wipe", "wiping GSI");
David Anderson3d782d52019-01-29 13:09:49 -08002505 } else if (arg == "disable") {
David Anderson1d504e32019-01-15 14:38:20 -08002506 fb->RawCommand("gsi:disable", "disabling GSI");
2507 } else {
2508 syntax_error("expected 'wipe' or 'disable'");
2509 }
David Anderson7c84b9f2019-06-27 22:15:29 -07002510 } else if (command == "wipe-super") {
2511 std::string image;
2512 if (args.empty()) {
2513 image = find_item_given_name("super_empty.img");
2514 } else {
2515 image = next_arg(&args);
2516 }
2517 do_wipe_super(image, slot_override);
David Andersonab8f4662019-10-21 16:45:59 -07002518 } else if (command == "snapshot-update") {
2519 std::string arg;
2520 if (!args.empty()) {
2521 arg = next_arg(&args);
2522 }
David Anderson220ddb12019-10-31 18:02:41 -07002523 if (!arg.empty() && (arg != "cancel" && arg != "merge")) {
2524 syntax_error("expected: snapshot-update [cancel|merge]");
David Andersonab8f4662019-10-21 16:45:59 -07002525 }
2526 fb->SnapshotUpdateCommand(arg);
Yifan Hongbcd27702021-02-16 19:37:32 -08002527 } else if (command == FB_CMD_FETCH) {
2528 std::string partition = next_arg(&args);
2529 std::string outfile = next_arg(&args);
2530 do_fetch(partition, slot_override, outfile);
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002531 } else {
Elliott Hughesd6365a72017-05-08 18:04:49 -07002532 syntax_error("unknown command %s", command.c_str());
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002533 }
2534 }
2535
2536 if (wants_wipe) {
David Andersonab8f4662019-10-21 16:45:59 -07002537 if (force_flash) {
2538 CancelSnapshotIfNeeded();
2539 }
Daniel Zheng65452d02022-11-30 02:25:31 +00002540 std::vector<std::string> partitions = {"userdata", "cache", "metadata"};
Paul Crowley4d170062018-04-24 17:06:30 -07002541 for (const auto& partition : partitions) {
2542 std::string partition_type;
Tom Cherry9027af02018-09-24 15:48:09 -07002543 if (fb->GetVar("partition-type:" + partition, &partition_type) != fastboot::SUCCESS) {
2544 continue;
2545 }
Paul Crowley4d170062018-04-24 17:06:30 -07002546 if (partition_type.empty()) continue;
Tom Cherry9027af02018-09-24 15:48:09 -07002547 fb->Erase(partition);
ThiƩbaud Weksteen5d72d6c2022-07-21 14:43:20 +10002548 fb_perform_format(partition, 1, partition_type, "", fs_options);
Elliott Hughes2fd45a92015-10-30 11:49:47 -07002549 }
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002550 }
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002551 if (wants_set_active) {
Tom Cherry9027af02018-09-24 15:48:09 -07002552 fb->SetActive(next_active);
Daniel Rosenberg0d088562015-11-11 16:15:30 -08002553 }
Mitchell Wills31dce302016-09-26 10:26:21 -07002554 if (wants_reboot && !skip_reboot) {
Tom Cherry9027af02018-09-24 15:48:09 -07002555 fb->Reboot();
2556 fb->WaitForDisconnect();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002557 } else if (wants_reboot_bootloader) {
Tom Cherry9027af02018-09-24 15:48:09 -07002558 fb->RebootTo("bootloader");
2559 fb->WaitForDisconnect();
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002560 } else if (wants_reboot_recovery) {
Tom Cherry9027af02018-09-24 15:48:09 -07002561 fb->RebootTo("recovery");
2562 fb->WaitForDisconnect();
Hridya Valsarajudea91b42018-07-17 11:14:01 -07002563 } else if (wants_reboot_fastboot) {
David Anderson11d6d272018-12-07 16:39:07 -08002564 reboot_to_userspace_fastboot();
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002565 }
2566
Elliott Hughes5620d222018-03-28 08:20:00 -07002567 fprintf(stderr, "Finished. Total time: %.3fs\n", (now() - start));
David Anderson03de6452018-09-04 14:32:54 -07002568
Tom Cherry9027af02018-09-24 15:48:09 -07002569 auto* old_transport = fb->set_transport(nullptr);
2570 delete old_transport;
2571
Tom Cherry11f12092018-08-29 21:36:28 -07002572 return 0;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08002573}
Elliott Hughes6ebec932018-04-10 14:22:13 -07002574
Aaron Wisnerdb511202018-06-26 15:38:35 -05002575void FastBootTool::ParseOsPatchLevel(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002576 unsigned year, month, day;
2577 if (sscanf(arg, "%u-%u-%u", &year, &month, &day) != 3) {
2578 syntax_error("OS patch level should be YYYY-MM-DD: %s", arg);
2579 }
2580 if (year < 2000 || year >= 2128) syntax_error("year out of range: %d", year);
2581 if (month < 1 || month > 12) syntax_error("month out of range: %d", month);
2582 hdr->SetOsPatchLevel(year, month);
2583}
2584
Aaron Wisnerdb511202018-06-26 15:38:35 -05002585void FastBootTool::ParseOsVersion(boot_img_hdr_v1* hdr, const char* arg) {
Elliott Hughes6ebec932018-04-10 14:22:13 -07002586 unsigned major = 0, minor = 0, patch = 0;
2587 std::vector<std::string> versions = android::base::Split(arg, ".");
2588 if (versions.size() < 1 || versions.size() > 3 ||
2589 (versions.size() >= 1 && !android::base::ParseUint(versions[0], &major)) ||
2590 (versions.size() >= 2 && !android::base::ParseUint(versions[1], &minor)) ||
2591 (versions.size() == 3 && !android::base::ParseUint(versions[2], &patch)) ||
2592 (major > 0x7f || minor > 0x7f || patch > 0x7f)) {
2593 syntax_error("bad OS version: %s", arg);
2594 }
2595 hdr->SetOsVersion(major, minor, patch);
2596}
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002597
2598unsigned FastBootTool::ParseFsOption(const char* arg) {
2599 unsigned fsOptions = 0;
2600
2601 std::vector<std::string> options = android::base::Split(arg, ",");
Daniel Zheng65452d02022-11-30 02:25:31 +00002602 if (options.size() < 1) syntax_error("bad options: %s", arg);
Jaegeuk Kim638d05e2020-11-09 08:54:13 -08002603
2604 for (size_t i = 0; i < options.size(); ++i) {
2605 if (options[i] == "casefold")
2606 fsOptions |= (1 << FS_OPT_CASEFOLD);
2607 else if (options[i] == "projid")
2608 fsOptions |= (1 << FS_OPT_PROJID);
2609 else if (options[i] == "compress")
2610 fsOptions |= (1 << FS_OPT_COMPRESS);
2611 else
2612 syntax_error("unsupported options: %s", options[i].c_str());
2613 }
2614 return fsOptions;
2615}