blob: b5ec1e0d041b643aa1c0f3ea480719f461fa99c9 [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
Kelvin Zhang944cdac2023-12-12 12:55:27 -080026#include <android-base/parsebool.h>
Tianjie Xu90aaa102017-10-10 17:39:03 -070027#include <android-base/properties.h>
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090028#include <android-base/unique_fd.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080029#include <base/bind.h>
30#include <base/logging.h>
Alex Deymo218397f2016-02-04 23:55:10 -080031#include <base/strings/string_number_conversions.h>
Sen Jiang2703ef42017-03-16 13:36:21 -070032#include <brillo/data_encoding.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080033#include <brillo/message_loops/message_loop.h>
Alex Deymo218397f2016-02-04 23:55:10 -080034#include <brillo/strings/string_utils.h>
Sen Jiangacbdd1c2017-10-19 13:30:19 -070035#include <log/log_safetynet.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080036
Amin Hassaniec7bc112020-10-29 16:47:58 -070037#include "update_engine/aosp/cleanup_previous_update_action.h"
Daniel Zhengda4f7292022-09-02 22:59:32 +000038#include "update_engine/common/clock.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080039#include "update_engine/common/constants.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070040#include "update_engine/common/daemon_state_interface.h"
41#include "update_engine/common/download_action.h"
Kelvin Zhangf8441982022-12-07 18:18:47 -080042#include "update_engine/common/error_code.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080043#include "update_engine/common/error_code_utils.h"
Alex Deymo2c131bb2016-05-26 16:43:13 -070044#include "update_engine/common/file_fetcher.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070045#include "update_engine/common/metrics_reporter_interface.h"
46#include "update_engine/common/network_selector.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080047#include "update_engine/common/utils.h"
Tianjie Xu1b661142017-09-28 14:03:42 -070048#include "update_engine/metrics_utils.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080049#include "update_engine/payload_consumer/delta_performer.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080050#include "update_engine/payload_consumer/file_descriptor.h"
51#include "update_engine/payload_consumer/file_descriptor_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080052#include "update_engine/payload_consumer/filesystem_verifier_action.h"
Kelvin Zhangcfc531f2022-08-24 17:58:53 +000053#include "update_engine/payload_consumer/partition_writer.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080054#include "update_engine/payload_consumer/payload_constants.h"
55#include "update_engine/payload_consumer/payload_metadata.h"
Tianjie Xu7a78d632019-10-08 16:32:39 -070056#include "update_engine/payload_consumer/payload_verifier.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080057#include "update_engine/payload_consumer/postinstall_runner_action.h"
Amin Hassani667cf7b2018-07-25 14:32:00 -070058#include "update_engine/update_boot_flags_action.h"
Kelvin Zhangf92fe252023-03-28 10:55:47 -070059#include "update_engine/update_status.h"
Alex Deymo3b678db2016-02-09 11:50:06 -080060#include "update_engine/update_status_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080061
Alex Deymo14c0da82016-07-20 16:45:45 -070062#ifndef _UE_SIDELOAD
63// Do not include support for external HTTP(s) urls when building
64// update_engine_sideload.
65#include "update_engine/libcurl_http_fetcher.h"
66#endif
67
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090068using android::base::unique_fd;
Alex Deymo5e3ea272016-01-28 13:42:23 -080069using base::Bind;
Tianjie Xu90aaa102017-10-10 17:39:03 -070070using base::Time;
Alex Deymo5e3ea272016-01-28 13:42:23 -080071using base::TimeDelta;
72using base::TimeTicks;
Alex Deymo5e3ea272016-01-28 13:42:23 -080073using std::string;
74using std::vector;
Aaron Wood7f92e2b2017-08-28 14:51:21 -070075using update_engine::UpdateEngineStatus;
Alex Deymo5e3ea272016-01-28 13:42:23 -080076
77namespace chromeos_update_engine {
78
79namespace {
80
Alex Deymo0d298542016-03-30 18:31:49 -070081// Minimum threshold to broadcast an status update in progress and time.
82const double kBroadcastThresholdProgress = 0.01; // 1%
83const int kBroadcastThresholdSeconds = 10;
84
Daniel Zheng92f7d172023-06-22 14:31:37 -070085// Log and set the error on the passed ErrorPtr.
86bool LogAndSetGenericError(Error* error,
87 int line_number,
88 const char* file_name,
89 const string& reason) {
90 LOG(ERROR) << "Replying with failure: " << file_name << " " << line_number
91 << ": " << reason;
92 error->line_number = line_number;
93 error->file_name = file_name;
94 error->message = reason;
95 error->error_code = ErrorCode::kError;
96 return false;
97}
Alex Deymo5e3ea272016-01-28 13:42:23 -080098
99// Log and set the error on the passed ErrorPtr.
Daniel Zheng92f7d172023-06-22 14:31:37 -0700100bool LogAndSetError(Error* error,
101 int line_number,
102 const char* file_name,
103 const string& reason,
104 ErrorCode error_code) {
105 LOG(ERROR) << "Replying with failure: " << file_name << " " << line_number
106 << ": " << reason;
107 error->line_number = line_number;
108 error->file_name = file_name;
109 error->message = reason;
110 error->error_code = error_code;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800111 return false;
112}
113
Sen Jiangfe522822017-10-31 15:14:11 -0700114bool GetHeaderAsBool(const string& header, bool default_value) {
115 int value = 0;
116 if (base::StringToInt(header, &value) && (value == 0 || value == 1))
117 return value == 1;
118 return default_value;
119}
120
Yifan Hongbd47d622019-12-13 14:59:58 -0800121bool ParseKeyValuePairHeaders(const vector<string>& key_value_pair_headers,
122 std::map<string, string>* headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700123 Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800124 for (const string& key_value_pair : key_value_pair_headers) {
125 string key;
126 string value;
127 if (!brillo::string_utils::SplitAtFirst(
128 key_value_pair, "=", &key, &value, false)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700129 return LogAndSetGenericError(error,
130 __LINE__,
131 __FILE__,
132 "Passed invalid header: " + key_value_pair);
Yifan Hongbd47d622019-12-13 14:59:58 -0800133 }
134 if (!headers->emplace(key, value).second)
Daniel Zheng92f7d172023-06-22 14:31:37 -0700135 return LogAndSetGenericError(
136 error, __LINE__, __FILE__, "Passed repeated key: " + key);
Yifan Hongbd47d622019-12-13 14:59:58 -0800137 }
138 return true;
139}
140
141// Unique identifier for the payload. An empty string means that the payload
142// can't be resumed.
143string GetPayloadId(const std::map<string, string>& headers) {
144 return (headers.count(kPayloadPropertyFileHash)
145 ? headers.at(kPayloadPropertyFileHash)
146 : "") +
147 (headers.count(kPayloadPropertyMetadataHash)
148 ? headers.at(kPayloadPropertyMetadataHash)
149 : "");
150}
151
Kelvin Zhang13020502023-08-02 15:18:40 -0700152std::string GetCurrentBuildVersion() {
153 // Example: [ro.build.fingerprint]:
154 // [generic/aosp_cf_x86_64_phone/vsoc_x86_64:VanillaIceCream/AOSP.MAIN/user08011303:userdebug/test-keys]
155 return android::base::GetProperty("ro.build.fingerprint", "");
156}
157
Alex Deymo5e3ea272016-01-28 13:42:23 -0800158} // namespace
159
160UpdateAttempterAndroid::UpdateAttempterAndroid(
Alex Deymo03a4de72016-07-20 16:08:23 -0700161 DaemonStateInterface* daemon_state,
Alex Deymo5e3ea272016-01-28 13:42:23 -0800162 PrefsInterface* prefs,
163 BootControlInterface* boot_control,
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000164 HardwareInterface* hardware,
165 std::unique_ptr<ApexHandlerInterface> apex_handler)
Alex Deymo5e3ea272016-01-28 13:42:23 -0800166 : daemon_state_(daemon_state),
167 prefs_(prefs),
168 boot_control_(boot_control),
169 hardware_(hardware),
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000170 apex_handler_android_(std::move(apex_handler)),
Tianjie Xu1b661142017-09-28 14:03:42 -0700171 processor_(new ActionProcessor()),
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800172 clock_(new Clock()),
173 metric_bytes_downloaded_(kPrefsCurrentBytesDownloaded, prefs_),
174 metric_total_bytes_downloaded_(kPrefsTotalBytesDownloaded, prefs_) {
Yifan Hongc514f662021-02-04 11:18:43 -0800175 metrics_reporter_ = metrics::CreateMetricsReporter(
Kelvin Zhang9a5e3682021-03-29 12:58:48 -0400176 boot_control_->GetDynamicPartitionControl(), &install_plan_);
Alex Deymo87792ea2016-07-25 15:40:36 -0700177 network_selector_ = network::CreateNetworkSelector();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800178}
179
180UpdateAttempterAndroid::~UpdateAttempterAndroid() {
181 // Release ourselves as the ActionProcessor's delegate to prevent
182 // re-scheduling the updates due to the processing stopped.
183 processor_->set_delegate(nullptr);
184}
185
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400186[[nodiscard]] static bool DidSystemReboot(PrefsInterface* prefs) {
187 string boot_id;
188 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
189 string old_boot_id;
190 // If no previous boot id found, treat as a reboot and write boot ID.
191 if (!prefs->GetString(kPrefsBootId, &old_boot_id)) {
192 return true;
193 }
194 return old_boot_id != boot_id;
195}
196
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400197std::ostream& operator<<(std::ostream& out, OTAResult result) {
198 switch (result) {
199 case OTAResult::NOT_ATTEMPTED:
200 out << "OTAResult::NOT_ATTEMPTED";
201 break;
202 case OTAResult::ROLLED_BACK:
203 out << "OTAResult::ROLLED_BACK";
204 break;
205 case OTAResult::UPDATED_NEED_REBOOT:
206 out << "OTAResult::UPDATED_NEED_REBOOT";
207 break;
208 case OTAResult::OTA_SUCCESSFUL:
209 out << "OTAResult::OTA_SUCCESSFUL";
210 break;
211 }
212 return out;
213}
214
Alex Deymo5e3ea272016-01-28 13:42:23 -0800215void UpdateAttempterAndroid::Init() {
216 // In case of update_engine restart without a reboot we need to restore the
217 // reboot needed state.
Tianjie Xu90aaa102017-10-10 17:39:03 -0700218 if (UpdateCompletedOnThisBoot()) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400219 LOG(INFO) << "Updated installed but update_engine is restarted without "
220 "device reboot. Resuming old state.";
Alex Deymo0e061ae2016-02-09 17:49:03 -0800221 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700222 } else {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400223 const auto result = GetOTAUpdateResult();
224 LOG(INFO) << result;
Alex Deymo0e061ae2016-02-09 17:49:03 -0800225 SetStatusAndNotify(UpdateStatus::IDLE);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400226 if (DidSystemReboot(prefs_)) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400227 UpdateStateAfterReboot(result);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400228 }
229
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700230#ifdef _UE_SIDELOAD
231 LOG(INFO) << "Skip ScheduleCleanupPreviousUpdate in sideload because "
232 << "ApplyPayload will call it later.";
233#else
Yifan Hong90965502020-02-19 15:22:47 -0800234 ScheduleCleanupPreviousUpdate();
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700235#endif
Tianjie Xu90aaa102017-10-10 17:39:03 -0700236 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800237}
238
239bool UpdateAttempterAndroid::ApplyPayload(
240 const string& payload_url,
241 int64_t payload_offset,
242 int64_t payload_size,
243 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700244 Error* error) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800245 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Kelvin Zhangbe0a3492023-12-04 09:18:15 -0800246 return LogAndSetError(error,
247 __LINE__,
248 __FILE__,
249 "An update already applied, waiting for reboot",
250 ErrorCode::kUpdateAlreadyInstalled);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800251 }
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700252 if (processor_->IsRunning()) {
Kelvin Zhangbe0a3492023-12-04 09:18:15 -0800253 return LogAndSetError(error,
254 __LINE__,
255 __FILE__,
256 "Already processing an update, cancel it first.",
257 ErrorCode::kUpdateProcessing);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800258 }
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100259 DCHECK_EQ(status_, UpdateStatus::IDLE);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800260
Alex Deymo218397f2016-02-04 23:55:10 -0800261 std::map<string, string> headers;
Yifan Hongbd47d622019-12-13 14:59:58 -0800262 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
263 return false;
Alex Deymo218397f2016-02-04 23:55:10 -0800264 }
265
Yifan Hongbd47d622019-12-13 14:59:58 -0800266 string payload_id = GetPayloadId(headers);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800267
268 // Setup the InstallPlan based on the request.
269 install_plan_ = InstallPlan();
270
271 install_plan_.download_url = payload_url;
272 install_plan_.version = "";
Alex Deymo0fd51ff2016-02-03 14:22:43 -0800273 base_offset_ = payload_offset;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800274 InstallPlan::Payload payload;
275 payload.size = payload_size;
276 if (!payload.size) {
Alex Deymo218397f2016-02-04 23:55:10 -0800277 if (!base::StringToUint64(headers[kPayloadPropertyFileSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800278 &payload.size)) {
279 payload.size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800280 }
281 }
Sen Jiang2703ef42017-03-16 13:36:21 -0700282 if (!brillo::data_encoding::Base64Decode(headers[kPayloadPropertyFileHash],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800283 &payload.hash)) {
Sen Jiang2703ef42017-03-16 13:36:21 -0700284 LOG(WARNING) << "Unable to decode base64 file hash: "
285 << headers[kPayloadPropertyFileHash];
286 }
Alex Deymo218397f2016-02-04 23:55:10 -0800287 if (!base::StringToUint64(headers[kPayloadPropertyMetadataSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800288 &payload.metadata_size)) {
289 payload.metadata_size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800290 }
Sen Jiangcdd52062017-05-18 15:33:10 -0700291 // The |payload.type| is not used anymore since minor_version 3.
292 payload.type = InstallPayloadType::kUnknown;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800293 install_plan_.payloads.push_back(payload);
294
Alex Deymo5e3ea272016-01-28 13:42:23 -0800295 // The |public_key_rsa| key would override the public key stored on disk.
296 install_plan_.public_key_rsa = "";
297
298 install_plan_.hash_checks_mandatory = hardware_->IsOfficialBuild();
299 install_plan_.is_resume = !payload_id.empty() &&
300 DeltaPerformer::CanResumeUpdate(prefs_, payload_id);
301 if (!install_plan_.is_resume) {
Kelvin Zhange70fa762024-07-18 09:14:54 -0700302 LOG(INFO) << "Starting a new update " << payload_url
303 << " size: " << payload_size << " offset: " << payload_offset;
Kelvin Zhang42c2d552022-07-25 11:04:00 -0700304 boot_control_->GetDynamicPartitionControl()->Cleanup();
Kelvin Zhangc54c9962022-10-20 13:44:59 -0700305 boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_);
306
Alex Deymo5e3ea272016-01-28 13:42:23 -0800307 if (!prefs_->SetString(kPrefsUpdateCheckResponseHash, payload_id)) {
308 LOG(WARNING) << "Unable to save the update check response hash.";
309 }
310 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800311 install_plan_.source_slot = GetCurrentSlot();
312 install_plan_.target_slot = GetTargetSlot();
Alex Deymofb905d92016-06-03 19:26:58 -0700313
Alex Deymofb905d92016-06-03 19:26:58 -0700314 install_plan_.powerwash_required =
Sen Jiangfe522822017-10-31 15:14:11 -0700315 GetHeaderAsBool(headers[kPayloadPropertyPowerwash], false);
316
Kelvin Zhang85a6d992023-10-23 10:40:58 -0700317 install_plan_.spl_downgrade =
318 GetHeaderAsBool(headers[kPayloadPropertySplDowngrade], false);
319
Daniel Zheng9fc62b82023-03-24 22:57:20 +0000320 if (!IsProductionBuild()) {
321 install_plan_.disable_vabc =
322 GetHeaderAsBool(headers[kPayloadDisableVABC], false);
323 }
324
Sen Jiangfe522822017-10-31 15:14:11 -0700325 install_plan_.switch_slot_on_reboot =
326 GetHeaderAsBool(headers[kPayloadPropertySwitchSlotOnReboot], true);
327
Tianjie Xu087de9d2019-11-01 17:11:22 -0700328 install_plan_.run_post_install =
329 GetHeaderAsBool(headers[kPayloadPropertyRunPostInstall], true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800330
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700331 // Skip writing verity if we're resuming and verity has already been written.
332 install_plan_.write_verity = true;
333 if (install_plan_.is_resume && prefs_->Exists(kPrefsVerityWritten)) {
334 bool verity_written = false;
335 if (prefs_->GetBoolean(kPrefsVerityWritten, &verity_written) &&
336 verity_written) {
337 install_plan_.write_verity = false;
338 }
339 }
340
Alex Deymo87792ea2016-07-25 15:40:36 -0700341 NetworkId network_id = kDefaultNetworkId;
342 if (!headers[kPayloadPropertyNetworkId].empty()) {
343 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
344 &network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700345 return LogAndSetGenericError(
Alex Deymo87792ea2016-07-25 15:40:36 -0700346 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700347 __LINE__,
348 __FILE__,
Alex Deymo87792ea2016-07-25 15:40:36 -0700349 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
350 }
351 if (!network_selector_->SetProcessNetwork(network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700352 return LogAndSetGenericError(
Sen Jiangcbd37c62017-09-12 15:04:35 -0700353 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700354 __LINE__,
355 __FILE__,
Sen Jiangcbd37c62017-09-12 15:04:35 -0700356 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700357 }
Daniel Zheng7ff60fd2024-01-29 08:38:17 -0800358 LOG(INFO) << "Using network ID: " << network_id;
Alex Deymo87792ea2016-07-25 15:40:36 -0700359 }
360
Alex Deymo5e3ea272016-01-28 13:42:23 -0800361 LOG(INFO) << "Using this install plan:";
362 install_plan_.Dump();
363
Amin Hassani667cf7b2018-07-25 14:32:00 -0700364 HttpFetcher* fetcher = nullptr;
365 if (FileFetcher::SupportedUrl(payload_url)) {
366 DLOG(INFO) << "Using FileFetcher for file URL.";
367 fetcher = new FileFetcher();
368 } else {
369#ifdef _UE_SIDELOAD
370 LOG(FATAL) << "Unsupported sideload URI: " << payload_url;
Chih-Hung Hsieh6e4f3452022-12-21 12:20:45 -0800371 return false; // NOLINT, unreached but analyzer might not know.
372 // Suppress warnings about null 'fetcher' after this.
Amin Hassani667cf7b2018-07-25 14:32:00 -0700373#else
Kelvin Zhangc7a1d1f2022-07-29 13:36:29 -0700374 LibcurlHttpFetcher* libcurl_fetcher = new LibcurlHttpFetcher(hardware_);
Kelvin Zhang3cc4fa32022-09-27 16:15:10 -0700375 if (!headers[kPayloadDownloadRetry].empty()) {
376 libcurl_fetcher->set_max_retry_count(
377 atoi(headers[kPayloadDownloadRetry].c_str()));
378 }
Amin Hassani667cf7b2018-07-25 14:32:00 -0700379 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
380 fetcher = libcurl_fetcher;
381#endif // _UE_SIDELOAD
382 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800383 // Setup extra headers.
Alex Deymofdd6dec2016-03-03 22:35:43 -0800384 if (!headers[kPayloadPropertyAuthorization].empty())
385 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
386 if (!headers[kPayloadPropertyUserAgent].empty())
387 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
388
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700389 if (!headers[kPayloadPropertyNetworkProxy].empty()) {
390 LOG(INFO) << "Using proxy url from payload headers: "
391 << headers[kPayloadPropertyNetworkProxy];
392 fetcher->SetProxies({headers[kPayloadPropertyNetworkProxy]});
393 }
Kelvin Zhanga7407b52023-03-13 15:05:14 -0700394 if (!headers[kPayloadVABCNone].empty()) {
395 install_plan_.vabc_none = true;
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000396 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800397 if (!headers[kPayloadEnableThreading].empty()) {
Kelvin Zhang944cdac2023-12-12 12:55:27 -0800398 const auto res = android::base::ParseBool(headers[kPayloadEnableThreading]);
399 if (res != android::base::ParseBoolResult::kError) {
400 install_plan_.enable_threading =
401 res == android::base::ParseBoolResult::kTrue;
402 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800403 }
404 if (!headers[kPayloadBatchedWrites].empty()) {
405 install_plan_.batched_writes = true;
406 }
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700407
Amin Hassani667cf7b2018-07-25 14:32:00 -0700408 BuildUpdateActions(fetcher);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800409
Alex Deymo5e3ea272016-01-28 13:42:23 -0800410 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700411
412 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
413 // TODO(xunchang) report the metrics for unresumable updates
414
Amin Hassani667cf7b2018-07-25 14:32:00 -0700415 ScheduleProcessingStart();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800416 return true;
417}
418
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900419bool UpdateAttempterAndroid::ApplyPayload(
420 int fd,
421 int64_t payload_offset,
422 int64_t payload_size,
423 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700424 Error* error) {
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100425 // update_engine state must be checked before modifying payload_fd_ otherwise
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +0000426 // already running update will be terminated (existing file descriptor will be
427 // closed)
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100428 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700429 return LogAndSetGenericError(
430 error,
431 __LINE__,
432 __FILE__,
433 "An update already applied, waiting for reboot");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100434 }
435 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700436 return LogAndSetGenericError(
437 error,
438 __LINE__,
439 __FILE__,
440 "Already processing an update, cancel it first.");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100441 }
442 DCHECK_EQ(status_, UpdateStatus::IDLE);
443
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900444 payload_fd_.reset(dup(fd));
445 const string payload_url = "fd://" + std::to_string(payload_fd_.get());
446
447 return ApplyPayload(
448 payload_url, payload_offset, payload_size, key_value_pair_headers, error);
449}
450
Daniel Zheng92f7d172023-06-22 14:31:37 -0700451bool UpdateAttempterAndroid::SuspendUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700452 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700453 return LogAndSetGenericError(
454 error, __LINE__, __FILE__, "No ongoing update to suspend.");
Alex Deymof2858572016-02-25 11:20:13 -0800455 processor_->SuspendProcessing();
456 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800457}
458
Daniel Zheng92f7d172023-06-22 14:31:37 -0700459bool UpdateAttempterAndroid::ResumeUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700460 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700461 return LogAndSetGenericError(
462 error, __LINE__, __FILE__, "No ongoing update to resume.");
Alex Deymof2858572016-02-25 11:20:13 -0800463 processor_->ResumeProcessing();
464 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800465}
466
Daniel Zheng92f7d172023-06-22 14:31:37 -0700467bool UpdateAttempterAndroid::CancelUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700468 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700469 return LogAndSetGenericError(
470 error, __LINE__, __FILE__, "No ongoing update to cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800471 processor_->StopProcessing();
472 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800473}
474
Daniel Zheng92f7d172023-06-22 14:31:37 -0700475bool UpdateAttempterAndroid::ResetStatus(Error* error) {
Alex Deymo3b678db2016-02-09 11:50:06 -0800476 LOG(INFO) << "Attempting to reset state from "
477 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700478 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700479 return LogAndSetGenericError(
480 error,
481 __LINE__,
482 __FILE__,
483 "Already processing an update, cancel it first.");
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700484 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700485 if (status_ != UpdateStatus::IDLE &&
486 status_ != UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700487 return LogAndSetGenericError(
488 error,
489 __LINE__,
490 __FILE__,
491 "Status reset not allowed in this state, please "
492 "cancel on going OTA first.");
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700493 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800494
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000495 if (apex_handler_android_ != nullptr) {
496 LOG(INFO) << "Cleaning up reserved space for compressed APEX (if any)";
497 std::vector<ApexInfo> apex_infos_blank;
498 apex_handler_android_->AllocateSpace(apex_infos_blank);
499 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400500 // Remove the reboot marker so that if the machine is rebooted
501 // after resetting to idle state, it doesn't go back to
502 // UpdateStatus::UPDATED_NEED_REBOOT state.
503 if (!ClearUpdateCompletedMarker()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700504 return LogAndSetGenericError(error,
505 __LINE__,
506 __FILE__,
507 "Failed to reset the status because "
508 "ClearUpdateCompletedMarker() failed");
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400509 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700510 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
511 if (!resetShouldSwitchSlotOnReboot(error)) {
512 LOG(INFO) << "Failed to reset slot switch.";
513 return false;
514 }
515 LOG(INFO) << "Slot switch reset successful";
516 }
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700517 if (!boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_)) {
518 LOG(WARNING) << "Failed to reset snapshots. UpdateStatus is IDLE but"
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000519 << "space might not be freed.";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700520 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700521 return true;
Alex Deymo3b678db2016-02-09 11:50:06 -0800522}
523
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700524bool operator==(const std::vector<unsigned char>& a, std::string_view b) {
525 if (a.size() != b.size()) {
526 return false;
527 }
528 return memcmp(a.data(), b.data(), a.size()) == 0;
529}
530bool operator!=(const std::vector<unsigned char>& a, std::string_view b) {
531 return !(a == b);
532}
533
Yifan Hongbd47d622019-12-13 14:59:58 -0800534bool UpdateAttempterAndroid::VerifyPayloadParseManifest(
535 const std::string& metadata_filename,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700536 std::string_view expected_metadata_hash,
Yifan Hongbd47d622019-12-13 14:59:58 -0800537 DeltaArchiveManifest* manifest,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700538 Error* error) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800539 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
540 if (!fd->Open(metadata_filename.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700541 return LogAndSetError(error,
542 __LINE__,
543 __FILE__,
544 "Failed to open " + metadata_filename,
545 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800546 }
547 brillo::Blob metadata(kMaxPayloadHeaderSize);
548 if (!fd->Read(metadata.data(), metadata.size())) {
549 return LogAndSetError(
550 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700551 __LINE__,
552 __FILE__,
553 "Failed to read payload header from " + metadata_filename,
554 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800555 }
Daniel Zhengda4f7292022-09-02 22:59:32 +0000556 ErrorCode errorcode{};
Sen Jiang8371c1c2018-02-01 13:46:39 -0800557 PayloadMetadata payload_metadata;
Sen Jiangf1236632018-05-11 16:03:23 -0700558 if (payload_metadata.ParsePayloadHeader(metadata, &errorcode) !=
Sen Jiang8371c1c2018-02-01 13:46:39 -0800559 MetadataParseResult::kSuccess) {
560 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700561 __LINE__,
562 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800563 "Failed to parse payload header: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700564 utils::ErrorCodeToString(errorcode),
565 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800566 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700567 uint64_t metadata_size = payload_metadata.GetMetadataSize() +
568 payload_metadata.GetMetadataSignatureSize();
569 if (metadata_size < kMaxPayloadHeaderSize ||
570 metadata_size >
571 static_cast<uint64_t>(utils::FileSize(metadata_filename))) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800572 return LogAndSetError(
573 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700574 __LINE__,
575 __FILE__,
576 "Invalid metadata size: " + std::to_string(metadata_size),
577 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800578 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700579 metadata.resize(metadata_size);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800580 if (!fd->Read(metadata.data() + kMaxPayloadHeaderSize,
581 metadata.size() - kMaxPayloadHeaderSize)) {
582 return LogAndSetError(
583 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700584 __LINE__,
585 __FILE__,
586 "Failed to read metadata and signature from " + metadata_filename,
587 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800588 }
589 fd->Close();
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700590 if (!expected_metadata_hash.empty()) {
591 brillo::Blob metadata_hash;
592 TEST_AND_RETURN_FALSE(HashCalculator::RawHashOfBytes(
593 metadata.data(), payload_metadata.GetMetadataSize(), &metadata_hash));
594 if (metadata_hash != expected_metadata_hash) {
595 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700596 __LINE__,
597 __FILE__,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700598 "Metadata hash mismatch. Expected hash: " +
599 HexEncode(expected_metadata_hash) +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700600 " actual hash: " + HexEncode(metadata_hash),
601 ErrorCode::kDownloadManifestParseError);
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700602 } else {
603 LOG(INFO) << "Payload metadata hash check passed : "
604 << HexEncode(metadata_hash);
605 }
606 }
Sen Jiang08c6da12019-01-07 18:28:56 -0800607
Tianjie Xu7a78d632019-10-08 16:32:39 -0700608 auto payload_verifier = PayloadVerifier::CreateInstanceFromZipPath(
609 constants::kUpdateCertificatesPath);
610 if (!payload_verifier) {
611 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700612 __LINE__,
613 __FILE__,
Tianjie Xu7a78d632019-10-08 16:32:39 -0700614 "Failed to create the payload verifier from " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700615 std::string(constants::kUpdateCertificatesPath),
616 ErrorCode::kDownloadManifestParseError);
Sen Jiang08c6da12019-01-07 18:28:56 -0800617 }
Tianjie Xu7a78d632019-10-08 16:32:39 -0700618 errorcode = payload_metadata.ValidateMetadataSignature(
619 metadata, "", *payload_verifier);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800620 if (errorcode != ErrorCode::kSuccess) {
621 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700622 __LINE__,
623 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800624 "Failed to validate metadata signature: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700625 utils::ErrorCodeToString(errorcode),
626 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800627 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800628 if (!payload_metadata.GetManifest(metadata, manifest)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700629 return LogAndSetError(error,
630 __LINE__,
631 __FILE__,
632 "Failed to parse manifest.",
633 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800634 }
635
Yifan Hongbd47d622019-12-13 14:59:58 -0800636 return true;
637}
638
639bool UpdateAttempterAndroid::VerifyPayloadApplicable(
Daniel Zheng92f7d172023-06-22 14:31:37 -0700640 const std::string& metadata_filename, Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800641 DeltaArchiveManifest manifest;
642 TEST_AND_RETURN_FALSE(
643 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
644
645 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
Daniel Zhengda4f7292022-09-02 22:59:32 +0000646 ErrorCode errorcode{};
Yifan Hongbd47d622019-12-13 14:59:58 -0800647
648 BootControlInterface::Slot current_slot = GetCurrentSlot();
Kelvin Zhang1815c4d2023-11-07 14:21:18 -0800649 if (current_slot < 0) {
650 return LogAndSetError(
651 error,
652 __LINE__,
653 __FILE__,
654 "Failed to get current slot " + std::to_string(current_slot),
655 ErrorCode::kDownloadStateInitializationError);
656 }
Sen Jiang8371c1c2018-02-01 13:46:39 -0800657 for (const PartitionUpdate& partition : manifest.partitions()) {
658 if (!partition.has_old_partition_info())
659 continue;
660 string partition_path;
661 if (!boot_control_->GetPartitionDevice(
662 partition.partition_name(), current_slot, &partition_path)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700663 return LogAndSetGenericError(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800664 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700665 __LINE__,
666 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800667 "Failed to get partition device for " + partition.partition_name());
668 }
669 if (!fd->Open(partition_path.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700670 return LogAndSetGenericError(
671 error, __LINE__, __FILE__, "Failed to open " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800672 }
673 for (const InstallOperation& operation : partition.operations()) {
674 if (!operation.has_src_sha256_hash())
675 continue;
676 brillo::Blob source_hash;
677 if (!fd_utils::ReadAndHashExtents(fd,
678 operation.src_extents(),
679 manifest.block_size(),
680 &source_hash)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700681 return LogAndSetGenericError(
682 error, __LINE__, __FILE__, "Failed to hash " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800683 }
Kelvin Zhang9bd519d2020-09-23 12:55:19 -0400684 if (!PartitionWriter::ValidateSourceHash(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800685 source_hash, operation, fd, &errorcode)) {
686 return false;
687 }
688 }
689 fd->Close();
690 }
691 return true;
692}
693
Alex Deymo5e3ea272016-01-28 13:42:23 -0800694void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
695 ErrorCode code) {
696 LOG(INFO) << "Processing Done.";
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800697 metric_bytes_downloaded_.Flush(true);
698 metric_total_bytes_downloaded_.Flush(true);
Kelvin Zhangf8441982022-12-07 18:18:47 -0800699 last_error_ = code;
Yifan Hong90965502020-02-19 15:22:47 -0800700 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
701 TerminateUpdateAndNotify(code);
702 return;
703 }
704
Alex Deymo5990bf32016-07-19 17:01:41 -0700705 switch (code) {
706 case ErrorCode::kSuccess:
707 // Update succeeded.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400708 if (!WriteUpdateCompletedMarker()) {
709 LOG(ERROR) << "Failed to write update completion marker";
710 }
Alex Deymo5990bf32016-07-19 17:01:41 -0700711 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800712
Alex Deymo5990bf32016-07-19 17:01:41 -0700713 LOG(INFO) << "Update successfully applied, waiting to reboot.";
714 break;
715
716 case ErrorCode::kFilesystemCopierError:
717 case ErrorCode::kNewRootfsVerificationError:
718 case ErrorCode::kNewKernelVerificationError:
719 case ErrorCode::kFilesystemVerifierError:
720 case ErrorCode::kDownloadStateInitializationError:
721 // Reset the ongoing update for these errors so it starts from the
722 // beginning next time.
723 DeltaPerformer::ResetUpdateProgress(prefs_, false);
724 LOG(INFO) << "Resetting update progress.";
725 break;
726
Sen Jiangacbdd1c2017-10-19 13:30:19 -0700727 case ErrorCode::kPayloadTimestampError:
728 // SafetyNet logging, b/36232423
729 android_errorWriteLog(0x534e4554, "36232423");
730 break;
731
Alex Deymo5990bf32016-07-19 17:01:41 -0700732 default:
733 // Ignore all other error codes.
734 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700735 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800736
737 TerminateUpdateAndNotify(code);
738}
739
740void UpdateAttempterAndroid::ProcessingStopped(
741 const ActionProcessor* processor) {
742 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
743}
744
745void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
746 AbstractAction* action,
747 ErrorCode code) {
748 // Reset download progress regardless of whether or not the download
749 // action succeeded.
750 const string type = action->Type();
Yifan Hong40bb0d02020-02-24 17:33:14 -0800751 if (type == CleanupPreviousUpdateAction::StaticType() ||
752 (type == NoOpAction::StaticType() &&
753 status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE)) {
754 cleanup_previous_update_code_ = code;
755 NotifyCleanupPreviousUpdateCallbacksAndClear();
756 }
Kelvin Zhang70eef232020-06-12 20:32:40 +0000757 // download_progress_ is actually used by other actions, such as
758 // filesystem_verify_action. Therefore we always clear it.
759 download_progress_ = 0;
Sen Jiangfe522822017-10-31 15:14:11 -0700760 if (type == PostinstallRunnerAction::StaticType()) {
761 bool succeeded =
762 code == ErrorCode::kSuccess || code == ErrorCode::kUpdatedButNotActive;
763 prefs_->SetBoolean(kPrefsPostInstallSucceeded, succeeded);
764 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800765 if (code != ErrorCode::kSuccess) {
766 // If an action failed, the ActionProcessor will cancel the whole thing.
767 return;
768 }
Yifan Hong83517502020-02-19 15:34:13 -0800769 if (type == UpdateBootFlagsAction::StaticType()) {
770 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
771 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800772 if (type == DownloadAction::StaticType()) {
Kelvin Zhangd2da7b12020-07-07 17:19:21 -0400773 auto download_action = static_cast<DownloadAction*>(action);
774 install_plan_ = *download_action->install_plan();
Kelvin Zhang70eef232020-06-12 20:32:40 +0000775 SetStatusAndNotify(UpdateStatus::VERIFYING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700776 } else if (type == FilesystemVerifierAction::StaticType()) {
Kelvin Zhang70eef232020-06-12 20:32:40 +0000777 SetStatusAndNotify(UpdateStatus::FINALIZING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700778 prefs_->SetBoolean(kPrefsVerityWritten, true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800779 }
780}
781
782void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
783 uint64_t bytes_received,
784 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700785 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800786 if (total)
787 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700788 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800789 download_progress_ = progress;
790 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700791 } else {
792 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800793 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700794
795 // Update the bytes downloaded in prefs.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800796 metric_bytes_downloaded_ += bytes_progressed;
797 metric_total_bytes_downloaded_ += bytes_progressed;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800798}
799
800bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
801 // TODO(deymo): Notify the DownloadAction that it should cancel the update
802 // download.
803 return false;
804}
805
806void UpdateAttempterAndroid::DownloadComplete() {
807 // Nothing needs to be done when the download completes.
808}
809
Alex Deymo0d298542016-03-30 18:31:49 -0700810void UpdateAttempterAndroid::ProgressUpdate(double progress) {
811 // Self throttle based on progress. Also send notifications if progress is
812 // too slow.
813 if (progress == 1.0 ||
814 progress - download_progress_ >= kBroadcastThresholdProgress ||
815 TimeTicks::Now() - last_notify_time_ >=
816 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
817 download_progress_ = progress;
818 SetStatusAndNotify(status_);
819 }
820}
821
Kelvin Zhang70eef232020-06-12 20:32:40 +0000822void UpdateAttempterAndroid::OnVerifyProgressUpdate(double progress) {
823 assert(status_ == UpdateStatus::VERIFYING);
824 ProgressUpdate(progress);
825}
826
Alex Deymo5e3ea272016-01-28 13:42:23 -0800827void UpdateAttempterAndroid::ScheduleProcessingStart() {
828 LOG(INFO) << "Scheduling an action processor start.";
Kelvin Zhang20982a52021-08-13 12:31:16 -0700829 processor_->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800830 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700831 FROM_HERE,
832 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
833 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800834}
835
836void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
837 if (status_ == UpdateStatus::IDLE) {
838 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
839 return;
840 }
841
Yifan Hong90965502020-02-19 15:22:47 -0800842 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400843 ClearUpdateCompletedMarker();
Yifan Hong90965502020-02-19 15:22:47 -0800844 LOG(INFO) << "Terminating cleanup previous update.";
845 SetStatusAndNotify(UpdateStatus::IDLE);
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700846 for (auto observer : daemon_state_->service_observers())
847 observer->SendPayloadApplicationComplete(error_code);
Yifan Hong90965502020-02-19 15:22:47 -0800848 return;
849 }
850
Yifan Hong9194ce82019-11-07 11:03:42 -0800851 boot_control_->GetDynamicPartitionControl()->Cleanup();
Yifan Hong537802d2018-08-15 13:15:42 -0700852
Daniel Zheng57497982024-07-25 18:32:01 -0700853 for (auto observer : daemon_state_->service_observers())
854 observer->SendPayloadApplicationComplete(error_code);
855
Alex Deymo0d298542016-03-30 18:31:49 -0700856 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800857 UpdateStatus new_status =
858 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
859 : UpdateStatus::IDLE);
860 SetStatusAndNotify(new_status);
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900861 payload_fd_.reset();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800862
Sen Jiangb19c3ec2017-10-06 15:18:46 -0700863 // The network id is only applicable to one download attempt and once it's
864 // done the network id should not be re-used anymore.
865 if (!network_selector_->SetProcessNetwork(kDefaultNetworkId)) {
866 LOG(WARNING) << "Unable to unbind network.";
867 }
868
Tianjie Xu90aaa102017-10-10 17:39:03 -0700869 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
870 ClearMetricsPrefs();
871 if (error_code == ErrorCode::kSuccess) {
xunchang9cf52622019-01-25 11:04:58 -0800872 // We should only reset the PayloadAttemptNumber if the update succeeds, or
873 // we switch to a different payload.
874 prefs_->Delete(kPrefsPayloadAttemptNumber);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700875 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700876 // Clear the total bytes downloaded if and only if the update succeeds.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800877 metric_total_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700878 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800879}
880
881void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
882 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700883 size_t payload_size =
884 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700885 UpdateEngineStatus status_to_send = {.status = status_,
886 .progress = download_progress_,
887 .new_size_bytes = payload_size};
888
Alex Deymo5e3ea272016-01-28 13:42:23 -0800889 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700890 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800891 }
892 last_notify_time_ = TimeTicks::Now();
893}
894
Amin Hassani667cf7b2018-07-25 14:32:00 -0700895void UpdateAttempterAndroid::BuildUpdateActions(HttpFetcher* fetcher) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800896 CHECK(!processor_->IsRunning());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800897
898 // Actions:
Amin Hassani667cf7b2018-07-25 14:32:00 -0700899 auto update_boot_flags_action =
900 std::make_unique<UpdateBootFlagsAction>(boot_control_);
Yifan Hong83517502020-02-19 15:34:13 -0800901 auto cleanup_previous_update_action =
902 boot_control_->GetDynamicPartitionControl()
903 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
Amin Hassani667cf7b2018-07-25 14:32:00 -0700904 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
905 auto download_action =
906 std::make_unique<DownloadAction>(prefs_,
907 boot_control_,
908 hardware_,
Amin Hassani667cf7b2018-07-25 14:32:00 -0700909 fetcher, // passes ownership
Kelvin Zhang1304fe72021-10-06 19:12:12 -0700910 true /* interactive */,
911 update_certificates_path_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800912 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700913 download_action->set_base_offset(base_offset_);
Tianjie24f96092020-06-30 12:26:25 -0700914 auto filesystem_verifier_action = std::make_unique<FilesystemVerifierAction>(
915 boot_control_->GetDynamicPartitionControl());
Amin Hassani667cf7b2018-07-25 14:32:00 -0700916 auto postinstall_runner_action =
917 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang70eef232020-06-12 20:32:40 +0000918 filesystem_verifier_action->set_delegate(this);
Alex Deymob6eef732016-06-10 12:58:11 -0700919 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800920
Alex Deymo5e3ea272016-01-28 13:42:23 -0800921 // Bond them together. We have to use the leaf-types when calling
922 // BondActions().
923 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700924 BondActions(download_action.get(), filesystem_verifier_action.get());
925 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800926 postinstall_runner_action.get());
927
Amin Hassani667cf7b2018-07-25 14:32:00 -0700928 processor_->EnqueueAction(std::move(update_boot_flags_action));
Yifan Hong83517502020-02-19 15:34:13 -0800929 processor_->EnqueueAction(std::move(cleanup_previous_update_action));
Amin Hassani667cf7b2018-07-25 14:32:00 -0700930 processor_->EnqueueAction(std::move(install_plan_action));
931 processor_->EnqueueAction(std::move(download_action));
932 processor_->EnqueueAction(std::move(filesystem_verifier_action));
933 processor_->EnqueueAction(std::move(postinstall_runner_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800934}
935
Alex Deymo5e3ea272016-01-28 13:42:23 -0800936bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
937 string boot_id;
938 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800939 LOG(INFO) << "Writing update complete marker, slot "
940 << boot_control_->GetCurrentSlot() << ", boot id: " << boot_id;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400941 TEST_AND_RETURN_FALSE(
942 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id));
943 TEST_AND_RETURN_FALSE(
944 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot()));
945 return true;
946}
947
948bool UpdateAttempterAndroid::ClearUpdateCompletedMarker() {
949 LOG(INFO) << "Clearing update complete marker.";
950 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsUpdateCompletedOnBootId));
951 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsPreviousSlot));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800952 return true;
953}
954
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800955bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() const {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800956 // In case of an update_engine restart without a reboot, we stored the boot_id
957 // when the update was completed by setting a pref, so we can check whether
958 // the last update was on this boot or a previous one.
959 string boot_id;
960 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
961
962 string update_completed_on_boot_id;
963 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
964 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
965 &update_completed_on_boot_id) &&
966 update_completed_on_boot_id == boot_id);
967}
968
Tianjie Xu90aaa102017-10-10 17:39:03 -0700969// Collect and report the android metrics when we terminate the update.
970void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
971 ErrorCode error_code) {
972 int64_t attempt_number =
973 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
974 PayloadType payload_type = kPayloadTypeFull;
975 int64_t payload_size = 0;
976 for (const auto& p : install_plan_.payloads) {
977 if (p.type == InstallPayloadType::kDelta)
978 payload_type = kPayloadTypeDelta;
979 payload_size += p.size;
980 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700981 // In some cases, e.g. after calling |setShouldSwitchSlotOnReboot()|, this
982 // function will be triggered, but payload_size in this case might be 0, if so
983 // skip reporting any metrics.
984 if (payload_size == 0) {
985 return;
986 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700987
988 metrics::AttemptResult attempt_result =
989 metrics_utils::GetAttemptResult(error_code);
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700990 Time boot_time_start = Time::FromInternalValue(
991 metrics_utils::GetPersistedValue(kPrefsUpdateBootTimestampStart, prefs_));
992 Time monotonic_time_start = Time::FromInternalValue(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700993 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700994 TimeDelta duration = clock_->GetBootTime() - boot_time_start;
995 TimeDelta duration_uptime = clock_->GetMonotonicTime() - monotonic_time_start;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700996
997 metrics_reporter_->ReportUpdateAttemptMetrics(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700998 static_cast<int>(attempt_number),
999 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -07001000 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -07001001 duration_uptime,
1002 payload_size,
1003 attempt_result,
1004 error_code);
1005
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001006 int64_t current_bytes_downloaded = metric_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -07001007 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
1008 current_bytes_downloaded,
1009 0,
1010 DownloadSource::kNumDownloadSources,
1011 metrics::DownloadErrorCode::kUnset,
1012 metrics::ConnectionType::kUnset);
1013
Tianjie Xu90aaa102017-10-10 17:39:03 -07001014 if (error_code == ErrorCode::kSuccess) {
1015 int64_t reboot_count =
1016 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1017 string build_version;
1018 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -07001019
1020 // For android metrics, we only care about the total bytes downloaded
1021 // for all sources; for now we assume the only download source is
1022 // HttpsServer.
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001023 int64_t total_bytes_downloaded = metric_total_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -07001024 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
1025 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
1026 total_bytes_downloaded;
1027
1028 int download_overhead_percentage = 0;
Tianjie Xu21030c12019-08-14 13:00:23 -07001029 if (total_bytes_downloaded >= payload_size) {
1030 CHECK_GT(payload_size, 0);
Tianjie Xud4777a12017-10-24 14:54:18 -07001031 download_overhead_percentage =
Tianjie Xu21030c12019-08-14 13:00:23 -07001032 (total_bytes_downloaded - payload_size) * 100ull / payload_size;
1033 } else {
1034 LOG(WARNING) << "Downloaded bytes " << total_bytes_downloaded
1035 << " is smaller than the payload size " << payload_size;
Tianjie Xud4777a12017-10-24 14:54:18 -07001036 }
Tianjie Xu21030c12019-08-14 13:00:23 -07001037
Tianjie Xu90aaa102017-10-10 17:39:03 -07001038 metrics_reporter_->ReportSuccessfulUpdateMetrics(
1039 static_cast<int>(attempt_number),
1040 0, // update abandoned count
1041 payload_type,
1042 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -07001043 num_bytes_downloaded,
1044 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -07001045 duration,
Sen Jiang8712e962018-05-08 12:12:28 -07001046 duration_uptime,
Tianjie Xu90aaa102017-10-10 17:39:03 -07001047 static_cast<int>(reboot_count),
1048 0); // url_switch_count
1049 }
1050}
1051
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001052bool UpdateAttempterAndroid::OTARebootSucceeded() const {
1053 const auto current_slot = boot_control_->GetCurrentSlot();
Kelvin Zhang13020502023-08-02 15:18:40 -07001054 const string current_version = GetCurrentBuildVersion();
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001055 int64_t previous_slot = -1;
1056 TEST_AND_RETURN_FALSE(prefs_->GetInt64(kPrefsPreviousSlot, &previous_slot));
1057 string previous_version;
1058 TEST_AND_RETURN_FALSE(
1059 prefs_->GetString(kPrefsPreviousVersion, &previous_version));
1060 if (previous_slot != current_slot) {
1061 LOG(INFO) << "Detected a slot switch, OTA succeeded, device updated from "
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001062 << previous_version << " to " << current_version
1063 << ", previous slot: " << previous_slot
1064 << " current slot: " << current_slot;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001065 if (previous_version == current_version) {
1066 LOG(INFO) << "Previous version is the same as current version, this is "
1067 "possibly a self-OTA.";
1068 }
1069 return true;
1070 } else {
1071 LOG(INFO) << "Slot didn't switch, either the OTA is rolled back, or slot "
1072 "switch never happened, or system not rebooted at all.";
1073 if (previous_version != current_version) {
1074 LOG(INFO) << "Slot didn't change, but version changed from "
1075 << previous_version << " to " << current_version
1076 << " device could be flashed.";
1077 }
1078 return false;
1079 }
1080}
1081
1082OTAResult UpdateAttempterAndroid::GetOTAUpdateResult() const {
1083 // We only set |kPrefsSystemUpdatedMarker| if slot is actually switched, so
1084 // existence of this pref is sufficient indicator. Given that we have to
1085 // delete this pref after checking it. This is done in
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001086 // |DeltaPerformer::ResetUpdateProgress| and
1087 // |UpdateAttempterAndroid::UpdateStateAfterReboot|
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001088 auto slot_switch_attempted = prefs_->Exists(kPrefsUpdateCompletedOnBootId);
1089 auto system_rebooted = DidSystemReboot(prefs_);
1090 auto ota_successful = OTARebootSucceeded();
1091 if (ota_successful) {
1092 return OTAResult::OTA_SUCCESSFUL;
1093 }
1094 if (slot_switch_attempted) {
1095 if (system_rebooted) {
1096 // If we attempted slot switch, but still end up on the same slot, we
1097 // probably rolled back.
1098 return OTAResult::ROLLED_BACK;
1099 } else {
1100 return OTAResult::UPDATED_NEED_REBOOT;
1101 }
1102 }
1103 return OTAResult::NOT_ATTEMPTED;
1104}
1105
1106void UpdateAttempterAndroid::UpdateStateAfterReboot(const OTAResult result) {
Kelvin Zhang13020502023-08-02 15:18:40 -07001107 const string current_version = GetCurrentBuildVersion();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001108 TEST_AND_RETURN(!current_version.empty());
1109
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001110 // |UpdateStateAfterReboot()| is only called after system reboot, so record
1111 // boot id unconditionally
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001112 string current_boot_id;
1113 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
1114 prefs_->SetString(kPrefsBootId, current_boot_id);
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001115 std::string slot_switch_indicator;
1116 prefs_->GetString(kPrefsUpdateCompletedOnBootId, &slot_switch_indicator);
1117 if (slot_switch_indicator != current_boot_id) {
1118 ClearUpdateCompletedMarker();
1119 }
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001120
Tianjie Xu90aaa102017-10-10 17:39:03 -07001121 // If there's no record of previous version (e.g. due to a data wipe), we
1122 // save the info of current boot and skip the metrics report.
1123 if (!prefs_->Exists(kPrefsPreviousVersion)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001124 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001125 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001126 ClearMetricsPrefs();
1127 return;
1128 }
Kelvin Zhang86603472021-05-11 12:16:27 -04001129 // update_engine restarted under the same build and same slot.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001130 if (result != OTAResult::OTA_SUCCESSFUL) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001131 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
1132 // set when we start a new update.
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001133 if (prefs_->Exists(kPrefsNumReboots)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001134 int64_t reboot_count =
1135 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1136 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
1137 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001138
1139 if (result == OTAResult::ROLLED_BACK) {
1140 // This will release all space previously allocated for apex
1141 // decompression. If we detect a rollback, we should release space and
1142 // return the space to user. Any subsequent attempt to install OTA will
1143 // allocate space again anyway.
1144 LOG(INFO) << "Detected a rollback, releasing space allocated for apex "
1145 "deompression.";
1146 apex_handler_android_->AllocateSpace({});
1147 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1148 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001149 return;
1150 }
1151
1152 // Now that the build version changes, report the update metrics.
1153 // TODO(xunchang) check the build version is larger than the previous one.
Tianjie Xu90aaa102017-10-10 17:39:03 -07001154 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001155 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001156
1157 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
1158 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
1159 if (previous_attempt_exists) {
1160 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
1161 }
1162
1163 metrics_utils::LoadAndReportTimeToReboot(
1164 metrics_reporter_.get(), prefs_, clock_.get());
1165 ClearMetricsPrefs();
Sen Jiang1bafff82019-01-02 15:54:40 -08001166
1167 // Also reset the update progress if the build version has changed.
1168 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
1169 LOG(WARNING) << "Unable to reset the update progress.";
1170 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001171}
1172
1173// Save the update start time. Reset the reboot count and attempt number if the
1174// update isn't a resume; otherwise increment the attempt number.
1175void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
1176 if (!is_resume) {
1177 metrics_utils::SetNumReboots(0, prefs_);
1178 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
1179 } else {
1180 int64_t attempt_number =
1181 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
1182 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
1183 }
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001184 metrics_utils::SetUpdateTimestampStart(clock_->GetMonotonicTime(), prefs_);
1185 metrics_utils::SetUpdateBootTimestampStart(clock_->GetBootTime(), prefs_);
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001186 ClearUpdateCompletedMarker();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001187}
1188
1189void UpdateAttempterAndroid::ClearMetricsPrefs() {
1190 CHECK(prefs_);
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001191 metric_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001192 prefs_->Delete(kPrefsNumReboots);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001193 prefs_->Delete(kPrefsSystemUpdatedMarker);
1194 prefs_->Delete(kPrefsUpdateTimestampStart);
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001195 prefs_->Delete(kPrefsUpdateBootTimestampStart);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001196}
1197
Yifan Hongbd47d622019-12-13 14:59:58 -08001198BootControlInterface::Slot UpdateAttempterAndroid::GetCurrentSlot() const {
1199 return boot_control_->GetCurrentSlot();
1200}
1201
1202BootControlInterface::Slot UpdateAttempterAndroid::GetTargetSlot() const {
1203 return GetCurrentSlot() == 0 ? 1 : 0;
1204}
1205
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001206uint64_t UpdateAttempterAndroid::AllocateSpaceForPayload(
1207 const std::string& metadata_filename,
1208 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001209 Error* error) {
Yifan Hong65613032020-01-09 17:52:13 -08001210 std::map<string, string> headers;
1211 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
1212 return 0;
1213 }
Kelvin Zhangabb082f2023-04-27 20:46:06 -07001214 DeltaArchiveManifest manifest;
1215 brillo::Blob metadata_hash;
1216 if (!brillo::data_encoding::Base64Decode(
1217 headers[kPayloadPropertyMetadataHash], &metadata_hash)) {
1218 metadata_hash.clear();
1219 }
1220 if (!VerifyPayloadParseManifest(
1221 metadata_filename, ToStringView(metadata_hash), &manifest, error)) {
1222 return 0;
1223 }
Yifan Hong65613032020-01-09 17:52:13 -08001224
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001225 std::vector<ApexInfo> apex_infos(manifest.apex_info().begin(),
1226 manifest.apex_info().end());
1227 uint64_t apex_size_required = 0;
1228 if (apex_handler_android_ != nullptr) {
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001229 auto result = apex_handler_android_->CalculateSize(apex_infos);
1230 if (!result.ok()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001231 LogAndSetGenericError(
1232 error,
1233 __LINE__,
1234 __FILE__,
1235 "Failed to calculate size required for compressed APEX");
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001236 return 0;
1237 }
1238 apex_size_required = *result;
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001239 }
1240
Yifan Hong65613032020-01-09 17:52:13 -08001241 string payload_id = GetPayloadId(headers);
1242 uint64_t required_size = 0;
Daniel Zhengeede4c82023-06-13 11:21:06 -07001243 ErrorCode error_code{};
1244
Yifan Hong65613032020-01-09 17:52:13 -08001245 if (!DeltaPerformer::PreparePartitionsForUpdate(prefs_,
1246 boot_control_,
1247 GetTargetSlot(),
1248 manifest,
1249 payload_id,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001250 &required_size,
1251 &error_code)) {
1252 if (error_code == ErrorCode::kOverlayfsenabledError) {
1253 LogAndSetError(error,
1254 __LINE__,
1255 __FILE__,
1256 "OverlayFS Shouldn't be enabled for OTA.",
1257 error_code);
1258 return 0;
1259 }
Yifan Hong65613032020-01-09 17:52:13 -08001260 if (required_size == 0) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001261 LogAndSetGenericError(
1262 error, __LINE__, __FILE__, "Failed to allocate space for payload.");
Yifan Hong65613032020-01-09 17:52:13 -08001263 return 0;
1264 } else {
1265 LOG(ERROR) << "Insufficient space for payload: " << required_size
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001266 << " bytes, apex decompression: " << apex_size_required
Yifan Hong65613032020-01-09 17:52:13 -08001267 << " bytes";
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001268 return required_size + apex_size_required;
Yifan Hong65613032020-01-09 17:52:13 -08001269 }
1270 }
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001271
1272 if (apex_size_required > 0 && apex_handler_android_ != nullptr &&
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001273 !apex_handler_android_->AllocateSpace(apex_infos)) {
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001274 LOG(ERROR) << "Insufficient space for apex decompression: "
1275 << apex_size_required << " bytes";
1276 return apex_size_required;
Kelvin Zhang8933d572021-01-28 10:17:34 -05001277 }
Yifan Hong65613032020-01-09 17:52:13 -08001278
1279 LOG(INFO) << "Successfully allocated space for payload.";
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001280 return 0;
1281}
1282
Yifan Hong40bb0d02020-02-24 17:33:14 -08001283void UpdateAttempterAndroid::CleanupSuccessfulUpdate(
1284 std::unique_ptr<CleanupSuccessfulUpdateCallbackInterface> callback,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001285 Error* error) {
Yifan Hong40bb0d02020-02-24 17:33:14 -08001286 if (cleanup_previous_update_code_.has_value()) {
1287 LOG(INFO) << "CleanupSuccessfulUpdate has previously completed with "
1288 << utils::ErrorCodeToString(*cleanup_previous_update_code_);
1289 if (callback) {
1290 callback->OnCleanupComplete(
1291 static_cast<int32_t>(*cleanup_previous_update_code_));
1292 }
1293 return;
Yifan Hong4f611562020-01-15 23:41:33 -08001294 }
Yifan Hong40bb0d02020-02-24 17:33:14 -08001295 if (callback) {
1296 auto callback_ptr = callback.get();
1297 cleanup_previous_update_callbacks_.emplace_back(std::move(callback));
Kelvin Zhang2f6c25a2023-07-05 12:49:34 -07001298 callback_ptr->RegisterForDeathNotifications([this, callback_ptr]() {
1299 RemoveCleanupPreviousUpdateCallback(callback_ptr);
1300 });
Yifan Hong40bb0d02020-02-24 17:33:14 -08001301 }
1302 ScheduleCleanupPreviousUpdate();
Yifan Hong2236ea02019-12-13 16:11:22 -08001303}
1304
Tianjie7f8f2ab2021-07-23 17:08:50 -07001305bool UpdateAttempterAndroid::setShouldSwitchSlotOnReboot(
Daniel Zheng92f7d172023-06-22 14:31:37 -07001306 const std::string& metadata_filename, Error* error) {
Kelvin Zhang20982a52021-08-13 12:31:16 -07001307 LOG(INFO) << "setShouldSwitchSlotOnReboot(" << metadata_filename << ")";
Tianjie7f8f2ab2021-07-23 17:08:50 -07001308 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001309 return LogAndSetGenericError(
1310 error,
1311 __LINE__,
1312 __FILE__,
1313 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001314 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001315 DeltaArchiveManifest manifest;
1316 TEST_AND_RETURN_FALSE(
1317 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
1318
Kelvin Zhang20982a52021-08-13 12:31:16 -07001319 InstallPlan install_plan_;
1320 install_plan_.source_slot = GetCurrentSlot();
1321 install_plan_.target_slot = GetTargetSlot();
1322 // Don't do verity computation, just hash the partitions
1323 install_plan_.write_verity = false;
1324 // Don't run postinstall, we just need PostinstallAction to switch the slots.
1325 install_plan_.run_post_install = false;
1326 install_plan_.is_resume = true;
1327
1328 CHECK_NE(install_plan_.source_slot, UINT32_MAX);
1329 CHECK_NE(install_plan_.target_slot, UINT32_MAX);
1330
Kelvin Zhang20982a52021-08-13 12:31:16 -07001331 auto postinstall_runner_action =
1332 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001333 postinstall_runner_action->set_delegate(this);
1334
Kelvin Zhangf8441982022-12-07 18:18:47 -08001335 // If last error code is kUpdatedButNotActive, we know that we reached this
1336 // state by calling applyPayload() with switch_slot=false. That applyPayload()
1337 // call would have already performed filesystem verification, therefore, we
1338 // can safely skip the verification to save time.
1339 if (last_error_ == ErrorCode::kUpdatedButNotActive) {
Kelvin Zhang19acf4f2024-01-08 21:18:28 +00001340 auto install_plan_action =
1341 std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhangf8441982022-12-07 18:18:47 -08001342 BondActions(install_plan_action.get(), postinstall_runner_action.get());
1343 processor_->EnqueueAction(std::move(install_plan_action));
Kelvin Zhang19acf4f2024-01-08 21:18:28 +00001344 SetStatusAndNotify(UpdateStatus::FINALIZING);
Kelvin Zhangf8441982022-12-07 18:18:47 -08001345 } else {
Kelvin Zhang19acf4f2024-01-08 21:18:28 +00001346 ErrorCode error_code{};
Kelvin Zhang263a5402022-12-08 23:03:32 -08001347 if (!boot_control_->GetDynamicPartitionControl()
1348 ->PreparePartitionsForUpdate(GetCurrentSlot(),
1349 GetTargetSlot(),
1350 manifest,
1351 false /* should update */,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001352 nullptr,
1353 &error_code)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001354 return LogAndSetGenericError(
1355 error, __LINE__, __FILE__, "Failed to PreparePartitionsForUpdate");
Kelvin Zhang263a5402022-12-08 23:03:32 -08001356 }
Kelvin Zhang263a5402022-12-08 23:03:32 -08001357 if (!install_plan_.ParsePartitions(manifest.partitions(),
1358 boot_control_,
1359 manifest.block_size(),
1360 &error_code)) {
1361 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001362 __LINE__,
1363 __FILE__,
Kelvin Zhang263a5402022-12-08 23:03:32 -08001364 "Failed to LoadPartitionsFromSlots " +
Daniel Zheng92f7d172023-06-22 14:31:37 -07001365 utils::ErrorCodeToString(error_code),
1366 error_code);
Kelvin Zhang263a5402022-12-08 23:03:32 -08001367 }
Kelvin Zhang19acf4f2024-01-08 21:18:28 +00001368 auto install_plan_action =
1369 std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhangf8441982022-12-07 18:18:47 -08001370 auto filesystem_verifier_action =
1371 std::make_unique<FilesystemVerifierAction>(
1372 boot_control_->GetDynamicPartitionControl());
1373 filesystem_verifier_action->set_delegate(this);
1374 BondActions(install_plan_action.get(), filesystem_verifier_action.get());
1375 BondActions(filesystem_verifier_action.get(),
1376 postinstall_runner_action.get());
1377 processor_->EnqueueAction(std::move(install_plan_action));
1378 processor_->EnqueueAction(std::move(filesystem_verifier_action));
Kelvin Zhang19acf4f2024-01-08 21:18:28 +00001379 SetStatusAndNotify(UpdateStatus::VERIFYING);
Kelvin Zhangf8441982022-12-07 18:18:47 -08001380 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001381
Kelvin Zhang20982a52021-08-13 12:31:16 -07001382 processor_->EnqueueAction(std::move(postinstall_runner_action));
1383 ScheduleProcessingStart();
1384 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001385}
1386
Daniel Zheng92f7d172023-06-22 14:31:37 -07001387bool UpdateAttempterAndroid::resetShouldSwitchSlotOnReboot(Error* error) {
Tianjie7f8f2ab2021-07-23 17:08:50 -07001388 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001389 return LogAndSetGenericError(
1390 error,
1391 __LINE__,
1392 __FILE__,
1393 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001394 }
Daniel Zhenge76cf562022-11-08 17:32:10 +00001395 TEST_AND_RETURN_FALSE(ClearUpdateCompletedMarker());
Kelvin Zhang20982a52021-08-13 12:31:16 -07001396 // Update the boot flags so the current slot has higher priority.
1397 if (!boot_control_->SetActiveBootSlot(GetCurrentSlot())) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001398 return LogAndSetGenericError(
1399 error, __LINE__, __FILE__, "Failed to SetActiveBootSlot");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001400 }
1401
1402 // Mark the current slot as successful again, since marking it as active
1403 // may reset the successful bit. We ignore the result of whether marking
1404 // the current slot as successful worked.
1405 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful) {}))) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001406 return LogAndSetGenericError(
1407 error, __LINE__, __FILE__, "Failed to MarkBootSuccessfulAsync");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001408 }
1409
1410 // Resets the warm reset property since we won't switch the slot.
1411 hardware_->SetWarmReset(false);
1412
1413 // Resets the vbmeta digest.
1414 hardware_->SetVbmetaDigestForInactiveSlot(true /* reset */);
1415 LOG(INFO) << "Slot switch cancelled.";
1416 SetStatusAndNotify(UpdateStatus::IDLE);
1417 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001418}
1419
Yifan Hong90965502020-02-19 15:22:47 -08001420void UpdateAttempterAndroid::ScheduleCleanupPreviousUpdate() {
1421 // If a previous CleanupSuccessfulUpdate call has not finished, or an update
1422 // is in progress, skip enqueueing the action.
1423 if (processor_->IsRunning()) {
1424 LOG(INFO) << "Already processing an update. CleanupPreviousUpdate should "
1425 << "be done when the current update finishes.";
1426 return;
1427 }
1428 LOG(INFO) << "Scheduling CleanupPreviousUpdateAction.";
1429 auto action =
1430 boot_control_->GetDynamicPartitionControl()
1431 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
1432 processor_->EnqueueAction(std::move(action));
1433 processor_->set_delegate(this);
1434 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
1435 processor_->StartProcessing();
1436}
1437
Yifan Hong40bb0d02020-02-24 17:33:14 -08001438void UpdateAttempterAndroid::OnCleanupProgressUpdate(double progress) {
1439 for (auto&& callback : cleanup_previous_update_callbacks_) {
1440 callback->OnCleanupProgressUpdate(progress);
1441 }
1442}
1443
1444void UpdateAttempterAndroid::NotifyCleanupPreviousUpdateCallbacksAndClear() {
1445 CHECK(cleanup_previous_update_code_.has_value());
1446 for (auto&& callback : cleanup_previous_update_callbacks_) {
1447 callback->OnCleanupComplete(
1448 static_cast<int32_t>(*cleanup_previous_update_code_));
1449 }
1450 cleanup_previous_update_callbacks_.clear();
1451}
1452
1453void UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback(
1454 CleanupSuccessfulUpdateCallbackInterface* callback) {
1455 auto end_it =
1456 std::remove_if(cleanup_previous_update_callbacks_.begin(),
1457 cleanup_previous_update_callbacks_.end(),
1458 [&](const auto& e) { return e.get() == callback; });
1459 cleanup_previous_update_callbacks_.erase(
1460 end_it, cleanup_previous_update_callbacks_.end());
1461}
Yifan Hong90965502020-02-19 15:22:47 -08001462
Daniel Zheng9fc62b82023-03-24 22:57:20 +00001463bool UpdateAttempterAndroid::IsProductionBuild() {
1464 if (android::base::GetProperty("ro.build.type", "") != "userdebug" ||
1465 android::base::GetProperty("ro.build.tags", "") == "release-keys" ||
1466 android::base::GetProperty("ro.boot.verifiedbootstate", "") == "green") {
1467 return true;
1468 }
1469 return false;
1470}
1471
Alex Deymo5e3ea272016-01-28 13:42:23 -08001472} // namespace chromeos_update_engine