blob: 80e5f1bb81d9211c84cbb6e83fbf2e6e18022a87 [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) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700190 auto device = android::base::GetProperty("ro.product.device", "");
191 auto pkg_device = get_value(metadata, "pre-device");
192 if (pkg_device != device || pkg_device.empty()) {
193 LOG(ERROR) << "Package is for product " << pkg_device << " but expected " << device;
194 return INSTALL_ERROR;
195 }
196
197 // We allow the package to not have any serialno; and we also allow it to carry multiple serial
198 // numbers split by "|"; e.g. serialno=serialno1|serialno2|serialno3 ... We will fail the
199 // verification if the device's serialno doesn't match any of these carried numbers.
200 auto pkg_serial_no = get_value(metadata, "serialno");
201 if (!pkg_serial_no.empty()) {
202 auto device_serial_no = android::base::GetProperty("ro.serialno", "");
203 bool serial_number_match = false;
204 for (const auto& number : android::base::Split(pkg_serial_no, "|")) {
205 if (device_serial_no == android::base::Trim(number)) {
206 serial_number_match = true;
207 }
208 }
209 if (!serial_number_match) {
210 LOG(ERROR) << "Package is for serial " << pkg_serial_no;
211 return INSTALL_ERROR;
212 }
213 }
214
215 if (ota_type == OtaType::AB) {
Alessandro Astone8b726282020-03-17 23:06:52 +0100216 return CheckAbSpecificMetadata(metadata, allow_ab_downgrade);
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700217 }
218
219 return 0;
220}
221
Tao Baocf60a442018-06-18 14:56:20 -0700222int SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
Tao Bao00d57572017-05-02 15:48:54 -0700223 std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700224 CHECK(cmd != nullptr);
Alex Deymo4344d632016-08-03 21:03:53 -0700225
Tao Baobc4b1fe2017-04-17 16:46:05 -0700226 // For A/B updates we extract the payload properties to a buffer and obtain the RAW payload offset
227 // in the zip file.
228 static constexpr const char* AB_OTA_PAYLOAD_PROPERTIES = "payload_properties.txt";
229 ZipString property_name(AB_OTA_PAYLOAD_PROPERTIES);
230 ZipEntry properties_entry;
231 if (FindEntry(zip, property_name, &properties_entry) != 0) {
232 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
233 return INSTALL_CORRUPT;
234 }
235 uint32_t properties_entry_length = properties_entry.uncompressed_length;
236 std::vector<uint8_t> payload_properties(properties_entry_length);
237 int32_t err =
238 ExtractToMemory(zip, &properties_entry, payload_properties.data(), properties_entry_length);
239 if (err != 0) {
240 LOG(ERROR) << "Failed to extract " << AB_OTA_PAYLOAD_PROPERTIES << ": " << ErrorCodeString(err);
241 return INSTALL_CORRUPT;
242 }
Alex Deymo4344d632016-08-03 21:03:53 -0700243
Tao Baobc4b1fe2017-04-17 16:46:05 -0700244 static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
245 ZipString payload_name(AB_OTA_PAYLOAD);
246 ZipEntry payload_entry;
247 if (FindEntry(zip, payload_name, &payload_entry) != 0) {
248 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
249 return INSTALL_CORRUPT;
250 }
251 long payload_offset = payload_entry.offset;
252 *cmd = {
Tao Bao2cc9bbb2018-08-14 12:34:46 -0700253 "/system/bin/update_engine_sideload",
Tao Bao00d57572017-05-02 15:48:54 -0700254 "--payload=file://" + package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700255 android::base::StringPrintf("--offset=%ld", payload_offset),
256 "--headers=" + std::string(payload_properties.begin(), payload_properties.end()),
257 android::base::StringPrintf("--status_fd=%d", status_fd),
258 };
259 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700260}
261
Tao Baocf60a442018-06-18 14:56:20 -0700262int SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
263 int status_fd, std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700264 CHECK(cmd != nullptr);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700265
Tao Baocf60a442018-06-18 14:56:20 -0700266 // In non-A/B updates we extract the update binary from the package.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700267 static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
268 ZipString binary_name(UPDATE_BINARY_NAME);
269 ZipEntry binary_entry;
270 if (FindEntry(zip, binary_name, &binary_entry) != 0) {
271 LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
272 return INSTALL_CORRUPT;
273 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700274
Tao Baocf60a442018-06-18 14:56:20 -0700275 const std::string binary_path = Paths::Get().temporary_update_binary();
Tao Bao00d57572017-05-02 15:48:54 -0700276 unlink(binary_path.c_str());
Tao Baocf60a442018-06-18 14:56:20 -0700277 android::base::unique_fd fd(
278 open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
Tao Baobc4b1fe2017-04-17 16:46:05 -0700279 if (fd == -1) {
Tao Bao00d57572017-05-02 15:48:54 -0700280 PLOG(ERROR) << "Failed to create " << binary_path;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700281 return INSTALL_ERROR;
282 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700283
Tao Baobc4b1fe2017-04-17 16:46:05 -0700284 int32_t error = ExtractEntryToFile(zip, &binary_entry, fd);
Tao Baobc4b1fe2017-04-17 16:46:05 -0700285 if (error != 0) {
286 LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
287 return INSTALL_ERROR;
288 }
289
Tao Bao6fcd2082019-01-16 09:29:17 -0800290 // When executing the update binary contained in the package, the arguments passed are:
291 // - the version number for this interface
292 // - an FD to which the program can write in order to update the progress bar.
293 // - the name of the package zip file.
294 // - an optional argument "retry" if this update is a retry of a failed update attempt.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700295 *cmd = {
Tao Bao00d57572017-05-02 15:48:54 -0700296 binary_path,
Tao Baobd0ddcd2017-05-04 13:03:18 -0700297 std::to_string(kRecoveryApiVersion),
Tao Baobc4b1fe2017-04-17 16:46:05 -0700298 std::to_string(status_fd),
Tao Bao00d57572017-05-02 15:48:54 -0700299 package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700300 };
301 if (retry_count > 0) {
302 cmd->push_back("retry");
303 }
304 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700305}
Alex Deymo4344d632016-08-03 21:03:53 -0700306
Tianjie Xu37957102017-06-07 17:59:55 -0700307static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700308 CHECK(max_temperature != nullptr);
309 std::mutex mtx;
310 std::unique_lock<std::mutex> lck(mtx);
Tianjie Xu37957102017-06-07 17:59:55 -0700311 while (!logger_finished.load() &&
312 finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700313 *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
314 }
315}
316
Alex Deymo4344d632016-08-03 21:03:53 -0700317// If the package contains an update binary, extract it and run it.
Tao Bao00d57572017-05-02 15:48:54 -0700318static int try_update_binary(const std::string& package, ZipArchiveHandle zip, bool* wipe_cache,
Tao Bao29ee69b2017-05-01 12:23:17 -0700319 std::vector<std::string>* log_buffer, int retry_count,
Alessandro Astone8b726282020-03-17 23:06:52 +0100320 bool allow_ab_downgrade, int* max_temperature, RecoveryUI* ui) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700321 std::map<std::string, std::string> metadata;
Christopher N. Hessef3657eb2018-04-03 21:57:30 +0200322 bool is_ab_ota = false;
323 if (ReadMetadataFromPackage(zip, &metadata)) {
324 ReadSourceTargetBuild(metadata, log_buffer);
Alessandro Astone72832592020-03-17 13:53:23 +0100325 if (get_value(metadata, "ota-type") == OtaTypeToString(OtaType::AB)) {
326 is_ab_ota = true;
Alessandro Astone8b726282020-03-17 23:06:52 +0100327 int check_status = CheckPackageMetadata(metadata, OtaType::AB, allow_ab_downgrade);
Alessandro Astone72832592020-03-17 13:53:23 +0100328 if (check_status != 0) {
329 return check_status;
330 }
331 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700332 }
333
Tao Bao6fcd2082019-01-16 09:29:17 -0800334 // The updater in child process writes to the pipe to communicate with recovery.
335 android::base::unique_fd pipe_read, pipe_write;
Bill Peckham08ba1ad2019-03-28 18:42:13 -0700336 // Explicitly disable O_CLOEXEC using 0 as the flags (last) parameter to Pipe
337 // so that the child updater process will recieve a non-closed fd.
338 if (!android::base::Pipe(&pipe_read, &pipe_write, 0)) {
Tao Bao6fcd2082019-01-16 09:29:17 -0800339 PLOG(ERROR) << "Failed to create pipe for updater-recovery communication";
340 return INSTALL_CORRUPT;
341 }
342
343 // The updater-recovery communication protocol.
344 //
345 // progress <frac> <secs>
346 // fill up the next <frac> part of of the progress bar over <secs> seconds. If <secs> is
347 // zero, use `set_progress` commands to manually control the progress of this segment of the
348 // bar.
349 //
350 // set_progress <frac>
351 // <frac> should be between 0.0 and 1.0; sets the progress bar within the segment defined by
352 // the most recent progress command.
353 //
354 // ui_print <string>
355 // display <string> on the screen.
356 //
357 // wipe_cache
358 // a wipe of cache will be performed following a successful installation.
359 //
360 // clear_display
361 // turn off the text display.
362 //
363 // enable_reboot
364 // packages can explicitly request that they want the user to be able to reboot during
365 // installation (useful for debugging packages that don't exit).
366 //
367 // retry_update
368 // updater encounters some issue during the update. It requests a reboot to retry the same
369 // package automatically.
370 //
371 // log <string>
372 // updater requests logging the string (e.g. cause of the failure).
373 //
374
Tao Bao20c581e2016-12-28 20:55:51 -0800375 std::vector<std::string> args;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700376 if (int update_status =
Christopher N. Hessef3657eb2018-04-03 21:57:30 +0200377 is_ab_ota ? SetUpAbUpdateCommands(package, zip, pipe_write.get(), &args)
378 : SetUpNonAbUpdateCommands(package, zip, retry_count, pipe_write.get(), &args);
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700379 update_status != 0) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700380 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700381 return update_status;
Tao Bao20c581e2016-12-28 20:55:51 -0800382 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700383
Tao Bao20c581e2016-12-28 20:55:51 -0800384 pid_t pid = fork();
Tao Bao20c581e2016-12-28 20:55:51 -0800385 if (pid == -1) {
Tao Bao20c581e2016-12-28 20:55:51 -0800386 PLOG(ERROR) << "Failed to fork update binary";
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700387 log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
Tao Bao20c581e2016-12-28 20:55:51 -0800388 return INSTALL_ERROR;
389 }
390
391 if (pid == 0) {
392 umask(022);
Tao Bao6fcd2082019-01-16 09:29:17 -0800393 pipe_read.reset();
394
395 // Convert the std::string vector to a NULL-terminated char* vector suitable for execv.
396 auto chr_args = StringVectorToNullTerminatedArray(args);
Tao Bao3d69f0d2018-12-20 09:44:06 -0800397 execv(chr_args[0], chr_args.data());
Tao Bao6fcd2082019-01-16 09:29:17 -0800398 // We shouldn't use LOG/PLOG in the forked process, since they may cause the child process to
399 // hang. This deadlock results from an improperly copied mutex in the ui functions.
400 // (Bug: 34769056)
Tianjie Xuab1abae2017-01-30 16:48:52 -0800401 fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
Tao Bao3da88012017-02-03 13:09:23 -0800402 _exit(EXIT_FAILURE);
Tao Bao20c581e2016-12-28 20:55:51 -0800403 }
Tao Bao6fcd2082019-01-16 09:29:17 -0800404 pipe_write.reset();
Tao Bao20c581e2016-12-28 20:55:51 -0800405
Tianjie Xu37957102017-06-07 17:59:55 -0700406 std::atomic<bool> logger_finished(false);
407 std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700408
Tao Bao20c581e2016-12-28 20:55:51 -0800409 *wipe_cache = false;
410 bool retry_update = false;
411
412 char buffer[1024];
Tao Bao6fcd2082019-01-16 09:29:17 -0800413 FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
Tao Bao20c581e2016-12-28 20:55:51 -0800414 while (fgets(buffer, sizeof(buffer), from_child) != nullptr) {
415 std::string line(buffer);
416 size_t space = line.find_first_of(" \n");
417 std::string command(line.substr(0, space));
418 if (command.empty()) continue;
419
420 // Get rid of the leading and trailing space and/or newline.
421 std::string args = space == std::string::npos ? "" : android::base::Trim(line.substr(space));
422
423 if (command == "progress") {
424 std::vector<std::string> tokens = android::base::Split(args, " ");
425 double fraction;
426 int seconds;
427 if (tokens.size() == 2 && android::base::ParseDouble(tokens[0].c_str(), &fraction) &&
428 android::base::ParseInt(tokens[1], &seconds)) {
429 ui->ShowProgress(fraction * (1 - VERIFICATION_PROGRESS_FRACTION), seconds);
430 } else {
431 LOG(ERROR) << "invalid \"progress\" parameters: " << line;
432 }
433 } else if (command == "set_progress") {
434 std::vector<std::string> tokens = android::base::Split(args, " ");
435 double fraction;
436 if (tokens.size() == 1 && android::base::ParseDouble(tokens[0].c_str(), &fraction)) {
437 ui->SetProgress(fraction);
438 } else {
439 LOG(ERROR) << "invalid \"set_progress\" parameters: " << line;
440 }
441 } else if (command == "ui_print") {
Tao Baof0136422017-01-21 13:03:25 -0800442 ui->PrintOnScreenOnly("%s\n", args.c_str());
Tao Bao20c581e2016-12-28 20:55:51 -0800443 fflush(stdout);
444 } else if (command == "wipe_cache") {
445 *wipe_cache = true;
446 } else if (command == "clear_display") {
447 ui->SetBackground(RecoveryUI::NONE);
448 } else if (command == "enable_reboot") {
449 // packages can explicitly request that they want the user
450 // to be able to reboot during installation (useful for
451 // debugging packages that don't exit).
452 ui->SetEnableReboot(true);
453 } else if (command == "retry_update") {
454 retry_update = true;
455 } else if (command == "log") {
456 if (!args.empty()) {
457 // Save the logging request from updater and write to last_install later.
Tao Bao29ee69b2017-05-01 12:23:17 -0700458 log_buffer->push_back(args);
Tao Bao20c581e2016-12-28 20:55:51 -0800459 } else {
460 LOG(ERROR) << "invalid \"log\" parameters: " << line;
461 }
462 } else {
463 LOG(ERROR) << "unknown command [" << command << "]";
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700464 }
Tao Bao20c581e2016-12-28 20:55:51 -0800465 }
466 fclose(from_child);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700467
Tao Bao20c581e2016-12-28 20:55:51 -0800468 int status;
469 waitpid(pid, &status, 0);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700470
Tianjie Xu37957102017-06-07 17:59:55 -0700471 logger_finished.store(true);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700472 finish_log_temperature.notify_one();
473 temperature_logger.join();
474
Tao Bao20c581e2016-12-28 20:55:51 -0800475 if (retry_update) {
476 return INSTALL_RETRY;
477 }
Tao Baoe7b775c2018-11-07 15:13:30 -0800478 if (WIFEXITED(status)) {
479 if (WEXITSTATUS(status) != EXIT_SUCCESS) {
480 LOG(ERROR) << "Error in " << package << " (status " << WEXITSTATUS(status) << ")";
481 return INSTALL_ERROR;
482 }
483 } else if (WIFSIGNALED(status)) {
484 LOG(ERROR) << "Error in " << package << " (killed by signal " << WTERMSIG(status) << ")";
Tao Bao20c581e2016-12-28 20:55:51 -0800485 return INSTALL_ERROR;
Tao Baoe7b775c2018-11-07 15:13:30 -0800486 } else {
487 LOG(FATAL) << "Invalid status code " << status;
Tao Bao20c581e2016-12-28 20:55:51 -0800488 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700489
Tao Bao20c581e2016-12-28 20:55:51 -0800490 return INSTALL_SUCCESS;
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700491}
492
Tao Bao1d866052017-04-10 16:55:57 -0700493// Verifes the compatibility info in a Treble-compatible package. Returns true directly if the
494// entry doesn't exist. Note that the compatibility info is packed in a zip file inside the OTA
495// package.
496bool verify_package_compatibility(ZipArchiveHandle package_zip) {
497 LOG(INFO) << "Verifying package compatibility...";
498
499 static constexpr const char* COMPATIBILITY_ZIP_ENTRY = "compatibility.zip";
500 ZipString compatibility_entry_name(COMPATIBILITY_ZIP_ENTRY);
501 ZipEntry compatibility_entry;
502 if (FindEntry(package_zip, compatibility_entry_name, &compatibility_entry) != 0) {
503 LOG(INFO) << "Package doesn't contain " << COMPATIBILITY_ZIP_ENTRY << " entry";
504 return true;
505 }
506
507 std::string zip_content(compatibility_entry.uncompressed_length, '\0');
508 int32_t ret;
509 if ((ret = ExtractToMemory(package_zip, &compatibility_entry,
510 reinterpret_cast<uint8_t*>(&zip_content[0]),
511 compatibility_entry.uncompressed_length)) != 0) {
512 LOG(ERROR) << "Failed to read " << COMPATIBILITY_ZIP_ENTRY << ": " << ErrorCodeString(ret);
513 return false;
514 }
515
516 ZipArchiveHandle zip_handle;
517 ret = OpenArchiveFromMemory(static_cast<void*>(const_cast<char*>(zip_content.data())),
518 zip_content.size(), COMPATIBILITY_ZIP_ENTRY, &zip_handle);
519 if (ret != 0) {
520 LOG(ERROR) << "Failed to OpenArchiveFromMemory: " << ErrorCodeString(ret);
521 return false;
522 }
523
524 // Iterate all the entries inside COMPATIBILITY_ZIP_ENTRY and read the contents.
525 void* cookie;
526 ret = StartIteration(zip_handle, &cookie, nullptr, nullptr);
527 if (ret != 0) {
528 LOG(ERROR) << "Failed to start iterating zip entries: " << ErrorCodeString(ret);
529 CloseArchive(zip_handle);
530 return false;
531 }
532 std::unique_ptr<void, decltype(&EndIteration)> guard(cookie, EndIteration);
533
534 std::vector<std::string> compatibility_info;
535 ZipEntry info_entry;
536 ZipString info_name;
537 while (Next(cookie, &info_entry, &info_name) == 0) {
538 std::string content(info_entry.uncompressed_length, '\0');
539 int32_t ret = ExtractToMemory(zip_handle, &info_entry, reinterpret_cast<uint8_t*>(&content[0]),
540 info_entry.uncompressed_length);
541 if (ret != 0) {
542 LOG(ERROR) << "Failed to read " << info_name.name << ": " << ErrorCodeString(ret);
543 CloseArchive(zip_handle);
544 return false;
545 }
546 compatibility_info.emplace_back(std::move(content));
547 }
Tao Bao1d866052017-04-10 16:55:57 -0700548 CloseArchive(zip_handle);
549
Tao Bao919d2c92017-04-10 16:55:57 -0700550 // VintfObjectRecovery::CheckCompatibility returns zero on success.
551 std::string err;
552 int result = android::vintf::VintfObjectRecovery::CheckCompatibility(compatibility_info, &err);
553 if (result == 0) {
554 return true;
555 }
556
557 LOG(ERROR) << "Failed to verify package compatibility (result " << result << "): " << err;
558 return false;
Tao Bao1d866052017-04-10 16:55:57 -0700559}
560
Tao Bao29ee69b2017-05-01 12:23:17 -0700561static int really_install_package(const std::string& path, bool* wipe_cache, bool needs_mount,
562 std::vector<std::string>* log_buffer, int retry_count,
Alessandro Astone8b726282020-03-17 23:06:52 +0100563 bool verify, bool allow_ab_downgrade, int* max_temperature, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700564 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
565 ui->Print("Finding update package...\n");
566 // Give verification half the progress bar...
567 ui->SetProgressType(RecoveryUI::DETERMINATE);
568 ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
569 LOG(INFO) << "Update location: " << path;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800570
Tao Bao29ee69b2017-05-01 12:23:17 -0700571 // Map the update package into memory.
572 ui->Print("Opening update package...\n");
Doug Zongker99916f02014-01-13 14:16:58 -0800573
Tao Bao29ee69b2017-05-01 12:23:17 -0700574 if (needs_mount) {
575 if (path[0] == '@') {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800576 ensure_path_mounted(path.substr(1));
Tao Bao29ee69b2017-05-01 12:23:17 -0700577 } else {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800578 ensure_path_mounted(path);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800579 }
Tao Bao29ee69b2017-05-01 12:23:17 -0700580 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800581
xunchangf07ed2e2019-02-25 14:14:01 -0800582 auto package = Package::CreateMemoryPackage(
583 path, std::bind(&RecoveryUI::SetProgress, ui, std::placeholders::_1));
584 if (!package) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700585 log_buffer->push_back(android::base::StringPrintf("error: %d", kMapFileFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700586 return INSTALL_CORRUPT;
587 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800588
Tao Bao29ee69b2017-05-01 12:23:17 -0700589 // Verify package.
Tom Marshall03354052018-06-21 00:57:24 +0200590 if (verify && !verify_package(package.get(), ui)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700591 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
Tom Marshall03354052018-06-21 00:57:24 +0200592 return INSTALL_UNVERIFIED;
Tao Bao29ee69b2017-05-01 12:23:17 -0700593 }
Doug Zongker60151a22009-08-12 18:30:03 -0700594
Tao Bao29ee69b2017-05-01 12:23:17 -0700595 // Try to open the package.
xunchangf07ed2e2019-02-25 14:14:01 -0800596 ZipArchiveHandle zip = package->GetZipArchiveHandle();
597 if (!zip) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700598 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipOpenFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700599 return INSTALL_CORRUPT;
600 }
601
Tao Bao032403f2019-03-18 13:22:50 -0700602 // Additionally verify the compatibility of the package if it's a fresh install.
603 if (retry_count == 0 && !verify_package_compatibility(zip)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700604 log_buffer->push_back(android::base::StringPrintf("error: %d", kPackageCompatibilityFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700605 return INSTALL_CORRUPT;
606 }
607
608 // Verify and install the contents of the package.
609 ui->Print("Installing update...\n");
610 if (retry_count > 0) {
611 ui->Print("Retry attempt: %d\n", retry_count);
612 }
613 ui->SetEnableReboot(false);
Alessandro Astone8b726282020-03-17 23:06:52 +0100614 int result = try_update_binary(path, zip, wipe_cache, log_buffer, retry_count, allow_ab_downgrade,
615 max_temperature, ui);
Tao Bao29ee69b2017-05-01 12:23:17 -0700616 ui->SetEnableReboot(true);
617 ui->Print("\n");
618
Tao Bao29ee69b2017-05-01 12:23:17 -0700619 return result;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800620}
Doug Zongker469243e2011-04-12 09:28:10 -0700621
xunchang388d2532019-04-12 16:22:15 -0700622int install_package(const std::string& path, bool should_wipe_cache, bool needs_mount,
Alessandro Astone8b726282020-03-17 23:06:52 +0100623 int retry_count, bool verify, bool allow_ab_downgrade, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700624 CHECK(!path.empty());
Tao Bao29ee69b2017-05-01 12:23:17 -0700625
Tao Baof8119fb2017-04-18 21:35:12 -0700626 auto start = std::chrono::system_clock::now();
Tao Bao682c34b2015-04-07 17:16:35 -0700627
Tao Baof8119fb2017-04-18 21:35:12 -0700628 int start_temperature = GetMaxValueFromThermalZone();
629 int max_temperature = start_temperature;
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700630
Tao Baof8119fb2017-04-18 21:35:12 -0700631 int result;
632 std::vector<std::string> log_buffer;
633 if (setup_install_mounts() != 0) {
634 LOG(ERROR) << "failed to set up expected mounts for install; aborting";
635 result = INSTALL_ERROR;
636 } else {
xunchang388d2532019-04-12 16:22:15 -0700637 bool updater_wipe_cache = false;
638 result = really_install_package(path, &updater_wipe_cache, needs_mount, &log_buffer,
Alessandro Astone8b726282020-03-17 23:06:52 +0100639 retry_count, verify, allow_ab_downgrade, &max_temperature, ui);
xunchang388d2532019-04-12 16:22:15 -0700640 should_wipe_cache = should_wipe_cache || updater_wipe_cache;
Tao Baof8119fb2017-04-18 21:35:12 -0700641 }
642
643 // Measure the time spent to apply OTA update in seconds.
644 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
645 int time_total = static_cast<int>(duration.count());
646
Tao Bao3e18f2b2017-09-29 17:11:13 -0700647 bool has_cache = volume_for_mount_point("/cache") != nullptr;
Tao Baof8119fb2017-04-18 21:35:12 -0700648 // Skip logging the uncrypt_status on devices without /cache.
649 if (has_cache) {
650 static constexpr const char* UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
651 if (ensure_path_mounted(UNCRYPT_STATUS) != 0) {
652 LOG(WARNING) << "Can't mount " << UNCRYPT_STATUS;
Doug Zongker239ac6a2013-08-20 16:03:25 -0700653 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700654 std::string uncrypt_status;
655 if (!android::base::ReadFileToString(UNCRYPT_STATUS, &uncrypt_status)) {
656 PLOG(WARNING) << "failed to read uncrypt status";
657 } else if (!android::base::StartsWith(uncrypt_status, "uncrypt_")) {
658 LOG(WARNING) << "corrupted uncrypt_status: " << uncrypt_status;
Tianjie Xua2867782017-03-24 14:13:56 -0700659 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700660 log_buffer.push_back(android::base::Trim(uncrypt_status));
Tianjie Xua2867782017-03-24 14:13:56 -0700661 }
Doug Zongker469243e2011-04-12 09:28:10 -0700662 }
Tao Baof8119fb2017-04-18 21:35:12 -0700663 }
Tao Baobadaac42016-09-26 11:39:14 -0700664
Tao Baof8119fb2017-04-18 21:35:12 -0700665 // The first two lines need to be the package name and install result.
666 std::vector<std::string> log_header = {
667 path,
668 result == INSTALL_SUCCESS ? "1" : "0",
669 "time_total: " + std::to_string(time_total),
670 "retry: " + std::to_string(retry_count),
671 };
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700672
Tao Baof8119fb2017-04-18 21:35:12 -0700673 int end_temperature = GetMaxValueFromThermalZone();
674 max_temperature = std::max(end_temperature, max_temperature);
675 if (start_temperature > 0) {
676 log_buffer.push_back("temperature_start: " + std::to_string(start_temperature));
677 }
678 if (end_temperature > 0) {
679 log_buffer.push_back("temperature_end: " + std::to_string(end_temperature));
680 }
681 if (max_temperature > 0) {
682 log_buffer.push_back("temperature_max: " + std::to_string(max_temperature));
683 }
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700684
Tao Baof8119fb2017-04-18 21:35:12 -0700685 std::string log_content =
686 android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
Tao Bao641fa972018-04-25 18:59:40 -0700687 const std::string& install_file = Paths::Get().temporary_install_file();
Tao Baof8119fb2017-04-18 21:35:12 -0700688 if (!android::base::WriteStringToFile(log_content, install_file)) {
689 PLOG(ERROR) << "failed to write " << install_file;
690 }
Tao Baobadaac42016-09-26 11:39:14 -0700691
Tao Baof8119fb2017-04-18 21:35:12 -0700692 // Write a copy into last_log.
693 LOG(INFO) << log_content;
Tao Baobadaac42016-09-26 11:39:14 -0700694
xunchang388d2532019-04-12 16:22:15 -0700695 if (result == INSTALL_SUCCESS && should_wipe_cache) {
696 if (!WipeCache(ui, nullptr)) {
697 result = INSTALL_ERROR;
698 }
699 }
700
Tao Baof8119fb2017-04-18 21:35:12 -0700701 return result;
Doug Zongker469243e2011-04-12 09:28:10 -0700702}
Yabin Cui6faf0262016-06-09 14:09:39 -0700703
xunchang24788852019-03-22 16:08:52 -0700704bool verify_package(Package* package, RecoveryUI* ui) {
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700705 static constexpr const char* CERTIFICATE_ZIP_FILE = "/system/etc/security/otacerts.zip";
706 std::vector<Certificate> loaded_keys = LoadKeysFromZipfile(CERTIFICATE_ZIP_FILE);
707 if (loaded_keys.empty()) {
Tao Bao5e535012017-03-16 17:37:38 -0700708 LOG(ERROR) << "Failed to load keys";
709 return false;
710 }
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700711 LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
Yabin Cui6faf0262016-06-09 14:09:39 -0700712
Tao Bao5e535012017-03-16 17:37:38 -0700713 // Verify package.
714 ui->Print("Verifying update package...\n");
715 auto t0 = std::chrono::system_clock::now();
xunchangf07ed2e2019-02-25 14:14:01 -0800716 int err = verify_file(package, loaded_keys);
Tao Bao5e535012017-03-16 17:37:38 -0700717 std::chrono::duration<double> duration = std::chrono::system_clock::now() - t0;
718 ui->Print("Update package verification took %.1f s (result %d).\n", duration.count(), err);
719 if (err != VERIFY_SUCCESS) {
720 LOG(ERROR) << "Signature verification failed";
721 LOG(ERROR) << "error: " << kZipVerificationFailure;
722 return false;
723 }
724 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700725}