blob: 562810923762cf4ba4b025c206f54dd4b7068b33 [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
Alex Deymo5e3ea272016-01-28 13:42:23 -080084const char* const kErrorDomain = "update_engine";
85// TODO(deymo): Convert the different errors to a numeric value to report them
86// back on the service error.
87const char* const kGenericError = "generic_error";
88
89// Log and set the error on the passed ErrorPtr.
90bool LogAndSetError(brillo::ErrorPtr* error,
Jakub Pawlowski7e1dcf72018-07-26 00:29:42 -070091 const base::Location& location,
Alex Deymo5e3ea272016-01-28 13:42:23 -080092 const string& reason) {
93 brillo::Error::AddTo(error, location, kErrorDomain, kGenericError, reason);
94 LOG(ERROR) << "Replying with failure: " << location.ToString() << ": "
95 << reason;
96 return false;
97}
98
Sen Jiangfe522822017-10-31 15:14:11 -070099bool GetHeaderAsBool(const string& header, bool default_value) {
100 int value = 0;
101 if (base::StringToInt(header, &value) && (value == 0 || value == 1))
102 return value == 1;
103 return default_value;
104}
105
Yifan Hongbd47d622019-12-13 14:59:58 -0800106bool ParseKeyValuePairHeaders(const vector<string>& key_value_pair_headers,
107 std::map<string, string>* headers,
108 brillo::ErrorPtr* error) {
109 for (const string& key_value_pair : key_value_pair_headers) {
110 string key;
111 string value;
112 if (!brillo::string_utils::SplitAtFirst(
113 key_value_pair, "=", &key, &value, false)) {
114 return LogAndSetError(
115 error, FROM_HERE, "Passed invalid header: " + key_value_pair);
116 }
117 if (!headers->emplace(key, value).second)
118 return LogAndSetError(error, FROM_HERE, "Passed repeated key: " + key);
119 }
120 return true;
121}
122
123// Unique identifier for the payload. An empty string means that the payload
124// can't be resumed.
125string GetPayloadId(const std::map<string, string>& headers) {
126 return (headers.count(kPayloadPropertyFileHash)
127 ? headers.at(kPayloadPropertyFileHash)
128 : "") +
129 (headers.count(kPayloadPropertyMetadataHash)
130 ? headers.at(kPayloadPropertyMetadataHash)
131 : "");
132}
133
Alex Deymo5e3ea272016-01-28 13:42:23 -0800134} // namespace
135
136UpdateAttempterAndroid::UpdateAttempterAndroid(
Alex Deymo03a4de72016-07-20 16:08:23 -0700137 DaemonStateInterface* daemon_state,
Alex Deymo5e3ea272016-01-28 13:42:23 -0800138 PrefsInterface* prefs,
139 BootControlInterface* boot_control,
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000140 HardwareInterface* hardware,
141 std::unique_ptr<ApexHandlerInterface> apex_handler)
Alex Deymo5e3ea272016-01-28 13:42:23 -0800142 : daemon_state_(daemon_state),
143 prefs_(prefs),
144 boot_control_(boot_control),
145 hardware_(hardware),
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000146 apex_handler_android_(std::move(apex_handler)),
Tianjie Xu1b661142017-09-28 14:03:42 -0700147 processor_(new ActionProcessor()),
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800148 clock_(new Clock()),
149 metric_bytes_downloaded_(kPrefsCurrentBytesDownloaded, prefs_),
150 metric_total_bytes_downloaded_(kPrefsTotalBytesDownloaded, prefs_) {
Yifan Hongc514f662021-02-04 11:18:43 -0800151 metrics_reporter_ = metrics::CreateMetricsReporter(
Kelvin Zhang9a5e3682021-03-29 12:58:48 -0400152 boot_control_->GetDynamicPartitionControl(), &install_plan_);
Alex Deymo87792ea2016-07-25 15:40:36 -0700153 network_selector_ = network::CreateNetworkSelector();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800154}
155
156UpdateAttempterAndroid::~UpdateAttempterAndroid() {
157 // Release ourselves as the ActionProcessor's delegate to prevent
158 // re-scheduling the updates due to the processing stopped.
159 processor_->set_delegate(nullptr);
160}
161
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400162[[nodiscard]] static bool DidSystemReboot(PrefsInterface* prefs) {
163 string boot_id;
164 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
165 string old_boot_id;
166 // If no previous boot id found, treat as a reboot and write boot ID.
167 if (!prefs->GetString(kPrefsBootId, &old_boot_id)) {
168 return true;
169 }
170 return old_boot_id != boot_id;
171}
172
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400173std::ostream& operator<<(std::ostream& out, OTAResult result) {
174 switch (result) {
175 case OTAResult::NOT_ATTEMPTED:
176 out << "OTAResult::NOT_ATTEMPTED";
177 break;
178 case OTAResult::ROLLED_BACK:
179 out << "OTAResult::ROLLED_BACK";
180 break;
181 case OTAResult::UPDATED_NEED_REBOOT:
182 out << "OTAResult::UPDATED_NEED_REBOOT";
183 break;
184 case OTAResult::OTA_SUCCESSFUL:
185 out << "OTAResult::OTA_SUCCESSFUL";
186 break;
187 }
188 return out;
189}
190
Alex Deymo5e3ea272016-01-28 13:42:23 -0800191void UpdateAttempterAndroid::Init() {
192 // In case of update_engine restart without a reboot we need to restore the
193 // reboot needed state.
Tianjie Xu90aaa102017-10-10 17:39:03 -0700194 if (UpdateCompletedOnThisBoot()) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400195 LOG(INFO) << "Updated installed but update_engine is restarted without "
196 "device reboot. Resuming old state.";
Alex Deymo0e061ae2016-02-09 17:49:03 -0800197 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700198 } else {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400199 const auto result = GetOTAUpdateResult();
200 LOG(INFO) << result;
Alex Deymo0e061ae2016-02-09 17:49:03 -0800201 SetStatusAndNotify(UpdateStatus::IDLE);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400202 if (DidSystemReboot(prefs_)) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400203 UpdateStateAfterReboot(result);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400204 }
205
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700206#ifdef _UE_SIDELOAD
207 LOG(INFO) << "Skip ScheduleCleanupPreviousUpdate in sideload because "
208 << "ApplyPayload will call it later.";
209#else
Yifan Hong90965502020-02-19 15:22:47 -0800210 ScheduleCleanupPreviousUpdate();
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700211#endif
Tianjie Xu90aaa102017-10-10 17:39:03 -0700212 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800213}
214
215bool UpdateAttempterAndroid::ApplyPayload(
216 const string& payload_url,
217 int64_t payload_offset,
218 int64_t payload_size,
219 const vector<string>& key_value_pair_headers,
220 brillo::ErrorPtr* error) {
221 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
222 return LogAndSetError(
223 error, FROM_HERE, "An update already applied, waiting for reboot");
224 }
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700225 if (processor_->IsRunning()) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800226 return LogAndSetError(
227 error, FROM_HERE, "Already processing an update, cancel it first.");
228 }
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100229 DCHECK_EQ(status_, UpdateStatus::IDLE);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800230
Alex Deymo218397f2016-02-04 23:55:10 -0800231 std::map<string, string> headers;
Yifan Hongbd47d622019-12-13 14:59:58 -0800232 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
233 return false;
Alex Deymo218397f2016-02-04 23:55:10 -0800234 }
235
Yifan Hongbd47d622019-12-13 14:59:58 -0800236 string payload_id = GetPayloadId(headers);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800237
238 // Setup the InstallPlan based on the request.
239 install_plan_ = InstallPlan();
240
241 install_plan_.download_url = payload_url;
242 install_plan_.version = "";
Alex Deymo0fd51ff2016-02-03 14:22:43 -0800243 base_offset_ = payload_offset;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800244 InstallPlan::Payload payload;
245 payload.size = payload_size;
246 if (!payload.size) {
Alex Deymo218397f2016-02-04 23:55:10 -0800247 if (!base::StringToUint64(headers[kPayloadPropertyFileSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800248 &payload.size)) {
249 payload.size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800250 }
251 }
Sen Jiang2703ef42017-03-16 13:36:21 -0700252 if (!brillo::data_encoding::Base64Decode(headers[kPayloadPropertyFileHash],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800253 &payload.hash)) {
Sen Jiang2703ef42017-03-16 13:36:21 -0700254 LOG(WARNING) << "Unable to decode base64 file hash: "
255 << headers[kPayloadPropertyFileHash];
256 }
Alex Deymo218397f2016-02-04 23:55:10 -0800257 if (!base::StringToUint64(headers[kPayloadPropertyMetadataSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800258 &payload.metadata_size)) {
259 payload.metadata_size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800260 }
Sen Jiangcdd52062017-05-18 15:33:10 -0700261 // The |payload.type| is not used anymore since minor_version 3.
262 payload.type = InstallPayloadType::kUnknown;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800263 install_plan_.payloads.push_back(payload);
264
Alex Deymo5e3ea272016-01-28 13:42:23 -0800265 // The |public_key_rsa| key would override the public key stored on disk.
266 install_plan_.public_key_rsa = "";
267
268 install_plan_.hash_checks_mandatory = hardware_->IsOfficialBuild();
269 install_plan_.is_resume = !payload_id.empty() &&
270 DeltaPerformer::CanResumeUpdate(prefs_, payload_id);
271 if (!install_plan_.is_resume) {
Kelvin Zhang42c2d552022-07-25 11:04:00 -0700272 boot_control_->GetDynamicPartitionControl()->Cleanup();
Kelvin Zhangc54c9962022-10-20 13:44:59 -0700273 boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_);
274
Alex Deymo5e3ea272016-01-28 13:42:23 -0800275 if (!prefs_->SetString(kPrefsUpdateCheckResponseHash, payload_id)) {
276 LOG(WARNING) << "Unable to save the update check response hash.";
277 }
278 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800279 install_plan_.source_slot = GetCurrentSlot();
280 install_plan_.target_slot = GetTargetSlot();
Alex Deymofb905d92016-06-03 19:26:58 -0700281
Alex Deymofb905d92016-06-03 19:26:58 -0700282 install_plan_.powerwash_required =
Sen Jiangfe522822017-10-31 15:14:11 -0700283 GetHeaderAsBool(headers[kPayloadPropertyPowerwash], false);
284
Daniel Zheng9fc62b82023-03-24 22:57:20 +0000285 if (!IsProductionBuild()) {
286 install_plan_.disable_vabc =
287 GetHeaderAsBool(headers[kPayloadDisableVABC], false);
288 }
289
Sen Jiangfe522822017-10-31 15:14:11 -0700290 install_plan_.switch_slot_on_reboot =
291 GetHeaderAsBool(headers[kPayloadPropertySwitchSlotOnReboot], true);
292
Tianjie Xu087de9d2019-11-01 17:11:22 -0700293 install_plan_.run_post_install =
294 GetHeaderAsBool(headers[kPayloadPropertyRunPostInstall], true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800295
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700296 // Skip writing verity if we're resuming and verity has already been written.
297 install_plan_.write_verity = true;
298 if (install_plan_.is_resume && prefs_->Exists(kPrefsVerityWritten)) {
299 bool verity_written = false;
300 if (prefs_->GetBoolean(kPrefsVerityWritten, &verity_written) &&
301 verity_written) {
302 install_plan_.write_verity = false;
303 }
304 }
305
Alex Deymo87792ea2016-07-25 15:40:36 -0700306 NetworkId network_id = kDefaultNetworkId;
307 if (!headers[kPayloadPropertyNetworkId].empty()) {
308 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
309 &network_id)) {
310 return LogAndSetError(
311 error,
312 FROM_HERE,
313 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
314 }
315 if (!network_selector_->SetProcessNetwork(network_id)) {
Sen Jiangcbd37c62017-09-12 15:04:35 -0700316 return LogAndSetError(
317 error,
318 FROM_HERE,
319 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700320 }
321 }
322
Alex Deymo5e3ea272016-01-28 13:42:23 -0800323 LOG(INFO) << "Using this install plan:";
324 install_plan_.Dump();
325
Amin Hassani667cf7b2018-07-25 14:32:00 -0700326 HttpFetcher* fetcher = nullptr;
327 if (FileFetcher::SupportedUrl(payload_url)) {
328 DLOG(INFO) << "Using FileFetcher for file URL.";
329 fetcher = new FileFetcher();
330 } else {
331#ifdef _UE_SIDELOAD
332 LOG(FATAL) << "Unsupported sideload URI: " << payload_url;
Chih-Hung Hsieh6e4f3452022-12-21 12:20:45 -0800333 return false; // NOLINT, unreached but analyzer might not know.
334 // Suppress warnings about null 'fetcher' after this.
Amin Hassani667cf7b2018-07-25 14:32:00 -0700335#else
Kelvin Zhangc7a1d1f2022-07-29 13:36:29 -0700336 LibcurlHttpFetcher* libcurl_fetcher = new LibcurlHttpFetcher(hardware_);
Kelvin Zhang3cc4fa32022-09-27 16:15:10 -0700337 if (!headers[kPayloadDownloadRetry].empty()) {
338 libcurl_fetcher->set_max_retry_count(
339 atoi(headers[kPayloadDownloadRetry].c_str()));
340 }
Amin Hassani667cf7b2018-07-25 14:32:00 -0700341 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
342 fetcher = libcurl_fetcher;
343#endif // _UE_SIDELOAD
344 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800345 // Setup extra headers.
Alex Deymofdd6dec2016-03-03 22:35:43 -0800346 if (!headers[kPayloadPropertyAuthorization].empty())
347 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
348 if (!headers[kPayloadPropertyUserAgent].empty())
349 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
350
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700351 if (!headers[kPayloadPropertyNetworkProxy].empty()) {
352 LOG(INFO) << "Using proxy url from payload headers: "
353 << headers[kPayloadPropertyNetworkProxy];
354 fetcher->SetProxies({headers[kPayloadPropertyNetworkProxy]});
355 }
Kelvin Zhanga7407b52023-03-13 15:05:14 -0700356 if (!headers[kPayloadVABCNone].empty()) {
357 install_plan_.vabc_none = true;
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000358 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800359 if (!headers[kPayloadEnableThreading].empty()) {
360 install_plan_.enable_threading = true;
361 }
362 if (!headers[kPayloadBatchedWrites].empty()) {
363 install_plan_.batched_writes = true;
364 }
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700365
Amin Hassani667cf7b2018-07-25 14:32:00 -0700366 BuildUpdateActions(fetcher);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800367
Alex Deymo5e3ea272016-01-28 13:42:23 -0800368 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700369
370 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
371 // TODO(xunchang) report the metrics for unresumable updates
372
Amin Hassani667cf7b2018-07-25 14:32:00 -0700373 ScheduleProcessingStart();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800374 return true;
375}
376
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900377bool UpdateAttempterAndroid::ApplyPayload(
378 int fd,
379 int64_t payload_offset,
380 int64_t payload_size,
381 const vector<string>& key_value_pair_headers,
382 brillo::ErrorPtr* error) {
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100383 // update_engine state must be checked before modifying payload_fd_ otherwise
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +0000384 // already running update will be terminated (existing file descriptor will be
385 // closed)
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100386 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
387 return LogAndSetError(
388 error, FROM_HERE, "An update already applied, waiting for reboot");
389 }
390 if (processor_->IsRunning()) {
391 return LogAndSetError(
392 error, FROM_HERE, "Already processing an update, cancel it first.");
393 }
394 DCHECK_EQ(status_, UpdateStatus::IDLE);
395
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900396 payload_fd_.reset(dup(fd));
397 const string payload_url = "fd://" + std::to_string(payload_fd_.get());
398
399 return ApplyPayload(
400 payload_url, payload_offset, payload_size, key_value_pair_headers, error);
401}
402
Alex Deymo5e3ea272016-01-28 13:42:23 -0800403bool UpdateAttempterAndroid::SuspendUpdate(brillo::ErrorPtr* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700404 if (!processor_->IsRunning())
Alex Deymof2858572016-02-25 11:20:13 -0800405 return LogAndSetError(error, FROM_HERE, "No ongoing update to suspend.");
406 processor_->SuspendProcessing();
407 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800408}
409
410bool UpdateAttempterAndroid::ResumeUpdate(brillo::ErrorPtr* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700411 if (!processor_->IsRunning())
Alex Deymof2858572016-02-25 11:20:13 -0800412 return LogAndSetError(error, FROM_HERE, "No ongoing update to resume.");
413 processor_->ResumeProcessing();
414 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800415}
416
417bool UpdateAttempterAndroid::CancelUpdate(brillo::ErrorPtr* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700418 if (!processor_->IsRunning())
Alex Deymo5e3ea272016-01-28 13:42:23 -0800419 return LogAndSetError(error, FROM_HERE, "No ongoing update to cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800420 processor_->StopProcessing();
421 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800422}
423
Alex Deymo3b678db2016-02-09 11:50:06 -0800424bool UpdateAttempterAndroid::ResetStatus(brillo::ErrorPtr* error) {
425 LOG(INFO) << "Attempting to reset state from "
426 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700427 if (processor_->IsRunning()) {
428 return LogAndSetError(
429 error, FROM_HERE, "Already processing an update, cancel it first.");
430 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700431 if (status_ != UpdateStatus::IDLE &&
432 status_ != UpdateStatus::UPDATED_NEED_REBOOT) {
433 return LogAndSetError(error,
434 FROM_HERE,
435 "Status reset not allowed in this state, please "
436 "cancel on going OTA first.");
437 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800438
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000439 if (apex_handler_android_ != nullptr) {
440 LOG(INFO) << "Cleaning up reserved space for compressed APEX (if any)";
441 std::vector<ApexInfo> apex_infos_blank;
442 apex_handler_android_->AllocateSpace(apex_infos_blank);
443 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400444 // Remove the reboot marker so that if the machine is rebooted
445 // after resetting to idle state, it doesn't go back to
446 // UpdateStatus::UPDATED_NEED_REBOOT state.
447 if (!ClearUpdateCompletedMarker()) {
448 return LogAndSetError(error,
449 FROM_HERE,
450 "Failed to reset the status because "
451 "ClearUpdateCompletedMarker() failed");
452 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700453 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
454 if (!resetShouldSwitchSlotOnReboot(error)) {
455 LOG(INFO) << "Failed to reset slot switch.";
456 return false;
457 }
458 LOG(INFO) << "Slot switch reset successful";
459 }
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700460 if (!boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_)) {
461 LOG(WARNING) << "Failed to reset snapshots. UpdateStatus is IDLE but"
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000462 << "space might not be freed.";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700463 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700464 return true;
Alex Deymo3b678db2016-02-09 11:50:06 -0800465}
466
Yifan Hongbd47d622019-12-13 14:59:58 -0800467bool UpdateAttempterAndroid::VerifyPayloadParseManifest(
468 const std::string& metadata_filename,
469 DeltaArchiveManifest* manifest,
470 brillo::ErrorPtr* error) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800471 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
472 if (!fd->Open(metadata_filename.c_str(), O_RDONLY)) {
473 return LogAndSetError(
474 error, FROM_HERE, "Failed to open " + metadata_filename);
475 }
476 brillo::Blob metadata(kMaxPayloadHeaderSize);
477 if (!fd->Read(metadata.data(), metadata.size())) {
478 return LogAndSetError(
479 error,
480 FROM_HERE,
481 "Failed to read payload header from " + metadata_filename);
482 }
Daniel Zhengda4f7292022-09-02 22:59:32 +0000483 ErrorCode errorcode{};
Sen Jiang8371c1c2018-02-01 13:46:39 -0800484 PayloadMetadata payload_metadata;
Sen Jiangf1236632018-05-11 16:03:23 -0700485 if (payload_metadata.ParsePayloadHeader(metadata, &errorcode) !=
Sen Jiang8371c1c2018-02-01 13:46:39 -0800486 MetadataParseResult::kSuccess) {
487 return LogAndSetError(error,
488 FROM_HERE,
489 "Failed to parse payload header: " +
490 utils::ErrorCodeToString(errorcode));
491 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700492 uint64_t metadata_size = payload_metadata.GetMetadataSize() +
493 payload_metadata.GetMetadataSignatureSize();
494 if (metadata_size < kMaxPayloadHeaderSize ||
495 metadata_size >
496 static_cast<uint64_t>(utils::FileSize(metadata_filename))) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800497 return LogAndSetError(
498 error,
499 FROM_HERE,
Sen Jiang840a7ea2018-09-19 14:29:44 -0700500 "Invalid metadata size: " + std::to_string(metadata_size));
Sen Jiang8371c1c2018-02-01 13:46:39 -0800501 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700502 metadata.resize(metadata_size);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800503 if (!fd->Read(metadata.data() + kMaxPayloadHeaderSize,
504 metadata.size() - kMaxPayloadHeaderSize)) {
505 return LogAndSetError(
506 error,
507 FROM_HERE,
508 "Failed to read metadata and signature from " + metadata_filename);
509 }
510 fd->Close();
Sen Jiang08c6da12019-01-07 18:28:56 -0800511
Tianjie Xu7a78d632019-10-08 16:32:39 -0700512 auto payload_verifier = PayloadVerifier::CreateInstanceFromZipPath(
513 constants::kUpdateCertificatesPath);
514 if (!payload_verifier) {
515 return LogAndSetError(error,
516 FROM_HERE,
517 "Failed to create the payload verifier from " +
518 std::string(constants::kUpdateCertificatesPath));
Sen Jiang08c6da12019-01-07 18:28:56 -0800519 }
Tianjie Xu7a78d632019-10-08 16:32:39 -0700520 errorcode = payload_metadata.ValidateMetadataSignature(
521 metadata, "", *payload_verifier);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800522 if (errorcode != ErrorCode::kSuccess) {
523 return LogAndSetError(error,
524 FROM_HERE,
525 "Failed to validate metadata signature: " +
526 utils::ErrorCodeToString(errorcode));
527 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800528 if (!payload_metadata.GetManifest(metadata, manifest)) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800529 return LogAndSetError(error, FROM_HERE, "Failed to parse manifest.");
530 }
531
Yifan Hongbd47d622019-12-13 14:59:58 -0800532 return true;
533}
534
535bool UpdateAttempterAndroid::VerifyPayloadApplicable(
536 const std::string& metadata_filename, brillo::ErrorPtr* error) {
537 DeltaArchiveManifest manifest;
538 TEST_AND_RETURN_FALSE(
539 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
540
541 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
Daniel Zhengda4f7292022-09-02 22:59:32 +0000542 ErrorCode errorcode{};
Yifan Hongbd47d622019-12-13 14:59:58 -0800543
544 BootControlInterface::Slot current_slot = GetCurrentSlot();
Sen Jiang8371c1c2018-02-01 13:46:39 -0800545 for (const PartitionUpdate& partition : manifest.partitions()) {
546 if (!partition.has_old_partition_info())
547 continue;
548 string partition_path;
549 if (!boot_control_->GetPartitionDevice(
550 partition.partition_name(), current_slot, &partition_path)) {
551 return LogAndSetError(
552 error,
553 FROM_HERE,
554 "Failed to get partition device for " + partition.partition_name());
555 }
556 if (!fd->Open(partition_path.c_str(), O_RDONLY)) {
557 return LogAndSetError(
558 error, FROM_HERE, "Failed to open " + partition_path);
559 }
560 for (const InstallOperation& operation : partition.operations()) {
561 if (!operation.has_src_sha256_hash())
562 continue;
563 brillo::Blob source_hash;
564 if (!fd_utils::ReadAndHashExtents(fd,
565 operation.src_extents(),
566 manifest.block_size(),
567 &source_hash)) {
568 return LogAndSetError(
569 error, FROM_HERE, "Failed to hash " + partition_path);
570 }
Kelvin Zhang9bd519d2020-09-23 12:55:19 -0400571 if (!PartitionWriter::ValidateSourceHash(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800572 source_hash, operation, fd, &errorcode)) {
573 return false;
574 }
575 }
576 fd->Close();
577 }
578 return true;
579}
580
Alex Deymo5e3ea272016-01-28 13:42:23 -0800581void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
582 ErrorCode code) {
583 LOG(INFO) << "Processing Done.";
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800584 metric_bytes_downloaded_.Flush(true);
585 metric_total_bytes_downloaded_.Flush(true);
Kelvin Zhangf8441982022-12-07 18:18:47 -0800586 last_error_ = code;
Yifan Hong90965502020-02-19 15:22:47 -0800587 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
588 TerminateUpdateAndNotify(code);
589 return;
590 }
591
Alex Deymo5990bf32016-07-19 17:01:41 -0700592 switch (code) {
593 case ErrorCode::kSuccess:
594 // Update succeeded.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400595 if (!WriteUpdateCompletedMarker()) {
596 LOG(ERROR) << "Failed to write update completion marker";
597 }
Alex Deymo5990bf32016-07-19 17:01:41 -0700598 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800599
Alex Deymo5990bf32016-07-19 17:01:41 -0700600 LOG(INFO) << "Update successfully applied, waiting to reboot.";
601 break;
602
603 case ErrorCode::kFilesystemCopierError:
604 case ErrorCode::kNewRootfsVerificationError:
605 case ErrorCode::kNewKernelVerificationError:
606 case ErrorCode::kFilesystemVerifierError:
607 case ErrorCode::kDownloadStateInitializationError:
608 // Reset the ongoing update for these errors so it starts from the
609 // beginning next time.
610 DeltaPerformer::ResetUpdateProgress(prefs_, false);
611 LOG(INFO) << "Resetting update progress.";
612 break;
613
Sen Jiangacbdd1c2017-10-19 13:30:19 -0700614 case ErrorCode::kPayloadTimestampError:
615 // SafetyNet logging, b/36232423
616 android_errorWriteLog(0x534e4554, "36232423");
617 break;
618
Alex Deymo5990bf32016-07-19 17:01:41 -0700619 default:
620 // Ignore all other error codes.
621 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700622 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800623
624 TerminateUpdateAndNotify(code);
625}
626
627void UpdateAttempterAndroid::ProcessingStopped(
628 const ActionProcessor* processor) {
629 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
630}
631
632void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
633 AbstractAction* action,
634 ErrorCode code) {
635 // Reset download progress regardless of whether or not the download
636 // action succeeded.
637 const string type = action->Type();
Yifan Hong40bb0d02020-02-24 17:33:14 -0800638 if (type == CleanupPreviousUpdateAction::StaticType() ||
639 (type == NoOpAction::StaticType() &&
640 status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE)) {
641 cleanup_previous_update_code_ = code;
642 NotifyCleanupPreviousUpdateCallbacksAndClear();
643 }
Kelvin Zhang70eef232020-06-12 20:32:40 +0000644 // download_progress_ is actually used by other actions, such as
645 // filesystem_verify_action. Therefore we always clear it.
646 download_progress_ = 0;
Sen Jiangfe522822017-10-31 15:14:11 -0700647 if (type == PostinstallRunnerAction::StaticType()) {
648 bool succeeded =
649 code == ErrorCode::kSuccess || code == ErrorCode::kUpdatedButNotActive;
650 prefs_->SetBoolean(kPrefsPostInstallSucceeded, succeeded);
651 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800652 if (code != ErrorCode::kSuccess) {
653 // If an action failed, the ActionProcessor will cancel the whole thing.
654 return;
655 }
Yifan Hong83517502020-02-19 15:34:13 -0800656 if (type == UpdateBootFlagsAction::StaticType()) {
657 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
658 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800659 if (type == DownloadAction::StaticType()) {
Kelvin Zhangd2da7b12020-07-07 17:19:21 -0400660 auto download_action = static_cast<DownloadAction*>(action);
661 install_plan_ = *download_action->install_plan();
Kelvin Zhang70eef232020-06-12 20:32:40 +0000662 SetStatusAndNotify(UpdateStatus::VERIFYING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700663 } else if (type == FilesystemVerifierAction::StaticType()) {
Kelvin Zhang70eef232020-06-12 20:32:40 +0000664 SetStatusAndNotify(UpdateStatus::FINALIZING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700665 prefs_->SetBoolean(kPrefsVerityWritten, true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800666 }
667}
668
669void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
670 uint64_t bytes_received,
671 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700672 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800673 if (total)
674 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700675 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800676 download_progress_ = progress;
677 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700678 } else {
679 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800680 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700681
682 // Update the bytes downloaded in prefs.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800683 metric_bytes_downloaded_ += bytes_progressed;
684 metric_total_bytes_downloaded_ += bytes_progressed;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800685}
686
687bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
688 // TODO(deymo): Notify the DownloadAction that it should cancel the update
689 // download.
690 return false;
691}
692
693void UpdateAttempterAndroid::DownloadComplete() {
694 // Nothing needs to be done when the download completes.
695}
696
Alex Deymo0d298542016-03-30 18:31:49 -0700697void UpdateAttempterAndroid::ProgressUpdate(double progress) {
698 // Self throttle based on progress. Also send notifications if progress is
699 // too slow.
700 if (progress == 1.0 ||
701 progress - download_progress_ >= kBroadcastThresholdProgress ||
702 TimeTicks::Now() - last_notify_time_ >=
703 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
704 download_progress_ = progress;
705 SetStatusAndNotify(status_);
706 }
707}
708
Kelvin Zhang70eef232020-06-12 20:32:40 +0000709void UpdateAttempterAndroid::OnVerifyProgressUpdate(double progress) {
710 assert(status_ == UpdateStatus::VERIFYING);
711 ProgressUpdate(progress);
712}
713
Alex Deymo5e3ea272016-01-28 13:42:23 -0800714void UpdateAttempterAndroid::ScheduleProcessingStart() {
715 LOG(INFO) << "Scheduling an action processor start.";
Kelvin Zhang20982a52021-08-13 12:31:16 -0700716 processor_->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800717 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700718 FROM_HERE,
719 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
720 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800721}
722
723void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
724 if (status_ == UpdateStatus::IDLE) {
725 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
726 return;
727 }
728
Yifan Hong90965502020-02-19 15:22:47 -0800729 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400730 ClearUpdateCompletedMarker();
Yifan Hong90965502020-02-19 15:22:47 -0800731 LOG(INFO) << "Terminating cleanup previous update.";
732 SetStatusAndNotify(UpdateStatus::IDLE);
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700733 for (auto observer : daemon_state_->service_observers())
734 observer->SendPayloadApplicationComplete(error_code);
Yifan Hong90965502020-02-19 15:22:47 -0800735 return;
736 }
737
Yifan Hong9194ce82019-11-07 11:03:42 -0800738 boot_control_->GetDynamicPartitionControl()->Cleanup();
Yifan Hong537802d2018-08-15 13:15:42 -0700739
Alex Deymo0d298542016-03-30 18:31:49 -0700740 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800741 UpdateStatus new_status =
742 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
743 : UpdateStatus::IDLE);
744 SetStatusAndNotify(new_status);
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900745 payload_fd_.reset();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800746
Sen Jiangb19c3ec2017-10-06 15:18:46 -0700747 // The network id is only applicable to one download attempt and once it's
748 // done the network id should not be re-used anymore.
749 if (!network_selector_->SetProcessNetwork(kDefaultNetworkId)) {
750 LOG(WARNING) << "Unable to unbind network.";
751 }
752
Alex Deymo5e3ea272016-01-28 13:42:23 -0800753 for (auto observer : daemon_state_->service_observers())
754 observer->SendPayloadApplicationComplete(error_code);
Tianjie Xu1b661142017-09-28 14:03:42 -0700755
Tianjie Xu90aaa102017-10-10 17:39:03 -0700756 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
757 ClearMetricsPrefs();
758 if (error_code == ErrorCode::kSuccess) {
xunchang9cf52622019-01-25 11:04:58 -0800759 // We should only reset the PayloadAttemptNumber if the update succeeds, or
760 // we switch to a different payload.
761 prefs_->Delete(kPrefsPayloadAttemptNumber);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700762 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700763 // Clear the total bytes downloaded if and only if the update succeeds.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800764 metric_total_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700765 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800766}
767
768void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
769 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700770 size_t payload_size =
771 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700772 UpdateEngineStatus status_to_send = {.status = status_,
773 .progress = download_progress_,
774 .new_size_bytes = payload_size};
775
Alex Deymo5e3ea272016-01-28 13:42:23 -0800776 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700777 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800778 }
779 last_notify_time_ = TimeTicks::Now();
780}
781
Amin Hassani667cf7b2018-07-25 14:32:00 -0700782void UpdateAttempterAndroid::BuildUpdateActions(HttpFetcher* fetcher) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800783 CHECK(!processor_->IsRunning());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800784
785 // Actions:
Amin Hassani667cf7b2018-07-25 14:32:00 -0700786 auto update_boot_flags_action =
787 std::make_unique<UpdateBootFlagsAction>(boot_control_);
Yifan Hong83517502020-02-19 15:34:13 -0800788 auto cleanup_previous_update_action =
789 boot_control_->GetDynamicPartitionControl()
790 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
Amin Hassani667cf7b2018-07-25 14:32:00 -0700791 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
792 auto download_action =
793 std::make_unique<DownloadAction>(prefs_,
794 boot_control_,
795 hardware_,
Amin Hassani667cf7b2018-07-25 14:32:00 -0700796 fetcher, // passes ownership
Kelvin Zhang1304fe72021-10-06 19:12:12 -0700797 true /* interactive */,
798 update_certificates_path_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800799 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700800 download_action->set_base_offset(base_offset_);
Tianjie24f96092020-06-30 12:26:25 -0700801 auto filesystem_verifier_action = std::make_unique<FilesystemVerifierAction>(
802 boot_control_->GetDynamicPartitionControl());
Amin Hassani667cf7b2018-07-25 14:32:00 -0700803 auto postinstall_runner_action =
804 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang70eef232020-06-12 20:32:40 +0000805 filesystem_verifier_action->set_delegate(this);
Alex Deymob6eef732016-06-10 12:58:11 -0700806 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800807
Alex Deymo5e3ea272016-01-28 13:42:23 -0800808 // Bond them together. We have to use the leaf-types when calling
809 // BondActions().
810 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700811 BondActions(download_action.get(), filesystem_verifier_action.get());
812 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800813 postinstall_runner_action.get());
814
Amin Hassani667cf7b2018-07-25 14:32:00 -0700815 processor_->EnqueueAction(std::move(update_boot_flags_action));
Yifan Hong83517502020-02-19 15:34:13 -0800816 processor_->EnqueueAction(std::move(cleanup_previous_update_action));
Amin Hassani667cf7b2018-07-25 14:32:00 -0700817 processor_->EnqueueAction(std::move(install_plan_action));
818 processor_->EnqueueAction(std::move(download_action));
819 processor_->EnqueueAction(std::move(filesystem_verifier_action));
820 processor_->EnqueueAction(std::move(postinstall_runner_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800821}
822
Alex Deymo5e3ea272016-01-28 13:42:23 -0800823bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
824 string boot_id;
825 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800826 LOG(INFO) << "Writing update complete marker, slot "
827 << boot_control_->GetCurrentSlot() << ", boot id: " << boot_id;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400828 TEST_AND_RETURN_FALSE(
829 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id));
830 TEST_AND_RETURN_FALSE(
831 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot()));
832 return true;
833}
834
835bool UpdateAttempterAndroid::ClearUpdateCompletedMarker() {
836 LOG(INFO) << "Clearing update complete marker.";
837 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsUpdateCompletedOnBootId));
838 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsPreviousSlot));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800839 return true;
840}
841
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800842bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() const {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800843 // In case of an update_engine restart without a reboot, we stored the boot_id
844 // when the update was completed by setting a pref, so we can check whether
845 // the last update was on this boot or a previous one.
846 string boot_id;
847 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
848
849 string update_completed_on_boot_id;
850 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
851 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
852 &update_completed_on_boot_id) &&
853 update_completed_on_boot_id == boot_id);
854}
855
Tianjie Xu90aaa102017-10-10 17:39:03 -0700856// Collect and report the android metrics when we terminate the update.
857void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
858 ErrorCode error_code) {
859 int64_t attempt_number =
860 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
861 PayloadType payload_type = kPayloadTypeFull;
862 int64_t payload_size = 0;
863 for (const auto& p : install_plan_.payloads) {
864 if (p.type == InstallPayloadType::kDelta)
865 payload_type = kPayloadTypeDelta;
866 payload_size += p.size;
867 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700868 // In some cases, e.g. after calling |setShouldSwitchSlotOnReboot()|, this
869 // function will be triggered, but payload_size in this case might be 0, if so
870 // skip reporting any metrics.
871 if (payload_size == 0) {
872 return;
873 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700874
875 metrics::AttemptResult attempt_result =
876 metrics_utils::GetAttemptResult(error_code);
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700877 Time boot_time_start = Time::FromInternalValue(
878 metrics_utils::GetPersistedValue(kPrefsUpdateBootTimestampStart, prefs_));
879 Time monotonic_time_start = Time::FromInternalValue(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700880 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700881 TimeDelta duration = clock_->GetBootTime() - boot_time_start;
882 TimeDelta duration_uptime = clock_->GetMonotonicTime() - monotonic_time_start;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700883
884 metrics_reporter_->ReportUpdateAttemptMetrics(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700885 static_cast<int>(attempt_number),
886 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700887 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700888 duration_uptime,
889 payload_size,
890 attempt_result,
891 error_code);
892
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800893 int64_t current_bytes_downloaded = metric_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -0700894 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
895 current_bytes_downloaded,
896 0,
897 DownloadSource::kNumDownloadSources,
898 metrics::DownloadErrorCode::kUnset,
899 metrics::ConnectionType::kUnset);
900
Tianjie Xu90aaa102017-10-10 17:39:03 -0700901 if (error_code == ErrorCode::kSuccess) {
902 int64_t reboot_count =
903 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
904 string build_version;
905 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -0700906
907 // For android metrics, we only care about the total bytes downloaded
908 // for all sources; for now we assume the only download source is
909 // HttpsServer.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800910 int64_t total_bytes_downloaded = metric_total_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -0700911 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
912 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
913 total_bytes_downloaded;
914
915 int download_overhead_percentage = 0;
Tianjie Xu21030c12019-08-14 13:00:23 -0700916 if (total_bytes_downloaded >= payload_size) {
917 CHECK_GT(payload_size, 0);
Tianjie Xud4777a12017-10-24 14:54:18 -0700918 download_overhead_percentage =
Tianjie Xu21030c12019-08-14 13:00:23 -0700919 (total_bytes_downloaded - payload_size) * 100ull / payload_size;
920 } else {
921 LOG(WARNING) << "Downloaded bytes " << total_bytes_downloaded
922 << " is smaller than the payload size " << payload_size;
Tianjie Xud4777a12017-10-24 14:54:18 -0700923 }
Tianjie Xu21030c12019-08-14 13:00:23 -0700924
Tianjie Xu90aaa102017-10-10 17:39:03 -0700925 metrics_reporter_->ReportSuccessfulUpdateMetrics(
926 static_cast<int>(attempt_number),
927 0, // update abandoned count
928 payload_type,
929 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -0700930 num_bytes_downloaded,
931 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700932 duration,
Sen Jiang8712e962018-05-08 12:12:28 -0700933 duration_uptime,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700934 static_cast<int>(reboot_count),
935 0); // url_switch_count
936 }
937}
938
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400939bool UpdateAttempterAndroid::OTARebootSucceeded() const {
940 const auto current_slot = boot_control_->GetCurrentSlot();
941 const string current_version =
942 android::base::GetProperty("ro.build.version.incremental", "");
943 int64_t previous_slot = -1;
944 TEST_AND_RETURN_FALSE(prefs_->GetInt64(kPrefsPreviousSlot, &previous_slot));
945 string previous_version;
946 TEST_AND_RETURN_FALSE(
947 prefs_->GetString(kPrefsPreviousVersion, &previous_version));
948 if (previous_slot != current_slot) {
949 LOG(INFO) << "Detected a slot switch, OTA succeeded, device updated from "
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800950 << previous_version << " to " << current_version
951 << ", previous slot: " << previous_slot
952 << " current slot: " << current_slot;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400953 if (previous_version == current_version) {
954 LOG(INFO) << "Previous version is the same as current version, this is "
955 "possibly a self-OTA.";
956 }
957 return true;
958 } else {
959 LOG(INFO) << "Slot didn't switch, either the OTA is rolled back, or slot "
960 "switch never happened, or system not rebooted at all.";
961 if (previous_version != current_version) {
962 LOG(INFO) << "Slot didn't change, but version changed from "
963 << previous_version << " to " << current_version
964 << " device could be flashed.";
965 }
966 return false;
967 }
968}
969
970OTAResult UpdateAttempterAndroid::GetOTAUpdateResult() const {
971 // We only set |kPrefsSystemUpdatedMarker| if slot is actually switched, so
972 // existence of this pref is sufficient indicator. Given that we have to
973 // delete this pref after checking it. This is done in
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800974 // |DeltaPerformer::ResetUpdateProgress| and
975 // |UpdateAttempterAndroid::UpdateStateAfterReboot|
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400976 auto slot_switch_attempted = prefs_->Exists(kPrefsUpdateCompletedOnBootId);
977 auto system_rebooted = DidSystemReboot(prefs_);
978 auto ota_successful = OTARebootSucceeded();
979 if (ota_successful) {
980 return OTAResult::OTA_SUCCESSFUL;
981 }
982 if (slot_switch_attempted) {
983 if (system_rebooted) {
984 // If we attempted slot switch, but still end up on the same slot, we
985 // probably rolled back.
986 return OTAResult::ROLLED_BACK;
987 } else {
988 return OTAResult::UPDATED_NEED_REBOOT;
989 }
990 }
991 return OTAResult::NOT_ATTEMPTED;
992}
993
994void UpdateAttempterAndroid::UpdateStateAfterReboot(const OTAResult result) {
Tianjie Xu90aaa102017-10-10 17:39:03 -0700995 // Example: [ro.build.version.incremental]: [4292972]
996 string current_version =
997 android::base::GetProperty("ro.build.version.incremental", "");
998 TEST_AND_RETURN(!current_version.empty());
999
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001000 // |UpdateStateAfterReboot()| is only called after system reboot, so record
1001 // boot id unconditionally
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001002 string current_boot_id;
1003 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
1004 prefs_->SetString(kPrefsBootId, current_boot_id);
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001005 std::string slot_switch_indicator;
1006 prefs_->GetString(kPrefsUpdateCompletedOnBootId, &slot_switch_indicator);
1007 if (slot_switch_indicator != current_boot_id) {
1008 ClearUpdateCompletedMarker();
1009 }
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001010
Tianjie Xu90aaa102017-10-10 17:39:03 -07001011 // If there's no record of previous version (e.g. due to a data wipe), we
1012 // save the info of current boot and skip the metrics report.
1013 if (!prefs_->Exists(kPrefsPreviousVersion)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001014 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001015 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001016 ClearMetricsPrefs();
1017 return;
1018 }
Kelvin Zhang86603472021-05-11 12:16:27 -04001019 // update_engine restarted under the same build and same slot.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001020 if (result != OTAResult::OTA_SUCCESSFUL) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001021 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
1022 // set when we start a new update.
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001023 if (prefs_->Exists(kPrefsNumReboots)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001024 int64_t reboot_count =
1025 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1026 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
1027 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001028
1029 if (result == OTAResult::ROLLED_BACK) {
1030 // This will release all space previously allocated for apex
1031 // decompression. If we detect a rollback, we should release space and
1032 // return the space to user. Any subsequent attempt to install OTA will
1033 // allocate space again anyway.
1034 LOG(INFO) << "Detected a rollback, releasing space allocated for apex "
1035 "deompression.";
1036 apex_handler_android_->AllocateSpace({});
1037 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1038 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001039 return;
1040 }
1041
1042 // Now that the build version changes, report the update metrics.
1043 // TODO(xunchang) check the build version is larger than the previous one.
Tianjie Xu90aaa102017-10-10 17:39:03 -07001044 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001045 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001046
1047 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
1048 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
1049 if (previous_attempt_exists) {
1050 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
1051 }
1052
1053 metrics_utils::LoadAndReportTimeToReboot(
1054 metrics_reporter_.get(), prefs_, clock_.get());
1055 ClearMetricsPrefs();
Sen Jiang1bafff82019-01-02 15:54:40 -08001056
1057 // Also reset the update progress if the build version has changed.
1058 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
1059 LOG(WARNING) << "Unable to reset the update progress.";
1060 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001061}
1062
1063// Save the update start time. Reset the reboot count and attempt number if the
1064// update isn't a resume; otherwise increment the attempt number.
1065void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
1066 if (!is_resume) {
1067 metrics_utils::SetNumReboots(0, prefs_);
1068 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
1069 } else {
1070 int64_t attempt_number =
1071 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
1072 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
1073 }
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001074 metrics_utils::SetUpdateTimestampStart(clock_->GetMonotonicTime(), prefs_);
1075 metrics_utils::SetUpdateBootTimestampStart(clock_->GetBootTime(), prefs_);
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001076 ClearUpdateCompletedMarker();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001077}
1078
1079void UpdateAttempterAndroid::ClearMetricsPrefs() {
1080 CHECK(prefs_);
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001081 metric_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001082 prefs_->Delete(kPrefsNumReboots);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001083 prefs_->Delete(kPrefsSystemUpdatedMarker);
1084 prefs_->Delete(kPrefsUpdateTimestampStart);
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001085 prefs_->Delete(kPrefsUpdateBootTimestampStart);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001086}
1087
Yifan Hongbd47d622019-12-13 14:59:58 -08001088BootControlInterface::Slot UpdateAttempterAndroid::GetCurrentSlot() const {
1089 return boot_control_->GetCurrentSlot();
1090}
1091
1092BootControlInterface::Slot UpdateAttempterAndroid::GetTargetSlot() const {
1093 return GetCurrentSlot() == 0 ? 1 : 0;
1094}
1095
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001096uint64_t UpdateAttempterAndroid::AllocateSpaceForPayload(
1097 const std::string& metadata_filename,
1098 const vector<string>& key_value_pair_headers,
1099 brillo::ErrorPtr* error) {
Yifan Hong65613032020-01-09 17:52:13 -08001100 DeltaArchiveManifest manifest;
1101 if (!VerifyPayloadParseManifest(metadata_filename, &manifest, error)) {
1102 return 0;
1103 }
1104 std::map<string, string> headers;
1105 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
1106 return 0;
1107 }
1108
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001109 std::vector<ApexInfo> apex_infos(manifest.apex_info().begin(),
1110 manifest.apex_info().end());
1111 uint64_t apex_size_required = 0;
1112 if (apex_handler_android_ != nullptr) {
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001113 auto result = apex_handler_android_->CalculateSize(apex_infos);
1114 if (!result.ok()) {
1115 LogAndSetError(error,
1116 FROM_HERE,
1117 "Failed to calculate size required for compressed APEX");
1118 return 0;
1119 }
1120 apex_size_required = *result;
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001121 }
1122
Yifan Hong65613032020-01-09 17:52:13 -08001123 string payload_id = GetPayloadId(headers);
1124 uint64_t required_size = 0;
1125 if (!DeltaPerformer::PreparePartitionsForUpdate(prefs_,
1126 boot_control_,
1127 GetTargetSlot(),
1128 manifest,
1129 payload_id,
1130 &required_size)) {
1131 if (required_size == 0) {
1132 LogAndSetError(error, FROM_HERE, "Failed to allocate space for payload.");
1133 return 0;
1134 } else {
1135 LOG(ERROR) << "Insufficient space for payload: " << required_size
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001136 << " bytes, apex decompression: " << apex_size_required
Yifan Hong65613032020-01-09 17:52:13 -08001137 << " bytes";
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001138 return required_size + apex_size_required;
Yifan Hong65613032020-01-09 17:52:13 -08001139 }
1140 }
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001141
1142 if (apex_size_required > 0 && apex_handler_android_ != nullptr &&
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001143 !apex_handler_android_->AllocateSpace(apex_infos)) {
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001144 LOG(ERROR) << "Insufficient space for apex decompression: "
1145 << apex_size_required << " bytes";
1146 return apex_size_required;
Kelvin Zhang8933d572021-01-28 10:17:34 -05001147 }
Yifan Hong65613032020-01-09 17:52:13 -08001148
1149 LOG(INFO) << "Successfully allocated space for payload.";
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001150 return 0;
1151}
1152
Yifan Hong40bb0d02020-02-24 17:33:14 -08001153void UpdateAttempterAndroid::CleanupSuccessfulUpdate(
1154 std::unique_ptr<CleanupSuccessfulUpdateCallbackInterface> callback,
Yifan Hong2236ea02019-12-13 16:11:22 -08001155 brillo::ErrorPtr* error) {
Yifan Hong40bb0d02020-02-24 17:33:14 -08001156 if (cleanup_previous_update_code_.has_value()) {
1157 LOG(INFO) << "CleanupSuccessfulUpdate has previously completed with "
1158 << utils::ErrorCodeToString(*cleanup_previous_update_code_);
1159 if (callback) {
1160 callback->OnCleanupComplete(
1161 static_cast<int32_t>(*cleanup_previous_update_code_));
1162 }
1163 return;
Yifan Hong4f611562020-01-15 23:41:33 -08001164 }
Yifan Hong40bb0d02020-02-24 17:33:14 -08001165 if (callback) {
1166 auto callback_ptr = callback.get();
1167 cleanup_previous_update_callbacks_.emplace_back(std::move(callback));
1168 callback_ptr->RegisterForDeathNotifications(
1169 base::Bind(&UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback,
1170 base::Unretained(this),
1171 base::Unretained(callback_ptr)));
1172 }
1173 ScheduleCleanupPreviousUpdate();
Yifan Hong2236ea02019-12-13 16:11:22 -08001174}
1175
Tianjie7f8f2ab2021-07-23 17:08:50 -07001176bool UpdateAttempterAndroid::setShouldSwitchSlotOnReboot(
1177 const std::string& metadata_filename, brillo::ErrorPtr* error) {
Kelvin Zhang20982a52021-08-13 12:31:16 -07001178 LOG(INFO) << "setShouldSwitchSlotOnReboot(" << metadata_filename << ")";
Tianjie7f8f2ab2021-07-23 17:08:50 -07001179 if (processor_->IsRunning()) {
1180 return LogAndSetError(
1181 error, FROM_HERE, "Already processing an update, cancel it first.");
1182 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001183 DeltaArchiveManifest manifest;
1184 TEST_AND_RETURN_FALSE(
1185 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
1186
Kelvin Zhang20982a52021-08-13 12:31:16 -07001187 InstallPlan install_plan_;
1188 install_plan_.source_slot = GetCurrentSlot();
1189 install_plan_.target_slot = GetTargetSlot();
1190 // Don't do verity computation, just hash the partitions
1191 install_plan_.write_verity = false;
1192 // Don't run postinstall, we just need PostinstallAction to switch the slots.
1193 install_plan_.run_post_install = false;
1194 install_plan_.is_resume = true;
1195
1196 CHECK_NE(install_plan_.source_slot, UINT32_MAX);
1197 CHECK_NE(install_plan_.target_slot, UINT32_MAX);
1198
Kelvin Zhang20982a52021-08-13 12:31:16 -07001199 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001200 auto postinstall_runner_action =
1201 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
1202 SetStatusAndNotify(UpdateStatus::VERIFYING);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001203 postinstall_runner_action->set_delegate(this);
1204
Kelvin Zhangf8441982022-12-07 18:18:47 -08001205 // If last error code is kUpdatedButNotActive, we know that we reached this
1206 // state by calling applyPayload() with switch_slot=false. That applyPayload()
1207 // call would have already performed filesystem verification, therefore, we
1208 // can safely skip the verification to save time.
1209 if (last_error_ == ErrorCode::kUpdatedButNotActive) {
1210 BondActions(install_plan_action.get(), postinstall_runner_action.get());
1211 processor_->EnqueueAction(std::move(install_plan_action));
1212 } else {
Kelvin Zhang263a5402022-12-08 23:03:32 -08001213 if (!boot_control_->GetDynamicPartitionControl()
1214 ->PreparePartitionsForUpdate(GetCurrentSlot(),
1215 GetTargetSlot(),
1216 manifest,
1217 false /* should update */,
1218 nullptr)) {
1219 return LogAndSetError(
1220 error, FROM_HERE, "Failed to PreparePartitionsForUpdate");
1221 }
1222 ErrorCode error_code{};
1223 if (!install_plan_.ParsePartitions(manifest.partitions(),
1224 boot_control_,
1225 manifest.block_size(),
1226 &error_code)) {
1227 return LogAndSetError(error,
1228 FROM_HERE,
1229 "Failed to LoadPartitionsFromSlots " +
1230 utils::ErrorCodeToString(error_code));
1231 }
1232
Kelvin Zhangf8441982022-12-07 18:18:47 -08001233 auto filesystem_verifier_action =
1234 std::make_unique<FilesystemVerifierAction>(
1235 boot_control_->GetDynamicPartitionControl());
1236 filesystem_verifier_action->set_delegate(this);
1237 BondActions(install_plan_action.get(), filesystem_verifier_action.get());
1238 BondActions(filesystem_verifier_action.get(),
1239 postinstall_runner_action.get());
1240 processor_->EnqueueAction(std::move(install_plan_action));
1241 processor_->EnqueueAction(std::move(filesystem_verifier_action));
1242 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001243
Kelvin Zhang20982a52021-08-13 12:31:16 -07001244 processor_->EnqueueAction(std::move(postinstall_runner_action));
1245 ScheduleProcessingStart();
1246 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001247}
1248
1249bool UpdateAttempterAndroid::resetShouldSwitchSlotOnReboot(
1250 brillo::ErrorPtr* error) {
1251 if (processor_->IsRunning()) {
1252 return LogAndSetError(
1253 error, FROM_HERE, "Already processing an update, cancel it first.");
1254 }
Daniel Zhenge76cf562022-11-08 17:32:10 +00001255 TEST_AND_RETURN_FALSE(ClearUpdateCompletedMarker());
Kelvin Zhang20982a52021-08-13 12:31:16 -07001256 // Update the boot flags so the current slot has higher priority.
1257 if (!boot_control_->SetActiveBootSlot(GetCurrentSlot())) {
1258 return LogAndSetError(error, FROM_HERE, "Failed to SetActiveBootSlot");
1259 }
1260
1261 // Mark the current slot as successful again, since marking it as active
1262 // may reset the successful bit. We ignore the result of whether marking
1263 // the current slot as successful worked.
1264 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful) {}))) {
1265 return LogAndSetError(
1266 error, FROM_HERE, "Failed to MarkBootSuccessfulAsync");
1267 }
1268
1269 // Resets the warm reset property since we won't switch the slot.
1270 hardware_->SetWarmReset(false);
1271
1272 // Resets the vbmeta digest.
1273 hardware_->SetVbmetaDigestForInactiveSlot(true /* reset */);
1274 LOG(INFO) << "Slot switch cancelled.";
1275 SetStatusAndNotify(UpdateStatus::IDLE);
1276 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001277}
1278
Yifan Hong90965502020-02-19 15:22:47 -08001279void UpdateAttempterAndroid::ScheduleCleanupPreviousUpdate() {
1280 // If a previous CleanupSuccessfulUpdate call has not finished, or an update
1281 // is in progress, skip enqueueing the action.
1282 if (processor_->IsRunning()) {
1283 LOG(INFO) << "Already processing an update. CleanupPreviousUpdate should "
1284 << "be done when the current update finishes.";
1285 return;
1286 }
1287 LOG(INFO) << "Scheduling CleanupPreviousUpdateAction.";
1288 auto action =
1289 boot_control_->GetDynamicPartitionControl()
1290 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
1291 processor_->EnqueueAction(std::move(action));
1292 processor_->set_delegate(this);
1293 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
1294 processor_->StartProcessing();
1295}
1296
Yifan Hong40bb0d02020-02-24 17:33:14 -08001297void UpdateAttempterAndroid::OnCleanupProgressUpdate(double progress) {
1298 for (auto&& callback : cleanup_previous_update_callbacks_) {
1299 callback->OnCleanupProgressUpdate(progress);
1300 }
1301}
1302
1303void UpdateAttempterAndroid::NotifyCleanupPreviousUpdateCallbacksAndClear() {
1304 CHECK(cleanup_previous_update_code_.has_value());
1305 for (auto&& callback : cleanup_previous_update_callbacks_) {
1306 callback->OnCleanupComplete(
1307 static_cast<int32_t>(*cleanup_previous_update_code_));
1308 }
1309 cleanup_previous_update_callbacks_.clear();
1310}
1311
1312void UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback(
1313 CleanupSuccessfulUpdateCallbackInterface* callback) {
1314 auto end_it =
1315 std::remove_if(cleanup_previous_update_callbacks_.begin(),
1316 cleanup_previous_update_callbacks_.end(),
1317 [&](const auto& e) { return e.get() == callback; });
1318 cleanup_previous_update_callbacks_.erase(
1319 end_it, cleanup_previous_update_callbacks_.end());
1320}
Yifan Hong90965502020-02-19 15:22:47 -08001321
Daniel Zheng9fc62b82023-03-24 22:57:20 +00001322bool UpdateAttempterAndroid::IsProductionBuild() {
1323 if (android::base::GetProperty("ro.build.type", "") != "userdebug" ||
1324 android::base::GetProperty("ro.build.tags", "") == "release-keys" ||
1325 android::base::GetProperty("ro.boot.verifiedbootstate", "") == "green") {
1326 return true;
1327 }
1328 return false;
1329}
1330
Alex Deymo5e3ea272016-01-28 13:42:23 -08001331} // namespace chromeos_update_engine