blob: e2d470096d21850874e833349cde3ffcab2d7b46 [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"
xunchang316e9712019-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) {
79 LOG(ERROR) << "Failed to find " << METADATA_PATH;
80 return false;
81 }
82
83 uint32_t length = entry.uncompressed_length;
Tianjie Xu93b5bf22018-10-25 10:39:01 -070084 std::string metadata_string(length, '\0');
85 int32_t err =
86 ExtractToMemory(zip, &entry, reinterpret_cast<uint8_t*>(&metadata_string[0]), length);
Tao Bao8a7afcc2017-04-18 22:05:50 -070087 if (err != 0) {
88 LOG(ERROR) << "Failed to extract " << METADATA_PATH << ": " << ErrorCodeString(err);
89 return false;
90 }
Tianjie Xu93b5bf22018-10-25 10:39:01 -070091
92 for (const std::string& line : android::base::Split(metadata_string, "\n")) {
93 size_t eq = line.find('=');
94 if (eq != std::string::npos) {
95 metadata->emplace(android::base::Trim(line.substr(0, eq)),
96 android::base::Trim(line.substr(eq + 1)));
97 }
98 }
99
Tao Bao8a7afcc2017-04-18 22:05:50 -0700100 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700101}
102
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700103// Gets the value for the given key in |metadata|. Returns an emtpy string if the key isn't
104// present.
105static std::string get_value(const std::map<std::string, std::string>& metadata,
106 const std::string& key) {
107 const auto& it = metadata.find(key);
108 return (it == metadata.end()) ? "" : it->second;
109}
110
111static std::string OtaTypeToString(OtaType type) {
112 switch (type) {
113 case OtaType::AB:
114 return "AB";
115 case OtaType::BLOCK:
116 return "BLOCK";
117 case OtaType::BRICK:
118 return "BRICK";
Tao Bao8a7afcc2017-04-18 22:05:50 -0700119 }
Tianjie Xub0ddae52016-06-08 14:30:04 -0700120}
121
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700122// Read the build.version.incremental of src/tgt from the metadata and log it to last_install.
123static void ReadSourceTargetBuild(const std::map<std::string, std::string>& metadata,
124 std::vector<std::string>* log_buffer) {
125 // Examples of the pre-build and post-build strings in metadata:
126 // pre-build-incremental=2943039
127 // post-build-incremental=2951741
128 auto source_build = get_value(metadata, "pre-build-incremental");
129 if (!source_build.empty()) {
130 log_buffer->push_back("source_build: " + source_build);
131 }
132
133 auto target_build = get_value(metadata, "post-build-incremental");
134 if (!target_build.empty()) {
135 log_buffer->push_back("target_build: " + target_build);
136 }
137}
138
139// Checks the build version, fingerprint and timestamp in the metadata of the A/B package.
140// Downgrading is not allowed unless explicitly enabled in the package and only for
Tao Baocf60a442018-06-18 14:56:20 -0700141// incremental packages.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700142static int CheckAbSpecificMetadata(const std::map<std::string, std::string>& metadata) {
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.
161 int64_t build_timestamp =
162 android::base::GetIntProperty("ro.build.date.utc", std::numeric_limits<int64_t>::max());
163 int64_t pkg_post_timestamp = 0;
164 // We allow to full update to the same version we are running, in case there
165 // is a problem with the current copy of that version.
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700166 auto pkg_post_timestamp_string = get_value(metadata, "post-timestamp");
167 if (pkg_post_timestamp_string.empty() ||
168 !android::base::ParseInt(pkg_post_timestamp_string, &pkg_post_timestamp) ||
Tao Baoefc35592017-01-08 22:45:47 -0800169 pkg_post_timestamp < build_timestamp) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700170 if (get_value(metadata, "ota-downgrade") != "yes") {
Tao Baoefc35592017-01-08 22:45:47 -0800171 LOG(ERROR) << "Update package is older than the current build, expected a build "
172 "newer than timestamp "
173 << build_timestamp << " but package has timestamp " << pkg_post_timestamp
174 << " and downgrade not allowed.";
175 return INSTALL_ERROR;
176 }
177 if (pkg_pre_build_fingerprint.empty()) {
178 LOG(ERROR) << "Downgrade package must have a pre-build version set, not allowed.";
179 return INSTALL_ERROR;
180 }
181 }
182
183 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700184}
185
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700186int CheckPackageMetadata(const std::map<std::string, std::string>& metadata, OtaType ota_type) {
187 auto package_ota_type = get_value(metadata, "ota-type");
188 auto expected_ota_type = OtaTypeToString(ota_type);
189 if (ota_type != OtaType::AB && ota_type != OtaType::BRICK) {
190 LOG(INFO) << "Skip package metadata check for ota type " << expected_ota_type;
191 return 0;
192 }
193
194 if (package_ota_type != expected_ota_type) {
195 LOG(ERROR) << "Unexpected ota package type, expects " << expected_ota_type << ", actual "
196 << package_ota_type;
197 return INSTALL_ERROR;
198 }
199
200 auto device = android::base::GetProperty("ro.product.device", "");
201 auto pkg_device = get_value(metadata, "pre-device");
202 if (pkg_device != device || pkg_device.empty()) {
203 LOG(ERROR) << "Package is for product " << pkg_device << " but expected " << device;
204 return INSTALL_ERROR;
205 }
206
207 // We allow the package to not have any serialno; and we also allow it to carry multiple serial
208 // numbers split by "|"; e.g. serialno=serialno1|serialno2|serialno3 ... We will fail the
209 // verification if the device's serialno doesn't match any of these carried numbers.
210 auto pkg_serial_no = get_value(metadata, "serialno");
211 if (!pkg_serial_no.empty()) {
212 auto device_serial_no = android::base::GetProperty("ro.serialno", "");
213 bool serial_number_match = false;
214 for (const auto& number : android::base::Split(pkg_serial_no, "|")) {
215 if (device_serial_no == android::base::Trim(number)) {
216 serial_number_match = true;
217 }
218 }
219 if (!serial_number_match) {
220 LOG(ERROR) << "Package is for serial " << pkg_serial_no;
221 return INSTALL_ERROR;
222 }
223 }
224
225 if (ota_type == OtaType::AB) {
226 return CheckAbSpecificMetadata(metadata);
227 }
228
229 return 0;
230}
231
Tao Baocf60a442018-06-18 14:56:20 -0700232int SetUpAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int status_fd,
Tao Bao00d57572017-05-02 15:48:54 -0700233 std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700234 CHECK(cmd != nullptr);
Alex Deymo4344d632016-08-03 21:03:53 -0700235
Tao Baobc4b1fe2017-04-17 16:46:05 -0700236 // For A/B updates we extract the payload properties to a buffer and obtain the RAW payload offset
237 // in the zip file.
238 static constexpr const char* AB_OTA_PAYLOAD_PROPERTIES = "payload_properties.txt";
239 ZipString property_name(AB_OTA_PAYLOAD_PROPERTIES);
240 ZipEntry properties_entry;
241 if (FindEntry(zip, property_name, &properties_entry) != 0) {
242 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD_PROPERTIES;
243 return INSTALL_CORRUPT;
244 }
245 uint32_t properties_entry_length = properties_entry.uncompressed_length;
246 std::vector<uint8_t> payload_properties(properties_entry_length);
247 int32_t err =
248 ExtractToMemory(zip, &properties_entry, payload_properties.data(), properties_entry_length);
249 if (err != 0) {
250 LOG(ERROR) << "Failed to extract " << AB_OTA_PAYLOAD_PROPERTIES << ": " << ErrorCodeString(err);
251 return INSTALL_CORRUPT;
252 }
Alex Deymo4344d632016-08-03 21:03:53 -0700253
Tao Baobc4b1fe2017-04-17 16:46:05 -0700254 static constexpr const char* AB_OTA_PAYLOAD = "payload.bin";
255 ZipString payload_name(AB_OTA_PAYLOAD);
256 ZipEntry payload_entry;
257 if (FindEntry(zip, payload_name, &payload_entry) != 0) {
258 LOG(ERROR) << "Failed to find " << AB_OTA_PAYLOAD;
259 return INSTALL_CORRUPT;
260 }
261 long payload_offset = payload_entry.offset;
262 *cmd = {
Tao Bao2cc9bbb2018-08-14 12:34:46 -0700263 "/system/bin/update_engine_sideload",
Tao Bao00d57572017-05-02 15:48:54 -0700264 "--payload=file://" + package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700265 android::base::StringPrintf("--offset=%ld", payload_offset),
266 "--headers=" + std::string(payload_properties.begin(), payload_properties.end()),
267 android::base::StringPrintf("--status_fd=%d", status_fd),
268 };
269 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700270}
271
Tao Baocf60a442018-06-18 14:56:20 -0700272int SetUpNonAbUpdateCommands(const std::string& package, ZipArchiveHandle zip, int retry_count,
273 int status_fd, std::vector<std::string>* cmd) {
Tao Baobc4b1fe2017-04-17 16:46:05 -0700274 CHECK(cmd != nullptr);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700275
Tao Baocf60a442018-06-18 14:56:20 -0700276 // In non-A/B updates we extract the update binary from the package.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700277 static constexpr const char* UPDATE_BINARY_NAME = "META-INF/com/google/android/update-binary";
278 ZipString binary_name(UPDATE_BINARY_NAME);
279 ZipEntry binary_entry;
280 if (FindEntry(zip, binary_name, &binary_entry) != 0) {
281 LOG(ERROR) << "Failed to find update binary " << UPDATE_BINARY_NAME;
282 return INSTALL_CORRUPT;
283 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700284
Tao Baocf60a442018-06-18 14:56:20 -0700285 const std::string binary_path = Paths::Get().temporary_update_binary();
Tao Bao00d57572017-05-02 15:48:54 -0700286 unlink(binary_path.c_str());
Tao Baocf60a442018-06-18 14:56:20 -0700287 android::base::unique_fd fd(
288 open(binary_path.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0755));
Tao Baobc4b1fe2017-04-17 16:46:05 -0700289 if (fd == -1) {
Tao Bao00d57572017-05-02 15:48:54 -0700290 PLOG(ERROR) << "Failed to create " << binary_path;
Tao Baobc4b1fe2017-04-17 16:46:05 -0700291 return INSTALL_ERROR;
292 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700293
Tao Baobc4b1fe2017-04-17 16:46:05 -0700294 int32_t error = ExtractEntryToFile(zip, &binary_entry, fd);
Tao Baobc4b1fe2017-04-17 16:46:05 -0700295 if (error != 0) {
296 LOG(ERROR) << "Failed to extract " << UPDATE_BINARY_NAME << ": " << ErrorCodeString(error);
297 return INSTALL_ERROR;
298 }
299
Tao Bao6fcd2082019-01-16 09:29:17 -0800300 // When executing the update binary contained in the package, the arguments passed are:
301 // - the version number for this interface
302 // - an FD to which the program can write in order to update the progress bar.
303 // - the name of the package zip file.
304 // - an optional argument "retry" if this update is a retry of a failed update attempt.
Tao Baobc4b1fe2017-04-17 16:46:05 -0700305 *cmd = {
Tao Bao00d57572017-05-02 15:48:54 -0700306 binary_path,
Tao Baobd0ddcd2017-05-04 13:03:18 -0700307 std::to_string(kRecoveryApiVersion),
Tao Baobc4b1fe2017-04-17 16:46:05 -0700308 std::to_string(status_fd),
Tao Bao00d57572017-05-02 15:48:54 -0700309 package,
Tao Baobc4b1fe2017-04-17 16:46:05 -0700310 };
311 if (retry_count > 0) {
312 cmd->push_back("retry");
313 }
314 return 0;
Alex Deymo4344d632016-08-03 21:03:53 -0700315}
Alex Deymo4344d632016-08-03 21:03:53 -0700316
Tianjie Xu37957102017-06-07 17:59:55 -0700317static void log_max_temperature(int* max_temperature, const std::atomic<bool>& logger_finished) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700318 CHECK(max_temperature != nullptr);
319 std::mutex mtx;
320 std::unique_lock<std::mutex> lck(mtx);
Tianjie Xu37957102017-06-07 17:59:55 -0700321 while (!logger_finished.load() &&
322 finish_log_temperature.wait_for(lck, 20s) == std::cv_status::timeout) {
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700323 *max_temperature = std::max(*max_temperature, GetMaxValueFromThermalZone());
324 }
325}
326
Alex Deymo4344d632016-08-03 21:03:53 -0700327// If the package contains an update binary, extract it and run it.
Tao Bao00d57572017-05-02 15:48:54 -0700328static int try_update_binary(const std::string& package, ZipArchiveHandle zip, bool* wipe_cache,
Tao Bao29ee69b2017-05-01 12:23:17 -0700329 std::vector<std::string>* log_buffer, int retry_count,
xunchang24788852019-03-22 16:08:52 -0700330 int* max_temperature, RecoveryUI* ui) {
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700331 std::map<std::string, std::string> metadata;
332 if (!ReadMetadataFromPackage(zip, &metadata)) {
333 LOG(ERROR) << "Failed to parse metadata in the zip file";
334 return INSTALL_CORRUPT;
335 }
336
337 bool is_ab = android::base::GetBoolProperty("ro.build.ab_update", false);
338 // Verifies against the metadata in the package first.
339 if (int check_status = is_ab ? CheckPackageMetadata(metadata, OtaType::AB) : 0;
340 check_status != 0) {
341 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
342 return check_status;
343 }
344
345 ReadSourceTargetBuild(metadata, log_buffer);
Alex Deymo4344d632016-08-03 21:03:53 -0700346
Tao Bao6fcd2082019-01-16 09:29:17 -0800347 // The updater in child process writes to the pipe to communicate with recovery.
348 android::base::unique_fd pipe_read, pipe_write;
Bill Peckham08ba1ad2019-03-28 18:42:13 -0700349 // Explicitly disable O_CLOEXEC using 0 as the flags (last) parameter to Pipe
350 // so that the child updater process will recieve a non-closed fd.
351 if (!android::base::Pipe(&pipe_read, &pipe_write, 0)) {
Tao Bao6fcd2082019-01-16 09:29:17 -0800352 PLOG(ERROR) << "Failed to create pipe for updater-recovery communication";
353 return INSTALL_CORRUPT;
354 }
355
356 // The updater-recovery communication protocol.
357 //
358 // progress <frac> <secs>
359 // fill up the next <frac> part of of the progress bar over <secs> seconds. If <secs> is
360 // zero, use `set_progress` commands to manually control the progress of this segment of the
361 // bar.
362 //
363 // set_progress <frac>
364 // <frac> should be between 0.0 and 1.0; sets the progress bar within the segment defined by
365 // the most recent progress command.
366 //
367 // ui_print <string>
368 // display <string> on the screen.
369 //
370 // wipe_cache
371 // a wipe of cache will be performed following a successful installation.
372 //
373 // clear_display
374 // turn off the text display.
375 //
376 // enable_reboot
377 // packages can explicitly request that they want the user to be able to reboot during
378 // installation (useful for debugging packages that don't exit).
379 //
380 // retry_update
381 // updater encounters some issue during the update. It requests a reboot to retry the same
382 // package automatically.
383 //
384 // log <string>
385 // updater requests logging the string (e.g. cause of the failure).
386 //
387
Tao Bao20c581e2016-12-28 20:55:51 -0800388 std::vector<std::string> args;
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700389 if (int update_status =
Tao Bao6fcd2082019-01-16 09:29:17 -0800390 is_ab ? SetUpAbUpdateCommands(package, zip, pipe_write.get(), &args)
391 : SetUpNonAbUpdateCommands(package, zip, retry_count, pipe_write.get(), &args);
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700392 update_status != 0) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700393 log_buffer->push_back(android::base::StringPrintf("error: %d", kUpdateBinaryCommandFailure));
Tianjie Xu93b5bf22018-10-25 10:39:01 -0700394 return update_status;
Tao Bao20c581e2016-12-28 20:55:51 -0800395 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700396
Tao Bao20c581e2016-12-28 20:55:51 -0800397 pid_t pid = fork();
Tao Bao20c581e2016-12-28 20:55:51 -0800398 if (pid == -1) {
Tao Bao20c581e2016-12-28 20:55:51 -0800399 PLOG(ERROR) << "Failed to fork update binary";
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700400 log_buffer->push_back(android::base::StringPrintf("error: %d", kForkUpdateBinaryFailure));
Tao Bao20c581e2016-12-28 20:55:51 -0800401 return INSTALL_ERROR;
402 }
403
404 if (pid == 0) {
405 umask(022);
Tao Bao6fcd2082019-01-16 09:29:17 -0800406 pipe_read.reset();
407
408 // Convert the std::string vector to a NULL-terminated char* vector suitable for execv.
409 auto chr_args = StringVectorToNullTerminatedArray(args);
Tao Bao3d69f0d2018-12-20 09:44:06 -0800410 execv(chr_args[0], chr_args.data());
Tao Bao6fcd2082019-01-16 09:29:17 -0800411 // We shouldn't use LOG/PLOG in the forked process, since they may cause the child process to
412 // hang. This deadlock results from an improperly copied mutex in the ui functions.
413 // (Bug: 34769056)
Tianjie Xuab1abae2017-01-30 16:48:52 -0800414 fprintf(stdout, "E:Can't run %s (%s)\n", chr_args[0], strerror(errno));
Tao Bao3da88012017-02-03 13:09:23 -0800415 _exit(EXIT_FAILURE);
Tao Bao20c581e2016-12-28 20:55:51 -0800416 }
Tao Bao6fcd2082019-01-16 09:29:17 -0800417 pipe_write.reset();
Tao Bao20c581e2016-12-28 20:55:51 -0800418
Tianjie Xu37957102017-06-07 17:59:55 -0700419 std::atomic<bool> logger_finished(false);
420 std::thread temperature_logger(log_max_temperature, max_temperature, std::ref(logger_finished));
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700421
Tao Bao20c581e2016-12-28 20:55:51 -0800422 *wipe_cache = false;
423 bool retry_update = false;
424
425 char buffer[1024];
Tao Bao6fcd2082019-01-16 09:29:17 -0800426 FILE* from_child = android::base::Fdopen(std::move(pipe_read), "r");
Tao Bao20c581e2016-12-28 20:55:51 -0800427 while (fgets(buffer, sizeof(buffer), from_child) != nullptr) {
428 std::string line(buffer);
429 size_t space = line.find_first_of(" \n");
430 std::string command(line.substr(0, space));
431 if (command.empty()) continue;
432
433 // Get rid of the leading and trailing space and/or newline.
434 std::string args = space == std::string::npos ? "" : android::base::Trim(line.substr(space));
435
436 if (command == "progress") {
437 std::vector<std::string> tokens = android::base::Split(args, " ");
438 double fraction;
439 int seconds;
440 if (tokens.size() == 2 && android::base::ParseDouble(tokens[0].c_str(), &fraction) &&
441 android::base::ParseInt(tokens[1], &seconds)) {
442 ui->ShowProgress(fraction * (1 - VERIFICATION_PROGRESS_FRACTION), seconds);
443 } else {
444 LOG(ERROR) << "invalid \"progress\" parameters: " << line;
445 }
446 } else if (command == "set_progress") {
447 std::vector<std::string> tokens = android::base::Split(args, " ");
448 double fraction;
449 if (tokens.size() == 1 && android::base::ParseDouble(tokens[0].c_str(), &fraction)) {
450 ui->SetProgress(fraction);
451 } else {
452 LOG(ERROR) << "invalid \"set_progress\" parameters: " << line;
453 }
454 } else if (command == "ui_print") {
Tao Baof0136422017-01-21 13:03:25 -0800455 ui->PrintOnScreenOnly("%s\n", args.c_str());
Tao Bao20c581e2016-12-28 20:55:51 -0800456 fflush(stdout);
457 } else if (command == "wipe_cache") {
458 *wipe_cache = true;
459 } else if (command == "clear_display") {
460 ui->SetBackground(RecoveryUI::NONE);
461 } else if (command == "enable_reboot") {
462 // packages can explicitly request that they want the user
463 // to be able to reboot during installation (useful for
464 // debugging packages that don't exit).
465 ui->SetEnableReboot(true);
466 } else if (command == "retry_update") {
467 retry_update = true;
468 } else if (command == "log") {
469 if (!args.empty()) {
470 // Save the logging request from updater and write to last_install later.
Tao Bao29ee69b2017-05-01 12:23:17 -0700471 log_buffer->push_back(args);
Tao Bao20c581e2016-12-28 20:55:51 -0800472 } else {
473 LOG(ERROR) << "invalid \"log\" parameters: " << line;
474 }
475 } else {
476 LOG(ERROR) << "unknown command [" << command << "]";
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700477 }
Tao Bao20c581e2016-12-28 20:55:51 -0800478 }
479 fclose(from_child);
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700480
Tao Bao20c581e2016-12-28 20:55:51 -0800481 int status;
482 waitpid(pid, &status, 0);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700483
Tianjie Xu37957102017-06-07 17:59:55 -0700484 logger_finished.store(true);
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700485 finish_log_temperature.notify_one();
486 temperature_logger.join();
487
Tao Bao20c581e2016-12-28 20:55:51 -0800488 if (retry_update) {
489 return INSTALL_RETRY;
490 }
Tao Baoe7b775c2018-11-07 15:13:30 -0800491 if (WIFEXITED(status)) {
492 if (WEXITSTATUS(status) != EXIT_SUCCESS) {
493 LOG(ERROR) << "Error in " << package << " (status " << WEXITSTATUS(status) << ")";
494 return INSTALL_ERROR;
495 }
496 } else if (WIFSIGNALED(status)) {
497 LOG(ERROR) << "Error in " << package << " (killed by signal " << WTERMSIG(status) << ")";
Tao Bao20c581e2016-12-28 20:55:51 -0800498 return INSTALL_ERROR;
Tao Baoe7b775c2018-11-07 15:13:30 -0800499 } else {
500 LOG(FATAL) << "Invalid status code " << status;
Tao Bao20c581e2016-12-28 20:55:51 -0800501 }
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700502
Tao Bao20c581e2016-12-28 20:55:51 -0800503 return INSTALL_SUCCESS;
Doug Zongkerb2ee9202009-06-04 10:24:53 -0700504}
505
Tao Bao1d866052017-04-10 16:55:57 -0700506// Verifes the compatibility info in a Treble-compatible package. Returns true directly if the
507// entry doesn't exist. Note that the compatibility info is packed in a zip file inside the OTA
508// package.
509bool verify_package_compatibility(ZipArchiveHandle package_zip) {
510 LOG(INFO) << "Verifying package compatibility...";
511
512 static constexpr const char* COMPATIBILITY_ZIP_ENTRY = "compatibility.zip";
513 ZipString compatibility_entry_name(COMPATIBILITY_ZIP_ENTRY);
514 ZipEntry compatibility_entry;
515 if (FindEntry(package_zip, compatibility_entry_name, &compatibility_entry) != 0) {
516 LOG(INFO) << "Package doesn't contain " << COMPATIBILITY_ZIP_ENTRY << " entry";
517 return true;
518 }
519
520 std::string zip_content(compatibility_entry.uncompressed_length, '\0');
521 int32_t ret;
522 if ((ret = ExtractToMemory(package_zip, &compatibility_entry,
523 reinterpret_cast<uint8_t*>(&zip_content[0]),
524 compatibility_entry.uncompressed_length)) != 0) {
525 LOG(ERROR) << "Failed to read " << COMPATIBILITY_ZIP_ENTRY << ": " << ErrorCodeString(ret);
526 return false;
527 }
528
529 ZipArchiveHandle zip_handle;
530 ret = OpenArchiveFromMemory(static_cast<void*>(const_cast<char*>(zip_content.data())),
531 zip_content.size(), COMPATIBILITY_ZIP_ENTRY, &zip_handle);
532 if (ret != 0) {
533 LOG(ERROR) << "Failed to OpenArchiveFromMemory: " << ErrorCodeString(ret);
534 return false;
535 }
536
537 // Iterate all the entries inside COMPATIBILITY_ZIP_ENTRY and read the contents.
538 void* cookie;
539 ret = StartIteration(zip_handle, &cookie, nullptr, nullptr);
540 if (ret != 0) {
541 LOG(ERROR) << "Failed to start iterating zip entries: " << ErrorCodeString(ret);
542 CloseArchive(zip_handle);
543 return false;
544 }
545 std::unique_ptr<void, decltype(&EndIteration)> guard(cookie, EndIteration);
546
547 std::vector<std::string> compatibility_info;
548 ZipEntry info_entry;
549 ZipString info_name;
550 while (Next(cookie, &info_entry, &info_name) == 0) {
551 std::string content(info_entry.uncompressed_length, '\0');
552 int32_t ret = ExtractToMemory(zip_handle, &info_entry, reinterpret_cast<uint8_t*>(&content[0]),
553 info_entry.uncompressed_length);
554 if (ret != 0) {
555 LOG(ERROR) << "Failed to read " << info_name.name << ": " << ErrorCodeString(ret);
556 CloseArchive(zip_handle);
557 return false;
558 }
559 compatibility_info.emplace_back(std::move(content));
560 }
Tao Bao1d866052017-04-10 16:55:57 -0700561 CloseArchive(zip_handle);
562
Tao Bao919d2c92017-04-10 16:55:57 -0700563 // VintfObjectRecovery::CheckCompatibility returns zero on success.
564 std::string err;
565 int result = android::vintf::VintfObjectRecovery::CheckCompatibility(compatibility_info, &err);
566 if (result == 0) {
567 return true;
568 }
569
570 LOG(ERROR) << "Failed to verify package compatibility (result " << result << "): " << err;
571 return false;
Tao Bao1d866052017-04-10 16:55:57 -0700572}
573
Tao Bao29ee69b2017-05-01 12:23:17 -0700574static int really_install_package(const std::string& path, bool* wipe_cache, bool needs_mount,
575 std::vector<std::string>* log_buffer, int retry_count,
xunchang24788852019-03-22 16:08:52 -0700576 int* max_temperature, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700577 ui->SetBackground(RecoveryUI::INSTALLING_UPDATE);
578 ui->Print("Finding update package...\n");
579 // Give verification half the progress bar...
580 ui->SetProgressType(RecoveryUI::DETERMINATE);
581 ui->ShowProgress(VERIFICATION_PROGRESS_FRACTION, VERIFICATION_PROGRESS_TIME);
582 LOG(INFO) << "Update location: " << path;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800583
Tao Bao29ee69b2017-05-01 12:23:17 -0700584 // Map the update package into memory.
585 ui->Print("Opening update package...\n");
Doug Zongker99916f02014-01-13 14:16:58 -0800586
Tao Bao29ee69b2017-05-01 12:23:17 -0700587 if (needs_mount) {
588 if (path[0] == '@') {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800589 ensure_path_mounted(path.substr(1));
Tao Bao29ee69b2017-05-01 12:23:17 -0700590 } else {
Yifan Hongd81b8e32018-12-17 14:29:06 -0800591 ensure_path_mounted(path);
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800592 }
Tao Bao29ee69b2017-05-01 12:23:17 -0700593 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800594
xunchangf07ed2e2019-02-25 14:14:01 -0800595 auto package = Package::CreateMemoryPackage(
596 path, std::bind(&RecoveryUI::SetProgress, ui, std::placeholders::_1));
597 if (!package) {
Tianjie Xu3fec8c62017-08-23 00:18:07 -0700598 log_buffer->push_back(android::base::StringPrintf("error: %d", kMapFileFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700599 return INSTALL_CORRUPT;
600 }
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800601
Tao Bao29ee69b2017-05-01 12:23:17 -0700602 // Verify package.
xunchang24788852019-03-22 16:08:52 -0700603 if (!verify_package(package.get(), ui)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700604 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipVerificationFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700605 return INSTALL_CORRUPT;
606 }
Doug Zongker60151a22009-08-12 18:30:03 -0700607
Tao Bao29ee69b2017-05-01 12:23:17 -0700608 // Try to open the package.
xunchangf07ed2e2019-02-25 14:14:01 -0800609 ZipArchiveHandle zip = package->GetZipArchiveHandle();
610 if (!zip) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700611 log_buffer->push_back(android::base::StringPrintf("error: %d", kZipOpenFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700612 return INSTALL_CORRUPT;
613 }
614
Tao Bao032403f2019-03-18 13:22:50 -0700615 // Additionally verify the compatibility of the package if it's a fresh install.
616 if (retry_count == 0 && !verify_package_compatibility(zip)) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700617 log_buffer->push_back(android::base::StringPrintf("error: %d", kPackageCompatibilityFailure));
Tao Bao29ee69b2017-05-01 12:23:17 -0700618 return INSTALL_CORRUPT;
619 }
620
621 // Verify and install the contents of the package.
622 ui->Print("Installing update...\n");
623 if (retry_count > 0) {
624 ui->Print("Retry attempt: %d\n", retry_count);
625 }
626 ui->SetEnableReboot(false);
xunchang24788852019-03-22 16:08:52 -0700627 int result =
628 try_update_binary(path, zip, wipe_cache, log_buffer, retry_count, max_temperature, ui);
Tao Bao29ee69b2017-05-01 12:23:17 -0700629 ui->SetEnableReboot(true);
630 ui->Print("\n");
631
Tao Bao29ee69b2017-05-01 12:23:17 -0700632 return result;
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -0800633}
Doug Zongker469243e2011-04-12 09:28:10 -0700634
xunchang316e9712019-04-12 16:22:15 -0700635int install_package(const std::string& path, bool should_wipe_cache, bool needs_mount,
636 int retry_count, RecoveryUI* ui) {
Tao Bao29ee69b2017-05-01 12:23:17 -0700637 CHECK(!path.empty());
Tao Bao29ee69b2017-05-01 12:23:17 -0700638
Tao Baof8119fb2017-04-18 21:35:12 -0700639 auto start = std::chrono::system_clock::now();
Tao Bao682c34b2015-04-07 17:16:35 -0700640
Tao Baof8119fb2017-04-18 21:35:12 -0700641 int start_temperature = GetMaxValueFromThermalZone();
642 int max_temperature = start_temperature;
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700643
Tao Baof8119fb2017-04-18 21:35:12 -0700644 int result;
645 std::vector<std::string> log_buffer;
646 if (setup_install_mounts() != 0) {
647 LOG(ERROR) << "failed to set up expected mounts for install; aborting";
648 result = INSTALL_ERROR;
649 } else {
xunchang316e9712019-04-12 16:22:15 -0700650 bool updater_wipe_cache = false;
651 result = really_install_package(path, &updater_wipe_cache, needs_mount, &log_buffer,
652 retry_count, &max_temperature, ui);
653 should_wipe_cache = should_wipe_cache || updater_wipe_cache;
Tao Baof8119fb2017-04-18 21:35:12 -0700654 }
655
656 // Measure the time spent to apply OTA update in seconds.
657 std::chrono::duration<double> duration = std::chrono::system_clock::now() - start;
658 int time_total = static_cast<int>(duration.count());
659
Tao Bao3e18f2b2017-09-29 17:11:13 -0700660 bool has_cache = volume_for_mount_point("/cache") != nullptr;
Tao Baof8119fb2017-04-18 21:35:12 -0700661 // Skip logging the uncrypt_status on devices without /cache.
662 if (has_cache) {
663 static constexpr const char* UNCRYPT_STATUS = "/cache/recovery/uncrypt_status";
664 if (ensure_path_mounted(UNCRYPT_STATUS) != 0) {
665 LOG(WARNING) << "Can't mount " << UNCRYPT_STATUS;
Doug Zongker239ac6a2013-08-20 16:03:25 -0700666 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700667 std::string uncrypt_status;
668 if (!android::base::ReadFileToString(UNCRYPT_STATUS, &uncrypt_status)) {
669 PLOG(WARNING) << "failed to read uncrypt status";
670 } else if (!android::base::StartsWith(uncrypt_status, "uncrypt_")) {
671 LOG(WARNING) << "corrupted uncrypt_status: " << uncrypt_status;
Tianjie Xua2867782017-03-24 14:13:56 -0700672 } else {
Tao Baof8119fb2017-04-18 21:35:12 -0700673 log_buffer.push_back(android::base::Trim(uncrypt_status));
Tianjie Xua2867782017-03-24 14:13:56 -0700674 }
Doug Zongker469243e2011-04-12 09:28:10 -0700675 }
Tao Baof8119fb2017-04-18 21:35:12 -0700676 }
Tao Baobadaac42016-09-26 11:39:14 -0700677
Tao Baof8119fb2017-04-18 21:35:12 -0700678 // The first two lines need to be the package name and install result.
679 std::vector<std::string> log_header = {
680 path,
681 result == INSTALL_SUCCESS ? "1" : "0",
682 "time_total: " + std::to_string(time_total),
683 "retry: " + std::to_string(retry_count),
684 };
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700685
Tao Baof8119fb2017-04-18 21:35:12 -0700686 int end_temperature = GetMaxValueFromThermalZone();
687 max_temperature = std::max(end_temperature, max_temperature);
688 if (start_temperature > 0) {
689 log_buffer.push_back("temperature_start: " + std::to_string(start_temperature));
690 }
691 if (end_temperature > 0) {
692 log_buffer.push_back("temperature_end: " + std::to_string(end_temperature));
693 }
694 if (max_temperature > 0) {
695 log_buffer.push_back("temperature_max: " + std::to_string(max_temperature));
696 }
Tianjie Xu3ee2b9d2017-03-27 14:12:26 -0700697
Tao Baof8119fb2017-04-18 21:35:12 -0700698 std::string log_content =
699 android::base::Join(log_header, "\n") + "\n" + android::base::Join(log_buffer, "\n") + "\n";
Tao Bao641fa972018-04-25 18:59:40 -0700700 const std::string& install_file = Paths::Get().temporary_install_file();
Tao Baof8119fb2017-04-18 21:35:12 -0700701 if (!android::base::WriteStringToFile(log_content, install_file)) {
702 PLOG(ERROR) << "failed to write " << install_file;
703 }
Tao Baobadaac42016-09-26 11:39:14 -0700704
Tao Baof8119fb2017-04-18 21:35:12 -0700705 // Write a copy into last_log.
706 LOG(INFO) << log_content;
Tao Baobadaac42016-09-26 11:39:14 -0700707
xunchang316e9712019-04-12 16:22:15 -0700708 if (result == INSTALL_SUCCESS && should_wipe_cache) {
709 if (!WipeCache(ui, nullptr)) {
710 result = INSTALL_ERROR;
711 }
712 }
713
Tao Baof8119fb2017-04-18 21:35:12 -0700714 return result;
Doug Zongker469243e2011-04-12 09:28:10 -0700715}
Yabin Cui6faf0262016-06-09 14:09:39 -0700716
xunchang24788852019-03-22 16:08:52 -0700717bool verify_package(Package* package, RecoveryUI* ui) {
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700718 static constexpr const char* CERTIFICATE_ZIP_FILE = "/system/etc/security/otacerts.zip";
719 std::vector<Certificate> loaded_keys = LoadKeysFromZipfile(CERTIFICATE_ZIP_FILE);
720 if (loaded_keys.empty()) {
Tao Bao5e535012017-03-16 17:37:38 -0700721 LOG(ERROR) << "Failed to load keys";
722 return false;
723 }
Tianjie Xue1d02fb2018-10-19 15:52:17 -0700724 LOG(INFO) << loaded_keys.size() << " key(s) loaded from " << CERTIFICATE_ZIP_FILE;
Yabin Cui6faf0262016-06-09 14:09:39 -0700725
Tao Bao5e535012017-03-16 17:37:38 -0700726 // Verify package.
727 ui->Print("Verifying update package...\n");
728 auto t0 = std::chrono::system_clock::now();
xunchangf07ed2e2019-02-25 14:14:01 -0800729 int err = verify_file(package, loaded_keys);
Tao Bao5e535012017-03-16 17:37:38 -0700730 std::chrono::duration<double> duration = std::chrono::system_clock::now() - t0;
731 ui->Print("Update package verification took %.1f s (result %d).\n", duration.count(), err);
732 if (err != VERIFY_SUCCESS) {
733 LOG(ERROR) << "Signature verification failed";
734 LOG(ERROR) << "error: " << kZipVerificationFailure;
735 return false;
736 }
737 return true;
Yabin Cui6faf0262016-06-09 14:09:39 -0700738}