blob: e52f26aaca6270db507cfab0c8d3ea863ccdf8bf [file] [log] [blame]
Alex Deymo5e3ea272016-01-28 13:42:23 -08001//
2// Copyright (C) 2016 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
Amin Hassaniec7bc112020-10-29 16:47:58 -070017#include "update_engine/aosp/update_attempter_android.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080018
19#include <algorithm>
Alex Deymo218397f2016-02-04 23:55:10 -080020#include <map>
Tianjie Xu90aaa102017-10-10 17:39:03 -070021#include <memory>
Kelvin Zhanga43d6e82021-05-26 10:14:42 -040022#include <ostream>
Alex Deymo5e3ea272016-01-28 13:42:23 -080023#include <utility>
Daniel Zhengda4f7292022-09-02 22:59:32 +000024#include <vector>
Alex Deymo5e3ea272016-01-28 13:42:23 -080025
Tianjie Xu90aaa102017-10-10 17:39:03 -070026#include <android-base/properties.h>
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090027#include <android-base/unique_fd.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080028#include <base/bind.h>
29#include <base/logging.h>
Alex Deymo218397f2016-02-04 23:55:10 -080030#include <base/strings/string_number_conversions.h>
Sen Jiang2703ef42017-03-16 13:36:21 -070031#include <brillo/data_encoding.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080032#include <brillo/message_loops/message_loop.h>
Alex Deymo218397f2016-02-04 23:55:10 -080033#include <brillo/strings/string_utils.h>
Sen Jiangacbdd1c2017-10-19 13:30:19 -070034#include <log/log_safetynet.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080035
Amin Hassaniec7bc112020-10-29 16:47:58 -070036#include "update_engine/aosp/cleanup_previous_update_action.h"
Daniel Zhengda4f7292022-09-02 22:59:32 +000037#include "update_engine/common/clock.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080038#include "update_engine/common/constants.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070039#include "update_engine/common/daemon_state_interface.h"
40#include "update_engine/common/download_action.h"
Kelvin Zhangf8441982022-12-07 18:18:47 -080041#include "update_engine/common/error_code.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080042#include "update_engine/common/error_code_utils.h"
Alex Deymo2c131bb2016-05-26 16:43:13 -070043#include "update_engine/common/file_fetcher.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070044#include "update_engine/common/metrics_reporter_interface.h"
45#include "update_engine/common/network_selector.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080046#include "update_engine/common/utils.h"
Tianjie Xu1b661142017-09-28 14:03:42 -070047#include "update_engine/metrics_utils.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080048#include "update_engine/payload_consumer/delta_performer.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080049#include "update_engine/payload_consumer/file_descriptor.h"
50#include "update_engine/payload_consumer/file_descriptor_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080051#include "update_engine/payload_consumer/filesystem_verifier_action.h"
Kelvin Zhangcfc531f2022-08-24 17:58:53 +000052#include "update_engine/payload_consumer/partition_writer.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080053#include "update_engine/payload_consumer/payload_constants.h"
54#include "update_engine/payload_consumer/payload_metadata.h"
Tianjie Xu7a78d632019-10-08 16:32:39 -070055#include "update_engine/payload_consumer/payload_verifier.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080056#include "update_engine/payload_consumer/postinstall_runner_action.h"
Amin Hassani667cf7b2018-07-25 14:32:00 -070057#include "update_engine/update_boot_flags_action.h"
Kelvin Zhangf92fe252023-03-28 10:55:47 -070058#include "update_engine/update_status.h"
Alex Deymo3b678db2016-02-09 11:50:06 -080059#include "update_engine/update_status_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080060
Alex Deymo14c0da82016-07-20 16:45:45 -070061#ifndef _UE_SIDELOAD
62// Do not include support for external HTTP(s) urls when building
63// update_engine_sideload.
64#include "update_engine/libcurl_http_fetcher.h"
65#endif
66
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090067using android::base::unique_fd;
Alex Deymo5e3ea272016-01-28 13:42:23 -080068using base::Bind;
Tianjie Xu90aaa102017-10-10 17:39:03 -070069using base::Time;
Alex Deymo5e3ea272016-01-28 13:42:23 -080070using base::TimeDelta;
71using base::TimeTicks;
Alex Deymo5e3ea272016-01-28 13:42:23 -080072using std::string;
73using std::vector;
Aaron Wood7f92e2b2017-08-28 14:51:21 -070074using update_engine::UpdateEngineStatus;
Alex Deymo5e3ea272016-01-28 13:42:23 -080075
76namespace chromeos_update_engine {
77
78namespace {
79
Alex Deymo0d298542016-03-30 18:31:49 -070080// Minimum threshold to broadcast an status update in progress and time.
81const double kBroadcastThresholdProgress = 0.01; // 1%
82const int kBroadcastThresholdSeconds = 10;
83
Daniel Zheng92f7d172023-06-22 14:31:37 -070084// Log and set the error on the passed ErrorPtr.
85bool LogAndSetGenericError(Error* error,
86 int line_number,
87 const char* file_name,
88 const string& reason) {
89 LOG(ERROR) << "Replying with failure: " << file_name << " " << line_number
90 << ": " << reason;
91 error->line_number = line_number;
92 error->file_name = file_name;
93 error->message = reason;
94 error->error_code = ErrorCode::kError;
95 return false;
96}
Alex Deymo5e3ea272016-01-28 13:42:23 -080097
98// Log and set the error on the passed ErrorPtr.
Daniel Zheng92f7d172023-06-22 14:31:37 -070099bool LogAndSetError(Error* error,
100 int line_number,
101 const char* file_name,
102 const string& reason,
103 ErrorCode error_code) {
104 LOG(ERROR) << "Replying with failure: " << file_name << " " << line_number
105 << ": " << reason;
106 error->line_number = line_number;
107 error->file_name = file_name;
108 error->message = reason;
109 error->error_code = error_code;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800110 return false;
111}
112
Sen Jiangfe522822017-10-31 15:14:11 -0700113bool GetHeaderAsBool(const string& header, bool default_value) {
114 int value = 0;
115 if (base::StringToInt(header, &value) && (value == 0 || value == 1))
116 return value == 1;
117 return default_value;
118}
119
Yifan Hongbd47d622019-12-13 14:59:58 -0800120bool ParseKeyValuePairHeaders(const vector<string>& key_value_pair_headers,
121 std::map<string, string>* headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700122 Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800123 for (const string& key_value_pair : key_value_pair_headers) {
124 string key;
125 string value;
126 if (!brillo::string_utils::SplitAtFirst(
127 key_value_pair, "=", &key, &value, false)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700128 return LogAndSetGenericError(error,
129 __LINE__,
130 __FILE__,
131 "Passed invalid header: " + key_value_pair);
Yifan Hongbd47d622019-12-13 14:59:58 -0800132 }
133 if (!headers->emplace(key, value).second)
Daniel Zheng92f7d172023-06-22 14:31:37 -0700134 return LogAndSetGenericError(
135 error, __LINE__, __FILE__, "Passed repeated key: " + key);
Yifan Hongbd47d622019-12-13 14:59:58 -0800136 }
137 return true;
138}
139
140// Unique identifier for the payload. An empty string means that the payload
141// can't be resumed.
142string GetPayloadId(const std::map<string, string>& headers) {
143 return (headers.count(kPayloadPropertyFileHash)
144 ? headers.at(kPayloadPropertyFileHash)
145 : "") +
146 (headers.count(kPayloadPropertyMetadataHash)
147 ? headers.at(kPayloadPropertyMetadataHash)
148 : "");
149}
150
Kelvin Zhang13020502023-08-02 15:18:40 -0700151std::string GetCurrentBuildVersion() {
152 // Example: [ro.build.fingerprint]:
153 // [generic/aosp_cf_x86_64_phone/vsoc_x86_64:VanillaIceCream/AOSP.MAIN/user08011303:userdebug/test-keys]
154 return android::base::GetProperty("ro.build.fingerprint", "");
155}
156
Alex Deymo5e3ea272016-01-28 13:42:23 -0800157} // namespace
158
159UpdateAttempterAndroid::UpdateAttempterAndroid(
Alex Deymo03a4de72016-07-20 16:08:23 -0700160 DaemonStateInterface* daemon_state,
Alex Deymo5e3ea272016-01-28 13:42:23 -0800161 PrefsInterface* prefs,
162 BootControlInterface* boot_control,
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000163 HardwareInterface* hardware,
164 std::unique_ptr<ApexHandlerInterface> apex_handler)
Alex Deymo5e3ea272016-01-28 13:42:23 -0800165 : daemon_state_(daemon_state),
166 prefs_(prefs),
167 boot_control_(boot_control),
168 hardware_(hardware),
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000169 apex_handler_android_(std::move(apex_handler)),
Tianjie Xu1b661142017-09-28 14:03:42 -0700170 processor_(new ActionProcessor()),
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800171 clock_(new Clock()),
172 metric_bytes_downloaded_(kPrefsCurrentBytesDownloaded, prefs_),
173 metric_total_bytes_downloaded_(kPrefsTotalBytesDownloaded, prefs_) {
Yifan Hongc514f662021-02-04 11:18:43 -0800174 metrics_reporter_ = metrics::CreateMetricsReporter(
Kelvin Zhang9a5e3682021-03-29 12:58:48 -0400175 boot_control_->GetDynamicPartitionControl(), &install_plan_);
Alex Deymo87792ea2016-07-25 15:40:36 -0700176 network_selector_ = network::CreateNetworkSelector();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800177}
178
179UpdateAttempterAndroid::~UpdateAttempterAndroid() {
180 // Release ourselves as the ActionProcessor's delegate to prevent
181 // re-scheduling the updates due to the processing stopped.
182 processor_->set_delegate(nullptr);
183}
184
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400185[[nodiscard]] static bool DidSystemReboot(PrefsInterface* prefs) {
186 string boot_id;
187 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
188 string old_boot_id;
189 // If no previous boot id found, treat as a reboot and write boot ID.
190 if (!prefs->GetString(kPrefsBootId, &old_boot_id)) {
191 return true;
192 }
193 return old_boot_id != boot_id;
194}
195
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400196std::ostream& operator<<(std::ostream& out, OTAResult result) {
197 switch (result) {
198 case OTAResult::NOT_ATTEMPTED:
199 out << "OTAResult::NOT_ATTEMPTED";
200 break;
201 case OTAResult::ROLLED_BACK:
202 out << "OTAResult::ROLLED_BACK";
203 break;
204 case OTAResult::UPDATED_NEED_REBOOT:
205 out << "OTAResult::UPDATED_NEED_REBOOT";
206 break;
207 case OTAResult::OTA_SUCCESSFUL:
208 out << "OTAResult::OTA_SUCCESSFUL";
209 break;
210 }
211 return out;
212}
213
Alex Deymo5e3ea272016-01-28 13:42:23 -0800214void UpdateAttempterAndroid::Init() {
215 // In case of update_engine restart without a reboot we need to restore the
216 // reboot needed state.
Tianjie Xu90aaa102017-10-10 17:39:03 -0700217 if (UpdateCompletedOnThisBoot()) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400218 LOG(INFO) << "Updated installed but update_engine is restarted without "
219 "device reboot. Resuming old state.";
Alex Deymo0e061ae2016-02-09 17:49:03 -0800220 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700221 } else {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400222 const auto result = GetOTAUpdateResult();
223 LOG(INFO) << result;
Alex Deymo0e061ae2016-02-09 17:49:03 -0800224 SetStatusAndNotify(UpdateStatus::IDLE);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400225 if (DidSystemReboot(prefs_)) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400226 UpdateStateAfterReboot(result);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400227 }
228
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700229#ifdef _UE_SIDELOAD
230 LOG(INFO) << "Skip ScheduleCleanupPreviousUpdate in sideload because "
231 << "ApplyPayload will call it later.";
232#else
Yifan Hong90965502020-02-19 15:22:47 -0800233 ScheduleCleanupPreviousUpdate();
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700234#endif
Tianjie Xu90aaa102017-10-10 17:39:03 -0700235 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800236}
237
238bool UpdateAttempterAndroid::ApplyPayload(
239 const string& payload_url,
240 int64_t payload_offset,
241 int64_t payload_size,
242 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700243 Error* error) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800244 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700245 return LogAndSetGenericError(
246 error,
247 __LINE__,
248 __FILE__,
249 "An update already applied, waiting for reboot");
Alex Deymo5e3ea272016-01-28 13:42:23 -0800250 }
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700251 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700252 return LogAndSetGenericError(
253 error,
254 __LINE__,
255 __FILE__,
256 "Already processing an update, cancel it first.");
Alex Deymo5e3ea272016-01-28 13:42:23 -0800257 }
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100258 DCHECK_EQ(status_, UpdateStatus::IDLE);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800259
Alex Deymo218397f2016-02-04 23:55:10 -0800260 std::map<string, string> headers;
Yifan Hongbd47d622019-12-13 14:59:58 -0800261 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
262 return false;
Alex Deymo218397f2016-02-04 23:55:10 -0800263 }
264
Yifan Hongbd47d622019-12-13 14:59:58 -0800265 string payload_id = GetPayloadId(headers);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800266
267 // Setup the InstallPlan based on the request.
268 install_plan_ = InstallPlan();
269
270 install_plan_.download_url = payload_url;
271 install_plan_.version = "";
Alex Deymo0fd51ff2016-02-03 14:22:43 -0800272 base_offset_ = payload_offset;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800273 InstallPlan::Payload payload;
274 payload.size = payload_size;
275 if (!payload.size) {
Alex Deymo218397f2016-02-04 23:55:10 -0800276 if (!base::StringToUint64(headers[kPayloadPropertyFileSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800277 &payload.size)) {
278 payload.size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800279 }
280 }
Sen Jiang2703ef42017-03-16 13:36:21 -0700281 if (!brillo::data_encoding::Base64Decode(headers[kPayloadPropertyFileHash],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800282 &payload.hash)) {
Sen Jiang2703ef42017-03-16 13:36:21 -0700283 LOG(WARNING) << "Unable to decode base64 file hash: "
284 << headers[kPayloadPropertyFileHash];
285 }
Alex Deymo218397f2016-02-04 23:55:10 -0800286 if (!base::StringToUint64(headers[kPayloadPropertyMetadataSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800287 &payload.metadata_size)) {
288 payload.metadata_size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800289 }
Sen Jiangcdd52062017-05-18 15:33:10 -0700290 // The |payload.type| is not used anymore since minor_version 3.
291 payload.type = InstallPayloadType::kUnknown;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800292 install_plan_.payloads.push_back(payload);
293
Alex Deymo5e3ea272016-01-28 13:42:23 -0800294 // The |public_key_rsa| key would override the public key stored on disk.
295 install_plan_.public_key_rsa = "";
296
297 install_plan_.hash_checks_mandatory = hardware_->IsOfficialBuild();
298 install_plan_.is_resume = !payload_id.empty() &&
299 DeltaPerformer::CanResumeUpdate(prefs_, payload_id);
300 if (!install_plan_.is_resume) {
Kelvin Zhang42c2d552022-07-25 11:04:00 -0700301 boot_control_->GetDynamicPartitionControl()->Cleanup();
Kelvin Zhangc54c9962022-10-20 13:44:59 -0700302 boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_);
303
Alex Deymo5e3ea272016-01-28 13:42:23 -0800304 if (!prefs_->SetString(kPrefsUpdateCheckResponseHash, payload_id)) {
305 LOG(WARNING) << "Unable to save the update check response hash.";
306 }
307 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800308 install_plan_.source_slot = GetCurrentSlot();
309 install_plan_.target_slot = GetTargetSlot();
Alex Deymofb905d92016-06-03 19:26:58 -0700310
Alex Deymofb905d92016-06-03 19:26:58 -0700311 install_plan_.powerwash_required =
Sen Jiangfe522822017-10-31 15:14:11 -0700312 GetHeaderAsBool(headers[kPayloadPropertyPowerwash], false);
313
Daniel Zheng9fc62b82023-03-24 22:57:20 +0000314 if (!IsProductionBuild()) {
315 install_plan_.disable_vabc =
316 GetHeaderAsBool(headers[kPayloadDisableVABC], false);
317 }
318
Sen Jiangfe522822017-10-31 15:14:11 -0700319 install_plan_.switch_slot_on_reboot =
320 GetHeaderAsBool(headers[kPayloadPropertySwitchSlotOnReboot], true);
321
Tianjie Xu087de9d2019-11-01 17:11:22 -0700322 install_plan_.run_post_install =
323 GetHeaderAsBool(headers[kPayloadPropertyRunPostInstall], true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800324
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700325 // Skip writing verity if we're resuming and verity has already been written.
326 install_plan_.write_verity = true;
327 if (install_plan_.is_resume && prefs_->Exists(kPrefsVerityWritten)) {
328 bool verity_written = false;
329 if (prefs_->GetBoolean(kPrefsVerityWritten, &verity_written) &&
330 verity_written) {
331 install_plan_.write_verity = false;
332 }
333 }
334
Alex Deymo87792ea2016-07-25 15:40:36 -0700335 NetworkId network_id = kDefaultNetworkId;
336 if (!headers[kPayloadPropertyNetworkId].empty()) {
337 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
338 &network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700339 return LogAndSetGenericError(
Alex Deymo87792ea2016-07-25 15:40:36 -0700340 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700341 __LINE__,
342 __FILE__,
Alex Deymo87792ea2016-07-25 15:40:36 -0700343 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
344 }
345 if (!network_selector_->SetProcessNetwork(network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700346 return LogAndSetGenericError(
Sen Jiangcbd37c62017-09-12 15:04:35 -0700347 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700348 __LINE__,
349 __FILE__,
Sen Jiangcbd37c62017-09-12 15:04:35 -0700350 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700351 }
352 }
353
Alex Deymo5e3ea272016-01-28 13:42:23 -0800354 LOG(INFO) << "Using this install plan:";
355 install_plan_.Dump();
356
Amin Hassani667cf7b2018-07-25 14:32:00 -0700357 HttpFetcher* fetcher = nullptr;
358 if (FileFetcher::SupportedUrl(payload_url)) {
359 DLOG(INFO) << "Using FileFetcher for file URL.";
360 fetcher = new FileFetcher();
361 } else {
362#ifdef _UE_SIDELOAD
363 LOG(FATAL) << "Unsupported sideload URI: " << payload_url;
Chih-Hung Hsieh6e4f3452022-12-21 12:20:45 -0800364 return false; // NOLINT, unreached but analyzer might not know.
365 // Suppress warnings about null 'fetcher' after this.
Amin Hassani667cf7b2018-07-25 14:32:00 -0700366#else
Kelvin Zhangc7a1d1f2022-07-29 13:36:29 -0700367 LibcurlHttpFetcher* libcurl_fetcher = new LibcurlHttpFetcher(hardware_);
Kelvin Zhang3cc4fa32022-09-27 16:15:10 -0700368 if (!headers[kPayloadDownloadRetry].empty()) {
369 libcurl_fetcher->set_max_retry_count(
370 atoi(headers[kPayloadDownloadRetry].c_str()));
371 }
Amin Hassani667cf7b2018-07-25 14:32:00 -0700372 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
373 fetcher = libcurl_fetcher;
374#endif // _UE_SIDELOAD
375 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800376 // Setup extra headers.
Alex Deymofdd6dec2016-03-03 22:35:43 -0800377 if (!headers[kPayloadPropertyAuthorization].empty())
378 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
379 if (!headers[kPayloadPropertyUserAgent].empty())
380 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
381
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700382 if (!headers[kPayloadPropertyNetworkProxy].empty()) {
383 LOG(INFO) << "Using proxy url from payload headers: "
384 << headers[kPayloadPropertyNetworkProxy];
385 fetcher->SetProxies({headers[kPayloadPropertyNetworkProxy]});
386 }
Kelvin Zhanga7407b52023-03-13 15:05:14 -0700387 if (!headers[kPayloadVABCNone].empty()) {
388 install_plan_.vabc_none = true;
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000389 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800390 if (!headers[kPayloadEnableThreading].empty()) {
391 install_plan_.enable_threading = true;
392 }
393 if (!headers[kPayloadBatchedWrites].empty()) {
394 install_plan_.batched_writes = true;
395 }
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700396
Amin Hassani667cf7b2018-07-25 14:32:00 -0700397 BuildUpdateActions(fetcher);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800398
Alex Deymo5e3ea272016-01-28 13:42:23 -0800399 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700400
401 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
402 // TODO(xunchang) report the metrics for unresumable updates
403
Amin Hassani667cf7b2018-07-25 14:32:00 -0700404 ScheduleProcessingStart();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800405 return true;
406}
407
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900408bool UpdateAttempterAndroid::ApplyPayload(
409 int fd,
410 int64_t payload_offset,
411 int64_t payload_size,
412 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700413 Error* error) {
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100414 // update_engine state must be checked before modifying payload_fd_ otherwise
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +0000415 // already running update will be terminated (existing file descriptor will be
416 // closed)
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100417 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700418 return LogAndSetGenericError(
419 error,
420 __LINE__,
421 __FILE__,
422 "An update already applied, waiting for reboot");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100423 }
424 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700425 return LogAndSetGenericError(
426 error,
427 __LINE__,
428 __FILE__,
429 "Already processing an update, cancel it first.");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100430 }
431 DCHECK_EQ(status_, UpdateStatus::IDLE);
432
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900433 payload_fd_.reset(dup(fd));
434 const string payload_url = "fd://" + std::to_string(payload_fd_.get());
435
436 return ApplyPayload(
437 payload_url, payload_offset, payload_size, key_value_pair_headers, error);
438}
439
Daniel Zheng92f7d172023-06-22 14:31:37 -0700440bool UpdateAttempterAndroid::SuspendUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700441 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700442 return LogAndSetGenericError(
443 error, __LINE__, __FILE__, "No ongoing update to suspend.");
Alex Deymof2858572016-02-25 11:20:13 -0800444 processor_->SuspendProcessing();
445 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800446}
447
Daniel Zheng92f7d172023-06-22 14:31:37 -0700448bool UpdateAttempterAndroid::ResumeUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700449 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700450 return LogAndSetGenericError(
451 error, __LINE__, __FILE__, "No ongoing update to resume.");
Alex Deymof2858572016-02-25 11:20:13 -0800452 processor_->ResumeProcessing();
453 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800454}
455
Daniel Zheng92f7d172023-06-22 14:31:37 -0700456bool UpdateAttempterAndroid::CancelUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700457 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700458 return LogAndSetGenericError(
459 error, __LINE__, __FILE__, "No ongoing update to cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800460 processor_->StopProcessing();
461 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800462}
463
Daniel Zheng92f7d172023-06-22 14:31:37 -0700464bool UpdateAttempterAndroid::ResetStatus(Error* error) {
Alex Deymo3b678db2016-02-09 11:50:06 -0800465 LOG(INFO) << "Attempting to reset state from "
466 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700467 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700468 return LogAndSetGenericError(
469 error,
470 __LINE__,
471 __FILE__,
472 "Already processing an update, cancel it first.");
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700473 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700474 if (status_ != UpdateStatus::IDLE &&
475 status_ != UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700476 return LogAndSetGenericError(
477 error,
478 __LINE__,
479 __FILE__,
480 "Status reset not allowed in this state, please "
481 "cancel on going OTA first.");
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700482 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800483
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000484 if (apex_handler_android_ != nullptr) {
485 LOG(INFO) << "Cleaning up reserved space for compressed APEX (if any)";
486 std::vector<ApexInfo> apex_infos_blank;
487 apex_handler_android_->AllocateSpace(apex_infos_blank);
488 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400489 // Remove the reboot marker so that if the machine is rebooted
490 // after resetting to idle state, it doesn't go back to
491 // UpdateStatus::UPDATED_NEED_REBOOT state.
492 if (!ClearUpdateCompletedMarker()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700493 return LogAndSetGenericError(error,
494 __LINE__,
495 __FILE__,
496 "Failed to reset the status because "
497 "ClearUpdateCompletedMarker() failed");
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400498 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700499 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
500 if (!resetShouldSwitchSlotOnReboot(error)) {
501 LOG(INFO) << "Failed to reset slot switch.";
502 return false;
503 }
504 LOG(INFO) << "Slot switch reset successful";
505 }
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700506 if (!boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_)) {
507 LOG(WARNING) << "Failed to reset snapshots. UpdateStatus is IDLE but"
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000508 << "space might not be freed.";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700509 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700510 return true;
Alex Deymo3b678db2016-02-09 11:50:06 -0800511}
512
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700513bool operator==(const std::vector<unsigned char>& a, std::string_view b) {
514 if (a.size() != b.size()) {
515 return false;
516 }
517 return memcmp(a.data(), b.data(), a.size()) == 0;
518}
519bool operator!=(const std::vector<unsigned char>& a, std::string_view b) {
520 return !(a == b);
521}
522
Yifan Hongbd47d622019-12-13 14:59:58 -0800523bool UpdateAttempterAndroid::VerifyPayloadParseManifest(
524 const std::string& metadata_filename,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700525 std::string_view expected_metadata_hash,
Yifan Hongbd47d622019-12-13 14:59:58 -0800526 DeltaArchiveManifest* manifest,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700527 Error* error) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800528 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
529 if (!fd->Open(metadata_filename.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700530 return LogAndSetError(error,
531 __LINE__,
532 __FILE__,
533 "Failed to open " + metadata_filename,
534 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800535 }
536 brillo::Blob metadata(kMaxPayloadHeaderSize);
537 if (!fd->Read(metadata.data(), metadata.size())) {
538 return LogAndSetError(
539 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700540 __LINE__,
541 __FILE__,
542 "Failed to read payload header from " + metadata_filename,
543 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800544 }
Daniel Zhengda4f7292022-09-02 22:59:32 +0000545 ErrorCode errorcode{};
Sen Jiang8371c1c2018-02-01 13:46:39 -0800546 PayloadMetadata payload_metadata;
Sen Jiangf1236632018-05-11 16:03:23 -0700547 if (payload_metadata.ParsePayloadHeader(metadata, &errorcode) !=
Sen Jiang8371c1c2018-02-01 13:46:39 -0800548 MetadataParseResult::kSuccess) {
549 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700550 __LINE__,
551 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800552 "Failed to parse payload header: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700553 utils::ErrorCodeToString(errorcode),
554 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800555 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700556 uint64_t metadata_size = payload_metadata.GetMetadataSize() +
557 payload_metadata.GetMetadataSignatureSize();
558 if (metadata_size < kMaxPayloadHeaderSize ||
559 metadata_size >
560 static_cast<uint64_t>(utils::FileSize(metadata_filename))) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800561 return LogAndSetError(
562 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700563 __LINE__,
564 __FILE__,
565 "Invalid metadata size: " + std::to_string(metadata_size),
566 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800567 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700568 metadata.resize(metadata_size);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800569 if (!fd->Read(metadata.data() + kMaxPayloadHeaderSize,
570 metadata.size() - kMaxPayloadHeaderSize)) {
571 return LogAndSetError(
572 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700573 __LINE__,
574 __FILE__,
575 "Failed to read metadata and signature from " + metadata_filename,
576 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800577 }
578 fd->Close();
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700579 if (!expected_metadata_hash.empty()) {
580 brillo::Blob metadata_hash;
581 TEST_AND_RETURN_FALSE(HashCalculator::RawHashOfBytes(
582 metadata.data(), payload_metadata.GetMetadataSize(), &metadata_hash));
583 if (metadata_hash != expected_metadata_hash) {
584 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700585 __LINE__,
586 __FILE__,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700587 "Metadata hash mismatch. Expected hash: " +
588 HexEncode(expected_metadata_hash) +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700589 " actual hash: " + HexEncode(metadata_hash),
590 ErrorCode::kDownloadManifestParseError);
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700591 } else {
592 LOG(INFO) << "Payload metadata hash check passed : "
593 << HexEncode(metadata_hash);
594 }
595 }
Sen Jiang08c6da12019-01-07 18:28:56 -0800596
Tianjie Xu7a78d632019-10-08 16:32:39 -0700597 auto payload_verifier = PayloadVerifier::CreateInstanceFromZipPath(
598 constants::kUpdateCertificatesPath);
599 if (!payload_verifier) {
600 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700601 __LINE__,
602 __FILE__,
Tianjie Xu7a78d632019-10-08 16:32:39 -0700603 "Failed to create the payload verifier from " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700604 std::string(constants::kUpdateCertificatesPath),
605 ErrorCode::kDownloadManifestParseError);
Sen Jiang08c6da12019-01-07 18:28:56 -0800606 }
Tianjie Xu7a78d632019-10-08 16:32:39 -0700607 errorcode = payload_metadata.ValidateMetadataSignature(
608 metadata, "", *payload_verifier);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800609 if (errorcode != ErrorCode::kSuccess) {
610 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700611 __LINE__,
612 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800613 "Failed to validate metadata signature: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700614 utils::ErrorCodeToString(errorcode),
615 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800616 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800617 if (!payload_metadata.GetManifest(metadata, manifest)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700618 return LogAndSetError(error,
619 __LINE__,
620 __FILE__,
621 "Failed to parse manifest.",
622 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800623 }
624
Yifan Hongbd47d622019-12-13 14:59:58 -0800625 return true;
626}
627
628bool UpdateAttempterAndroid::VerifyPayloadApplicable(
Daniel Zheng92f7d172023-06-22 14:31:37 -0700629 const std::string& metadata_filename, Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800630 DeltaArchiveManifest manifest;
631 TEST_AND_RETURN_FALSE(
632 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
633
634 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
Daniel Zhengda4f7292022-09-02 22:59:32 +0000635 ErrorCode errorcode{};
Yifan Hongbd47d622019-12-13 14:59:58 -0800636
637 BootControlInterface::Slot current_slot = GetCurrentSlot();
Sen Jiang8371c1c2018-02-01 13:46:39 -0800638 for (const PartitionUpdate& partition : manifest.partitions()) {
639 if (!partition.has_old_partition_info())
640 continue;
641 string partition_path;
642 if (!boot_control_->GetPartitionDevice(
643 partition.partition_name(), current_slot, &partition_path)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700644 return LogAndSetGenericError(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800645 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700646 __LINE__,
647 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800648 "Failed to get partition device for " + partition.partition_name());
649 }
650 if (!fd->Open(partition_path.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700651 return LogAndSetGenericError(
652 error, __LINE__, __FILE__, "Failed to open " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800653 }
654 for (const InstallOperation& operation : partition.operations()) {
655 if (!operation.has_src_sha256_hash())
656 continue;
657 brillo::Blob source_hash;
658 if (!fd_utils::ReadAndHashExtents(fd,
659 operation.src_extents(),
660 manifest.block_size(),
661 &source_hash)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700662 return LogAndSetGenericError(
663 error, __LINE__, __FILE__, "Failed to hash " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800664 }
Kelvin Zhang9bd519d2020-09-23 12:55:19 -0400665 if (!PartitionWriter::ValidateSourceHash(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800666 source_hash, operation, fd, &errorcode)) {
667 return false;
668 }
669 }
670 fd->Close();
671 }
672 return true;
673}
674
Alex Deymo5e3ea272016-01-28 13:42:23 -0800675void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
676 ErrorCode code) {
677 LOG(INFO) << "Processing Done.";
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800678 metric_bytes_downloaded_.Flush(true);
679 metric_total_bytes_downloaded_.Flush(true);
Kelvin Zhangf8441982022-12-07 18:18:47 -0800680 last_error_ = code;
Yifan Hong90965502020-02-19 15:22:47 -0800681 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
682 TerminateUpdateAndNotify(code);
683 return;
684 }
685
Alex Deymo5990bf32016-07-19 17:01:41 -0700686 switch (code) {
687 case ErrorCode::kSuccess:
688 // Update succeeded.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400689 if (!WriteUpdateCompletedMarker()) {
690 LOG(ERROR) << "Failed to write update completion marker";
691 }
Alex Deymo5990bf32016-07-19 17:01:41 -0700692 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800693
Alex Deymo5990bf32016-07-19 17:01:41 -0700694 LOG(INFO) << "Update successfully applied, waiting to reboot.";
695 break;
696
697 case ErrorCode::kFilesystemCopierError:
698 case ErrorCode::kNewRootfsVerificationError:
699 case ErrorCode::kNewKernelVerificationError:
700 case ErrorCode::kFilesystemVerifierError:
701 case ErrorCode::kDownloadStateInitializationError:
702 // Reset the ongoing update for these errors so it starts from the
703 // beginning next time.
704 DeltaPerformer::ResetUpdateProgress(prefs_, false);
705 LOG(INFO) << "Resetting update progress.";
706 break;
707
Sen Jiangacbdd1c2017-10-19 13:30:19 -0700708 case ErrorCode::kPayloadTimestampError:
709 // SafetyNet logging, b/36232423
710 android_errorWriteLog(0x534e4554, "36232423");
711 break;
712
Alex Deymo5990bf32016-07-19 17:01:41 -0700713 default:
714 // Ignore all other error codes.
715 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700716 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800717
718 TerminateUpdateAndNotify(code);
719}
720
721void UpdateAttempterAndroid::ProcessingStopped(
722 const ActionProcessor* processor) {
723 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
724}
725
726void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
727 AbstractAction* action,
728 ErrorCode code) {
729 // Reset download progress regardless of whether or not the download
730 // action succeeded.
731 const string type = action->Type();
Yifan Hong40bb0d02020-02-24 17:33:14 -0800732 if (type == CleanupPreviousUpdateAction::StaticType() ||
733 (type == NoOpAction::StaticType() &&
734 status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE)) {
735 cleanup_previous_update_code_ = code;
736 NotifyCleanupPreviousUpdateCallbacksAndClear();
737 }
Kelvin Zhang70eef232020-06-12 20:32:40 +0000738 // download_progress_ is actually used by other actions, such as
739 // filesystem_verify_action. Therefore we always clear it.
740 download_progress_ = 0;
Sen Jiangfe522822017-10-31 15:14:11 -0700741 if (type == PostinstallRunnerAction::StaticType()) {
742 bool succeeded =
743 code == ErrorCode::kSuccess || code == ErrorCode::kUpdatedButNotActive;
744 prefs_->SetBoolean(kPrefsPostInstallSucceeded, succeeded);
745 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800746 if (code != ErrorCode::kSuccess) {
747 // If an action failed, the ActionProcessor will cancel the whole thing.
748 return;
749 }
Yifan Hong83517502020-02-19 15:34:13 -0800750 if (type == UpdateBootFlagsAction::StaticType()) {
751 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
752 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800753 if (type == DownloadAction::StaticType()) {
Kelvin Zhangd2da7b12020-07-07 17:19:21 -0400754 auto download_action = static_cast<DownloadAction*>(action);
755 install_plan_ = *download_action->install_plan();
Kelvin Zhang70eef232020-06-12 20:32:40 +0000756 SetStatusAndNotify(UpdateStatus::VERIFYING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700757 } else if (type == FilesystemVerifierAction::StaticType()) {
Kelvin Zhang70eef232020-06-12 20:32:40 +0000758 SetStatusAndNotify(UpdateStatus::FINALIZING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700759 prefs_->SetBoolean(kPrefsVerityWritten, true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800760 }
761}
762
763void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
764 uint64_t bytes_received,
765 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700766 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800767 if (total)
768 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700769 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800770 download_progress_ = progress;
771 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700772 } else {
773 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800774 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700775
776 // Update the bytes downloaded in prefs.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800777 metric_bytes_downloaded_ += bytes_progressed;
778 metric_total_bytes_downloaded_ += bytes_progressed;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800779}
780
781bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
782 // TODO(deymo): Notify the DownloadAction that it should cancel the update
783 // download.
784 return false;
785}
786
787void UpdateAttempterAndroid::DownloadComplete() {
788 // Nothing needs to be done when the download completes.
789}
790
Alex Deymo0d298542016-03-30 18:31:49 -0700791void UpdateAttempterAndroid::ProgressUpdate(double progress) {
792 // Self throttle based on progress. Also send notifications if progress is
793 // too slow.
794 if (progress == 1.0 ||
795 progress - download_progress_ >= kBroadcastThresholdProgress ||
796 TimeTicks::Now() - last_notify_time_ >=
797 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
798 download_progress_ = progress;
799 SetStatusAndNotify(status_);
800 }
801}
802
Kelvin Zhang70eef232020-06-12 20:32:40 +0000803void UpdateAttempterAndroid::OnVerifyProgressUpdate(double progress) {
804 assert(status_ == UpdateStatus::VERIFYING);
805 ProgressUpdate(progress);
806}
807
Alex Deymo5e3ea272016-01-28 13:42:23 -0800808void UpdateAttempterAndroid::ScheduleProcessingStart() {
809 LOG(INFO) << "Scheduling an action processor start.";
Kelvin Zhang20982a52021-08-13 12:31:16 -0700810 processor_->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800811 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700812 FROM_HERE,
813 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
814 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800815}
816
817void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
818 if (status_ == UpdateStatus::IDLE) {
819 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
820 return;
821 }
822
Yifan Hong90965502020-02-19 15:22:47 -0800823 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400824 ClearUpdateCompletedMarker();
Yifan Hong90965502020-02-19 15:22:47 -0800825 LOG(INFO) << "Terminating cleanup previous update.";
826 SetStatusAndNotify(UpdateStatus::IDLE);
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700827 for (auto observer : daemon_state_->service_observers())
828 observer->SendPayloadApplicationComplete(error_code);
Yifan Hong90965502020-02-19 15:22:47 -0800829 return;
830 }
831
Yifan Hong9194ce82019-11-07 11:03:42 -0800832 boot_control_->GetDynamicPartitionControl()->Cleanup();
Yifan Hong537802d2018-08-15 13:15:42 -0700833
Alex Deymo0d298542016-03-30 18:31:49 -0700834 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800835 UpdateStatus new_status =
836 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
837 : UpdateStatus::IDLE);
838 SetStatusAndNotify(new_status);
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900839 payload_fd_.reset();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800840
Sen Jiangb19c3ec2017-10-06 15:18:46 -0700841 // The network id is only applicable to one download attempt and once it's
842 // done the network id should not be re-used anymore.
843 if (!network_selector_->SetProcessNetwork(kDefaultNetworkId)) {
844 LOG(WARNING) << "Unable to unbind network.";
845 }
846
Alex Deymo5e3ea272016-01-28 13:42:23 -0800847 for (auto observer : daemon_state_->service_observers())
848 observer->SendPayloadApplicationComplete(error_code);
Tianjie Xu1b661142017-09-28 14:03:42 -0700849
Tianjie Xu90aaa102017-10-10 17:39:03 -0700850 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
851 ClearMetricsPrefs();
852 if (error_code == ErrorCode::kSuccess) {
xunchang9cf52622019-01-25 11:04:58 -0800853 // We should only reset the PayloadAttemptNumber if the update succeeds, or
854 // we switch to a different payload.
855 prefs_->Delete(kPrefsPayloadAttemptNumber);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700856 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700857 // Clear the total bytes downloaded if and only if the update succeeds.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800858 metric_total_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700859 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800860}
861
862void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
863 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700864 size_t payload_size =
865 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700866 UpdateEngineStatus status_to_send = {.status = status_,
867 .progress = download_progress_,
868 .new_size_bytes = payload_size};
869
Alex Deymo5e3ea272016-01-28 13:42:23 -0800870 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700871 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800872 }
873 last_notify_time_ = TimeTicks::Now();
874}
875
Amin Hassani667cf7b2018-07-25 14:32:00 -0700876void UpdateAttempterAndroid::BuildUpdateActions(HttpFetcher* fetcher) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800877 CHECK(!processor_->IsRunning());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800878
879 // Actions:
Amin Hassani667cf7b2018-07-25 14:32:00 -0700880 auto update_boot_flags_action =
881 std::make_unique<UpdateBootFlagsAction>(boot_control_);
Yifan Hong83517502020-02-19 15:34:13 -0800882 auto cleanup_previous_update_action =
883 boot_control_->GetDynamicPartitionControl()
884 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
Amin Hassani667cf7b2018-07-25 14:32:00 -0700885 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
886 auto download_action =
887 std::make_unique<DownloadAction>(prefs_,
888 boot_control_,
889 hardware_,
Amin Hassani667cf7b2018-07-25 14:32:00 -0700890 fetcher, // passes ownership
Kelvin Zhang1304fe72021-10-06 19:12:12 -0700891 true /* interactive */,
892 update_certificates_path_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800893 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700894 download_action->set_base_offset(base_offset_);
Tianjie24f96092020-06-30 12:26:25 -0700895 auto filesystem_verifier_action = std::make_unique<FilesystemVerifierAction>(
896 boot_control_->GetDynamicPartitionControl());
Amin Hassani667cf7b2018-07-25 14:32:00 -0700897 auto postinstall_runner_action =
898 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang70eef232020-06-12 20:32:40 +0000899 filesystem_verifier_action->set_delegate(this);
Alex Deymob6eef732016-06-10 12:58:11 -0700900 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800901
Alex Deymo5e3ea272016-01-28 13:42:23 -0800902 // Bond them together. We have to use the leaf-types when calling
903 // BondActions().
904 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700905 BondActions(download_action.get(), filesystem_verifier_action.get());
906 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800907 postinstall_runner_action.get());
908
Amin Hassani667cf7b2018-07-25 14:32:00 -0700909 processor_->EnqueueAction(std::move(update_boot_flags_action));
Yifan Hong83517502020-02-19 15:34:13 -0800910 processor_->EnqueueAction(std::move(cleanup_previous_update_action));
Amin Hassani667cf7b2018-07-25 14:32:00 -0700911 processor_->EnqueueAction(std::move(install_plan_action));
912 processor_->EnqueueAction(std::move(download_action));
913 processor_->EnqueueAction(std::move(filesystem_verifier_action));
914 processor_->EnqueueAction(std::move(postinstall_runner_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800915}
916
Alex Deymo5e3ea272016-01-28 13:42:23 -0800917bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
918 string boot_id;
919 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800920 LOG(INFO) << "Writing update complete marker, slot "
921 << boot_control_->GetCurrentSlot() << ", boot id: " << boot_id;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400922 TEST_AND_RETURN_FALSE(
923 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id));
924 TEST_AND_RETURN_FALSE(
925 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot()));
926 return true;
927}
928
929bool UpdateAttempterAndroid::ClearUpdateCompletedMarker() {
930 LOG(INFO) << "Clearing update complete marker.";
931 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsUpdateCompletedOnBootId));
932 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsPreviousSlot));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800933 return true;
934}
935
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800936bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() const {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800937 // In case of an update_engine restart without a reboot, we stored the boot_id
938 // when the update was completed by setting a pref, so we can check whether
939 // the last update was on this boot or a previous one.
940 string boot_id;
941 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
942
943 string update_completed_on_boot_id;
944 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
945 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
946 &update_completed_on_boot_id) &&
947 update_completed_on_boot_id == boot_id);
948}
949
Tianjie Xu90aaa102017-10-10 17:39:03 -0700950// Collect and report the android metrics when we terminate the update.
951void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
952 ErrorCode error_code) {
953 int64_t attempt_number =
954 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
955 PayloadType payload_type = kPayloadTypeFull;
956 int64_t payload_size = 0;
957 for (const auto& p : install_plan_.payloads) {
958 if (p.type == InstallPayloadType::kDelta)
959 payload_type = kPayloadTypeDelta;
960 payload_size += p.size;
961 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700962 // In some cases, e.g. after calling |setShouldSwitchSlotOnReboot()|, this
963 // function will be triggered, but payload_size in this case might be 0, if so
964 // skip reporting any metrics.
965 if (payload_size == 0) {
966 return;
967 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700968
969 metrics::AttemptResult attempt_result =
970 metrics_utils::GetAttemptResult(error_code);
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700971 Time boot_time_start = Time::FromInternalValue(
972 metrics_utils::GetPersistedValue(kPrefsUpdateBootTimestampStart, prefs_));
973 Time monotonic_time_start = Time::FromInternalValue(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700974 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700975 TimeDelta duration = clock_->GetBootTime() - boot_time_start;
976 TimeDelta duration_uptime = clock_->GetMonotonicTime() - monotonic_time_start;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700977
978 metrics_reporter_->ReportUpdateAttemptMetrics(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700979 static_cast<int>(attempt_number),
980 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700981 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700982 duration_uptime,
983 payload_size,
984 attempt_result,
985 error_code);
986
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800987 int64_t current_bytes_downloaded = metric_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -0700988 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
989 current_bytes_downloaded,
990 0,
991 DownloadSource::kNumDownloadSources,
992 metrics::DownloadErrorCode::kUnset,
993 metrics::ConnectionType::kUnset);
994
Tianjie Xu90aaa102017-10-10 17:39:03 -0700995 if (error_code == ErrorCode::kSuccess) {
996 int64_t reboot_count =
997 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
998 string build_version;
999 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -07001000
1001 // For android metrics, we only care about the total bytes downloaded
1002 // for all sources; for now we assume the only download source is
1003 // HttpsServer.
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001004 int64_t total_bytes_downloaded = metric_total_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -07001005 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
1006 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
1007 total_bytes_downloaded;
1008
1009 int download_overhead_percentage = 0;
Tianjie Xu21030c12019-08-14 13:00:23 -07001010 if (total_bytes_downloaded >= payload_size) {
1011 CHECK_GT(payload_size, 0);
Tianjie Xud4777a12017-10-24 14:54:18 -07001012 download_overhead_percentage =
Tianjie Xu21030c12019-08-14 13:00:23 -07001013 (total_bytes_downloaded - payload_size) * 100ull / payload_size;
1014 } else {
1015 LOG(WARNING) << "Downloaded bytes " << total_bytes_downloaded
1016 << " is smaller than the payload size " << payload_size;
Tianjie Xud4777a12017-10-24 14:54:18 -07001017 }
Tianjie Xu21030c12019-08-14 13:00:23 -07001018
Tianjie Xu90aaa102017-10-10 17:39:03 -07001019 metrics_reporter_->ReportSuccessfulUpdateMetrics(
1020 static_cast<int>(attempt_number),
1021 0, // update abandoned count
1022 payload_type,
1023 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -07001024 num_bytes_downloaded,
1025 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -07001026 duration,
Sen Jiang8712e962018-05-08 12:12:28 -07001027 duration_uptime,
Tianjie Xu90aaa102017-10-10 17:39:03 -07001028 static_cast<int>(reboot_count),
1029 0); // url_switch_count
1030 }
1031}
1032
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001033bool UpdateAttempterAndroid::OTARebootSucceeded() const {
1034 const auto current_slot = boot_control_->GetCurrentSlot();
Kelvin Zhang13020502023-08-02 15:18:40 -07001035 const string current_version = GetCurrentBuildVersion();
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001036 int64_t previous_slot = -1;
1037 TEST_AND_RETURN_FALSE(prefs_->GetInt64(kPrefsPreviousSlot, &previous_slot));
1038 string previous_version;
1039 TEST_AND_RETURN_FALSE(
1040 prefs_->GetString(kPrefsPreviousVersion, &previous_version));
1041 if (previous_slot != current_slot) {
1042 LOG(INFO) << "Detected a slot switch, OTA succeeded, device updated from "
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001043 << previous_version << " to " << current_version
1044 << ", previous slot: " << previous_slot
1045 << " current slot: " << current_slot;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001046 if (previous_version == current_version) {
1047 LOG(INFO) << "Previous version is the same as current version, this is "
1048 "possibly a self-OTA.";
1049 }
1050 return true;
1051 } else {
1052 LOG(INFO) << "Slot didn't switch, either the OTA is rolled back, or slot "
1053 "switch never happened, or system not rebooted at all.";
1054 if (previous_version != current_version) {
1055 LOG(INFO) << "Slot didn't change, but version changed from "
1056 << previous_version << " to " << current_version
1057 << " device could be flashed.";
1058 }
1059 return false;
1060 }
1061}
1062
1063OTAResult UpdateAttempterAndroid::GetOTAUpdateResult() const {
1064 // We only set |kPrefsSystemUpdatedMarker| if slot is actually switched, so
1065 // existence of this pref is sufficient indicator. Given that we have to
1066 // delete this pref after checking it. This is done in
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001067 // |DeltaPerformer::ResetUpdateProgress| and
1068 // |UpdateAttempterAndroid::UpdateStateAfterReboot|
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001069 auto slot_switch_attempted = prefs_->Exists(kPrefsUpdateCompletedOnBootId);
1070 auto system_rebooted = DidSystemReboot(prefs_);
1071 auto ota_successful = OTARebootSucceeded();
1072 if (ota_successful) {
1073 return OTAResult::OTA_SUCCESSFUL;
1074 }
1075 if (slot_switch_attempted) {
1076 if (system_rebooted) {
1077 // If we attempted slot switch, but still end up on the same slot, we
1078 // probably rolled back.
1079 return OTAResult::ROLLED_BACK;
1080 } else {
1081 return OTAResult::UPDATED_NEED_REBOOT;
1082 }
1083 }
1084 return OTAResult::NOT_ATTEMPTED;
1085}
1086
1087void UpdateAttempterAndroid::UpdateStateAfterReboot(const OTAResult result) {
Kelvin Zhang13020502023-08-02 15:18:40 -07001088 const string current_version = GetCurrentBuildVersion();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001089 TEST_AND_RETURN(!current_version.empty());
1090
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001091 // |UpdateStateAfterReboot()| is only called after system reboot, so record
1092 // boot id unconditionally
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001093 string current_boot_id;
1094 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
1095 prefs_->SetString(kPrefsBootId, current_boot_id);
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001096 std::string slot_switch_indicator;
1097 prefs_->GetString(kPrefsUpdateCompletedOnBootId, &slot_switch_indicator);
1098 if (slot_switch_indicator != current_boot_id) {
1099 ClearUpdateCompletedMarker();
1100 }
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001101
Tianjie Xu90aaa102017-10-10 17:39:03 -07001102 // If there's no record of previous version (e.g. due to a data wipe), we
1103 // save the info of current boot and skip the metrics report.
1104 if (!prefs_->Exists(kPrefsPreviousVersion)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001105 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001106 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001107 ClearMetricsPrefs();
1108 return;
1109 }
Kelvin Zhang86603472021-05-11 12:16:27 -04001110 // update_engine restarted under the same build and same slot.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001111 if (result != OTAResult::OTA_SUCCESSFUL) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001112 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
1113 // set when we start a new update.
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001114 if (prefs_->Exists(kPrefsNumReboots)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001115 int64_t reboot_count =
1116 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1117 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
1118 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001119
1120 if (result == OTAResult::ROLLED_BACK) {
1121 // This will release all space previously allocated for apex
1122 // decompression. If we detect a rollback, we should release space and
1123 // return the space to user. Any subsequent attempt to install OTA will
1124 // allocate space again anyway.
1125 LOG(INFO) << "Detected a rollback, releasing space allocated for apex "
1126 "deompression.";
1127 apex_handler_android_->AllocateSpace({});
1128 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1129 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001130 return;
1131 }
1132
1133 // Now that the build version changes, report the update metrics.
1134 // TODO(xunchang) check the build version is larger than the previous one.
Tianjie Xu90aaa102017-10-10 17:39:03 -07001135 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001136 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001137
1138 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
1139 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
1140 if (previous_attempt_exists) {
1141 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
1142 }
1143
1144 metrics_utils::LoadAndReportTimeToReboot(
1145 metrics_reporter_.get(), prefs_, clock_.get());
1146 ClearMetricsPrefs();
Sen Jiang1bafff82019-01-02 15:54:40 -08001147
1148 // Also reset the update progress if the build version has changed.
1149 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
1150 LOG(WARNING) << "Unable to reset the update progress.";
1151 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001152}
1153
1154// Save the update start time. Reset the reboot count and attempt number if the
1155// update isn't a resume; otherwise increment the attempt number.
1156void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
1157 if (!is_resume) {
1158 metrics_utils::SetNumReboots(0, prefs_);
1159 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
1160 } else {
1161 int64_t attempt_number =
1162 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
1163 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
1164 }
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001165 metrics_utils::SetUpdateTimestampStart(clock_->GetMonotonicTime(), prefs_);
1166 metrics_utils::SetUpdateBootTimestampStart(clock_->GetBootTime(), prefs_);
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001167 ClearUpdateCompletedMarker();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001168}
1169
1170void UpdateAttempterAndroid::ClearMetricsPrefs() {
1171 CHECK(prefs_);
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001172 metric_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001173 prefs_->Delete(kPrefsNumReboots);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001174 prefs_->Delete(kPrefsSystemUpdatedMarker);
1175 prefs_->Delete(kPrefsUpdateTimestampStart);
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001176 prefs_->Delete(kPrefsUpdateBootTimestampStart);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001177}
1178
Yifan Hongbd47d622019-12-13 14:59:58 -08001179BootControlInterface::Slot UpdateAttempterAndroid::GetCurrentSlot() const {
1180 return boot_control_->GetCurrentSlot();
1181}
1182
1183BootControlInterface::Slot UpdateAttempterAndroid::GetTargetSlot() const {
1184 return GetCurrentSlot() == 0 ? 1 : 0;
1185}
1186
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001187uint64_t UpdateAttempterAndroid::AllocateSpaceForPayload(
1188 const std::string& metadata_filename,
1189 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001190 Error* error) {
Yifan Hong65613032020-01-09 17:52:13 -08001191 std::map<string, string> headers;
1192 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
1193 return 0;
1194 }
Kelvin Zhangabb082f2023-04-27 20:46:06 -07001195 DeltaArchiveManifest manifest;
1196 brillo::Blob metadata_hash;
1197 if (!brillo::data_encoding::Base64Decode(
1198 headers[kPayloadPropertyMetadataHash], &metadata_hash)) {
1199 metadata_hash.clear();
1200 }
1201 if (!VerifyPayloadParseManifest(
1202 metadata_filename, ToStringView(metadata_hash), &manifest, error)) {
1203 return 0;
1204 }
Yifan Hong65613032020-01-09 17:52:13 -08001205
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001206 std::vector<ApexInfo> apex_infos(manifest.apex_info().begin(),
1207 manifest.apex_info().end());
1208 uint64_t apex_size_required = 0;
1209 if (apex_handler_android_ != nullptr) {
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001210 auto result = apex_handler_android_->CalculateSize(apex_infos);
1211 if (!result.ok()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001212 LogAndSetGenericError(
1213 error,
1214 __LINE__,
1215 __FILE__,
1216 "Failed to calculate size required for compressed APEX");
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001217 return 0;
1218 }
1219 apex_size_required = *result;
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001220 }
1221
Yifan Hong65613032020-01-09 17:52:13 -08001222 string payload_id = GetPayloadId(headers);
1223 uint64_t required_size = 0;
Daniel Zhengeede4c82023-06-13 11:21:06 -07001224 ErrorCode error_code{};
1225
Yifan Hong65613032020-01-09 17:52:13 -08001226 if (!DeltaPerformer::PreparePartitionsForUpdate(prefs_,
1227 boot_control_,
1228 GetTargetSlot(),
1229 manifest,
1230 payload_id,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001231 &required_size,
1232 &error_code)) {
1233 if (error_code == ErrorCode::kOverlayfsenabledError) {
1234 LogAndSetError(error,
1235 __LINE__,
1236 __FILE__,
1237 "OverlayFS Shouldn't be enabled for OTA.",
1238 error_code);
1239 return 0;
1240 }
Yifan Hong65613032020-01-09 17:52:13 -08001241 if (required_size == 0) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001242 LogAndSetGenericError(
1243 error, __LINE__, __FILE__, "Failed to allocate space for payload.");
Yifan Hong65613032020-01-09 17:52:13 -08001244 return 0;
1245 } else {
1246 LOG(ERROR) << "Insufficient space for payload: " << required_size
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001247 << " bytes, apex decompression: " << apex_size_required
Yifan Hong65613032020-01-09 17:52:13 -08001248 << " bytes";
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001249 return required_size + apex_size_required;
Yifan Hong65613032020-01-09 17:52:13 -08001250 }
1251 }
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001252
1253 if (apex_size_required > 0 && apex_handler_android_ != nullptr &&
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001254 !apex_handler_android_->AllocateSpace(apex_infos)) {
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001255 LOG(ERROR) << "Insufficient space for apex decompression: "
1256 << apex_size_required << " bytes";
1257 return apex_size_required;
Kelvin Zhang8933d572021-01-28 10:17:34 -05001258 }
Yifan Hong65613032020-01-09 17:52:13 -08001259
1260 LOG(INFO) << "Successfully allocated space for payload.";
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001261 return 0;
1262}
1263
Yifan Hong40bb0d02020-02-24 17:33:14 -08001264void UpdateAttempterAndroid::CleanupSuccessfulUpdate(
1265 std::unique_ptr<CleanupSuccessfulUpdateCallbackInterface> callback,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001266 Error* error) {
Yifan Hong40bb0d02020-02-24 17:33:14 -08001267 if (cleanup_previous_update_code_.has_value()) {
1268 LOG(INFO) << "CleanupSuccessfulUpdate has previously completed with "
1269 << utils::ErrorCodeToString(*cleanup_previous_update_code_);
1270 if (callback) {
1271 callback->OnCleanupComplete(
1272 static_cast<int32_t>(*cleanup_previous_update_code_));
1273 }
1274 return;
Yifan Hong4f611562020-01-15 23:41:33 -08001275 }
Yifan Hong40bb0d02020-02-24 17:33:14 -08001276 if (callback) {
1277 auto callback_ptr = callback.get();
1278 cleanup_previous_update_callbacks_.emplace_back(std::move(callback));
Kelvin Zhang2f6c25a2023-07-05 12:49:34 -07001279 callback_ptr->RegisterForDeathNotifications([this, callback_ptr]() {
1280 RemoveCleanupPreviousUpdateCallback(callback_ptr);
1281 });
Yifan Hong40bb0d02020-02-24 17:33:14 -08001282 }
1283 ScheduleCleanupPreviousUpdate();
Yifan Hong2236ea02019-12-13 16:11:22 -08001284}
1285
Tianjie7f8f2ab2021-07-23 17:08:50 -07001286bool UpdateAttempterAndroid::setShouldSwitchSlotOnReboot(
Daniel Zheng92f7d172023-06-22 14:31:37 -07001287 const std::string& metadata_filename, Error* error) {
Kelvin Zhang20982a52021-08-13 12:31:16 -07001288 LOG(INFO) << "setShouldSwitchSlotOnReboot(" << metadata_filename << ")";
Tianjie7f8f2ab2021-07-23 17:08:50 -07001289 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001290 return LogAndSetGenericError(
1291 error,
1292 __LINE__,
1293 __FILE__,
1294 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001295 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001296 DeltaArchiveManifest manifest;
1297 TEST_AND_RETURN_FALSE(
1298 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
1299
Kelvin Zhang20982a52021-08-13 12:31:16 -07001300 InstallPlan install_plan_;
1301 install_plan_.source_slot = GetCurrentSlot();
1302 install_plan_.target_slot = GetTargetSlot();
1303 // Don't do verity computation, just hash the partitions
1304 install_plan_.write_verity = false;
1305 // Don't run postinstall, we just need PostinstallAction to switch the slots.
1306 install_plan_.run_post_install = false;
1307 install_plan_.is_resume = true;
1308
1309 CHECK_NE(install_plan_.source_slot, UINT32_MAX);
1310 CHECK_NE(install_plan_.target_slot, UINT32_MAX);
1311
Kelvin Zhang20982a52021-08-13 12:31:16 -07001312 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001313 auto postinstall_runner_action =
1314 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
1315 SetStatusAndNotify(UpdateStatus::VERIFYING);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001316 postinstall_runner_action->set_delegate(this);
Daniel Zhengeede4c82023-06-13 11:21:06 -07001317 ErrorCode error_code{};
Kelvin Zhang20982a52021-08-13 12:31:16 -07001318
Kelvin Zhangf8441982022-12-07 18:18:47 -08001319 // If last error code is kUpdatedButNotActive, we know that we reached this
1320 // state by calling applyPayload() with switch_slot=false. That applyPayload()
1321 // call would have already performed filesystem verification, therefore, we
1322 // can safely skip the verification to save time.
1323 if (last_error_ == ErrorCode::kUpdatedButNotActive) {
1324 BondActions(install_plan_action.get(), postinstall_runner_action.get());
1325 processor_->EnqueueAction(std::move(install_plan_action));
1326 } else {
Kelvin Zhang263a5402022-12-08 23:03:32 -08001327 if (!boot_control_->GetDynamicPartitionControl()
1328 ->PreparePartitionsForUpdate(GetCurrentSlot(),
1329 GetTargetSlot(),
1330 manifest,
1331 false /* should update */,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001332 nullptr,
1333 &error_code)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001334 return LogAndSetGenericError(
1335 error, __LINE__, __FILE__, "Failed to PreparePartitionsForUpdate");
Kelvin Zhang263a5402022-12-08 23:03:32 -08001336 }
Kelvin Zhang263a5402022-12-08 23:03:32 -08001337 if (!install_plan_.ParsePartitions(manifest.partitions(),
1338 boot_control_,
1339 manifest.block_size(),
1340 &error_code)) {
1341 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001342 __LINE__,
1343 __FILE__,
Kelvin Zhang263a5402022-12-08 23:03:32 -08001344 "Failed to LoadPartitionsFromSlots " +
Daniel Zheng92f7d172023-06-22 14:31:37 -07001345 utils::ErrorCodeToString(error_code),
1346 error_code);
Kelvin Zhang263a5402022-12-08 23:03:32 -08001347 }
1348
Kelvin Zhangf8441982022-12-07 18:18:47 -08001349 auto filesystem_verifier_action =
1350 std::make_unique<FilesystemVerifierAction>(
1351 boot_control_->GetDynamicPartitionControl());
1352 filesystem_verifier_action->set_delegate(this);
1353 BondActions(install_plan_action.get(), filesystem_verifier_action.get());
1354 BondActions(filesystem_verifier_action.get(),
1355 postinstall_runner_action.get());
1356 processor_->EnqueueAction(std::move(install_plan_action));
1357 processor_->EnqueueAction(std::move(filesystem_verifier_action));
1358 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001359
Kelvin Zhang20982a52021-08-13 12:31:16 -07001360 processor_->EnqueueAction(std::move(postinstall_runner_action));
1361 ScheduleProcessingStart();
1362 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001363}
1364
Daniel Zheng92f7d172023-06-22 14:31:37 -07001365bool UpdateAttempterAndroid::resetShouldSwitchSlotOnReboot(Error* error) {
Tianjie7f8f2ab2021-07-23 17:08:50 -07001366 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001367 return LogAndSetGenericError(
1368 error,
1369 __LINE__,
1370 __FILE__,
1371 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001372 }
Daniel Zhenge76cf562022-11-08 17:32:10 +00001373 TEST_AND_RETURN_FALSE(ClearUpdateCompletedMarker());
Kelvin Zhang20982a52021-08-13 12:31:16 -07001374 // Update the boot flags so the current slot has higher priority.
1375 if (!boot_control_->SetActiveBootSlot(GetCurrentSlot())) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001376 return LogAndSetGenericError(
1377 error, __LINE__, __FILE__, "Failed to SetActiveBootSlot");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001378 }
1379
1380 // Mark the current slot as successful again, since marking it as active
1381 // may reset the successful bit. We ignore the result of whether marking
1382 // the current slot as successful worked.
1383 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful) {}))) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001384 return LogAndSetGenericError(
1385 error, __LINE__, __FILE__, "Failed to MarkBootSuccessfulAsync");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001386 }
1387
1388 // Resets the warm reset property since we won't switch the slot.
1389 hardware_->SetWarmReset(false);
1390
1391 // Resets the vbmeta digest.
1392 hardware_->SetVbmetaDigestForInactiveSlot(true /* reset */);
1393 LOG(INFO) << "Slot switch cancelled.";
1394 SetStatusAndNotify(UpdateStatus::IDLE);
1395 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001396}
1397
Yifan Hong90965502020-02-19 15:22:47 -08001398void UpdateAttempterAndroid::ScheduleCleanupPreviousUpdate() {
1399 // If a previous CleanupSuccessfulUpdate call has not finished, or an update
1400 // is in progress, skip enqueueing the action.
1401 if (processor_->IsRunning()) {
1402 LOG(INFO) << "Already processing an update. CleanupPreviousUpdate should "
1403 << "be done when the current update finishes.";
1404 return;
1405 }
1406 LOG(INFO) << "Scheduling CleanupPreviousUpdateAction.";
1407 auto action =
1408 boot_control_->GetDynamicPartitionControl()
1409 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
1410 processor_->EnqueueAction(std::move(action));
1411 processor_->set_delegate(this);
1412 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
1413 processor_->StartProcessing();
1414}
1415
Yifan Hong40bb0d02020-02-24 17:33:14 -08001416void UpdateAttempterAndroid::OnCleanupProgressUpdate(double progress) {
1417 for (auto&& callback : cleanup_previous_update_callbacks_) {
1418 callback->OnCleanupProgressUpdate(progress);
1419 }
1420}
1421
1422void UpdateAttempterAndroid::NotifyCleanupPreviousUpdateCallbacksAndClear() {
1423 CHECK(cleanup_previous_update_code_.has_value());
1424 for (auto&& callback : cleanup_previous_update_callbacks_) {
1425 callback->OnCleanupComplete(
1426 static_cast<int32_t>(*cleanup_previous_update_code_));
1427 }
1428 cleanup_previous_update_callbacks_.clear();
1429}
1430
1431void UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback(
1432 CleanupSuccessfulUpdateCallbackInterface* callback) {
1433 auto end_it =
1434 std::remove_if(cleanup_previous_update_callbacks_.begin(),
1435 cleanup_previous_update_callbacks_.end(),
1436 [&](const auto& e) { return e.get() == callback; });
1437 cleanup_previous_update_callbacks_.erase(
1438 end_it, cleanup_previous_update_callbacks_.end());
1439}
Yifan Hong90965502020-02-19 15:22:47 -08001440
Daniel Zheng9fc62b82023-03-24 22:57:20 +00001441bool UpdateAttempterAndroid::IsProductionBuild() {
1442 if (android::base::GetProperty("ro.build.type", "") != "userdebug" ||
1443 android::base::GetProperty("ro.build.tags", "") == "release-keys" ||
1444 android::base::GetProperty("ro.boot.verifiedbootstate", "") == "green") {
1445 return true;
1446 }
1447 return false;
1448}
1449
Alex Deymo5e3ea272016-01-28 13:42:23 -08001450} // namespace chromeos_update_engine