blob: 555ed333c3c1ec107d493e6e6d1c60076b26ee25 [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"
Alex Deymo3b678db2016-02-09 11:50:06 -080058#include "update_engine/update_status_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080059
Alex Deymo14c0da82016-07-20 16:45:45 -070060#ifndef _UE_SIDELOAD
61// Do not include support for external HTTP(s) urls when building
62// update_engine_sideload.
63#include "update_engine/libcurl_http_fetcher.h"
64#endif
65
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090066using android::base::unique_fd;
Alex Deymo5e3ea272016-01-28 13:42:23 -080067using base::Bind;
Tianjie Xu90aaa102017-10-10 17:39:03 -070068using base::Time;
Alex Deymo5e3ea272016-01-28 13:42:23 -080069using base::TimeDelta;
70using base::TimeTicks;
Alex Deymo5e3ea272016-01-28 13:42:23 -080071using std::string;
72using std::vector;
Aaron Wood7f92e2b2017-08-28 14:51:21 -070073using update_engine::UpdateEngineStatus;
Alex Deymo5e3ea272016-01-28 13:42:23 -080074
75namespace chromeos_update_engine {
76
77namespace {
78
Alex Deymo0d298542016-03-30 18:31:49 -070079// Minimum threshold to broadcast an status update in progress and time.
80const double kBroadcastThresholdProgress = 0.01; // 1%
81const int kBroadcastThresholdSeconds = 10;
82
Alex Deymo5e3ea272016-01-28 13:42:23 -080083const char* const kErrorDomain = "update_engine";
84// TODO(deymo): Convert the different errors to a numeric value to report them
85// back on the service error.
86const char* const kGenericError = "generic_error";
87
88// Log and set the error on the passed ErrorPtr.
89bool LogAndSetError(brillo::ErrorPtr* error,
Jakub Pawlowski7e1dcf72018-07-26 00:29:42 -070090 const base::Location& location,
Alex Deymo5e3ea272016-01-28 13:42:23 -080091 const string& reason) {
92 brillo::Error::AddTo(error, location, kErrorDomain, kGenericError, reason);
93 LOG(ERROR) << "Replying with failure: " << location.ToString() << ": "
94 << reason;
95 return false;
96}
97
Sen Jiangfe522822017-10-31 15:14:11 -070098bool GetHeaderAsBool(const string& header, bool default_value) {
99 int value = 0;
100 if (base::StringToInt(header, &value) && (value == 0 || value == 1))
101 return value == 1;
102 return default_value;
103}
104
Yifan Hongbd47d622019-12-13 14:59:58 -0800105bool ParseKeyValuePairHeaders(const vector<string>& key_value_pair_headers,
106 std::map<string, string>* headers,
107 brillo::ErrorPtr* error) {
108 for (const string& key_value_pair : key_value_pair_headers) {
109 string key;
110 string value;
111 if (!brillo::string_utils::SplitAtFirst(
112 key_value_pair, "=", &key, &value, false)) {
113 return LogAndSetError(
114 error, FROM_HERE, "Passed invalid header: " + key_value_pair);
115 }
116 if (!headers->emplace(key, value).second)
117 return LogAndSetError(error, FROM_HERE, "Passed repeated key: " + key);
118 }
119 return true;
120}
121
122// Unique identifier for the payload. An empty string means that the payload
123// can't be resumed.
124string GetPayloadId(const std::map<string, string>& headers) {
125 return (headers.count(kPayloadPropertyFileHash)
126 ? headers.at(kPayloadPropertyFileHash)
127 : "") +
128 (headers.count(kPayloadPropertyMetadataHash)
129 ? headers.at(kPayloadPropertyMetadataHash)
130 : "");
131}
132
Alex Deymo5e3ea272016-01-28 13:42:23 -0800133} // namespace
134
135UpdateAttempterAndroid::UpdateAttempterAndroid(
Alex Deymo03a4de72016-07-20 16:08:23 -0700136 DaemonStateInterface* daemon_state,
Alex Deymo5e3ea272016-01-28 13:42:23 -0800137 PrefsInterface* prefs,
138 BootControlInterface* boot_control,
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000139 HardwareInterface* hardware,
140 std::unique_ptr<ApexHandlerInterface> apex_handler)
Alex Deymo5e3ea272016-01-28 13:42:23 -0800141 : daemon_state_(daemon_state),
142 prefs_(prefs),
143 boot_control_(boot_control),
144 hardware_(hardware),
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000145 apex_handler_android_(std::move(apex_handler)),
Tianjie Xu1b661142017-09-28 14:03:42 -0700146 processor_(new ActionProcessor()),
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800147 clock_(new Clock()),
148 metric_bytes_downloaded_(kPrefsCurrentBytesDownloaded, prefs_),
149 metric_total_bytes_downloaded_(kPrefsTotalBytesDownloaded, prefs_) {
Yifan Hongc514f662021-02-04 11:18:43 -0800150 metrics_reporter_ = metrics::CreateMetricsReporter(
Kelvin Zhang9a5e3682021-03-29 12:58:48 -0400151 boot_control_->GetDynamicPartitionControl(), &install_plan_);
Alex Deymo87792ea2016-07-25 15:40:36 -0700152 network_selector_ = network::CreateNetworkSelector();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800153}
154
155UpdateAttempterAndroid::~UpdateAttempterAndroid() {
156 // Release ourselves as the ActionProcessor's delegate to prevent
157 // re-scheduling the updates due to the processing stopped.
158 processor_->set_delegate(nullptr);
159}
160
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400161[[nodiscard]] static bool DidSystemReboot(PrefsInterface* prefs) {
162 string boot_id;
163 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
164 string old_boot_id;
165 // If no previous boot id found, treat as a reboot and write boot ID.
166 if (!prefs->GetString(kPrefsBootId, &old_boot_id)) {
167 return true;
168 }
169 return old_boot_id != boot_id;
170}
171
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400172std::ostream& operator<<(std::ostream& out, OTAResult result) {
173 switch (result) {
174 case OTAResult::NOT_ATTEMPTED:
175 out << "OTAResult::NOT_ATTEMPTED";
176 break;
177 case OTAResult::ROLLED_BACK:
178 out << "OTAResult::ROLLED_BACK";
179 break;
180 case OTAResult::UPDATED_NEED_REBOOT:
181 out << "OTAResult::UPDATED_NEED_REBOOT";
182 break;
183 case OTAResult::OTA_SUCCESSFUL:
184 out << "OTAResult::OTA_SUCCESSFUL";
185 break;
186 }
187 return out;
188}
189
Alex Deymo5e3ea272016-01-28 13:42:23 -0800190void UpdateAttempterAndroid::Init() {
191 // In case of update_engine restart without a reboot we need to restore the
192 // reboot needed state.
Tianjie Xu90aaa102017-10-10 17:39:03 -0700193 if (UpdateCompletedOnThisBoot()) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400194 LOG(INFO) << "Updated installed but update_engine is restarted without "
195 "device reboot. Resuming old state.";
Alex Deymo0e061ae2016-02-09 17:49:03 -0800196 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700197 } else {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400198 const auto result = GetOTAUpdateResult();
199 LOG(INFO) << result;
Alex Deymo0e061ae2016-02-09 17:49:03 -0800200 SetStatusAndNotify(UpdateStatus::IDLE);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400201 if (DidSystemReboot(prefs_)) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400202 UpdateStateAfterReboot(result);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400203 }
204
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700205#ifdef _UE_SIDELOAD
206 LOG(INFO) << "Skip ScheduleCleanupPreviousUpdate in sideload because "
207 << "ApplyPayload will call it later.";
208#else
Yifan Hong90965502020-02-19 15:22:47 -0800209 ScheduleCleanupPreviousUpdate();
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700210#endif
Tianjie Xu90aaa102017-10-10 17:39:03 -0700211 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800212}
213
214bool UpdateAttempterAndroid::ApplyPayload(
215 const string& payload_url,
216 int64_t payload_offset,
217 int64_t payload_size,
218 const vector<string>& key_value_pair_headers,
219 brillo::ErrorPtr* error) {
220 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
221 return LogAndSetError(
222 error, FROM_HERE, "An update already applied, waiting for reboot");
223 }
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700224 if (processor_->IsRunning()) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800225 return LogAndSetError(
226 error, FROM_HERE, "Already processing an update, cancel it first.");
227 }
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100228 DCHECK_EQ(status_, UpdateStatus::IDLE);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800229
Alex Deymo218397f2016-02-04 23:55:10 -0800230 std::map<string, string> headers;
Yifan Hongbd47d622019-12-13 14:59:58 -0800231 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
232 return false;
Alex Deymo218397f2016-02-04 23:55:10 -0800233 }
234
Yifan Hongbd47d622019-12-13 14:59:58 -0800235 string payload_id = GetPayloadId(headers);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800236
237 // Setup the InstallPlan based on the request.
238 install_plan_ = InstallPlan();
239
240 install_plan_.download_url = payload_url;
241 install_plan_.version = "";
Alex Deymo0fd51ff2016-02-03 14:22:43 -0800242 base_offset_ = payload_offset;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800243 InstallPlan::Payload payload;
244 payload.size = payload_size;
245 if (!payload.size) {
Alex Deymo218397f2016-02-04 23:55:10 -0800246 if (!base::StringToUint64(headers[kPayloadPropertyFileSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800247 &payload.size)) {
248 payload.size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800249 }
250 }
Sen Jiang2703ef42017-03-16 13:36:21 -0700251 if (!brillo::data_encoding::Base64Decode(headers[kPayloadPropertyFileHash],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800252 &payload.hash)) {
Sen Jiang2703ef42017-03-16 13:36:21 -0700253 LOG(WARNING) << "Unable to decode base64 file hash: "
254 << headers[kPayloadPropertyFileHash];
255 }
Alex Deymo218397f2016-02-04 23:55:10 -0800256 if (!base::StringToUint64(headers[kPayloadPropertyMetadataSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800257 &payload.metadata_size)) {
258 payload.metadata_size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800259 }
Sen Jiangcdd52062017-05-18 15:33:10 -0700260 // The |payload.type| is not used anymore since minor_version 3.
261 payload.type = InstallPayloadType::kUnknown;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800262 install_plan_.payloads.push_back(payload);
263
Alex Deymo5e3ea272016-01-28 13:42:23 -0800264 // The |public_key_rsa| key would override the public key stored on disk.
265 install_plan_.public_key_rsa = "";
266
267 install_plan_.hash_checks_mandatory = hardware_->IsOfficialBuild();
268 install_plan_.is_resume = !payload_id.empty() &&
269 DeltaPerformer::CanResumeUpdate(prefs_, payload_id);
270 if (!install_plan_.is_resume) {
Kelvin Zhang42c2d552022-07-25 11:04:00 -0700271 boot_control_->GetDynamicPartitionControl()->Cleanup();
Kelvin Zhangc54c9962022-10-20 13:44:59 -0700272 boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_);
273
Alex Deymo5e3ea272016-01-28 13:42:23 -0800274 if (!prefs_->SetString(kPrefsUpdateCheckResponseHash, payload_id)) {
275 LOG(WARNING) << "Unable to save the update check response hash.";
276 }
277 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800278 install_plan_.source_slot = GetCurrentSlot();
279 install_plan_.target_slot = GetTargetSlot();
Alex Deymofb905d92016-06-03 19:26:58 -0700280
Alex Deymofb905d92016-06-03 19:26:58 -0700281 install_plan_.powerwash_required =
Sen Jiangfe522822017-10-31 15:14:11 -0700282 GetHeaderAsBool(headers[kPayloadPropertyPowerwash], false);
283
284 install_plan_.switch_slot_on_reboot =
285 GetHeaderAsBool(headers[kPayloadPropertySwitchSlotOnReboot], true);
286
Tianjie Xu087de9d2019-11-01 17:11:22 -0700287 install_plan_.run_post_install =
288 GetHeaderAsBool(headers[kPayloadPropertyRunPostInstall], true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800289
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700290 // Skip writing verity if we're resuming and verity has already been written.
291 install_plan_.write_verity = true;
292 if (install_plan_.is_resume && prefs_->Exists(kPrefsVerityWritten)) {
293 bool verity_written = false;
294 if (prefs_->GetBoolean(kPrefsVerityWritten, &verity_written) &&
295 verity_written) {
296 install_plan_.write_verity = false;
297 }
298 }
299
Alex Deymo87792ea2016-07-25 15:40:36 -0700300 NetworkId network_id = kDefaultNetworkId;
301 if (!headers[kPayloadPropertyNetworkId].empty()) {
302 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
303 &network_id)) {
304 return LogAndSetError(
305 error,
306 FROM_HERE,
307 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
308 }
309 if (!network_selector_->SetProcessNetwork(network_id)) {
Sen Jiangcbd37c62017-09-12 15:04:35 -0700310 return LogAndSetError(
311 error,
312 FROM_HERE,
313 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700314 }
315 }
316
Alex Deymo5e3ea272016-01-28 13:42:23 -0800317 LOG(INFO) << "Using this install plan:";
318 install_plan_.Dump();
319
Amin Hassani667cf7b2018-07-25 14:32:00 -0700320 HttpFetcher* fetcher = nullptr;
321 if (FileFetcher::SupportedUrl(payload_url)) {
322 DLOG(INFO) << "Using FileFetcher for file URL.";
323 fetcher = new FileFetcher();
324 } else {
325#ifdef _UE_SIDELOAD
326 LOG(FATAL) << "Unsupported sideload URI: " << payload_url;
Chih-Hung Hsieh6e4f3452022-12-21 12:20:45 -0800327 return false; // NOLINT, unreached but analyzer might not know.
328 // Suppress warnings about null 'fetcher' after this.
Amin Hassani667cf7b2018-07-25 14:32:00 -0700329#else
Kelvin Zhangc7a1d1f2022-07-29 13:36:29 -0700330 LibcurlHttpFetcher* libcurl_fetcher = new LibcurlHttpFetcher(hardware_);
Kelvin Zhang3cc4fa32022-09-27 16:15:10 -0700331 if (!headers[kPayloadDownloadRetry].empty()) {
332 libcurl_fetcher->set_max_retry_count(
333 atoi(headers[kPayloadDownloadRetry].c_str()));
334 }
Amin Hassani667cf7b2018-07-25 14:32:00 -0700335 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
336 fetcher = libcurl_fetcher;
337#endif // _UE_SIDELOAD
338 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800339 // Setup extra headers.
Alex Deymofdd6dec2016-03-03 22:35:43 -0800340 if (!headers[kPayloadPropertyAuthorization].empty())
341 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
342 if (!headers[kPayloadPropertyUserAgent].empty())
343 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
344
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700345 if (!headers[kPayloadPropertyNetworkProxy].empty()) {
346 LOG(INFO) << "Using proxy url from payload headers: "
347 << headers[kPayloadPropertyNetworkProxy];
348 fetcher->SetProxies({headers[kPayloadPropertyNetworkProxy]});
349 }
Kelvin Zhanga7407b52023-03-13 15:05:14 -0700350 if (!headers[kPayloadVABCNone].empty()) {
351 install_plan_.vabc_none = true;
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000352 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800353 if (!headers[kPayloadEnableThreading].empty()) {
354 install_plan_.enable_threading = true;
355 }
356 if (!headers[kPayloadBatchedWrites].empty()) {
357 install_plan_.batched_writes = true;
358 }
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700359
Amin Hassani667cf7b2018-07-25 14:32:00 -0700360 BuildUpdateActions(fetcher);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800361
Alex Deymo5e3ea272016-01-28 13:42:23 -0800362 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700363
364 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
365 // TODO(xunchang) report the metrics for unresumable updates
366
Amin Hassani667cf7b2018-07-25 14:32:00 -0700367 ScheduleProcessingStart();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800368 return true;
369}
370
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900371bool UpdateAttempterAndroid::ApplyPayload(
372 int fd,
373 int64_t payload_offset,
374 int64_t payload_size,
375 const vector<string>& key_value_pair_headers,
376 brillo::ErrorPtr* error) {
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100377 // update_engine state must be checked before modifying payload_fd_ otherwise
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +0000378 // already running update will be terminated (existing file descriptor will be
379 // closed)
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100380 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
381 return LogAndSetError(
382 error, FROM_HERE, "An update already applied, waiting for reboot");
383 }
384 if (processor_->IsRunning()) {
385 return LogAndSetError(
386 error, FROM_HERE, "Already processing an update, cancel it first.");
387 }
388 DCHECK_EQ(status_, UpdateStatus::IDLE);
389
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900390 payload_fd_.reset(dup(fd));
391 const string payload_url = "fd://" + std::to_string(payload_fd_.get());
392
393 return ApplyPayload(
394 payload_url, payload_offset, payload_size, key_value_pair_headers, error);
395}
396
Alex Deymo5e3ea272016-01-28 13:42:23 -0800397bool UpdateAttempterAndroid::SuspendUpdate(brillo::ErrorPtr* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700398 if (!processor_->IsRunning())
Alex Deymof2858572016-02-25 11:20:13 -0800399 return LogAndSetError(error, FROM_HERE, "No ongoing update to suspend.");
400 processor_->SuspendProcessing();
401 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800402}
403
404bool UpdateAttempterAndroid::ResumeUpdate(brillo::ErrorPtr* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700405 if (!processor_->IsRunning())
Alex Deymof2858572016-02-25 11:20:13 -0800406 return LogAndSetError(error, FROM_HERE, "No ongoing update to resume.");
407 processor_->ResumeProcessing();
408 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800409}
410
411bool UpdateAttempterAndroid::CancelUpdate(brillo::ErrorPtr* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700412 if (!processor_->IsRunning())
Alex Deymo5e3ea272016-01-28 13:42:23 -0800413 return LogAndSetError(error, FROM_HERE, "No ongoing update to cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800414 processor_->StopProcessing();
415 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800416}
417
Alex Deymo3b678db2016-02-09 11:50:06 -0800418bool UpdateAttempterAndroid::ResetStatus(brillo::ErrorPtr* error) {
419 LOG(INFO) << "Attempting to reset state from "
420 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700421 if (processor_->IsRunning()) {
422 return LogAndSetError(
423 error, FROM_HERE, "Already processing an update, cancel it first.");
424 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800425
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000426 if (apex_handler_android_ != nullptr) {
427 LOG(INFO) << "Cleaning up reserved space for compressed APEX (if any)";
428 std::vector<ApexInfo> apex_infos_blank;
429 apex_handler_android_->AllocateSpace(apex_infos_blank);
430 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400431 // Remove the reboot marker so that if the machine is rebooted
432 // after resetting to idle state, it doesn't go back to
433 // UpdateStatus::UPDATED_NEED_REBOOT state.
434 if (!ClearUpdateCompletedMarker()) {
435 return LogAndSetError(error,
436 FROM_HERE,
437 "Failed to reset the status because "
438 "ClearUpdateCompletedMarker() failed");
439 }
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000440
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700441 if (!boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_)) {
442 LOG(WARNING) << "Failed to reset snapshots. UpdateStatus is IDLE but"
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000443 << "space might not be freed.";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700444 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800445 switch (status_) {
Yifan Hong6a6d0f12020-03-11 13:20:52 -0700446 case UpdateStatus::IDLE: {
Alex Deymo3b678db2016-02-09 11:50:06 -0800447 return true;
Yifan Hong6a6d0f12020-03-11 13:20:52 -0700448 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800449
Amin Hassani7cc8bb02019-01-14 16:29:47 -0800450 case UpdateStatus::UPDATED_NEED_REBOOT: {
Kelvin Zhang20982a52021-08-13 12:31:16 -0700451 const bool ret_value = resetShouldSwitchSlotOnReboot(error);
452 if (ret_value) {
453 LOG(INFO) << "Reset status successful";
Alex Deymo3b678db2016-02-09 11:50:06 -0800454 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700455 return ret_value;
Alex Deymo3b678db2016-02-09 11:50:06 -0800456 }
457
458 default:
459 return LogAndSetError(
460 error,
461 FROM_HERE,
462 "Reset not allowed in this state. Cancel the ongoing update first");
463 }
464}
465
Yifan Hongbd47d622019-12-13 14:59:58 -0800466bool UpdateAttempterAndroid::VerifyPayloadParseManifest(
467 const std::string& metadata_filename,
468 DeltaArchiveManifest* manifest,
469 brillo::ErrorPtr* error) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800470 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
471 if (!fd->Open(metadata_filename.c_str(), O_RDONLY)) {
472 return LogAndSetError(
473 error, FROM_HERE, "Failed to open " + metadata_filename);
474 }
475 brillo::Blob metadata(kMaxPayloadHeaderSize);
476 if (!fd->Read(metadata.data(), metadata.size())) {
477 return LogAndSetError(
478 error,
479 FROM_HERE,
480 "Failed to read payload header from " + metadata_filename);
481 }
Daniel Zhengda4f7292022-09-02 22:59:32 +0000482 ErrorCode errorcode{};
Sen Jiang8371c1c2018-02-01 13:46:39 -0800483 PayloadMetadata payload_metadata;
Sen Jiangf1236632018-05-11 16:03:23 -0700484 if (payload_metadata.ParsePayloadHeader(metadata, &errorcode) !=
Sen Jiang8371c1c2018-02-01 13:46:39 -0800485 MetadataParseResult::kSuccess) {
486 return LogAndSetError(error,
487 FROM_HERE,
488 "Failed to parse payload header: " +
489 utils::ErrorCodeToString(errorcode));
490 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700491 uint64_t metadata_size = payload_metadata.GetMetadataSize() +
492 payload_metadata.GetMetadataSignatureSize();
493 if (metadata_size < kMaxPayloadHeaderSize ||
494 metadata_size >
495 static_cast<uint64_t>(utils::FileSize(metadata_filename))) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800496 return LogAndSetError(
497 error,
498 FROM_HERE,
Sen Jiang840a7ea2018-09-19 14:29:44 -0700499 "Invalid metadata size: " + std::to_string(metadata_size));
Sen Jiang8371c1c2018-02-01 13:46:39 -0800500 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700501 metadata.resize(metadata_size);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800502 if (!fd->Read(metadata.data() + kMaxPayloadHeaderSize,
503 metadata.size() - kMaxPayloadHeaderSize)) {
504 return LogAndSetError(
505 error,
506 FROM_HERE,
507 "Failed to read metadata and signature from " + metadata_filename);
508 }
509 fd->Close();
Sen Jiang08c6da12019-01-07 18:28:56 -0800510
Tianjie Xu7a78d632019-10-08 16:32:39 -0700511 auto payload_verifier = PayloadVerifier::CreateInstanceFromZipPath(
512 constants::kUpdateCertificatesPath);
513 if (!payload_verifier) {
514 return LogAndSetError(error,
515 FROM_HERE,
516 "Failed to create the payload verifier from " +
517 std::string(constants::kUpdateCertificatesPath));
Sen Jiang08c6da12019-01-07 18:28:56 -0800518 }
Tianjie Xu7a78d632019-10-08 16:32:39 -0700519 errorcode = payload_metadata.ValidateMetadataSignature(
520 metadata, "", *payload_verifier);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800521 if (errorcode != ErrorCode::kSuccess) {
522 return LogAndSetError(error,
523 FROM_HERE,
524 "Failed to validate metadata signature: " +
525 utils::ErrorCodeToString(errorcode));
526 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800527 if (!payload_metadata.GetManifest(metadata, manifest)) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800528 return LogAndSetError(error, FROM_HERE, "Failed to parse manifest.");
529 }
530
Yifan Hongbd47d622019-12-13 14:59:58 -0800531 return true;
532}
533
534bool UpdateAttempterAndroid::VerifyPayloadApplicable(
535 const std::string& metadata_filename, brillo::ErrorPtr* error) {
536 DeltaArchiveManifest manifest;
537 TEST_AND_RETURN_FALSE(
538 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
539
540 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
Daniel Zhengda4f7292022-09-02 22:59:32 +0000541 ErrorCode errorcode{};
Yifan Hongbd47d622019-12-13 14:59:58 -0800542
543 BootControlInterface::Slot current_slot = GetCurrentSlot();
Sen Jiang8371c1c2018-02-01 13:46:39 -0800544 for (const PartitionUpdate& partition : manifest.partitions()) {
545 if (!partition.has_old_partition_info())
546 continue;
547 string partition_path;
548 if (!boot_control_->GetPartitionDevice(
549 partition.partition_name(), current_slot, &partition_path)) {
550 return LogAndSetError(
551 error,
552 FROM_HERE,
553 "Failed to get partition device for " + partition.partition_name());
554 }
555 if (!fd->Open(partition_path.c_str(), O_RDONLY)) {
556 return LogAndSetError(
557 error, FROM_HERE, "Failed to open " + partition_path);
558 }
559 for (const InstallOperation& operation : partition.operations()) {
560 if (!operation.has_src_sha256_hash())
561 continue;
562 brillo::Blob source_hash;
563 if (!fd_utils::ReadAndHashExtents(fd,
564 operation.src_extents(),
565 manifest.block_size(),
566 &source_hash)) {
567 return LogAndSetError(
568 error, FROM_HERE, "Failed to hash " + partition_path);
569 }
Kelvin Zhang9bd519d2020-09-23 12:55:19 -0400570 if (!PartitionWriter::ValidateSourceHash(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800571 source_hash, operation, fd, &errorcode)) {
572 return false;
573 }
574 }
575 fd->Close();
576 }
577 return true;
578}
579
Alex Deymo5e3ea272016-01-28 13:42:23 -0800580void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
581 ErrorCode code) {
582 LOG(INFO) << "Processing Done.";
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800583 metric_bytes_downloaded_.Flush(true);
584 metric_total_bytes_downloaded_.Flush(true);
Kelvin Zhangf8441982022-12-07 18:18:47 -0800585 last_error_ = code;
Yifan Hong90965502020-02-19 15:22:47 -0800586 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
587 TerminateUpdateAndNotify(code);
588 return;
589 }
590
Alex Deymo5990bf32016-07-19 17:01:41 -0700591 switch (code) {
592 case ErrorCode::kSuccess:
593 // Update succeeded.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400594 if (!WriteUpdateCompletedMarker()) {
595 LOG(ERROR) << "Failed to write update completion marker";
596 }
Alex Deymo5990bf32016-07-19 17:01:41 -0700597 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800598
Alex Deymo5990bf32016-07-19 17:01:41 -0700599 LOG(INFO) << "Update successfully applied, waiting to reboot.";
600 break;
601
602 case ErrorCode::kFilesystemCopierError:
603 case ErrorCode::kNewRootfsVerificationError:
604 case ErrorCode::kNewKernelVerificationError:
605 case ErrorCode::kFilesystemVerifierError:
606 case ErrorCode::kDownloadStateInitializationError:
607 // Reset the ongoing update for these errors so it starts from the
608 // beginning next time.
609 DeltaPerformer::ResetUpdateProgress(prefs_, false);
610 LOG(INFO) << "Resetting update progress.";
611 break;
612
Sen Jiangacbdd1c2017-10-19 13:30:19 -0700613 case ErrorCode::kPayloadTimestampError:
614 // SafetyNet logging, b/36232423
615 android_errorWriteLog(0x534e4554, "36232423");
616 break;
617
Alex Deymo5990bf32016-07-19 17:01:41 -0700618 default:
619 // Ignore all other error codes.
620 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700621 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800622
623 TerminateUpdateAndNotify(code);
624}
625
626void UpdateAttempterAndroid::ProcessingStopped(
627 const ActionProcessor* processor) {
628 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
629}
630
631void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
632 AbstractAction* action,
633 ErrorCode code) {
634 // Reset download progress regardless of whether or not the download
635 // action succeeded.
636 const string type = action->Type();
Yifan Hong40bb0d02020-02-24 17:33:14 -0800637 if (type == CleanupPreviousUpdateAction::StaticType() ||
638 (type == NoOpAction::StaticType() &&
639 status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE)) {
640 cleanup_previous_update_code_ = code;
641 NotifyCleanupPreviousUpdateCallbacksAndClear();
642 }
Kelvin Zhang70eef232020-06-12 20:32:40 +0000643 // download_progress_ is actually used by other actions, such as
644 // filesystem_verify_action. Therefore we always clear it.
645 download_progress_ = 0;
Sen Jiangfe522822017-10-31 15:14:11 -0700646 if (type == PostinstallRunnerAction::StaticType()) {
647 bool succeeded =
648 code == ErrorCode::kSuccess || code == ErrorCode::kUpdatedButNotActive;
649 prefs_->SetBoolean(kPrefsPostInstallSucceeded, succeeded);
650 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800651 if (code != ErrorCode::kSuccess) {
652 // If an action failed, the ActionProcessor will cancel the whole thing.
653 return;
654 }
Yifan Hong83517502020-02-19 15:34:13 -0800655 if (type == UpdateBootFlagsAction::StaticType()) {
656 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
657 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800658 if (type == DownloadAction::StaticType()) {
Kelvin Zhangd2da7b12020-07-07 17:19:21 -0400659 auto download_action = static_cast<DownloadAction*>(action);
660 install_plan_ = *download_action->install_plan();
Kelvin Zhang70eef232020-06-12 20:32:40 +0000661 SetStatusAndNotify(UpdateStatus::VERIFYING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700662 } else if (type == FilesystemVerifierAction::StaticType()) {
Kelvin Zhang70eef232020-06-12 20:32:40 +0000663 SetStatusAndNotify(UpdateStatus::FINALIZING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700664 prefs_->SetBoolean(kPrefsVerityWritten, true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800665 }
666}
667
668void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
669 uint64_t bytes_received,
670 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700671 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800672 if (total)
673 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700674 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800675 download_progress_ = progress;
676 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700677 } else {
678 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800679 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700680
681 // Update the bytes downloaded in prefs.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800682 metric_bytes_downloaded_ += bytes_progressed;
683 metric_total_bytes_downloaded_ += bytes_progressed;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800684}
685
686bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
687 // TODO(deymo): Notify the DownloadAction that it should cancel the update
688 // download.
689 return false;
690}
691
692void UpdateAttempterAndroid::DownloadComplete() {
693 // Nothing needs to be done when the download completes.
694}
695
Alex Deymo0d298542016-03-30 18:31:49 -0700696void UpdateAttempterAndroid::ProgressUpdate(double progress) {
697 // Self throttle based on progress. Also send notifications if progress is
698 // too slow.
699 if (progress == 1.0 ||
700 progress - download_progress_ >= kBroadcastThresholdProgress ||
701 TimeTicks::Now() - last_notify_time_ >=
702 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
703 download_progress_ = progress;
704 SetStatusAndNotify(status_);
705 }
706}
707
Kelvin Zhang70eef232020-06-12 20:32:40 +0000708void UpdateAttempterAndroid::OnVerifyProgressUpdate(double progress) {
709 assert(status_ == UpdateStatus::VERIFYING);
710 ProgressUpdate(progress);
711}
712
Alex Deymo5e3ea272016-01-28 13:42:23 -0800713void UpdateAttempterAndroid::ScheduleProcessingStart() {
714 LOG(INFO) << "Scheduling an action processor start.";
Kelvin Zhang20982a52021-08-13 12:31:16 -0700715 processor_->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800716 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700717 FROM_HERE,
718 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
719 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800720}
721
722void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
723 if (status_ == UpdateStatus::IDLE) {
724 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
725 return;
726 }
727
Yifan Hong90965502020-02-19 15:22:47 -0800728 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400729 ClearUpdateCompletedMarker();
Yifan Hong90965502020-02-19 15:22:47 -0800730 LOG(INFO) << "Terminating cleanup previous update.";
731 SetStatusAndNotify(UpdateStatus::IDLE);
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700732 for (auto observer : daemon_state_->service_observers())
733 observer->SendPayloadApplicationComplete(error_code);
Yifan Hong90965502020-02-19 15:22:47 -0800734 return;
735 }
736
Yifan Hong9194ce82019-11-07 11:03:42 -0800737 boot_control_->GetDynamicPartitionControl()->Cleanup();
Yifan Hong537802d2018-08-15 13:15:42 -0700738
Alex Deymo0d298542016-03-30 18:31:49 -0700739 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800740 UpdateStatus new_status =
741 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
742 : UpdateStatus::IDLE);
743 SetStatusAndNotify(new_status);
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900744 payload_fd_.reset();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800745
Sen Jiangb19c3ec2017-10-06 15:18:46 -0700746 // The network id is only applicable to one download attempt and once it's
747 // done the network id should not be re-used anymore.
748 if (!network_selector_->SetProcessNetwork(kDefaultNetworkId)) {
749 LOG(WARNING) << "Unable to unbind network.";
750 }
751
Alex Deymo5e3ea272016-01-28 13:42:23 -0800752 for (auto observer : daemon_state_->service_observers())
753 observer->SendPayloadApplicationComplete(error_code);
Tianjie Xu1b661142017-09-28 14:03:42 -0700754
Tianjie Xu90aaa102017-10-10 17:39:03 -0700755 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
756 ClearMetricsPrefs();
757 if (error_code == ErrorCode::kSuccess) {
xunchang9cf52622019-01-25 11:04:58 -0800758 // We should only reset the PayloadAttemptNumber if the update succeeds, or
759 // we switch to a different payload.
760 prefs_->Delete(kPrefsPayloadAttemptNumber);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700761 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700762 // Clear the total bytes downloaded if and only if the update succeeds.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800763 metric_total_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700764 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800765}
766
767void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
768 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700769 size_t payload_size =
770 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700771 UpdateEngineStatus status_to_send = {.status = status_,
772 .progress = download_progress_,
773 .new_size_bytes = payload_size};
774
Alex Deymo5e3ea272016-01-28 13:42:23 -0800775 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700776 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800777 }
778 last_notify_time_ = TimeTicks::Now();
779}
780
Amin Hassani667cf7b2018-07-25 14:32:00 -0700781void UpdateAttempterAndroid::BuildUpdateActions(HttpFetcher* fetcher) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800782 CHECK(!processor_->IsRunning());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800783
784 // Actions:
Amin Hassani667cf7b2018-07-25 14:32:00 -0700785 auto update_boot_flags_action =
786 std::make_unique<UpdateBootFlagsAction>(boot_control_);
Yifan Hong83517502020-02-19 15:34:13 -0800787 auto cleanup_previous_update_action =
788 boot_control_->GetDynamicPartitionControl()
789 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
Amin Hassani667cf7b2018-07-25 14:32:00 -0700790 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
791 auto download_action =
792 std::make_unique<DownloadAction>(prefs_,
793 boot_control_,
794 hardware_,
Amin Hassani667cf7b2018-07-25 14:32:00 -0700795 fetcher, // passes ownership
Kelvin Zhang1304fe72021-10-06 19:12:12 -0700796 true /* interactive */,
797 update_certificates_path_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800798 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700799 download_action->set_base_offset(base_offset_);
Tianjie24f96092020-06-30 12:26:25 -0700800 auto filesystem_verifier_action = std::make_unique<FilesystemVerifierAction>(
801 boot_control_->GetDynamicPartitionControl());
Amin Hassani667cf7b2018-07-25 14:32:00 -0700802 auto postinstall_runner_action =
803 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang70eef232020-06-12 20:32:40 +0000804 filesystem_verifier_action->set_delegate(this);
Alex Deymob6eef732016-06-10 12:58:11 -0700805 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800806
Alex Deymo5e3ea272016-01-28 13:42:23 -0800807 // Bond them together. We have to use the leaf-types when calling
808 // BondActions().
809 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700810 BondActions(download_action.get(), filesystem_verifier_action.get());
811 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800812 postinstall_runner_action.get());
813
Amin Hassani667cf7b2018-07-25 14:32:00 -0700814 processor_->EnqueueAction(std::move(update_boot_flags_action));
Yifan Hong83517502020-02-19 15:34:13 -0800815 processor_->EnqueueAction(std::move(cleanup_previous_update_action));
Amin Hassani667cf7b2018-07-25 14:32:00 -0700816 processor_->EnqueueAction(std::move(install_plan_action));
817 processor_->EnqueueAction(std::move(download_action));
818 processor_->EnqueueAction(std::move(filesystem_verifier_action));
819 processor_->EnqueueAction(std::move(postinstall_runner_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800820}
821
Alex Deymo5e3ea272016-01-28 13:42:23 -0800822bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
823 string boot_id;
824 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800825 LOG(INFO) << "Writing update complete marker, slot "
826 << boot_control_->GetCurrentSlot() << ", boot id: " << boot_id;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400827 TEST_AND_RETURN_FALSE(
828 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id));
829 TEST_AND_RETURN_FALSE(
830 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot()));
831 return true;
832}
833
834bool UpdateAttempterAndroid::ClearUpdateCompletedMarker() {
835 LOG(INFO) << "Clearing update complete marker.";
836 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsUpdateCompletedOnBootId));
837 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsPreviousSlot));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800838 return true;
839}
840
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800841bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() const {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800842 // In case of an update_engine restart without a reboot, we stored the boot_id
843 // when the update was completed by setting a pref, so we can check whether
844 // the last update was on this boot or a previous one.
845 string boot_id;
846 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
847
848 string update_completed_on_boot_id;
849 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
850 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
851 &update_completed_on_boot_id) &&
852 update_completed_on_boot_id == boot_id);
853}
854
Tianjie Xu90aaa102017-10-10 17:39:03 -0700855// Collect and report the android metrics when we terminate the update.
856void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
857 ErrorCode error_code) {
858 int64_t attempt_number =
859 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
860 PayloadType payload_type = kPayloadTypeFull;
861 int64_t payload_size = 0;
862 for (const auto& p : install_plan_.payloads) {
863 if (p.type == InstallPayloadType::kDelta)
864 payload_type = kPayloadTypeDelta;
865 payload_size += p.size;
866 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700867 // In some cases, e.g. after calling |setShouldSwitchSlotOnReboot()|, this
868 // function will be triggered, but payload_size in this case might be 0, if so
869 // skip reporting any metrics.
870 if (payload_size == 0) {
871 return;
872 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700873
874 metrics::AttemptResult attempt_result =
875 metrics_utils::GetAttemptResult(error_code);
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700876 Time boot_time_start = Time::FromInternalValue(
877 metrics_utils::GetPersistedValue(kPrefsUpdateBootTimestampStart, prefs_));
878 Time monotonic_time_start = Time::FromInternalValue(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700879 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700880 TimeDelta duration = clock_->GetBootTime() - boot_time_start;
881 TimeDelta duration_uptime = clock_->GetMonotonicTime() - monotonic_time_start;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700882
883 metrics_reporter_->ReportUpdateAttemptMetrics(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700884 static_cast<int>(attempt_number),
885 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700886 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700887 duration_uptime,
888 payload_size,
889 attempt_result,
890 error_code);
891
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800892 int64_t current_bytes_downloaded = metric_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -0700893 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
894 current_bytes_downloaded,
895 0,
896 DownloadSource::kNumDownloadSources,
897 metrics::DownloadErrorCode::kUnset,
898 metrics::ConnectionType::kUnset);
899
Tianjie Xu90aaa102017-10-10 17:39:03 -0700900 if (error_code == ErrorCode::kSuccess) {
901 int64_t reboot_count =
902 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
903 string build_version;
904 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -0700905
906 // For android metrics, we only care about the total bytes downloaded
907 // for all sources; for now we assume the only download source is
908 // HttpsServer.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800909 int64_t total_bytes_downloaded = metric_total_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -0700910 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
911 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
912 total_bytes_downloaded;
913
914 int download_overhead_percentage = 0;
Tianjie Xu21030c12019-08-14 13:00:23 -0700915 if (total_bytes_downloaded >= payload_size) {
916 CHECK_GT(payload_size, 0);
Tianjie Xud4777a12017-10-24 14:54:18 -0700917 download_overhead_percentage =
Tianjie Xu21030c12019-08-14 13:00:23 -0700918 (total_bytes_downloaded - payload_size) * 100ull / payload_size;
919 } else {
920 LOG(WARNING) << "Downloaded bytes " << total_bytes_downloaded
921 << " is smaller than the payload size " << payload_size;
Tianjie Xud4777a12017-10-24 14:54:18 -0700922 }
Tianjie Xu21030c12019-08-14 13:00:23 -0700923
Tianjie Xu90aaa102017-10-10 17:39:03 -0700924 metrics_reporter_->ReportSuccessfulUpdateMetrics(
925 static_cast<int>(attempt_number),
926 0, // update abandoned count
927 payload_type,
928 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -0700929 num_bytes_downloaded,
930 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700931 duration,
Sen Jiang8712e962018-05-08 12:12:28 -0700932 duration_uptime,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700933 static_cast<int>(reboot_count),
934 0); // url_switch_count
935 }
936}
937
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400938bool UpdateAttempterAndroid::OTARebootSucceeded() const {
939 const auto current_slot = boot_control_->GetCurrentSlot();
940 const string current_version =
941 android::base::GetProperty("ro.build.version.incremental", "");
942 int64_t previous_slot = -1;
943 TEST_AND_RETURN_FALSE(prefs_->GetInt64(kPrefsPreviousSlot, &previous_slot));
944 string previous_version;
945 TEST_AND_RETURN_FALSE(
946 prefs_->GetString(kPrefsPreviousVersion, &previous_version));
947 if (previous_slot != current_slot) {
948 LOG(INFO) << "Detected a slot switch, OTA succeeded, device updated from "
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800949 << previous_version << " to " << current_version
950 << ", previous slot: " << previous_slot
951 << " current slot: " << current_slot;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400952 if (previous_version == current_version) {
953 LOG(INFO) << "Previous version is the same as current version, this is "
954 "possibly a self-OTA.";
955 }
956 return true;
957 } else {
958 LOG(INFO) << "Slot didn't switch, either the OTA is rolled back, or slot "
959 "switch never happened, or system not rebooted at all.";
960 if (previous_version != current_version) {
961 LOG(INFO) << "Slot didn't change, but version changed from "
962 << previous_version << " to " << current_version
963 << " device could be flashed.";
964 }
965 return false;
966 }
967}
968
969OTAResult UpdateAttempterAndroid::GetOTAUpdateResult() const {
970 // We only set |kPrefsSystemUpdatedMarker| if slot is actually switched, so
971 // existence of this pref is sufficient indicator. Given that we have to
972 // delete this pref after checking it. This is done in
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800973 // |DeltaPerformer::ResetUpdateProgress| and
974 // |UpdateAttempterAndroid::UpdateStateAfterReboot|
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400975 auto slot_switch_attempted = prefs_->Exists(kPrefsUpdateCompletedOnBootId);
976 auto system_rebooted = DidSystemReboot(prefs_);
977 auto ota_successful = OTARebootSucceeded();
978 if (ota_successful) {
979 return OTAResult::OTA_SUCCESSFUL;
980 }
981 if (slot_switch_attempted) {
982 if (system_rebooted) {
983 // If we attempted slot switch, but still end up on the same slot, we
984 // probably rolled back.
985 return OTAResult::ROLLED_BACK;
986 } else {
987 return OTAResult::UPDATED_NEED_REBOOT;
988 }
989 }
990 return OTAResult::NOT_ATTEMPTED;
991}
992
993void UpdateAttempterAndroid::UpdateStateAfterReboot(const OTAResult result) {
Tianjie Xu90aaa102017-10-10 17:39:03 -0700994 // Example: [ro.build.version.incremental]: [4292972]
995 string current_version =
996 android::base::GetProperty("ro.build.version.incremental", "");
997 TEST_AND_RETURN(!current_version.empty());
998
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400999 // |UpdateStateAfterReboot()| is only called after system reboot, so record
1000 // boot id unconditionally
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001001 string current_boot_id;
1002 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
1003 prefs_->SetString(kPrefsBootId, current_boot_id);
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001004 std::string slot_switch_indicator;
1005 prefs_->GetString(kPrefsUpdateCompletedOnBootId, &slot_switch_indicator);
1006 if (slot_switch_indicator != current_boot_id) {
1007 ClearUpdateCompletedMarker();
1008 }
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001009
Tianjie Xu90aaa102017-10-10 17:39:03 -07001010 // If there's no record of previous version (e.g. due to a data wipe), we
1011 // save the info of current boot and skip the metrics report.
1012 if (!prefs_->Exists(kPrefsPreviousVersion)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001013 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001014 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001015 ClearMetricsPrefs();
1016 return;
1017 }
Kelvin Zhang86603472021-05-11 12:16:27 -04001018 // update_engine restarted under the same build and same slot.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001019 if (result != OTAResult::OTA_SUCCESSFUL) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001020 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
1021 // set when we start a new update.
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001022 if (prefs_->Exists(kPrefsNumReboots)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001023 int64_t reboot_count =
1024 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1025 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
1026 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001027
1028 if (result == OTAResult::ROLLED_BACK) {
1029 // This will release all space previously allocated for apex
1030 // decompression. If we detect a rollback, we should release space and
1031 // return the space to user. Any subsequent attempt to install OTA will
1032 // allocate space again anyway.
1033 LOG(INFO) << "Detected a rollback, releasing space allocated for apex "
1034 "deompression.";
1035 apex_handler_android_->AllocateSpace({});
1036 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1037 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001038 return;
1039 }
1040
1041 // Now that the build version changes, report the update metrics.
1042 // TODO(xunchang) check the build version is larger than the previous one.
Tianjie Xu90aaa102017-10-10 17:39:03 -07001043 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001044 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001045
1046 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
1047 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
1048 if (previous_attempt_exists) {
1049 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
1050 }
1051
1052 metrics_utils::LoadAndReportTimeToReboot(
1053 metrics_reporter_.get(), prefs_, clock_.get());
1054 ClearMetricsPrefs();
Sen Jiang1bafff82019-01-02 15:54:40 -08001055
1056 // Also reset the update progress if the build version has changed.
1057 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
1058 LOG(WARNING) << "Unable to reset the update progress.";
1059 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001060}
1061
1062// Save the update start time. Reset the reboot count and attempt number if the
1063// update isn't a resume; otherwise increment the attempt number.
1064void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
1065 if (!is_resume) {
1066 metrics_utils::SetNumReboots(0, prefs_);
1067 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
1068 } else {
1069 int64_t attempt_number =
1070 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
1071 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
1072 }
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001073 metrics_utils::SetUpdateTimestampStart(clock_->GetMonotonicTime(), prefs_);
1074 metrics_utils::SetUpdateBootTimestampStart(clock_->GetBootTime(), prefs_);
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001075 ClearUpdateCompletedMarker();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001076}
1077
1078void UpdateAttempterAndroid::ClearMetricsPrefs() {
1079 CHECK(prefs_);
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001080 metric_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001081 prefs_->Delete(kPrefsNumReboots);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001082 prefs_->Delete(kPrefsSystemUpdatedMarker);
1083 prefs_->Delete(kPrefsUpdateTimestampStart);
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001084 prefs_->Delete(kPrefsUpdateBootTimestampStart);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001085}
1086
Yifan Hongbd47d622019-12-13 14:59:58 -08001087BootControlInterface::Slot UpdateAttempterAndroid::GetCurrentSlot() const {
1088 return boot_control_->GetCurrentSlot();
1089}
1090
1091BootControlInterface::Slot UpdateAttempterAndroid::GetTargetSlot() const {
1092 return GetCurrentSlot() == 0 ? 1 : 0;
1093}
1094
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001095uint64_t UpdateAttempterAndroid::AllocateSpaceForPayload(
1096 const std::string& metadata_filename,
1097 const vector<string>& key_value_pair_headers,
1098 brillo::ErrorPtr* error) {
Yifan Hong65613032020-01-09 17:52:13 -08001099 DeltaArchiveManifest manifest;
1100 if (!VerifyPayloadParseManifest(metadata_filename, &manifest, error)) {
1101 return 0;
1102 }
1103 std::map<string, string> headers;
1104 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
1105 return 0;
1106 }
1107
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001108 std::vector<ApexInfo> apex_infos(manifest.apex_info().begin(),
1109 manifest.apex_info().end());
1110 uint64_t apex_size_required = 0;
1111 if (apex_handler_android_ != nullptr) {
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001112 auto result = apex_handler_android_->CalculateSize(apex_infos);
1113 if (!result.ok()) {
1114 LogAndSetError(error,
1115 FROM_HERE,
1116 "Failed to calculate size required for compressed APEX");
1117 return 0;
1118 }
1119 apex_size_required = *result;
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001120 }
1121
Yifan Hong65613032020-01-09 17:52:13 -08001122 string payload_id = GetPayloadId(headers);
1123 uint64_t required_size = 0;
1124 if (!DeltaPerformer::PreparePartitionsForUpdate(prefs_,
1125 boot_control_,
1126 GetTargetSlot(),
1127 manifest,
1128 payload_id,
1129 &required_size)) {
1130 if (required_size == 0) {
1131 LogAndSetError(error, FROM_HERE, "Failed to allocate space for payload.");
1132 return 0;
1133 } else {
1134 LOG(ERROR) << "Insufficient space for payload: " << required_size
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001135 << " bytes, apex decompression: " << apex_size_required
Yifan Hong65613032020-01-09 17:52:13 -08001136 << " bytes";
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001137 return required_size + apex_size_required;
Yifan Hong65613032020-01-09 17:52:13 -08001138 }
1139 }
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001140
1141 if (apex_size_required > 0 && apex_handler_android_ != nullptr &&
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001142 !apex_handler_android_->AllocateSpace(apex_infos)) {
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001143 LOG(ERROR) << "Insufficient space for apex decompression: "
1144 << apex_size_required << " bytes";
1145 return apex_size_required;
Kelvin Zhang8933d572021-01-28 10:17:34 -05001146 }
Yifan Hong65613032020-01-09 17:52:13 -08001147
1148 LOG(INFO) << "Successfully allocated space for payload.";
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001149 return 0;
1150}
1151
Yifan Hong40bb0d02020-02-24 17:33:14 -08001152void UpdateAttempterAndroid::CleanupSuccessfulUpdate(
1153 std::unique_ptr<CleanupSuccessfulUpdateCallbackInterface> callback,
Yifan Hong2236ea02019-12-13 16:11:22 -08001154 brillo::ErrorPtr* error) {
Yifan Hong40bb0d02020-02-24 17:33:14 -08001155 if (cleanup_previous_update_code_.has_value()) {
1156 LOG(INFO) << "CleanupSuccessfulUpdate has previously completed with "
1157 << utils::ErrorCodeToString(*cleanup_previous_update_code_);
1158 if (callback) {
1159 callback->OnCleanupComplete(
1160 static_cast<int32_t>(*cleanup_previous_update_code_));
1161 }
1162 return;
Yifan Hong4f611562020-01-15 23:41:33 -08001163 }
Yifan Hong40bb0d02020-02-24 17:33:14 -08001164 if (callback) {
1165 auto callback_ptr = callback.get();
1166 cleanup_previous_update_callbacks_.emplace_back(std::move(callback));
1167 callback_ptr->RegisterForDeathNotifications(
1168 base::Bind(&UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback,
1169 base::Unretained(this),
1170 base::Unretained(callback_ptr)));
1171 }
1172 ScheduleCleanupPreviousUpdate();
Yifan Hong2236ea02019-12-13 16:11:22 -08001173}
1174
Tianjie7f8f2ab2021-07-23 17:08:50 -07001175bool UpdateAttempterAndroid::setShouldSwitchSlotOnReboot(
1176 const std::string& metadata_filename, brillo::ErrorPtr* error) {
Kelvin Zhang20982a52021-08-13 12:31:16 -07001177 LOG(INFO) << "setShouldSwitchSlotOnReboot(" << metadata_filename << ")";
Tianjie7f8f2ab2021-07-23 17:08:50 -07001178 if (processor_->IsRunning()) {
1179 return LogAndSetError(
1180 error, FROM_HERE, "Already processing an update, cancel it first.");
1181 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001182 DeltaArchiveManifest manifest;
1183 TEST_AND_RETURN_FALSE(
1184 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
1185
Kelvin Zhang20982a52021-08-13 12:31:16 -07001186 InstallPlan install_plan_;
1187 install_plan_.source_slot = GetCurrentSlot();
1188 install_plan_.target_slot = GetTargetSlot();
1189 // Don't do verity computation, just hash the partitions
1190 install_plan_.write_verity = false;
1191 // Don't run postinstall, we just need PostinstallAction to switch the slots.
1192 install_plan_.run_post_install = false;
1193 install_plan_.is_resume = true;
1194
1195 CHECK_NE(install_plan_.source_slot, UINT32_MAX);
1196 CHECK_NE(install_plan_.target_slot, UINT32_MAX);
1197
Kelvin Zhang20982a52021-08-13 12:31:16 -07001198 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001199 auto postinstall_runner_action =
1200 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
1201 SetStatusAndNotify(UpdateStatus::VERIFYING);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001202 postinstall_runner_action->set_delegate(this);
1203
Kelvin Zhangf8441982022-12-07 18:18:47 -08001204 // If last error code is kUpdatedButNotActive, we know that we reached this
1205 // state by calling applyPayload() with switch_slot=false. That applyPayload()
1206 // call would have already performed filesystem verification, therefore, we
1207 // can safely skip the verification to save time.
1208 if (last_error_ == ErrorCode::kUpdatedButNotActive) {
1209 BondActions(install_plan_action.get(), postinstall_runner_action.get());
1210 processor_->EnqueueAction(std::move(install_plan_action));
1211 } else {
Kelvin Zhang263a5402022-12-08 23:03:32 -08001212 if (!boot_control_->GetDynamicPartitionControl()
1213 ->PreparePartitionsForUpdate(GetCurrentSlot(),
1214 GetTargetSlot(),
1215 manifest,
1216 false /* should update */,
1217 nullptr)) {
1218 return LogAndSetError(
1219 error, FROM_HERE, "Failed to PreparePartitionsForUpdate");
1220 }
1221 ErrorCode error_code{};
1222 if (!install_plan_.ParsePartitions(manifest.partitions(),
1223 boot_control_,
1224 manifest.block_size(),
1225 &error_code)) {
1226 return LogAndSetError(error,
1227 FROM_HERE,
1228 "Failed to LoadPartitionsFromSlots " +
1229 utils::ErrorCodeToString(error_code));
1230 }
1231
Kelvin Zhangf8441982022-12-07 18:18:47 -08001232 auto filesystem_verifier_action =
1233 std::make_unique<FilesystemVerifierAction>(
1234 boot_control_->GetDynamicPartitionControl());
1235 filesystem_verifier_action->set_delegate(this);
1236 BondActions(install_plan_action.get(), filesystem_verifier_action.get());
1237 BondActions(filesystem_verifier_action.get(),
1238 postinstall_runner_action.get());
1239 processor_->EnqueueAction(std::move(install_plan_action));
1240 processor_->EnqueueAction(std::move(filesystem_verifier_action));
1241 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001242
Kelvin Zhang20982a52021-08-13 12:31:16 -07001243 processor_->EnqueueAction(std::move(postinstall_runner_action));
1244 ScheduleProcessingStart();
1245 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001246}
1247
1248bool UpdateAttempterAndroid::resetShouldSwitchSlotOnReboot(
1249 brillo::ErrorPtr* error) {
1250 if (processor_->IsRunning()) {
1251 return LogAndSetError(
1252 error, FROM_HERE, "Already processing an update, cancel it first.");
1253 }
Daniel Zhenge76cf562022-11-08 17:32:10 +00001254 TEST_AND_RETURN_FALSE(ClearUpdateCompletedMarker());
Kelvin Zhang20982a52021-08-13 12:31:16 -07001255 // Update the boot flags so the current slot has higher priority.
1256 if (!boot_control_->SetActiveBootSlot(GetCurrentSlot())) {
1257 return LogAndSetError(error, FROM_HERE, "Failed to SetActiveBootSlot");
1258 }
1259
1260 // Mark the current slot as successful again, since marking it as active
1261 // may reset the successful bit. We ignore the result of whether marking
1262 // the current slot as successful worked.
1263 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful) {}))) {
1264 return LogAndSetError(
1265 error, FROM_HERE, "Failed to MarkBootSuccessfulAsync");
1266 }
1267
1268 // Resets the warm reset property since we won't switch the slot.
1269 hardware_->SetWarmReset(false);
1270
1271 // Resets the vbmeta digest.
1272 hardware_->SetVbmetaDigestForInactiveSlot(true /* reset */);
1273 LOG(INFO) << "Slot switch cancelled.";
1274 SetStatusAndNotify(UpdateStatus::IDLE);
1275 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001276}
1277
Yifan Hong90965502020-02-19 15:22:47 -08001278void UpdateAttempterAndroid::ScheduleCleanupPreviousUpdate() {
1279 // If a previous CleanupSuccessfulUpdate call has not finished, or an update
1280 // is in progress, skip enqueueing the action.
1281 if (processor_->IsRunning()) {
1282 LOG(INFO) << "Already processing an update. CleanupPreviousUpdate should "
1283 << "be done when the current update finishes.";
1284 return;
1285 }
1286 LOG(INFO) << "Scheduling CleanupPreviousUpdateAction.";
1287 auto action =
1288 boot_control_->GetDynamicPartitionControl()
1289 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
1290 processor_->EnqueueAction(std::move(action));
1291 processor_->set_delegate(this);
1292 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
1293 processor_->StartProcessing();
1294}
1295
Yifan Hong40bb0d02020-02-24 17:33:14 -08001296void UpdateAttempterAndroid::OnCleanupProgressUpdate(double progress) {
1297 for (auto&& callback : cleanup_previous_update_callbacks_) {
1298 callback->OnCleanupProgressUpdate(progress);
1299 }
1300}
1301
1302void UpdateAttempterAndroid::NotifyCleanupPreviousUpdateCallbacksAndClear() {
1303 CHECK(cleanup_previous_update_code_.has_value());
1304 for (auto&& callback : cleanup_previous_update_callbacks_) {
1305 callback->OnCleanupComplete(
1306 static_cast<int32_t>(*cleanup_previous_update_code_));
1307 }
1308 cleanup_previous_update_callbacks_.clear();
1309}
1310
1311void UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback(
1312 CleanupSuccessfulUpdateCallbackInterface* callback) {
1313 auto end_it =
1314 std::remove_if(cleanup_previous_update_callbacks_.begin(),
1315 cleanup_previous_update_callbacks_.end(),
1316 [&](const auto& e) { return e.get() == callback; });
1317 cleanup_previous_update_callbacks_.erase(
1318 end_it, cleanup_previous_update_callbacks_.end());
1319}
Yifan Hong90965502020-02-19 15:22:47 -08001320
Alex Deymo5e3ea272016-01-28 13:42:23 -08001321} // namespace chromeos_update_engine