blob: d7cb2d28de21b09bb385107959f5bd3337c121b4 [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
Kelvin Zhang85a6d992023-10-23 10:40:58 -0700314 install_plan_.spl_downgrade =
315 GetHeaderAsBool(headers[kPayloadPropertySplDowngrade], false);
316
Daniel Zheng9fc62b82023-03-24 22:57:20 +0000317 if (!IsProductionBuild()) {
318 install_plan_.disable_vabc =
319 GetHeaderAsBool(headers[kPayloadDisableVABC], false);
320 }
321
Sen Jiangfe522822017-10-31 15:14:11 -0700322 install_plan_.switch_slot_on_reboot =
323 GetHeaderAsBool(headers[kPayloadPropertySwitchSlotOnReboot], true);
324
Tianjie Xu087de9d2019-11-01 17:11:22 -0700325 install_plan_.run_post_install =
326 GetHeaderAsBool(headers[kPayloadPropertyRunPostInstall], true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800327
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700328 // Skip writing verity if we're resuming and verity has already been written.
329 install_plan_.write_verity = true;
330 if (install_plan_.is_resume && prefs_->Exists(kPrefsVerityWritten)) {
331 bool verity_written = false;
332 if (prefs_->GetBoolean(kPrefsVerityWritten, &verity_written) &&
333 verity_written) {
334 install_plan_.write_verity = false;
335 }
336 }
337
Alex Deymo87792ea2016-07-25 15:40:36 -0700338 NetworkId network_id = kDefaultNetworkId;
339 if (!headers[kPayloadPropertyNetworkId].empty()) {
340 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
341 &network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700342 return LogAndSetGenericError(
Alex Deymo87792ea2016-07-25 15:40:36 -0700343 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700344 __LINE__,
345 __FILE__,
Alex Deymo87792ea2016-07-25 15:40:36 -0700346 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
347 }
348 if (!network_selector_->SetProcessNetwork(network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700349 return LogAndSetGenericError(
Sen Jiangcbd37c62017-09-12 15:04:35 -0700350 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700351 __LINE__,
352 __FILE__,
Sen Jiangcbd37c62017-09-12 15:04:35 -0700353 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700354 }
355 }
356
Alex Deymo5e3ea272016-01-28 13:42:23 -0800357 LOG(INFO) << "Using this install plan:";
358 install_plan_.Dump();
359
Amin Hassani667cf7b2018-07-25 14:32:00 -0700360 HttpFetcher* fetcher = nullptr;
361 if (FileFetcher::SupportedUrl(payload_url)) {
362 DLOG(INFO) << "Using FileFetcher for file URL.";
363 fetcher = new FileFetcher();
364 } else {
365#ifdef _UE_SIDELOAD
366 LOG(FATAL) << "Unsupported sideload URI: " << payload_url;
Chih-Hung Hsieh6e4f3452022-12-21 12:20:45 -0800367 return false; // NOLINT, unreached but analyzer might not know.
368 // Suppress warnings about null 'fetcher' after this.
Amin Hassani667cf7b2018-07-25 14:32:00 -0700369#else
Kelvin Zhangc7a1d1f2022-07-29 13:36:29 -0700370 LibcurlHttpFetcher* libcurl_fetcher = new LibcurlHttpFetcher(hardware_);
Kelvin Zhang3cc4fa32022-09-27 16:15:10 -0700371 if (!headers[kPayloadDownloadRetry].empty()) {
372 libcurl_fetcher->set_max_retry_count(
373 atoi(headers[kPayloadDownloadRetry].c_str()));
374 }
Amin Hassani667cf7b2018-07-25 14:32:00 -0700375 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
376 fetcher = libcurl_fetcher;
377#endif // _UE_SIDELOAD
378 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800379 // Setup extra headers.
Alex Deymofdd6dec2016-03-03 22:35:43 -0800380 if (!headers[kPayloadPropertyAuthorization].empty())
381 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
382 if (!headers[kPayloadPropertyUserAgent].empty())
383 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
384
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700385 if (!headers[kPayloadPropertyNetworkProxy].empty()) {
386 LOG(INFO) << "Using proxy url from payload headers: "
387 << headers[kPayloadPropertyNetworkProxy];
388 fetcher->SetProxies({headers[kPayloadPropertyNetworkProxy]});
389 }
Kelvin Zhanga7407b52023-03-13 15:05:14 -0700390 if (!headers[kPayloadVABCNone].empty()) {
391 install_plan_.vabc_none = true;
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000392 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800393 if (!headers[kPayloadEnableThreading].empty()) {
394 install_plan_.enable_threading = true;
395 }
396 if (!headers[kPayloadBatchedWrites].empty()) {
397 install_plan_.batched_writes = true;
398 }
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700399
Amin Hassani667cf7b2018-07-25 14:32:00 -0700400 BuildUpdateActions(fetcher);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800401
Alex Deymo5e3ea272016-01-28 13:42:23 -0800402 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700403
404 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
405 // TODO(xunchang) report the metrics for unresumable updates
406
Amin Hassani667cf7b2018-07-25 14:32:00 -0700407 ScheduleProcessingStart();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800408 return true;
409}
410
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900411bool UpdateAttempterAndroid::ApplyPayload(
412 int fd,
413 int64_t payload_offset,
414 int64_t payload_size,
415 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700416 Error* error) {
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100417 // update_engine state must be checked before modifying payload_fd_ otherwise
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +0000418 // already running update will be terminated (existing file descriptor will be
419 // closed)
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100420 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700421 return LogAndSetGenericError(
422 error,
423 __LINE__,
424 __FILE__,
425 "An update already applied, waiting for reboot");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100426 }
427 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700428 return LogAndSetGenericError(
429 error,
430 __LINE__,
431 __FILE__,
432 "Already processing an update, cancel it first.");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100433 }
434 DCHECK_EQ(status_, UpdateStatus::IDLE);
435
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900436 payload_fd_.reset(dup(fd));
437 const string payload_url = "fd://" + std::to_string(payload_fd_.get());
438
439 return ApplyPayload(
440 payload_url, payload_offset, payload_size, key_value_pair_headers, error);
441}
442
Daniel Zheng92f7d172023-06-22 14:31:37 -0700443bool UpdateAttempterAndroid::SuspendUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700444 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700445 return LogAndSetGenericError(
446 error, __LINE__, __FILE__, "No ongoing update to suspend.");
Alex Deymof2858572016-02-25 11:20:13 -0800447 processor_->SuspendProcessing();
448 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800449}
450
Daniel Zheng92f7d172023-06-22 14:31:37 -0700451bool UpdateAttempterAndroid::ResumeUpdate(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 resume.");
Alex Deymof2858572016-02-25 11:20:13 -0800455 processor_->ResumeProcessing();
456 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800457}
458
Daniel Zheng92f7d172023-06-22 14:31:37 -0700459bool UpdateAttempterAndroid::CancelUpdate(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 cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800463 processor_->StopProcessing();
464 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800465}
466
Daniel Zheng92f7d172023-06-22 14:31:37 -0700467bool UpdateAttempterAndroid::ResetStatus(Error* error) {
Alex Deymo3b678db2016-02-09 11:50:06 -0800468 LOG(INFO) << "Attempting to reset state from "
469 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700470 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700471 return LogAndSetGenericError(
472 error,
473 __LINE__,
474 __FILE__,
475 "Already processing an update, cancel it first.");
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700476 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700477 if (status_ != UpdateStatus::IDLE &&
478 status_ != UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700479 return LogAndSetGenericError(
480 error,
481 __LINE__,
482 __FILE__,
483 "Status reset not allowed in this state, please "
484 "cancel on going OTA first.");
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700485 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800486
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000487 if (apex_handler_android_ != nullptr) {
488 LOG(INFO) << "Cleaning up reserved space for compressed APEX (if any)";
489 std::vector<ApexInfo> apex_infos_blank;
490 apex_handler_android_->AllocateSpace(apex_infos_blank);
491 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400492 // Remove the reboot marker so that if the machine is rebooted
493 // after resetting to idle state, it doesn't go back to
494 // UpdateStatus::UPDATED_NEED_REBOOT state.
495 if (!ClearUpdateCompletedMarker()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700496 return LogAndSetGenericError(error,
497 __LINE__,
498 __FILE__,
499 "Failed to reset the status because "
500 "ClearUpdateCompletedMarker() failed");
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400501 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700502 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
503 if (!resetShouldSwitchSlotOnReboot(error)) {
504 LOG(INFO) << "Failed to reset slot switch.";
505 return false;
506 }
507 LOG(INFO) << "Slot switch reset successful";
508 }
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700509 if (!boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_)) {
510 LOG(WARNING) << "Failed to reset snapshots. UpdateStatus is IDLE but"
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000511 << "space might not be freed.";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700512 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700513 return true;
Alex Deymo3b678db2016-02-09 11:50:06 -0800514}
515
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700516bool operator==(const std::vector<unsigned char>& a, std::string_view b) {
517 if (a.size() != b.size()) {
518 return false;
519 }
520 return memcmp(a.data(), b.data(), a.size()) == 0;
521}
522bool operator!=(const std::vector<unsigned char>& a, std::string_view b) {
523 return !(a == b);
524}
525
Yifan Hongbd47d622019-12-13 14:59:58 -0800526bool UpdateAttempterAndroid::VerifyPayloadParseManifest(
527 const std::string& metadata_filename,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700528 std::string_view expected_metadata_hash,
Yifan Hongbd47d622019-12-13 14:59:58 -0800529 DeltaArchiveManifest* manifest,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700530 Error* error) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800531 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
532 if (!fd->Open(metadata_filename.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700533 return LogAndSetError(error,
534 __LINE__,
535 __FILE__,
536 "Failed to open " + metadata_filename,
537 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800538 }
539 brillo::Blob metadata(kMaxPayloadHeaderSize);
540 if (!fd->Read(metadata.data(), metadata.size())) {
541 return LogAndSetError(
542 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700543 __LINE__,
544 __FILE__,
545 "Failed to read payload header from " + metadata_filename,
546 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800547 }
Daniel Zhengda4f7292022-09-02 22:59:32 +0000548 ErrorCode errorcode{};
Sen Jiang8371c1c2018-02-01 13:46:39 -0800549 PayloadMetadata payload_metadata;
Sen Jiangf1236632018-05-11 16:03:23 -0700550 if (payload_metadata.ParsePayloadHeader(metadata, &errorcode) !=
Sen Jiang8371c1c2018-02-01 13:46:39 -0800551 MetadataParseResult::kSuccess) {
552 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700553 __LINE__,
554 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800555 "Failed to parse payload header: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700556 utils::ErrorCodeToString(errorcode),
557 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800558 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700559 uint64_t metadata_size = payload_metadata.GetMetadataSize() +
560 payload_metadata.GetMetadataSignatureSize();
561 if (metadata_size < kMaxPayloadHeaderSize ||
562 metadata_size >
563 static_cast<uint64_t>(utils::FileSize(metadata_filename))) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800564 return LogAndSetError(
565 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700566 __LINE__,
567 __FILE__,
568 "Invalid metadata size: " + std::to_string(metadata_size),
569 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800570 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700571 metadata.resize(metadata_size);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800572 if (!fd->Read(metadata.data() + kMaxPayloadHeaderSize,
573 metadata.size() - kMaxPayloadHeaderSize)) {
574 return LogAndSetError(
575 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700576 __LINE__,
577 __FILE__,
578 "Failed to read metadata and signature from " + metadata_filename,
579 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800580 }
581 fd->Close();
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700582 if (!expected_metadata_hash.empty()) {
583 brillo::Blob metadata_hash;
584 TEST_AND_RETURN_FALSE(HashCalculator::RawHashOfBytes(
585 metadata.data(), payload_metadata.GetMetadataSize(), &metadata_hash));
586 if (metadata_hash != expected_metadata_hash) {
587 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700588 __LINE__,
589 __FILE__,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700590 "Metadata hash mismatch. Expected hash: " +
591 HexEncode(expected_metadata_hash) +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700592 " actual hash: " + HexEncode(metadata_hash),
593 ErrorCode::kDownloadManifestParseError);
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700594 } else {
595 LOG(INFO) << "Payload metadata hash check passed : "
596 << HexEncode(metadata_hash);
597 }
598 }
Sen Jiang08c6da12019-01-07 18:28:56 -0800599
Tianjie Xu7a78d632019-10-08 16:32:39 -0700600 auto payload_verifier = PayloadVerifier::CreateInstanceFromZipPath(
601 constants::kUpdateCertificatesPath);
602 if (!payload_verifier) {
603 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700604 __LINE__,
605 __FILE__,
Tianjie Xu7a78d632019-10-08 16:32:39 -0700606 "Failed to create the payload verifier from " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700607 std::string(constants::kUpdateCertificatesPath),
608 ErrorCode::kDownloadManifestParseError);
Sen Jiang08c6da12019-01-07 18:28:56 -0800609 }
Tianjie Xu7a78d632019-10-08 16:32:39 -0700610 errorcode = payload_metadata.ValidateMetadataSignature(
611 metadata, "", *payload_verifier);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800612 if (errorcode != ErrorCode::kSuccess) {
613 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700614 __LINE__,
615 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800616 "Failed to validate metadata signature: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700617 utils::ErrorCodeToString(errorcode),
618 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800619 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800620 if (!payload_metadata.GetManifest(metadata, manifest)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700621 return LogAndSetError(error,
622 __LINE__,
623 __FILE__,
624 "Failed to parse manifest.",
625 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800626 }
627
Yifan Hongbd47d622019-12-13 14:59:58 -0800628 return true;
629}
630
631bool UpdateAttempterAndroid::VerifyPayloadApplicable(
Daniel Zheng92f7d172023-06-22 14:31:37 -0700632 const std::string& metadata_filename, Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800633 DeltaArchiveManifest manifest;
634 TEST_AND_RETURN_FALSE(
635 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
636
637 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
Daniel Zhengda4f7292022-09-02 22:59:32 +0000638 ErrorCode errorcode{};
Yifan Hongbd47d622019-12-13 14:59:58 -0800639
640 BootControlInterface::Slot current_slot = GetCurrentSlot();
Sen Jiang8371c1c2018-02-01 13:46:39 -0800641 for (const PartitionUpdate& partition : manifest.partitions()) {
642 if (!partition.has_old_partition_info())
643 continue;
644 string partition_path;
645 if (!boot_control_->GetPartitionDevice(
646 partition.partition_name(), current_slot, &partition_path)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700647 return LogAndSetGenericError(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800648 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700649 __LINE__,
650 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800651 "Failed to get partition device for " + partition.partition_name());
652 }
653 if (!fd->Open(partition_path.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700654 return LogAndSetGenericError(
655 error, __LINE__, __FILE__, "Failed to open " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800656 }
657 for (const InstallOperation& operation : partition.operations()) {
658 if (!operation.has_src_sha256_hash())
659 continue;
660 brillo::Blob source_hash;
661 if (!fd_utils::ReadAndHashExtents(fd,
662 operation.src_extents(),
663 manifest.block_size(),
664 &source_hash)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700665 return LogAndSetGenericError(
666 error, __LINE__, __FILE__, "Failed to hash " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800667 }
Kelvin Zhang9bd519d2020-09-23 12:55:19 -0400668 if (!PartitionWriter::ValidateSourceHash(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800669 source_hash, operation, fd, &errorcode)) {
670 return false;
671 }
672 }
673 fd->Close();
674 }
675 return true;
676}
677
Alex Deymo5e3ea272016-01-28 13:42:23 -0800678void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
679 ErrorCode code) {
680 LOG(INFO) << "Processing Done.";
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800681 metric_bytes_downloaded_.Flush(true);
682 metric_total_bytes_downloaded_.Flush(true);
Kelvin Zhangf8441982022-12-07 18:18:47 -0800683 last_error_ = code;
Yifan Hong90965502020-02-19 15:22:47 -0800684 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
685 TerminateUpdateAndNotify(code);
686 return;
687 }
688
Alex Deymo5990bf32016-07-19 17:01:41 -0700689 switch (code) {
690 case ErrorCode::kSuccess:
691 // Update succeeded.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400692 if (!WriteUpdateCompletedMarker()) {
693 LOG(ERROR) << "Failed to write update completion marker";
694 }
Alex Deymo5990bf32016-07-19 17:01:41 -0700695 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800696
Alex Deymo5990bf32016-07-19 17:01:41 -0700697 LOG(INFO) << "Update successfully applied, waiting to reboot.";
698 break;
699
700 case ErrorCode::kFilesystemCopierError:
701 case ErrorCode::kNewRootfsVerificationError:
702 case ErrorCode::kNewKernelVerificationError:
703 case ErrorCode::kFilesystemVerifierError:
704 case ErrorCode::kDownloadStateInitializationError:
705 // Reset the ongoing update for these errors so it starts from the
706 // beginning next time.
707 DeltaPerformer::ResetUpdateProgress(prefs_, false);
708 LOG(INFO) << "Resetting update progress.";
709 break;
710
Sen Jiangacbdd1c2017-10-19 13:30:19 -0700711 case ErrorCode::kPayloadTimestampError:
712 // SafetyNet logging, b/36232423
713 android_errorWriteLog(0x534e4554, "36232423");
714 break;
715
Alex Deymo5990bf32016-07-19 17:01:41 -0700716 default:
717 // Ignore all other error codes.
718 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700719 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800720
721 TerminateUpdateAndNotify(code);
722}
723
724void UpdateAttempterAndroid::ProcessingStopped(
725 const ActionProcessor* processor) {
726 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
727}
728
729void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
730 AbstractAction* action,
731 ErrorCode code) {
732 // Reset download progress regardless of whether or not the download
733 // action succeeded.
734 const string type = action->Type();
Yifan Hong40bb0d02020-02-24 17:33:14 -0800735 if (type == CleanupPreviousUpdateAction::StaticType() ||
736 (type == NoOpAction::StaticType() &&
737 status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE)) {
738 cleanup_previous_update_code_ = code;
739 NotifyCleanupPreviousUpdateCallbacksAndClear();
740 }
Kelvin Zhang70eef232020-06-12 20:32:40 +0000741 // download_progress_ is actually used by other actions, such as
742 // filesystem_verify_action. Therefore we always clear it.
743 download_progress_ = 0;
Sen Jiangfe522822017-10-31 15:14:11 -0700744 if (type == PostinstallRunnerAction::StaticType()) {
745 bool succeeded =
746 code == ErrorCode::kSuccess || code == ErrorCode::kUpdatedButNotActive;
747 prefs_->SetBoolean(kPrefsPostInstallSucceeded, succeeded);
748 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800749 if (code != ErrorCode::kSuccess) {
750 // If an action failed, the ActionProcessor will cancel the whole thing.
751 return;
752 }
Yifan Hong83517502020-02-19 15:34:13 -0800753 if (type == UpdateBootFlagsAction::StaticType()) {
754 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
755 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800756 if (type == DownloadAction::StaticType()) {
Kelvin Zhangd2da7b12020-07-07 17:19:21 -0400757 auto download_action = static_cast<DownloadAction*>(action);
758 install_plan_ = *download_action->install_plan();
Kelvin Zhang70eef232020-06-12 20:32:40 +0000759 SetStatusAndNotify(UpdateStatus::VERIFYING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700760 } else if (type == FilesystemVerifierAction::StaticType()) {
Kelvin Zhang70eef232020-06-12 20:32:40 +0000761 SetStatusAndNotify(UpdateStatus::FINALIZING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700762 prefs_->SetBoolean(kPrefsVerityWritten, true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800763 }
764}
765
766void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
767 uint64_t bytes_received,
768 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700769 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800770 if (total)
771 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700772 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800773 download_progress_ = progress;
774 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700775 } else {
776 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800777 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700778
779 // Update the bytes downloaded in prefs.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800780 metric_bytes_downloaded_ += bytes_progressed;
781 metric_total_bytes_downloaded_ += bytes_progressed;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800782}
783
784bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
785 // TODO(deymo): Notify the DownloadAction that it should cancel the update
786 // download.
787 return false;
788}
789
790void UpdateAttempterAndroid::DownloadComplete() {
791 // Nothing needs to be done when the download completes.
792}
793
Alex Deymo0d298542016-03-30 18:31:49 -0700794void UpdateAttempterAndroid::ProgressUpdate(double progress) {
795 // Self throttle based on progress. Also send notifications if progress is
796 // too slow.
797 if (progress == 1.0 ||
798 progress - download_progress_ >= kBroadcastThresholdProgress ||
799 TimeTicks::Now() - last_notify_time_ >=
800 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
801 download_progress_ = progress;
802 SetStatusAndNotify(status_);
803 }
804}
805
Kelvin Zhang70eef232020-06-12 20:32:40 +0000806void UpdateAttempterAndroid::OnVerifyProgressUpdate(double progress) {
807 assert(status_ == UpdateStatus::VERIFYING);
808 ProgressUpdate(progress);
809}
810
Alex Deymo5e3ea272016-01-28 13:42:23 -0800811void UpdateAttempterAndroid::ScheduleProcessingStart() {
812 LOG(INFO) << "Scheduling an action processor start.";
Kelvin Zhang20982a52021-08-13 12:31:16 -0700813 processor_->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800814 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700815 FROM_HERE,
816 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
817 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800818}
819
820void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
821 if (status_ == UpdateStatus::IDLE) {
822 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
823 return;
824 }
825
Yifan Hong90965502020-02-19 15:22:47 -0800826 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400827 ClearUpdateCompletedMarker();
Yifan Hong90965502020-02-19 15:22:47 -0800828 LOG(INFO) << "Terminating cleanup previous update.";
829 SetStatusAndNotify(UpdateStatus::IDLE);
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700830 for (auto observer : daemon_state_->service_observers())
831 observer->SendPayloadApplicationComplete(error_code);
Yifan Hong90965502020-02-19 15:22:47 -0800832 return;
833 }
834
Yifan Hong9194ce82019-11-07 11:03:42 -0800835 boot_control_->GetDynamicPartitionControl()->Cleanup();
Yifan Hong537802d2018-08-15 13:15:42 -0700836
Alex Deymo0d298542016-03-30 18:31:49 -0700837 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800838 UpdateStatus new_status =
839 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
840 : UpdateStatus::IDLE);
841 SetStatusAndNotify(new_status);
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900842 payload_fd_.reset();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800843
Sen Jiangb19c3ec2017-10-06 15:18:46 -0700844 // The network id is only applicable to one download attempt and once it's
845 // done the network id should not be re-used anymore.
846 if (!network_selector_->SetProcessNetwork(kDefaultNetworkId)) {
847 LOG(WARNING) << "Unable to unbind network.";
848 }
849
Alex Deymo5e3ea272016-01-28 13:42:23 -0800850 for (auto observer : daemon_state_->service_observers())
851 observer->SendPayloadApplicationComplete(error_code);
Tianjie Xu1b661142017-09-28 14:03:42 -0700852
Tianjie Xu90aaa102017-10-10 17:39:03 -0700853 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
854 ClearMetricsPrefs();
855 if (error_code == ErrorCode::kSuccess) {
xunchang9cf52622019-01-25 11:04:58 -0800856 // We should only reset the PayloadAttemptNumber if the update succeeds, or
857 // we switch to a different payload.
858 prefs_->Delete(kPrefsPayloadAttemptNumber);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700859 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700860 // Clear the total bytes downloaded if and only if the update succeeds.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800861 metric_total_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700862 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800863}
864
865void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
866 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700867 size_t payload_size =
868 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700869 UpdateEngineStatus status_to_send = {.status = status_,
870 .progress = download_progress_,
871 .new_size_bytes = payload_size};
872
Alex Deymo5e3ea272016-01-28 13:42:23 -0800873 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700874 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800875 }
876 last_notify_time_ = TimeTicks::Now();
877}
878
Amin Hassani667cf7b2018-07-25 14:32:00 -0700879void UpdateAttempterAndroid::BuildUpdateActions(HttpFetcher* fetcher) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800880 CHECK(!processor_->IsRunning());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800881
882 // Actions:
Amin Hassani667cf7b2018-07-25 14:32:00 -0700883 auto update_boot_flags_action =
884 std::make_unique<UpdateBootFlagsAction>(boot_control_);
Yifan Hong83517502020-02-19 15:34:13 -0800885 auto cleanup_previous_update_action =
886 boot_control_->GetDynamicPartitionControl()
887 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
Amin Hassani667cf7b2018-07-25 14:32:00 -0700888 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
889 auto download_action =
890 std::make_unique<DownloadAction>(prefs_,
891 boot_control_,
892 hardware_,
Amin Hassani667cf7b2018-07-25 14:32:00 -0700893 fetcher, // passes ownership
Kelvin Zhang1304fe72021-10-06 19:12:12 -0700894 true /* interactive */,
895 update_certificates_path_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800896 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700897 download_action->set_base_offset(base_offset_);
Tianjie24f96092020-06-30 12:26:25 -0700898 auto filesystem_verifier_action = std::make_unique<FilesystemVerifierAction>(
899 boot_control_->GetDynamicPartitionControl());
Amin Hassani667cf7b2018-07-25 14:32:00 -0700900 auto postinstall_runner_action =
901 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang70eef232020-06-12 20:32:40 +0000902 filesystem_verifier_action->set_delegate(this);
Alex Deymob6eef732016-06-10 12:58:11 -0700903 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800904
Alex Deymo5e3ea272016-01-28 13:42:23 -0800905 // Bond them together. We have to use the leaf-types when calling
906 // BondActions().
907 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700908 BondActions(download_action.get(), filesystem_verifier_action.get());
909 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800910 postinstall_runner_action.get());
911
Amin Hassani667cf7b2018-07-25 14:32:00 -0700912 processor_->EnqueueAction(std::move(update_boot_flags_action));
Yifan Hong83517502020-02-19 15:34:13 -0800913 processor_->EnqueueAction(std::move(cleanup_previous_update_action));
Amin Hassani667cf7b2018-07-25 14:32:00 -0700914 processor_->EnqueueAction(std::move(install_plan_action));
915 processor_->EnqueueAction(std::move(download_action));
916 processor_->EnqueueAction(std::move(filesystem_verifier_action));
917 processor_->EnqueueAction(std::move(postinstall_runner_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800918}
919
Alex Deymo5e3ea272016-01-28 13:42:23 -0800920bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
921 string boot_id;
922 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800923 LOG(INFO) << "Writing update complete marker, slot "
924 << boot_control_->GetCurrentSlot() << ", boot id: " << boot_id;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400925 TEST_AND_RETURN_FALSE(
926 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id));
927 TEST_AND_RETURN_FALSE(
928 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot()));
929 return true;
930}
931
932bool UpdateAttempterAndroid::ClearUpdateCompletedMarker() {
933 LOG(INFO) << "Clearing update complete marker.";
934 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsUpdateCompletedOnBootId));
935 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsPreviousSlot));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800936 return true;
937}
938
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800939bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() const {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800940 // In case of an update_engine restart without a reboot, we stored the boot_id
941 // when the update was completed by setting a pref, so we can check whether
942 // the last update was on this boot or a previous one.
943 string boot_id;
944 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
945
946 string update_completed_on_boot_id;
947 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
948 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
949 &update_completed_on_boot_id) &&
950 update_completed_on_boot_id == boot_id);
951}
952
Tianjie Xu90aaa102017-10-10 17:39:03 -0700953// Collect and report the android metrics when we terminate the update.
954void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
955 ErrorCode error_code) {
956 int64_t attempt_number =
957 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
958 PayloadType payload_type = kPayloadTypeFull;
959 int64_t payload_size = 0;
960 for (const auto& p : install_plan_.payloads) {
961 if (p.type == InstallPayloadType::kDelta)
962 payload_type = kPayloadTypeDelta;
963 payload_size += p.size;
964 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700965 // In some cases, e.g. after calling |setShouldSwitchSlotOnReboot()|, this
966 // function will be triggered, but payload_size in this case might be 0, if so
967 // skip reporting any metrics.
968 if (payload_size == 0) {
969 return;
970 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700971
972 metrics::AttemptResult attempt_result =
973 metrics_utils::GetAttemptResult(error_code);
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700974 Time boot_time_start = Time::FromInternalValue(
975 metrics_utils::GetPersistedValue(kPrefsUpdateBootTimestampStart, prefs_));
976 Time monotonic_time_start = Time::FromInternalValue(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700977 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700978 TimeDelta duration = clock_->GetBootTime() - boot_time_start;
979 TimeDelta duration_uptime = clock_->GetMonotonicTime() - monotonic_time_start;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700980
981 metrics_reporter_->ReportUpdateAttemptMetrics(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700982 static_cast<int>(attempt_number),
983 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700984 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700985 duration_uptime,
986 payload_size,
987 attempt_result,
988 error_code);
989
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800990 int64_t current_bytes_downloaded = metric_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -0700991 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
992 current_bytes_downloaded,
993 0,
994 DownloadSource::kNumDownloadSources,
995 metrics::DownloadErrorCode::kUnset,
996 metrics::ConnectionType::kUnset);
997
Tianjie Xu90aaa102017-10-10 17:39:03 -0700998 if (error_code == ErrorCode::kSuccess) {
999 int64_t reboot_count =
1000 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1001 string build_version;
1002 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -07001003
1004 // For android metrics, we only care about the total bytes downloaded
1005 // for all sources; for now we assume the only download source is
1006 // HttpsServer.
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001007 int64_t total_bytes_downloaded = metric_total_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -07001008 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
1009 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
1010 total_bytes_downloaded;
1011
1012 int download_overhead_percentage = 0;
Tianjie Xu21030c12019-08-14 13:00:23 -07001013 if (total_bytes_downloaded >= payload_size) {
1014 CHECK_GT(payload_size, 0);
Tianjie Xud4777a12017-10-24 14:54:18 -07001015 download_overhead_percentage =
Tianjie Xu21030c12019-08-14 13:00:23 -07001016 (total_bytes_downloaded - payload_size) * 100ull / payload_size;
1017 } else {
1018 LOG(WARNING) << "Downloaded bytes " << total_bytes_downloaded
1019 << " is smaller than the payload size " << payload_size;
Tianjie Xud4777a12017-10-24 14:54:18 -07001020 }
Tianjie Xu21030c12019-08-14 13:00:23 -07001021
Tianjie Xu90aaa102017-10-10 17:39:03 -07001022 metrics_reporter_->ReportSuccessfulUpdateMetrics(
1023 static_cast<int>(attempt_number),
1024 0, // update abandoned count
1025 payload_type,
1026 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -07001027 num_bytes_downloaded,
1028 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -07001029 duration,
Sen Jiang8712e962018-05-08 12:12:28 -07001030 duration_uptime,
Tianjie Xu90aaa102017-10-10 17:39:03 -07001031 static_cast<int>(reboot_count),
1032 0); // url_switch_count
1033 }
1034}
1035
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001036bool UpdateAttempterAndroid::OTARebootSucceeded() const {
1037 const auto current_slot = boot_control_->GetCurrentSlot();
Kelvin Zhang13020502023-08-02 15:18:40 -07001038 const string current_version = GetCurrentBuildVersion();
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001039 int64_t previous_slot = -1;
1040 TEST_AND_RETURN_FALSE(prefs_->GetInt64(kPrefsPreviousSlot, &previous_slot));
1041 string previous_version;
1042 TEST_AND_RETURN_FALSE(
1043 prefs_->GetString(kPrefsPreviousVersion, &previous_version));
1044 if (previous_slot != current_slot) {
1045 LOG(INFO) << "Detected a slot switch, OTA succeeded, device updated from "
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001046 << previous_version << " to " << current_version
1047 << ", previous slot: " << previous_slot
1048 << " current slot: " << current_slot;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001049 if (previous_version == current_version) {
1050 LOG(INFO) << "Previous version is the same as current version, this is "
1051 "possibly a self-OTA.";
1052 }
1053 return true;
1054 } else {
1055 LOG(INFO) << "Slot didn't switch, either the OTA is rolled back, or slot "
1056 "switch never happened, or system not rebooted at all.";
1057 if (previous_version != current_version) {
1058 LOG(INFO) << "Slot didn't change, but version changed from "
1059 << previous_version << " to " << current_version
1060 << " device could be flashed.";
1061 }
1062 return false;
1063 }
1064}
1065
1066OTAResult UpdateAttempterAndroid::GetOTAUpdateResult() const {
1067 // We only set |kPrefsSystemUpdatedMarker| if slot is actually switched, so
1068 // existence of this pref is sufficient indicator. Given that we have to
1069 // delete this pref after checking it. This is done in
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001070 // |DeltaPerformer::ResetUpdateProgress| and
1071 // |UpdateAttempterAndroid::UpdateStateAfterReboot|
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001072 auto slot_switch_attempted = prefs_->Exists(kPrefsUpdateCompletedOnBootId);
1073 auto system_rebooted = DidSystemReboot(prefs_);
1074 auto ota_successful = OTARebootSucceeded();
1075 if (ota_successful) {
1076 return OTAResult::OTA_SUCCESSFUL;
1077 }
1078 if (slot_switch_attempted) {
1079 if (system_rebooted) {
1080 // If we attempted slot switch, but still end up on the same slot, we
1081 // probably rolled back.
1082 return OTAResult::ROLLED_BACK;
1083 } else {
1084 return OTAResult::UPDATED_NEED_REBOOT;
1085 }
1086 }
1087 return OTAResult::NOT_ATTEMPTED;
1088}
1089
1090void UpdateAttempterAndroid::UpdateStateAfterReboot(const OTAResult result) {
Kelvin Zhang13020502023-08-02 15:18:40 -07001091 const string current_version = GetCurrentBuildVersion();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001092 TEST_AND_RETURN(!current_version.empty());
1093
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001094 // |UpdateStateAfterReboot()| is only called after system reboot, so record
1095 // boot id unconditionally
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001096 string current_boot_id;
1097 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
1098 prefs_->SetString(kPrefsBootId, current_boot_id);
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001099 std::string slot_switch_indicator;
1100 prefs_->GetString(kPrefsUpdateCompletedOnBootId, &slot_switch_indicator);
1101 if (slot_switch_indicator != current_boot_id) {
1102 ClearUpdateCompletedMarker();
1103 }
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001104
Tianjie Xu90aaa102017-10-10 17:39:03 -07001105 // If there's no record of previous version (e.g. due to a data wipe), we
1106 // save the info of current boot and skip the metrics report.
1107 if (!prefs_->Exists(kPrefsPreviousVersion)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001108 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001109 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001110 ClearMetricsPrefs();
1111 return;
1112 }
Kelvin Zhang86603472021-05-11 12:16:27 -04001113 // update_engine restarted under the same build and same slot.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001114 if (result != OTAResult::OTA_SUCCESSFUL) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001115 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
1116 // set when we start a new update.
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001117 if (prefs_->Exists(kPrefsNumReboots)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001118 int64_t reboot_count =
1119 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1120 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
1121 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001122
1123 if (result == OTAResult::ROLLED_BACK) {
1124 // This will release all space previously allocated for apex
1125 // decompression. If we detect a rollback, we should release space and
1126 // return the space to user. Any subsequent attempt to install OTA will
1127 // allocate space again anyway.
1128 LOG(INFO) << "Detected a rollback, releasing space allocated for apex "
1129 "deompression.";
1130 apex_handler_android_->AllocateSpace({});
1131 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1132 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001133 return;
1134 }
1135
1136 // Now that the build version changes, report the update metrics.
1137 // TODO(xunchang) check the build version is larger than the previous one.
Tianjie Xu90aaa102017-10-10 17:39:03 -07001138 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001139 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001140
1141 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
1142 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
1143 if (previous_attempt_exists) {
1144 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
1145 }
1146
1147 metrics_utils::LoadAndReportTimeToReboot(
1148 metrics_reporter_.get(), prefs_, clock_.get());
1149 ClearMetricsPrefs();
Sen Jiang1bafff82019-01-02 15:54:40 -08001150
1151 // Also reset the update progress if the build version has changed.
1152 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
1153 LOG(WARNING) << "Unable to reset the update progress.";
1154 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001155}
1156
1157// Save the update start time. Reset the reboot count and attempt number if the
1158// update isn't a resume; otherwise increment the attempt number.
1159void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
1160 if (!is_resume) {
1161 metrics_utils::SetNumReboots(0, prefs_);
1162 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
1163 } else {
1164 int64_t attempt_number =
1165 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
1166 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
1167 }
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001168 metrics_utils::SetUpdateTimestampStart(clock_->GetMonotonicTime(), prefs_);
1169 metrics_utils::SetUpdateBootTimestampStart(clock_->GetBootTime(), prefs_);
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001170 ClearUpdateCompletedMarker();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001171}
1172
1173void UpdateAttempterAndroid::ClearMetricsPrefs() {
1174 CHECK(prefs_);
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001175 metric_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001176 prefs_->Delete(kPrefsNumReboots);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001177 prefs_->Delete(kPrefsSystemUpdatedMarker);
1178 prefs_->Delete(kPrefsUpdateTimestampStart);
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001179 prefs_->Delete(kPrefsUpdateBootTimestampStart);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001180}
1181
Yifan Hongbd47d622019-12-13 14:59:58 -08001182BootControlInterface::Slot UpdateAttempterAndroid::GetCurrentSlot() const {
1183 return boot_control_->GetCurrentSlot();
1184}
1185
1186BootControlInterface::Slot UpdateAttempterAndroid::GetTargetSlot() const {
1187 return GetCurrentSlot() == 0 ? 1 : 0;
1188}
1189
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001190uint64_t UpdateAttempterAndroid::AllocateSpaceForPayload(
1191 const std::string& metadata_filename,
1192 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001193 Error* error) {
Yifan Hong65613032020-01-09 17:52:13 -08001194 std::map<string, string> headers;
1195 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
1196 return 0;
1197 }
Kelvin Zhangabb082f2023-04-27 20:46:06 -07001198 DeltaArchiveManifest manifest;
1199 brillo::Blob metadata_hash;
1200 if (!brillo::data_encoding::Base64Decode(
1201 headers[kPayloadPropertyMetadataHash], &metadata_hash)) {
1202 metadata_hash.clear();
1203 }
1204 if (!VerifyPayloadParseManifest(
1205 metadata_filename, ToStringView(metadata_hash), &manifest, error)) {
1206 return 0;
1207 }
Yifan Hong65613032020-01-09 17:52:13 -08001208
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001209 std::vector<ApexInfo> apex_infos(manifest.apex_info().begin(),
1210 manifest.apex_info().end());
1211 uint64_t apex_size_required = 0;
1212 if (apex_handler_android_ != nullptr) {
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001213 auto result = apex_handler_android_->CalculateSize(apex_infos);
1214 if (!result.ok()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001215 LogAndSetGenericError(
1216 error,
1217 __LINE__,
1218 __FILE__,
1219 "Failed to calculate size required for compressed APEX");
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001220 return 0;
1221 }
1222 apex_size_required = *result;
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001223 }
1224
Yifan Hong65613032020-01-09 17:52:13 -08001225 string payload_id = GetPayloadId(headers);
1226 uint64_t required_size = 0;
Daniel Zhengeede4c82023-06-13 11:21:06 -07001227 ErrorCode error_code{};
1228
Yifan Hong65613032020-01-09 17:52:13 -08001229 if (!DeltaPerformer::PreparePartitionsForUpdate(prefs_,
1230 boot_control_,
1231 GetTargetSlot(),
1232 manifest,
1233 payload_id,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001234 &required_size,
1235 &error_code)) {
1236 if (error_code == ErrorCode::kOverlayfsenabledError) {
1237 LogAndSetError(error,
1238 __LINE__,
1239 __FILE__,
1240 "OverlayFS Shouldn't be enabled for OTA.",
1241 error_code);
1242 return 0;
1243 }
Yifan Hong65613032020-01-09 17:52:13 -08001244 if (required_size == 0) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001245 LogAndSetGenericError(
1246 error, __LINE__, __FILE__, "Failed to allocate space for payload.");
Yifan Hong65613032020-01-09 17:52:13 -08001247 return 0;
1248 } else {
1249 LOG(ERROR) << "Insufficient space for payload: " << required_size
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001250 << " bytes, apex decompression: " << apex_size_required
Yifan Hong65613032020-01-09 17:52:13 -08001251 << " bytes";
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001252 return required_size + apex_size_required;
Yifan Hong65613032020-01-09 17:52:13 -08001253 }
1254 }
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001255
1256 if (apex_size_required > 0 && apex_handler_android_ != nullptr &&
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001257 !apex_handler_android_->AllocateSpace(apex_infos)) {
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001258 LOG(ERROR) << "Insufficient space for apex decompression: "
1259 << apex_size_required << " bytes";
1260 return apex_size_required;
Kelvin Zhang8933d572021-01-28 10:17:34 -05001261 }
Yifan Hong65613032020-01-09 17:52:13 -08001262
1263 LOG(INFO) << "Successfully allocated space for payload.";
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001264 return 0;
1265}
1266
Yifan Hong40bb0d02020-02-24 17:33:14 -08001267void UpdateAttempterAndroid::CleanupSuccessfulUpdate(
1268 std::unique_ptr<CleanupSuccessfulUpdateCallbackInterface> callback,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001269 Error* error) {
Yifan Hong40bb0d02020-02-24 17:33:14 -08001270 if (cleanup_previous_update_code_.has_value()) {
1271 LOG(INFO) << "CleanupSuccessfulUpdate has previously completed with "
1272 << utils::ErrorCodeToString(*cleanup_previous_update_code_);
1273 if (callback) {
1274 callback->OnCleanupComplete(
1275 static_cast<int32_t>(*cleanup_previous_update_code_));
1276 }
1277 return;
Yifan Hong4f611562020-01-15 23:41:33 -08001278 }
Yifan Hong40bb0d02020-02-24 17:33:14 -08001279 if (callback) {
1280 auto callback_ptr = callback.get();
1281 cleanup_previous_update_callbacks_.emplace_back(std::move(callback));
Kelvin Zhang2f6c25a2023-07-05 12:49:34 -07001282 callback_ptr->RegisterForDeathNotifications([this, callback_ptr]() {
1283 RemoveCleanupPreviousUpdateCallback(callback_ptr);
1284 });
Yifan Hong40bb0d02020-02-24 17:33:14 -08001285 }
1286 ScheduleCleanupPreviousUpdate();
Yifan Hong2236ea02019-12-13 16:11:22 -08001287}
1288
Tianjie7f8f2ab2021-07-23 17:08:50 -07001289bool UpdateAttempterAndroid::setShouldSwitchSlotOnReboot(
Daniel Zheng92f7d172023-06-22 14:31:37 -07001290 const std::string& metadata_filename, Error* error) {
Kelvin Zhang20982a52021-08-13 12:31:16 -07001291 LOG(INFO) << "setShouldSwitchSlotOnReboot(" << metadata_filename << ")";
Tianjie7f8f2ab2021-07-23 17:08:50 -07001292 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001293 return LogAndSetGenericError(
1294 error,
1295 __LINE__,
1296 __FILE__,
1297 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001298 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001299 DeltaArchiveManifest manifest;
1300 TEST_AND_RETURN_FALSE(
1301 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
1302
Kelvin Zhang20982a52021-08-13 12:31:16 -07001303 InstallPlan install_plan_;
1304 install_plan_.source_slot = GetCurrentSlot();
1305 install_plan_.target_slot = GetTargetSlot();
1306 // Don't do verity computation, just hash the partitions
1307 install_plan_.write_verity = false;
1308 // Don't run postinstall, we just need PostinstallAction to switch the slots.
1309 install_plan_.run_post_install = false;
1310 install_plan_.is_resume = true;
1311
1312 CHECK_NE(install_plan_.source_slot, UINT32_MAX);
1313 CHECK_NE(install_plan_.target_slot, UINT32_MAX);
1314
Kelvin Zhang20982a52021-08-13 12:31:16 -07001315 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001316 auto postinstall_runner_action =
1317 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
1318 SetStatusAndNotify(UpdateStatus::VERIFYING);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001319 postinstall_runner_action->set_delegate(this);
Daniel Zhengeede4c82023-06-13 11:21:06 -07001320 ErrorCode error_code{};
Kelvin Zhang20982a52021-08-13 12:31:16 -07001321
Kelvin Zhangf8441982022-12-07 18:18:47 -08001322 // If last error code is kUpdatedButNotActive, we know that we reached this
1323 // state by calling applyPayload() with switch_slot=false. That applyPayload()
1324 // call would have already performed filesystem verification, therefore, we
1325 // can safely skip the verification to save time.
1326 if (last_error_ == ErrorCode::kUpdatedButNotActive) {
1327 BondActions(install_plan_action.get(), postinstall_runner_action.get());
1328 processor_->EnqueueAction(std::move(install_plan_action));
1329 } else {
Kelvin Zhang263a5402022-12-08 23:03:32 -08001330 if (!boot_control_->GetDynamicPartitionControl()
1331 ->PreparePartitionsForUpdate(GetCurrentSlot(),
1332 GetTargetSlot(),
1333 manifest,
1334 false /* should update */,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001335 nullptr,
1336 &error_code)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001337 return LogAndSetGenericError(
1338 error, __LINE__, __FILE__, "Failed to PreparePartitionsForUpdate");
Kelvin Zhang263a5402022-12-08 23:03:32 -08001339 }
Kelvin Zhang263a5402022-12-08 23:03:32 -08001340 if (!install_plan_.ParsePartitions(manifest.partitions(),
1341 boot_control_,
1342 manifest.block_size(),
1343 &error_code)) {
1344 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001345 __LINE__,
1346 __FILE__,
Kelvin Zhang263a5402022-12-08 23:03:32 -08001347 "Failed to LoadPartitionsFromSlots " +
Daniel Zheng92f7d172023-06-22 14:31:37 -07001348 utils::ErrorCodeToString(error_code),
1349 error_code);
Kelvin Zhang263a5402022-12-08 23:03:32 -08001350 }
1351
Kelvin Zhangf8441982022-12-07 18:18:47 -08001352 auto filesystem_verifier_action =
1353 std::make_unique<FilesystemVerifierAction>(
1354 boot_control_->GetDynamicPartitionControl());
1355 filesystem_verifier_action->set_delegate(this);
1356 BondActions(install_plan_action.get(), filesystem_verifier_action.get());
1357 BondActions(filesystem_verifier_action.get(),
1358 postinstall_runner_action.get());
1359 processor_->EnqueueAction(std::move(install_plan_action));
1360 processor_->EnqueueAction(std::move(filesystem_verifier_action));
1361 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001362
Kelvin Zhang20982a52021-08-13 12:31:16 -07001363 processor_->EnqueueAction(std::move(postinstall_runner_action));
1364 ScheduleProcessingStart();
1365 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001366}
1367
Daniel Zheng92f7d172023-06-22 14:31:37 -07001368bool UpdateAttempterAndroid::resetShouldSwitchSlotOnReboot(Error* error) {
Tianjie7f8f2ab2021-07-23 17:08:50 -07001369 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001370 return LogAndSetGenericError(
1371 error,
1372 __LINE__,
1373 __FILE__,
1374 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001375 }
Daniel Zhenge76cf562022-11-08 17:32:10 +00001376 TEST_AND_RETURN_FALSE(ClearUpdateCompletedMarker());
Kelvin Zhang20982a52021-08-13 12:31:16 -07001377 // Update the boot flags so the current slot has higher priority.
1378 if (!boot_control_->SetActiveBootSlot(GetCurrentSlot())) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001379 return LogAndSetGenericError(
1380 error, __LINE__, __FILE__, "Failed to SetActiveBootSlot");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001381 }
1382
1383 // Mark the current slot as successful again, since marking it as active
1384 // may reset the successful bit. We ignore the result of whether marking
1385 // the current slot as successful worked.
1386 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful) {}))) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001387 return LogAndSetGenericError(
1388 error, __LINE__, __FILE__, "Failed to MarkBootSuccessfulAsync");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001389 }
1390
1391 // Resets the warm reset property since we won't switch the slot.
1392 hardware_->SetWarmReset(false);
1393
1394 // Resets the vbmeta digest.
1395 hardware_->SetVbmetaDigestForInactiveSlot(true /* reset */);
1396 LOG(INFO) << "Slot switch cancelled.";
1397 SetStatusAndNotify(UpdateStatus::IDLE);
1398 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001399}
1400
Yifan Hong90965502020-02-19 15:22:47 -08001401void UpdateAttempterAndroid::ScheduleCleanupPreviousUpdate() {
1402 // If a previous CleanupSuccessfulUpdate call has not finished, or an update
1403 // is in progress, skip enqueueing the action.
1404 if (processor_->IsRunning()) {
1405 LOG(INFO) << "Already processing an update. CleanupPreviousUpdate should "
1406 << "be done when the current update finishes.";
1407 return;
1408 }
1409 LOG(INFO) << "Scheduling CleanupPreviousUpdateAction.";
1410 auto action =
1411 boot_control_->GetDynamicPartitionControl()
1412 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
1413 processor_->EnqueueAction(std::move(action));
1414 processor_->set_delegate(this);
1415 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
1416 processor_->StartProcessing();
1417}
1418
Yifan Hong40bb0d02020-02-24 17:33:14 -08001419void UpdateAttempterAndroid::OnCleanupProgressUpdate(double progress) {
1420 for (auto&& callback : cleanup_previous_update_callbacks_) {
1421 callback->OnCleanupProgressUpdate(progress);
1422 }
1423}
1424
1425void UpdateAttempterAndroid::NotifyCleanupPreviousUpdateCallbacksAndClear() {
1426 CHECK(cleanup_previous_update_code_.has_value());
1427 for (auto&& callback : cleanup_previous_update_callbacks_) {
1428 callback->OnCleanupComplete(
1429 static_cast<int32_t>(*cleanup_previous_update_code_));
1430 }
1431 cleanup_previous_update_callbacks_.clear();
1432}
1433
1434void UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback(
1435 CleanupSuccessfulUpdateCallbackInterface* callback) {
1436 auto end_it =
1437 std::remove_if(cleanup_previous_update_callbacks_.begin(),
1438 cleanup_previous_update_callbacks_.end(),
1439 [&](const auto& e) { return e.get() == callback; });
1440 cleanup_previous_update_callbacks_.erase(
1441 end_it, cleanup_previous_update_callbacks_.end());
1442}
Yifan Hong90965502020-02-19 15:22:47 -08001443
Daniel Zheng9fc62b82023-03-24 22:57:20 +00001444bool UpdateAttempterAndroid::IsProductionBuild() {
1445 if (android::base::GetProperty("ro.build.type", "") != "userdebug" ||
1446 android::base::GetProperty("ro.build.tags", "") == "release-keys" ||
1447 android::base::GetProperty("ro.boot.verifiedbootstate", "") == "green") {
1448 return true;
1449 }
1450 return false;
1451}
1452
Alex Deymo5e3ea272016-01-28 13:42:23 -08001453} // namespace chromeos_update_engine