blob: a417d18e56051f5a300348d5b4fcf87b8dba1f5f [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
xunchang24788852019-03-22 16:08:52 -070017#include "install/install.h"
Tao Bao20c581e2016-12-28 20:55:51 -080018
Doug Zongkerb2ee9202009-06-04 10:24:53 -070019#include <ctype.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080020#include <errno.h>
21#include <fcntl.h>
Alex Deymo4e29ce02016-08-12 13:43:04 -070022#include <inttypes.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080023#include <limits.h>
Elliott Hughes26dbad22015-01-28 12:09:05 -080024#include <string.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080025#include <sys/stat.h>
Doug Zongkerb2ee9202009-06-04 10:24:53 -070026#include <sys/wait.h>
27#include <unistd.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080028
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070029#include <algorithm>
Tianjie Xu37957102017-06-07 17:59:55 -070030#include <atomic>
Elliott Hughes8febafa2016-04-13 16:39:56 -070031#include <chrono>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070032#include <condition_variable>
Tao Bao5e535012017-03-16 17:37:38 -070033#include <functional>
Alex Deymo4344d632016-08-03 21:03:53 -070034#include <limits>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070035#include <mutex>
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070036#include <thread>
Tao Bao71e3e092016-02-02 14:02:27 -080037#include <vector>
38
Tianjie Xue16e7992016-09-09 10:55:44 -070039#include <android-base/file.h>
40#include <android-base/logging.h>
Tao Bao20c581e2016-12-28 20:55:51 -080041#include <android-base/parsedouble.h>
Tianjie Xub0ddae52016-06-08 14:30:04 -070042#include <android-base/parseint.h>
Tao Baoefc35592017-01-08 22:45:47 -080043#include <android-base/properties.h>
Tianjie Xu16255832016-04-30 11:49:59 -070044#include <android-base/stringprintf.h>
45#include <android-base/strings.h>
Tao Baocf60a442018-06-18 14:56:20 -070046#include <android-base/unique_fd.h>
Tao Bao919d2c92017-04-10 16:55:57 -070047#include <vintf/VintfObjectRecovery.h>
Tianjie Xu16255832016-04-30 11:49:59 -070048
xunchang24788852019-03-22 16:08:52 -070049#include "install/package.h"
50#include "install/verifier.h"
xunchang388d2532019-04-12 16:22:15 -070051#include "install/wipe_data.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070052#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070053#include "otautil/paths.h"
xunchang24788852019-03-22 16:08:52 -070054#include "otautil/roots.h"
Tao Bao17054c02018-05-03 22:41:23 -070055#include "otautil/sysutil.h"
56#include "otautil/thermalutil.h"
xunchang24788852019-03-22 16:08:52 -070057#include "private/setup_commands.h"
Tianjie Xu8f397302018-08-20 13:40:47 -070058#include "recovery_ui/ui.h"
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080059
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070060using namespace std::chrono_literals;
61
xunchang24788852019-03-22 16:08:52 -070062static constexpr int kRecoveryApiVersion = 3;
63// Assert the version defined in code and in Android.mk are consistent.
64static_assert(kRecoveryApiVersion == RECOVERY_API_VERSION, "Mismatching recovery API versions.");
65
Doug Zongker74406302011-10-28 15:13:10 -070066// Default allocation of progress bar segments to operations
Tao Bao20c581e2016-12-28 20:55:51 -080067static constexpr int VERIFICATION_PROGRESS_TIME = 60;
68static constexpr float VERIFICATION_PROGRESS_FRACTION = 0.25;
Doug Zongker74406302011-10-28 15:13:10 -070069
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -070070static std::condition_variable finish_log_temperature;
71
Tianjie Xu93b5bf22018-10-25 10:39:01 -070072bool ReadMetadataFromPackage(ZipArchiveHandle zip, std::map<std::string, std::string>* metadata) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070073 CHECK(metadata != nullptr);
Tianjie Xub0ddae52016-06-08 14:30:04 -070074
Tao Bao8a7afcc2017-04-18 22:05:50 -070075 static constexpr const char* METADATA_PATH = "META-INF/com/android/metadata";
76 ZipString path(METADATA_PATH);
77 ZipEntry entry;
78 if (FindEntry(zip, path, &entry) != 0) {
Tao Bao8a7afcc2017-04-18 22:05:50 -070079 return false;
80 }
81
82 uint32_t length = entry.uncompressed_length;
Tianjie Xu93b5bf22018-10-25 10:39:01 -070083 std::string metadata_string(length, '\0');
84 int32_t err =
85 ExtractToMemory(zip, &entry, reinterpret_cast<uint8_t*>(&metadata_string[0]), length);
Tao Bao8a7afcc2017-04-18 22:05:50 -070086 if (err != 0) {
87 LOG(ERROR) << "Failed to extract " << METADATA_PATH << ": " << ErrorCodeString(err);
88 return false;
89 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -070090
91 for (const std::string& line : android::base::Split(metadata_string, "\n")) {
92 size_t eq = line.find('=');
93 if (eq != std::string::npos) {
94 metadata->emplace(android::base::Trim(line.substr(0, eq)),
95 android::base::Trim(line.substr(eq + 1)));
96 }
97 }
98
Tao Bao8a7afcc2017-04-18 22:05:50 -070099 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700100}
101
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700102// Gets the value for the given key in |metadata|. Returns an emtpy string if the key isn't
103// present.
104static std::string get_value(const std::map<std::string, std::string>& metadata,
105 const std::string& key) {
106 const auto& it = metadata.find(key);
107 return (it == metadata.end()) ? "" : it->second;
108}
109
110static std::string OtaTypeToString(OtaType type) {
111 switch (type) {
112 case OtaType::AB:
113 return "AB";
114 case OtaType::BLOCK:
115 return "BLOCK";
116 case OtaType::BRICK:
117 return "BRICK";
Tao Bao8a7afcc2017-04-18 22:05:50 -0700118 }
Tianjie Xub0ddae52016-06-08 14:30:04 -0700119}
120
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700121// Read the build.version.incremental of src/tgt from the metadata and log it to last_install.
122static void ReadSourceTargetBuild(const std::map<std::string, std::string>& metadata,
123 std::vector<std::string>* log_buffer) {
124 // Examples of the pre-build and post-build strings in metadata:
125 // pre-build-incremental=2943039
126 // post-build-incremental=2951741
127 auto source_build = get_value(metadata, "pre-build-incremental");
128 if (!source_build.empty()) {
129 log_buffer->push_back("source_build: " + source_build);
130 }
131
132 auto target_build = get_value(metadata, "post-build-incremental");
133 if (!target_build.empty()) {
134 log_buffer->push_back("target_build: " + target_build);
135 }
136}
137
138// Checks the build version, fingerprint and timestamp in the metadata of the A/B package.
139// Downgrading is not allowed unless explicitly enabled in the package and only for
Tao Baocf60a442018-06-18 14:56:20 -0700140// incremental packages.
Alessandro Astone8b726282020-03-17 23:06:52 +0100141static int CheckAbSpecificMetadata(const std::map<std::string, std::string>& metadata,
142 bool allow_ab_downgrade) {
Tao Baoefc35592017-01-08 22:45:47 -0800143 // Incremental updates should match the current build.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700144 auto device_pre_build = android::base::GetProperty("ro.build.version.incremental", "");
145 auto pkg_pre_build = get_value(metadata, "pre-build-incremental");
146 if (!pkg_pre_build.empty() && pkg_pre_build != device_pre_build) {
147 LOG(ERROR) << "Package is for source build " << pkg_pre_build << " but expected "
148 << device_pre_build;
Tao Baoefc35592017-01-08 22:45:47 -0800149 return INSTALL_ERROR;
150 }
Alex Deymo4344d632016-08-03 21:03:53 -0700151
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700152 auto device_fingerprint = android::base::GetProperty("ro.build.fingerprint", "");
153 auto pkg_pre_build_fingerprint = get_value(metadata, "pre-build");
154 if (!pkg_pre_build_fingerprint.empty() && pkg_pre_build_fingerprint != device_fingerprint) {
Tao Baoefc35592017-01-08 22:45:47 -0800155 LOG(ERROR) << "Package is for source build " << pkg_pre_build_fingerprint << " but expected "
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700156 << device_fingerprint;
Tao Baoefc35592017-01-08 22:45:47 -0800157 return INSTALL_ERROR;
158 }
Alex Deymo4344d632016-08-03 21:03:53 -0700159
Tao Baoefc35592017-01-08 22:45:47 -0800160 // Check for downgrade version.
Alessandro Astone8b726282020-03-17 23:06:52 +0100161 if (!allow_ab_downgrade) {
162 int64_t build_timestamp =
163 android::base::GetIntProperty("ro.build.date.utc", std::numeric_limits<int64_t>::max());
164 int64_t pkg_post_timestamp = 0;
165 // We allow to full update to the same version we are running, in case there
166 // is a problem with the current copy of that version.
167 auto pkg_post_timestamp_string = get_value(metadata, "post-timestamp");
168 if (pkg_post_timestamp_string.empty() ||
169 !android::base::ParseInt(pkg_post_timestamp_string, &pkg_post_timestamp) ||
170 pkg_post_timestamp < build_timestamp) {
171 if (get_value(metadata, "ota-downgrade") != "yes") {
172 LOG(ERROR) << "Update package is older than the current build, expected a build "
173 "newer than timestamp "
174 << build_timestamp << " but package has timestamp " << pkg_post_timestamp
175 << " and downgrade not allowed.";
176 return INSTALL_DOWNGRADE;
177 }
178 if (pkg_pre_build_fingerprint.empty()) {
179 LOG(ERROR) << "Downgrade package must have a pre-build version set, not allowed.";
180 return INSTALL_DOWNGRADE;
181 }
Tao Baoefc35592017-01-08 22:45:47 -0800182 }
183 }
184
185 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700186}
187
Alessandro Astone8b726282020-03-17 23:06:52 +0100188int CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type,
189 bool allow_ab_downgrade) {
Hernán Castañón4202fec2019-02-27 12:28:49 +0100190 // We allow the package to carry multiple product names split by ",";
191 // e.g. pre-device=device1,device2,device3 ... We will fail the
192 // verification if the device's name doesn't match any of these carried names.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700193 auto device = android::base::GetProperty("ro.product.device", "");
194 auto pkg_device = get_value(metadata, "pre-device");
Hernán Castañón4202fec2019-02-27 12:28:49 +0100195 bool product_name_match = false;
196 for (const auto& name : android::base::Split(pkg_device, ",")) {
197 if (device == android::base::Trim(name)) {
198 product_name_match = true;
199 }
200 }
201 if (!product_name_match) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700202 LOG(ERROR) << "Package is for product " << pkg_device << " but expected " << device;
203 return INSTALL_ERROR;
204 }
205
206 // We allow the package to not have any serialno; and we also allow it to carry multiple serial
207 // numbers split by "|"; e.g. serialno=serialno1|serialno2|serialno3 ... We will fail the
208 // verification if the device's serialno doesn't match any of these carried numbers.
209 auto pkg_serial_no = get_value(metadata, "serialno");
210 if (!pkg_serial_no.empty()) {
211 auto device_serial_no = android::base::GetProperty("ro.serialno", "");
212 bool serial_number_match = false;
213 for (const auto& number : android::base::Split(pkg_serial_no, "|")) {
214 if (device_serial_no == android::base::Trim(number)) {
215 serial_number_match = true;
216 }
217 }
218 if (!serial_number_match) {
219 LOG(ERROR) << "Package is for serial " << pkg_serial_no;
220 return INSTALL_ERROR;
221 }
222 }
223
224 if (ota_type == OtaType::AB) {
Alessandro Astone8b726282020-03-17 23:06:52 +0100225 return CheckAbSpecificMetadata(metadata, allow_ab_downgrade);
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700226 }
227
228 return 0;
229}
230
Tao Baocf60a442018-06-18 14:56:20 -0700231int SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
Tao Bao00d57572017-05-02 15:48:54 -0700232 std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700233 CHECK(cmd != nullptr);
Alex Deymo4344d632016-08-03 21:03:53 -0700234
Tao Baobc4b1fe2017-04-17 16:46:05 -0700235 // For A/B updates we extract the payload properties to a buffer and obtain the RAW payload offset
236 // in the zip file.
237 static constexpr const char* AB_OTA_PAYLOAD_PROPERTIES = "payload_properties.txt";
238 ZipString property_name(AB_OTA_PAYLOAD_PROPERTIES);
239 ZipEntry properties_entry;
240 if (FindEntry(zip, property_name, &properties_entry) != 0) {
241 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
242 return INSTALL_CORRUPT;
243 }
244 uint32_t properties_entry_length = properties_entry.uncompressed_length;
245 std::vector<uint8_t> payload_properties(properties_entry_length);
246 int32_t err =
247 ExtractToMemory(zip, &properties_entry, payload_properties.data(), properties_entry_length);
248 if (err != 0) {
249 LOG(ERROR) << "Failed to extract " << AB_OTA_PAYLOAD_PROPERTIES << ": " << ErrorCodeString(err);
250 return INSTALL_CORRUPT;
251 }
Alex Deymo4344d632016-08-03 21:03:53 -0700252
Tao Baobc4b1fe2017-04-17 16:46:05 -0700253 static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
254 ZipString payload_name(AB_OTA_PAYLOAD);
255 ZipEntry payload_entry;
256 if (FindEntry(zip, payload_name, &payload_entry) != 0) {
257 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
258 return INSTALL_CORRUPT;
259 }
260 long payload_offset = payload_entry.offset;
261 *cmd = {
Tao Bao2cc9bbb2018-08-14 12:34:46 -0700262 "/system/bin/update_engine_sideload",
Tao Bao00d57572017-05-02 15:48:54 -0700263 "--payload=file://" + package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700264 android::base::StringPrintf("--offset=%ld", payload_offset),
265 "--headers=" + std::string(payload_properties.begin(), payload_properties.end()),
266 android::base::StringPrintf("--status_fd=%d", status_fd),
267 };
268 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700269}
270
Tao Baocf60a442018-06-18 14:56:20 -0700271int SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
272 int status_fd, std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700273 CHECK(cmd != nullptr);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700274
Tao Baocf60a442018-06-18 14:56:20 -0700275 // In non-A/B updates we extract the update binary from the package.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700276 static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
277 ZipString binary_name(UPDATE_BINARY_NAME);
278 ZipEntry binary_entry;
279 if (FindEntry(zip, binary_name, &binary_entry) != 0) {
280 LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
281 return INSTALL_CORRUPT;
282 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700283
Tao Baocf60a442018-06-18 14:56:20 -0700284 const std::string binary_path = Paths::Get().temporary_update_binary();
Tao Bao00d57572017-05-02 15:48:54 -0700285 unlink(binary_path.c_str());
Tao Baocf60a442018-06-18 14:56:20 -0700286 android::base::unique_fd fd(
287 open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
Tao Baobc4b1fe2017-04-17 16:46:05 -0700288 if (fd == -1) {
Tao Bao00d57572017-05-02 15:48:54 -0700289 PLOG(ERROR) << "Failed to create " << binary_path;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700290 return INSTALL_ERROR;
291 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700292
Tao Baobc4b1fe2017-04-17 16:46:05 -0700293 int32_t error = ExtractEntryToFile(zip, &binary_entry, fd);
Tao Baobc4b1fe2017-04-17 16:46:05 -0700294 if (error != 0) {
295 LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
296 return INSTALL_ERROR;
297 }
298
Tao Bao6fcd2082019-01-16 09:29:17 -0800299 // When executing the update binary contained in the package, the arguments passed are:
300 // - the version number for this interface
301 // - an FD to which the program can write in order to update the progress bar.
302 // - the name of the package zip file.
303 // - an optional argument "retry" if this update is a retry of a failed update attempt.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700304 *cmd = {
Tao Bao00d57572017-05-02 15:48:54 -0700305 binary_path,
Tao Baobd0ddcd2017-05-04 13:03:18 -0700306 std::to_string(kRecoveryApiVersion),
Tao Baobc4b1fe2017-04-17 16:46:05 -0700307 std::to_string(status_fd),
Tao Bao00d57572017-05-02 15:48:54 -0700308 package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700309 };
310 if (retry_count > 0) {
311 cmd->push_back("retry");
312 }
313 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700314}
Alex Deymo4344d632016-08-03 21:03:53 -0700315
Tianjie Xu37957102017-06-07 17:59:55 -0700316static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700317 CHECK(max_temperature != nullptr);
318 std::mutex mtx;
319 std::unique_lock<std::mutex> lck(mtx);
Tianjie Xu37957102017-06-07 17:59:55 -0700320 while (!logger_finished.load() &&
321 finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700322 *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
323 }
324}
325
Alex Deymo4344d632016-08-03 21:03:53 -0700326// If the package contains an update binary, extract it and run it.
Tao Bao00d57572017-05-02 15:48:54 -0700327static int try_update_binary(const std::string& package, ZipArchiveHandle zip, bool* wipe_cache,
Tao Bao29ee69b2017-05-01 12:23:17 -0700328 std::vector<std::string>* log_buffer, int retry_count,
Alessandro Astone8b726282020-03-17 23:06:52 +0100329 bool allow_ab_downgrade, int* max_temperature, RecoveryUI* ui) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700330 std::map<std::string, std::string> metadata;
Christopher N. Hessef3657eb2018-04-03 21:57:30 +0200331 bool is_ab_ota = false;
332 if (ReadMetadataFromPackage(zip, &metadata)) {
333 ReadSourceTargetBuild(metadata, log_buffer);
Alessandro Astone72832592020-03-17 13:53:23 +0100334 if (get_value(metadata, "ota-type") == OtaTypeToString(OtaType::AB)) {
335 is_ab_ota = true;
Alessandro Astone8b726282020-03-17 23:06:52 +0100336 int check_status = CheckPackageMetadata(metadata, OtaType::AB, allow_ab_downgrade);
Alessandro Astone72832592020-03-17 13:53:23 +0100337 if (check_status != 0) {
338 return check_status;
339 }
340 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700341 }
342
Tao Bao6fcd2082019-01-16 09:29:17 -0800343 // The updater in child process writes to the pipe to communicate with recovery.
344 android::base::unique_fd pipe_read, pipe_write;
Bill Peckham08ba1ad2019-03-28 18:42:13 -0700345 // Explicitly disable O_CLOEXEC using 0 as the flags (last) parameter to Pipe
346 // so that the child updater process will recieve a non-closed fd.
347 if (!android::base::Pipe(&pipe_read, &pipe_write, 0)) {
Tao Bao6fcd2082019-01-16 09:29:17 -0800348 PLOG(ERROR) << "Failed to create pipe for updater-recovery communication";
349 return INSTALL_CORRUPT;
350 }
351
352 // The updater-recovery communication protocol.
353 //
354 // progress <frac> <secs>
355 // fill up the next <frac> part of of the progress bar over <secs> seconds. If <secs> is
356 // zero, use `set_progress` commands to manually control the progress of this segment of the
357 // bar.
358 //
359 // set_progress <frac>
360 // <frac> should be between 0.0 and 1.0; sets the progress bar within the segment defined by
361 // the most recent progress command.
362 //
363 // ui_print <string>
364 // display <string> on the screen.
365 //
366 // wipe_cache
367 // a wipe of cache will be performed following a successful installation.
368 //
369 // clear_display
370 // turn off the text display.
371 //
372 // enable_reboot
373 // packages can explicitly request that they want the user to be able to reboot during
374 // installation (useful for debugging packages that don't exit).
375 //
376 // retry_update
377 // updater encounters some issue during the update. It requests a reboot to retry the same
378 // package automatically.
379 //
380 // log <string>
381 // updater requests logging the string (e.g. cause of the failure).
382 //
383
Tao Bao20c581e2016-12-28 20:55:51 -0800384 std::vector<std::string> args;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700385 if (int update_status =
Christopher N. Hessef3657eb2018-04-03 21:57:30 +0200386 is_ab_ota ? SetUpAbUpdateCommands(package, zip, pipe_write.get(), &args)
387 : SetUpNonAbUpdateCommands(package, zip, retry_count, pipe_write.get(), &args);
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700388 update_status != 0) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700389 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700390 return update_status;
Tao Bao20c581e2016-12-28 20:55:51 -0800391 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700392
Tao Bao20c581e2016-12-28 20:55:51 -0800393 pid_t pid = fork();
Tao Bao20c581e2016-12-28 20:55:51 -0800394 if (pid == -1) {
Tao Bao20c581e2016-12-28 20:55:51 -0800395 PLOG(ERROR) << "Failed to fork update binary";
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700396 log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
Tao Bao20c581e2016-12-28 20:55:51 -0800397 return INSTALL_ERROR;
398 }
399
400 if (pid == 0) {
401 umask(022);
Tao Bao6fcd2082019-01-16 09:29:17 -0800402 pipe_read.reset();
403
404 // Convert the std::string vector to a NULL-terminated char* vector suitable for execv.
405 auto chr_args = StringVectorToNullTerminatedArray(args);
Tao Bao3d69f0d2018-12-20 09:44:06 -0800406 execv(chr_args[0], chr_args.data());
Tao Bao6fcd2082019-01-16 09:29:17 -0800407 // We shouldn't use LOG/PLOG in the forked process, since they may cause the child process to
408 // hang. This deadlock results from an improperly copied mutex in the ui functions.
409 // (Bug: 34769056)
Tianjie Xuab1abae2017-01-30 16:48:52 -0800410 fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
Tao Bao3da88012017-02-03 13:09:23 -0800411 _exit(EXIT_FAILURE);
Tao Bao20c581e2016-12-28 20:55:51 -0800412 }
Tao Bao6fcd2082019-01-16 09:29:17 -0800413 pipe_write.reset();
Tao Bao20c581e2016-12-28 20:55:51 -0800414
Tianjie Xu37957102017-06-07 17:59:55 -0700415 std::atomic<bool> logger_finished(false);
416 std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700417
Tao Bao20c581e2016-12-28 20:55:51 -0800418 *wipe_cache = false;
419 bool retry_update = false;
420
421 char buffer[1024];
Tao Bao6fcd2082019-01-16 09:29:17 -0800422 FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
Tao Bao20c581e2016-12-28 20:55:51 -0800423 while (fgets(buffer, sizeof(buffer), from_child) != nullptr) {
424 std::string line(buffer);
425 size_t space = line.find_first_of(" \n");
426 std::string command(line.substr(0, space));
427 if (command.empty()) continue;
428
429 // Get rid of the leading and trailing space and/or newline.
430 std::string args = space == std::string::npos ? "" : android::base::Trim(line.substr(space));
431
432 if (command == "progress") {
433 std::vector<std::string> tokens = android::base::Split(args, " ");
434 double fraction;
435 int seconds;
436 if (tokens.size() == 2 && android::base::ParseDouble(tokens[0].c_str(), &fraction) &&
437 android::base::ParseInt(tokens[1], &seconds)) {
438 ui->ShowProgress(fraction * (1 - VERIFICATION_PROGRESS_FRACTION), seconds);
439 } else {
440 LOG(ERROR) << "invalid \"progress\" parameters: " << line;
441 }
442 } else if (command == "set_progress") {
443 std::vector<std::string> tokens = android::base::Split(args, " ");
444 double fraction;
445 if (tokens.size() == 1 && android::base::ParseDouble(tokens[0].c_str(), &fraction)) {
446 ui->SetProgress(fraction);
447 } else {
448 LOG(ERROR) << "invalid \"set_progress\" parameters: " << line;
449 }
450 } else if (command == "ui_print") {
Tao Baof0136422017-01-21 13:03:25 -0800451 ui->PrintOnScreenOnly("%s\n", args.c_str());
Tao Bao20c581e2016-12-28 20:55:51 -0800452 fflush(stdout);
453 } else if (command == "wipe_cache") {
454 *wipe_cache = true;
455 } else if (command == "clear_display") {
456 ui->SetBackground(RecoveryUI::NONE);
457 } else if (command == "enable_reboot") {
458 // packages can explicitly request that they want the user
459 // to be able to reboot during installation (useful for
460 // debugging packages that don't exit).
461 ui->SetEnableReboot(true);
462 } else if (command == "retry_update") {
463 retry_update = true;
464 } else if (command == "log") {
465 if (!args.empty()) {
466 // Save the logging request from updater and write to last_install later.
Tao Bao29ee69b2017-05-01 12:23:17 -0700467 log_buffer->push_back(args);
Tao Bao20c581e2016-12-28 20:55:51 -0800468 } else {
469 LOG(ERROR) << "invalid \"log\" parameters: " << line;
470 }
471 } else {
472 LOG(ERROR) << "unknown command [" << command << "]";
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700473 }
Tao Bao20c581e2016-12-28 20:55:51 -0800474 }
475 fclose(from_child);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700476
Tao Bao20c581e2016-12-28 20:55:51 -0800477 int status;
478 waitpid(pid, &status, 0);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700479
Tianjie Xu37957102017-06-07 17:59:55 -0700480 logger_finished.store(true);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700481 finish_log_temperature.notify_one();
482 temperature_logger.join();
483
Tao Bao20c581e2016-12-28 20:55:51 -0800484 if (retry_update) {
485 return INSTALL_RETRY;
486 }
Tao Baoe7b775c2018-11-07 15:13:30 -0800487 if (WIFEXITED(status)) {
488 if (WEXITSTATUS(status) != EXIT_SUCCESS) {
489 LOG(ERROR) << "Error in " << package << " (status " << WEXITSTATUS(status) << ")";
490 return INSTALL_ERROR;
491 }
492 } else if (WIFSIGNALED(status)) {
493 LOG(ERROR) << "Error in " << package << " (killed by signal " << WTERMSIG(status) << ")";
Tao Bao20c581e2016-12-28 20:55:51 -0800494 return INSTALL_ERROR;
Tao Baoe7b775c2018-11-07 15:13:30 -0800495 } else {
496 LOG(FATAL) << "Invalid status code " << status;
Tao Bao20c581e2016-12-28 20:55:51 -0800497 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700498
Tao Bao20c581e2016-12-28 20:55:51 -0800499 return INSTALL_SUCCESS;
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700500}
501
Tao Bao1d866052017-04-10 16:55:57 -0700502// Verifes the compatibility info in a Treble-compatible package. Returns true directly if the
503// entry doesn't exist. Note that the compatibility info is packed in a zip file inside the OTA
504// package.
505bool verify_package_compatibility(ZipArchiveHandle package_zip) {
506 LOG(INFO) << "Verifying package compatibility...";
507
508 static constexpr const char* COMPATIBILITY_ZIP_ENTRY = "compatibility.zip";
509 ZipString compatibility_entry_name(COMPATIBILITY_ZIP_ENTRY);
510 ZipEntry compatibility_entry;
511 if (FindEntry(package_zip, compatibility_entry_name, &compatibility_entry) != 0) {
512 LOG(INFO) << "Package doesn't contain " << COMPATIBILITY_ZIP_ENTRY << " entry";
513 return true;
514 }
515
516 std::string zip_content(compatibility_entry.uncompressed_length, '\0');
517 int32_t ret;
518 if ((ret = ExtractToMemory(package_zip, &compatibility_entry,
519 reinterpret_cast<uint8_t*>(&zip_content[0]),
520 compatibility_entry.uncompressed_length)) != 0) {
521 LOG(ERROR) << "Failed to read " << COMPATIBILITY_ZIP_ENTRY << ": " << ErrorCodeString(ret);
522 return false;
523 }
524
525 ZipArchiveHandle zip_handle;
526 ret = OpenArchiveFromMemory(static_cast<void*>(const_cast<char*>(zip_content.data())),
527 zip_content.size(), COMPATIBILITY_ZIP_ENTRY, &zip_handle);
528 if (ret != 0) {
529 LOG(ERROR) << "Failed to OpenArchiveFromMemory: " << ErrorCodeString(ret);
530 return false;
531 }
532
533 // Iterate all the entries inside COMPATIBILITY_ZIP_ENTRY and read the contents.
534 void* cookie;
535 ret = StartIteration(zip_handle, &cookie, nullptr, nullptr);
536 if (ret != 0) {
537 LOG(ERROR) << "Failed to start iterating zip entries: " << ErrorCodeString(ret);
538 CloseArchive(zip_handle);
539 return false;
540 }
541 std::unique_ptr<void, decltype(&EndIteration)> guard(cookie, EndIteration);
542
543 std::vector<std::string> compatibility_info;
544 ZipEntry info_entry;
545 ZipString info_name;
546 while (Next(cookie, &info_entry, &info_name) == 0) {
547 std::string content(info_entry.uncompressed_length, '\0');
548 int32_t ret = ExtractToMemory(zip_handle, &info_entry, reinterpret_cast<uint8_t*>(&content[0]),
549 info_entry.uncompressed_length);
550 if (ret != 0) {
551 LOG(ERROR) << "Failed to read " << info_name.name << ": " << ErrorCodeString(ret);
552 CloseArchive(zip_handle);
553 return false;
554 }
555 compatibility_info.emplace_back(std::move(content));
556 }
Tao Bao1d866052017-04-10 16:55:57 -0700557 CloseArchive(zip_handle);
558
Tao Bao919d2c92017-04-10 16:55:57 -0700559 // VintfObjectRecovery::CheckCompatibility returns zero on success.
560 std::string err;
561 int result = android::vintf::VintfObjectRecovery::CheckCompatibility(compatibility_info, &err);
562 if (result == 0) {
563 return true;
564 }
565
566 LOG(ERROR) << "Failed to verify package compatibility (result " << result << "): " << err;
567 return false;
Tao Bao1d866052017-04-10 16:55:57 -0700568}
569
Tao Bao29ee69b2017-05-01 12:23:17 -0700570static int really_install_package(const std::string& path, bool* wipe_cache, bool needs_mount,
571 std::vector<std::string>* log_buffer, int retry_count,
Alessandro Astone8b726282020-03-17 23:06:52 +0100572 bool verify, bool allow_ab_downgrade, int* max_temperature, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700573 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
574 ui->Print("Finding update package...\n");
575 // Give verification half the progress bar...
576 ui->SetProgressType(RecoveryUI::DETERMINATE);
577 ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
578 LOG(INFO) << "Update location: " << path;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800579
Tao Bao29ee69b2017-05-01 12:23:17 -0700580 // Map the update package into memory.
581 ui->Print("Opening update package...\n");
Doug Zongker99916f02014-01-13 14:16:58 -0800582
Tao Bao29ee69b2017-05-01 12:23:17 -0700583 if (needs_mount) {
584 if (path[0] == '@') {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800585 ensure_path_mounted(path.substr(1));
Tao Bao29ee69b2017-05-01 12:23:17 -0700586 } else {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800587 ensure_path_mounted(path);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800588 }
Tao Bao29ee69b2017-05-01 12:23:17 -0700589 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800590
xunchangf07ed2e2019-02-25 14:14:01 -0800591 auto package = Package::CreateMemoryPackage(
592 path, std::bind(&RecoveryUI::SetProgress, ui, std::placeholders::_1));
593 if (!package) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700594 log_buffer->push_back(android::base::StringPrintf("error: %d", kMapFileFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700595 return INSTALL_CORRUPT;
596 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800597
Tao Bao29ee69b2017-05-01 12:23:17 -0700598 // Verify package.
Tom Marshall03354052018-06-21 00:57:24 +0200599 if (verify && !verify_package(package.get(), ui)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700600 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
Tom Marshall03354052018-06-21 00:57:24 +0200601 return INSTALL_UNVERIFIED;
Tao Bao29ee69b2017-05-01 12:23:17 -0700602 }
Doug Zongker60151a22009-08-12 18:30:03 -0700603
Tao Bao29ee69b2017-05-01 12:23:17 -0700604 // Try to open the package.
xunchangf07ed2e2019-02-25 14:14:01 -0800605 ZipArchiveHandle zip = package->GetZipArchiveHandle();
606 if (!zip) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700607 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipOpenFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700608 return INSTALL_CORRUPT;
609 }
610
Tao Bao032403f2019-03-18 13:22:50 -0700611 // Additionally verify the compatibility of the package if it's a fresh install.
612 if (retry_count == 0 && !verify_package_compatibility(zip)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700613 log_buffer->push_back(android::base::StringPrintf("error: %d", kPackageCompatibilityFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700614 return INSTALL_CORRUPT;
615 }
616
617 // Verify and install the contents of the package.
618 ui->Print("Installing update...\n");
619 if (retry_count > 0) {
620 ui->Print("Retry attempt: %d\n", retry_count);
621 }
622 ui->SetEnableReboot(false);
Alessandro Astone8b726282020-03-17 23:06:52 +0100623 int result = try_update_binary(path, zip, wipe_cache, log_buffer, retry_count, allow_ab_downgrade,
624 max_temperature, ui);
Tao Bao29ee69b2017-05-01 12:23:17 -0700625 ui->SetEnableReboot(true);
626 ui->Print("\n");
627
Tao Bao29ee69b2017-05-01 12:23:17 -0700628 return result;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800629}
Doug Zongker469243e2011-04-12 09:28:10 -0700630
xunchang388d2532019-04-12 16:22:15 -0700631int install_package(const std::string& path, bool should_wipe_cache, bool needs_mount,
Alessandro Astone8b726282020-03-17 23:06:52 +0100632 int retry_count, bool verify, bool allow_ab_downgrade, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700633 CHECK(!path.empty());
Tao Bao29ee69b2017-05-01 12:23:17 -0700634
Tao Baof8119fb2017-04-18 21:35:12 -0700635 auto start = std::chrono::system_clock::now();
Tao Bao682c34b2015-04-07 17:16:35 -0700636
Tao Baof8119fb2017-04-18 21:35:12 -0700637 int start_temperature = GetMaxValueFromThermalZone();
638 int max_temperature = start_temperature;
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700639
Tao Baof8119fb2017-04-18 21:35:12 -0700640 int result;
641 std::vector<std::string> log_buffer;
642 if (setup_install_mounts() != 0) {
643 LOG(ERROR) << "failed to set up expected mounts for install; aborting";
644 result = INSTALL_ERROR;
645 } else {
xunchang388d2532019-04-12 16:22:15 -0700646 bool updater_wipe_cache = false;
647 result = really_install_package(path, &updater_wipe_cache, needs_mount, &log_buffer,
Alessandro Astone8b726282020-03-17 23:06:52 +0100648 retry_count, verify, allow_ab_downgrade, &max_temperature, ui);
xunchang388d2532019-04-12 16:22:15 -0700649 should_wipe_cache = should_wipe_cache || updater_wipe_cache;
Tao Baof8119fb2017-04-18 21:35:12 -0700650 }
651
652 // Measure the time spent to apply OTA update in seconds.
653 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
654 int time_total = static_cast<int>(duration.count());
655
Tao Bao3e18f2b2017-09-29 17:11:13 -0700656 bool has_cache = volume_for_mount_point("/cache") != nullptr;
Tao Baof8119fb2017-04-18 21:35:12 -0700657 // Skip logging the uncrypt_status on devices without /cache.
658 if (has_cache) {
659 static constexpr const char* UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
660 if (ensure_path_mounted(UNCRYPT_STATUS) != 0) {
661 LOG(WARNING) << "Can't mount " << UNCRYPT_STATUS;
Doug Zongker239ac6a2013-08-20 16:03:25 -0700662 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700663 std::string uncrypt_status;
664 if (!android::base::ReadFileToString(UNCRYPT_STATUS, &uncrypt_status)) {
665 PLOG(WARNING) << "failed to read uncrypt status";
666 } else if (!android::base::StartsWith(uncrypt_status, "uncrypt_")) {
667 LOG(WARNING) << "corrupted uncrypt_status: " << uncrypt_status;
Tianjie Xua2867782017-03-24 14:13:56 -0700668 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700669 log_buffer.push_back(android::base::Trim(uncrypt_status));
Tianjie Xua2867782017-03-24 14:13:56 -0700670 }
Doug Zongker469243e2011-04-12 09:28:10 -0700671 }
Tao Baof8119fb2017-04-18 21:35:12 -0700672 }
Tao Baobadaac42016-09-26 11:39:14 -0700673
Tao Baof8119fb2017-04-18 21:35:12 -0700674 // The first two lines need to be the package name and install result.
675 std::vector<std::string> log_header = {
676 path,
677 result == INSTALL_SUCCESS ? "1" : "0",
678 "time_total: " + std::to_string(time_total),
679 "retry: " + std::to_string(retry_count),
680 };
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700681
Tao Baof8119fb2017-04-18 21:35:12 -0700682 int end_temperature = GetMaxValueFromThermalZone();
683 max_temperature = std::max(end_temperature, max_temperature);
684 if (start_temperature > 0) {
685 log_buffer.push_back("temperature_start: " + std::to_string(start_temperature));
686 }
687 if (end_temperature > 0) {
688 log_buffer.push_back("temperature_end: " + std::to_string(end_temperature));
689 }
690 if (max_temperature > 0) {
691 log_buffer.push_back("temperature_max: " + std::to_string(max_temperature));
692 }
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700693
Tao Baof8119fb2017-04-18 21:35:12 -0700694 std::string log_content =
695 android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
Tao Bao641fa972018-04-25 18:59:40 -0700696 const std::string& install_file = Paths::Get().temporary_install_file();
Tao Baof8119fb2017-04-18 21:35:12 -0700697 if (!android::base::WriteStringToFile(log_content, install_file)) {
698 PLOG(ERROR) << "failed to write " << install_file;
699 }
Tao Baobadaac42016-09-26 11:39:14 -0700700
Tao Baof8119fb2017-04-18 21:35:12 -0700701 // Write a copy into last_log.
702 LOG(INFO) << log_content;
Tao Baobadaac42016-09-26 11:39:14 -0700703
xunchang388d2532019-04-12 16:22:15 -0700704 if (result == INSTALL_SUCCESS && should_wipe_cache) {
705 if (!WipeCache(ui, nullptr)) {
706 result = INSTALL_ERROR;
707 }
708 }
709
Tao Baof8119fb2017-04-18 21:35:12 -0700710 return result;
Doug Zongker469243e2011-04-12 09:28:10 -0700711}
Yabin Cui6faf0262016-06-09 14:09:39 -0700712
xunchang24788852019-03-22 16:08:52 -0700713bool verify_package(Package* package, RecoveryUI* ui) {
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700714 static constexpr const char* CERTIFICATE_ZIP_FILE = "/system/etc/security/otacerts.zip";
715 std::vector<Certificate> loaded_keys = LoadKeysFromZipfile(CERTIFICATE_ZIP_FILE);
716 if (loaded_keys.empty()) {
Tao Bao5e535012017-03-16 17:37:38 -0700717 LOG(ERROR) << "Failed to load keys";
718 return false;
719 }
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700720 LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
Yabin Cui6faf0262016-06-09 14:09:39 -0700721
Tao Bao5e535012017-03-16 17:37:38 -0700722 // Verify package.
723 ui->Print("Verifying update package...\n");
724 auto t0 = std::chrono::system_clock::now();
xunchangf07ed2e2019-02-25 14:14:01 -0800725 int err = verify_file(package, loaded_keys);
Tao Bao5e535012017-03-16 17:37:38 -0700726 std::chrono::duration<double> duration = std::chrono::system_clock::now() - t0;
727 ui->Print("Update package verification took %.1f s (result %d).\n", duration.count(), err);
728 if (err != VERIFY_SUCCESS) {
729 LOG(ERROR) << "Signature verification failed";
730 LOG(ERROR) << "error: " << kZipVerificationFailure;
731 return false;
732 }
733 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700734}