blob: 1adaabc3c249e8f302aeb8c44125ba4920f7ad42 [file] [log] [blame]
Alex Deymo5e3ea272016-01-28 13:42:23 -08001//
2// Copyright (C) 2016 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
16
Amin Hassaniec7bc112020-10-29 16:47:58 -070017#include "update_engine/aosp/update_attempter_android.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080018
19#include <algorithm>
Alex Deymo218397f2016-02-04 23:55:10 -080020#include <map>
Tianjie Xu90aaa102017-10-10 17:39:03 -070021#include <memory>
Kelvin Zhanga43d6e82021-05-26 10:14:42 -040022#include <ostream>
Alex Deymo5e3ea272016-01-28 13:42:23 -080023#include <utility>
Daniel Zhengda4f7292022-09-02 22:59:32 +000024#include <vector>
Alex Deymo5e3ea272016-01-28 13:42:23 -080025
Kelvin Zhang944cdac2023-12-12 12:55:27 -080026#include <android-base/parsebool.h>
Tianjie Xu90aaa102017-10-10 17:39:03 -070027#include <android-base/properties.h>
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090028#include <android-base/unique_fd.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080029#include <base/bind.h>
30#include <base/logging.h>
Alex Deymo218397f2016-02-04 23:55:10 -080031#include <base/strings/string_number_conversions.h>
Sen Jiang2703ef42017-03-16 13:36:21 -070032#include <brillo/data_encoding.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080033#include <brillo/message_loops/message_loop.h>
Alex Deymo218397f2016-02-04 23:55:10 -080034#include <brillo/strings/string_utils.h>
Sen Jiangacbdd1c2017-10-19 13:30:19 -070035#include <log/log_safetynet.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080036
Amin Hassaniec7bc112020-10-29 16:47:58 -070037#include "update_engine/aosp/cleanup_previous_update_action.h"
Daniel Zhengda4f7292022-09-02 22:59:32 +000038#include "update_engine/common/clock.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080039#include "update_engine/common/constants.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070040#include "update_engine/common/daemon_state_interface.h"
41#include "update_engine/common/download_action.h"
Kelvin Zhangf8441982022-12-07 18:18:47 -080042#include "update_engine/common/error_code.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080043#include "update_engine/common/error_code_utils.h"
Alex Deymo2c131bb2016-05-26 16:43:13 -070044#include "update_engine/common/file_fetcher.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070045#include "update_engine/common/metrics_reporter_interface.h"
46#include "update_engine/common/network_selector.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080047#include "update_engine/common/utils.h"
Tianjie Xu1b661142017-09-28 14:03:42 -070048#include "update_engine/metrics_utils.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080049#include "update_engine/payload_consumer/delta_performer.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080050#include "update_engine/payload_consumer/file_descriptor.h"
51#include "update_engine/payload_consumer/file_descriptor_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080052#include "update_engine/payload_consumer/filesystem_verifier_action.h"
Kelvin Zhangcfc531f2022-08-24 17:58:53 +000053#include "update_engine/payload_consumer/partition_writer.h"
Sen Jiang8371c1c2018-02-01 13:46:39 -080054#include "update_engine/payload_consumer/payload_constants.h"
55#include "update_engine/payload_consumer/payload_metadata.h"
Tianjie Xu7a78d632019-10-08 16:32:39 -070056#include "update_engine/payload_consumer/payload_verifier.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080057#include "update_engine/payload_consumer/postinstall_runner_action.h"
Amin Hassani667cf7b2018-07-25 14:32:00 -070058#include "update_engine/update_boot_flags_action.h"
Kelvin Zhangf92fe252023-03-28 10:55:47 -070059#include "update_engine/update_status.h"
Alex Deymo3b678db2016-02-09 11:50:06 -080060#include "update_engine/update_status_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080061
Alex Deymo14c0da82016-07-20 16:45:45 -070062#ifndef _UE_SIDELOAD
63// Do not include support for external HTTP(s) urls when building
64// update_engine_sideload.
65#include "update_engine/libcurl_http_fetcher.h"
66#endif
67
Kyeongkab.Nam500ca132019-06-26 13:48:07 +090068using android::base::unique_fd;
Alex Deymo5e3ea272016-01-28 13:42:23 -080069using base::Bind;
Tianjie Xu90aaa102017-10-10 17:39:03 -070070using base::Time;
Alex Deymo5e3ea272016-01-28 13:42:23 -080071using base::TimeDelta;
72using base::TimeTicks;
Alex Deymo5e3ea272016-01-28 13:42:23 -080073using std::string;
74using std::vector;
Aaron Wood7f92e2b2017-08-28 14:51:21 -070075using update_engine::UpdateEngineStatus;
Alex Deymo5e3ea272016-01-28 13:42:23 -080076
77namespace chromeos_update_engine {
78
79namespace {
80
Alex Deymo0d298542016-03-30 18:31:49 -070081// Minimum threshold to broadcast an status update in progress and time.
82const double kBroadcastThresholdProgress = 0.01; // 1%
83const int kBroadcastThresholdSeconds = 10;
84
Daniel Zheng92f7d172023-06-22 14:31:37 -070085// Log and set the error on the passed ErrorPtr.
86bool LogAndSetGenericError(Error* error,
87 int line_number,
88 const char* file_name,
89 const string& reason) {
90 LOG(ERROR) << "Replying with failure: " << file_name << " " << line_number
91 << ": " << reason;
92 error->line_number = line_number;
93 error->file_name = file_name;
94 error->message = reason;
95 error->error_code = ErrorCode::kError;
96 return false;
97}
Alex Deymo5e3ea272016-01-28 13:42:23 -080098
99// Log and set the error on the passed ErrorPtr.
Daniel Zheng92f7d172023-06-22 14:31:37 -0700100bool LogAndSetError(Error* error,
101 int line_number,
102 const char* file_name,
103 const string& reason,
104 ErrorCode error_code) {
105 LOG(ERROR) << "Replying with failure: " << file_name << " " << line_number
106 << ": " << reason;
107 error->line_number = line_number;
108 error->file_name = file_name;
109 error->message = reason;
110 error->error_code = error_code;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800111 return false;
112}
113
Sen Jiangfe522822017-10-31 15:14:11 -0700114bool GetHeaderAsBool(const string& header, bool default_value) {
115 int value = 0;
116 if (base::StringToInt(header, &value) && (value == 0 || value == 1))
117 return value == 1;
118 return default_value;
119}
120
Yifan Hongbd47d622019-12-13 14:59:58 -0800121bool ParseKeyValuePairHeaders(const vector<string>& key_value_pair_headers,
122 std::map<string, string>* headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700123 Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800124 for (const string& key_value_pair : key_value_pair_headers) {
125 string key;
126 string value;
127 if (!brillo::string_utils::SplitAtFirst(
128 key_value_pair, "=", &key, &value, false)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700129 return LogAndSetGenericError(error,
130 __LINE__,
131 __FILE__,
132 "Passed invalid header: " + key_value_pair);
Yifan Hongbd47d622019-12-13 14:59:58 -0800133 }
134 if (!headers->emplace(key, value).second)
Daniel Zheng92f7d172023-06-22 14:31:37 -0700135 return LogAndSetGenericError(
136 error, __LINE__, __FILE__, "Passed repeated key: " + key);
Yifan Hongbd47d622019-12-13 14:59:58 -0800137 }
138 return true;
139}
140
141// Unique identifier for the payload. An empty string means that the payload
142// can't be resumed.
143string GetPayloadId(const std::map<string, string>& headers) {
144 return (headers.count(kPayloadPropertyFileHash)
145 ? headers.at(kPayloadPropertyFileHash)
146 : "") +
147 (headers.count(kPayloadPropertyMetadataHash)
148 ? headers.at(kPayloadPropertyMetadataHash)
149 : "");
150}
151
Kelvin Zhang13020502023-08-02 15:18:40 -0700152std::string GetCurrentBuildVersion() {
153 // Example: [ro.build.fingerprint]:
154 // [generic/aosp_cf_x86_64_phone/vsoc_x86_64:VanillaIceCream/AOSP.MAIN/user08011303:userdebug/test-keys]
155 return android::base::GetProperty("ro.build.fingerprint", "");
156}
157
Alex Deymo5e3ea272016-01-28 13:42:23 -0800158} // namespace
159
160UpdateAttempterAndroid::UpdateAttempterAndroid(
Alex Deymo03a4de72016-07-20 16:08:23 -0700161 DaemonStateInterface* daemon_state,
Alex Deymo5e3ea272016-01-28 13:42:23 -0800162 PrefsInterface* prefs,
163 BootControlInterface* boot_control,
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000164 HardwareInterface* hardware,
165 std::unique_ptr<ApexHandlerInterface> apex_handler)
Alex Deymo5e3ea272016-01-28 13:42:23 -0800166 : daemon_state_(daemon_state),
167 prefs_(prefs),
168 boot_control_(boot_control),
169 hardware_(hardware),
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +0000170 apex_handler_android_(std::move(apex_handler)),
Tianjie Xu1b661142017-09-28 14:03:42 -0700171 processor_(new ActionProcessor()),
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800172 clock_(new Clock()),
173 metric_bytes_downloaded_(kPrefsCurrentBytesDownloaded, prefs_),
174 metric_total_bytes_downloaded_(kPrefsTotalBytesDownloaded, prefs_) {
Yifan Hongc514f662021-02-04 11:18:43 -0800175 metrics_reporter_ = metrics::CreateMetricsReporter(
Kelvin Zhang9a5e3682021-03-29 12:58:48 -0400176 boot_control_->GetDynamicPartitionControl(), &install_plan_);
Alex Deymo87792ea2016-07-25 15:40:36 -0700177 network_selector_ = network::CreateNetworkSelector();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800178}
179
180UpdateAttempterAndroid::~UpdateAttempterAndroid() {
181 // Release ourselves as the ActionProcessor's delegate to prevent
182 // re-scheduling the updates due to the processing stopped.
183 processor_->set_delegate(nullptr);
184}
185
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400186[[nodiscard]] static bool DidSystemReboot(PrefsInterface* prefs) {
187 string boot_id;
188 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
189 string old_boot_id;
190 // If no previous boot id found, treat as a reboot and write boot ID.
191 if (!prefs->GetString(kPrefsBootId, &old_boot_id)) {
192 return true;
193 }
194 return old_boot_id != boot_id;
195}
196
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400197std::ostream& operator<<(std::ostream& out, OTAResult result) {
198 switch (result) {
199 case OTAResult::NOT_ATTEMPTED:
200 out << "OTAResult::NOT_ATTEMPTED";
201 break;
202 case OTAResult::ROLLED_BACK:
203 out << "OTAResult::ROLLED_BACK";
204 break;
205 case OTAResult::UPDATED_NEED_REBOOT:
206 out << "OTAResult::UPDATED_NEED_REBOOT";
207 break;
208 case OTAResult::OTA_SUCCESSFUL:
209 out << "OTAResult::OTA_SUCCESSFUL";
210 break;
211 }
212 return out;
213}
214
Alex Deymo5e3ea272016-01-28 13:42:23 -0800215void UpdateAttempterAndroid::Init() {
216 // In case of update_engine restart without a reboot we need to restore the
217 // reboot needed state.
Tianjie Xu90aaa102017-10-10 17:39:03 -0700218 if (UpdateCompletedOnThisBoot()) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400219 LOG(INFO) << "Updated installed but update_engine is restarted without "
220 "device reboot. Resuming old state.";
Alex Deymo0e061ae2016-02-09 17:49:03 -0800221 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700222 } else {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400223 const auto result = GetOTAUpdateResult();
224 LOG(INFO) << result;
Alex Deymo0e061ae2016-02-09 17:49:03 -0800225 SetStatusAndNotify(UpdateStatus::IDLE);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400226 if (DidSystemReboot(prefs_)) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400227 UpdateStateAfterReboot(result);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -0400228 }
229
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700230#ifdef _UE_SIDELOAD
231 LOG(INFO) << "Skip ScheduleCleanupPreviousUpdate in sideload because "
232 << "ApplyPayload will call it later.";
233#else
Yifan Hong90965502020-02-19 15:22:47 -0800234 ScheduleCleanupPreviousUpdate();
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700235#endif
Tianjie Xu90aaa102017-10-10 17:39:03 -0700236 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800237}
238
239bool UpdateAttempterAndroid::ApplyPayload(
240 const string& payload_url,
241 int64_t payload_offset,
242 int64_t payload_size,
243 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700244 Error* error) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800245 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Kelvin Zhangbe0a3492023-12-04 09:18:15 -0800246 return LogAndSetError(error,
247 __LINE__,
248 __FILE__,
249 "An update already applied, waiting for reboot",
250 ErrorCode::kUpdateAlreadyInstalled);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800251 }
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700252 if (processor_->IsRunning()) {
Kelvin Zhangbe0a3492023-12-04 09:18:15 -0800253 return LogAndSetError(error,
254 __LINE__,
255 __FILE__,
256 "Already processing an update, cancel it first.",
257 ErrorCode::kUpdateProcessing);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800258 }
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100259 DCHECK_EQ(status_, UpdateStatus::IDLE);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800260
Alex Deymo218397f2016-02-04 23:55:10 -0800261 std::map<string, string> headers;
Yifan Hongbd47d622019-12-13 14:59:58 -0800262 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
263 return false;
Alex Deymo218397f2016-02-04 23:55:10 -0800264 }
265
Yifan Hongbd47d622019-12-13 14:59:58 -0800266 string payload_id = GetPayloadId(headers);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800267
268 // Setup the InstallPlan based on the request.
269 install_plan_ = InstallPlan();
270
271 install_plan_.download_url = payload_url;
272 install_plan_.version = "";
Alex Deymo0fd51ff2016-02-03 14:22:43 -0800273 base_offset_ = payload_offset;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800274 InstallPlan::Payload payload;
275 payload.size = payload_size;
276 if (!payload.size) {
Alex Deymo218397f2016-02-04 23:55:10 -0800277 if (!base::StringToUint64(headers[kPayloadPropertyFileSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800278 &payload.size)) {
279 payload.size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800280 }
281 }
Sen Jiang2703ef42017-03-16 13:36:21 -0700282 if (!brillo::data_encoding::Base64Decode(headers[kPayloadPropertyFileHash],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800283 &payload.hash)) {
Sen Jiang2703ef42017-03-16 13:36:21 -0700284 LOG(WARNING) << "Unable to decode base64 file hash: "
285 << headers[kPayloadPropertyFileHash];
286 }
Alex Deymo218397f2016-02-04 23:55:10 -0800287 if (!base::StringToUint64(headers[kPayloadPropertyMetadataSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800288 &payload.metadata_size)) {
289 payload.metadata_size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800290 }
Sen Jiangcdd52062017-05-18 15:33:10 -0700291 // The |payload.type| is not used anymore since minor_version 3.
292 payload.type = InstallPayloadType::kUnknown;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800293 install_plan_.payloads.push_back(payload);
294
Alex Deymo5e3ea272016-01-28 13:42:23 -0800295 // The |public_key_rsa| key would override the public key stored on disk.
296 install_plan_.public_key_rsa = "";
297
298 install_plan_.hash_checks_mandatory = hardware_->IsOfficialBuild();
299 install_plan_.is_resume = !payload_id.empty() &&
300 DeltaPerformer::CanResumeUpdate(prefs_, payload_id);
301 if (!install_plan_.is_resume) {
Kelvin Zhang42c2d552022-07-25 11:04:00 -0700302 boot_control_->GetDynamicPartitionControl()->Cleanup();
Kelvin Zhangc54c9962022-10-20 13:44:59 -0700303 boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_);
304
Alex Deymo5e3ea272016-01-28 13:42:23 -0800305 if (!prefs_->SetString(kPrefsUpdateCheckResponseHash, payload_id)) {
306 LOG(WARNING) << "Unable to save the update check response hash.";
307 }
308 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800309 install_plan_.source_slot = GetCurrentSlot();
310 install_plan_.target_slot = GetTargetSlot();
Alex Deymofb905d92016-06-03 19:26:58 -0700311
Alex Deymofb905d92016-06-03 19:26:58 -0700312 install_plan_.powerwash_required =
Sen Jiangfe522822017-10-31 15:14:11 -0700313 GetHeaderAsBool(headers[kPayloadPropertyPowerwash], false);
314
Kelvin Zhang85a6d992023-10-23 10:40:58 -0700315 install_plan_.spl_downgrade =
316 GetHeaderAsBool(headers[kPayloadPropertySplDowngrade], false);
317
Daniel Zheng9fc62b82023-03-24 22:57:20 +0000318 if (!IsProductionBuild()) {
319 install_plan_.disable_vabc =
320 GetHeaderAsBool(headers[kPayloadDisableVABC], false);
321 }
322
Sen Jiangfe522822017-10-31 15:14:11 -0700323 install_plan_.switch_slot_on_reboot =
324 GetHeaderAsBool(headers[kPayloadPropertySwitchSlotOnReboot], true);
325
Tianjie Xu087de9d2019-11-01 17:11:22 -0700326 install_plan_.run_post_install =
327 GetHeaderAsBool(headers[kPayloadPropertyRunPostInstall], true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800328
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700329 // Skip writing verity if we're resuming and verity has already been written.
330 install_plan_.write_verity = true;
331 if (install_plan_.is_resume && prefs_->Exists(kPrefsVerityWritten)) {
332 bool verity_written = false;
333 if (prefs_->GetBoolean(kPrefsVerityWritten, &verity_written) &&
334 verity_written) {
335 install_plan_.write_verity = false;
336 }
337 }
338
Alex Deymo87792ea2016-07-25 15:40:36 -0700339 NetworkId network_id = kDefaultNetworkId;
340 if (!headers[kPayloadPropertyNetworkId].empty()) {
341 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
342 &network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700343 return LogAndSetGenericError(
Alex Deymo87792ea2016-07-25 15:40:36 -0700344 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700345 __LINE__,
346 __FILE__,
Alex Deymo87792ea2016-07-25 15:40:36 -0700347 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
348 }
349 if (!network_selector_->SetProcessNetwork(network_id)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700350 return LogAndSetGenericError(
Sen Jiangcbd37c62017-09-12 15:04:35 -0700351 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700352 __LINE__,
353 __FILE__,
Sen Jiangcbd37c62017-09-12 15:04:35 -0700354 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700355 }
356 }
357
Alex Deymo5e3ea272016-01-28 13:42:23 -0800358 LOG(INFO) << "Using this install plan:";
359 install_plan_.Dump();
360
Amin Hassani667cf7b2018-07-25 14:32:00 -0700361 HttpFetcher* fetcher = nullptr;
362 if (FileFetcher::SupportedUrl(payload_url)) {
363 DLOG(INFO) << "Using FileFetcher for file URL.";
364 fetcher = new FileFetcher();
365 } else {
366#ifdef _UE_SIDELOAD
367 LOG(FATAL) << "Unsupported sideload URI: " << payload_url;
Chih-Hung Hsieh6e4f3452022-12-21 12:20:45 -0800368 return false; // NOLINT, unreached but analyzer might not know.
369 // Suppress warnings about null 'fetcher' after this.
Amin Hassani667cf7b2018-07-25 14:32:00 -0700370#else
Kelvin Zhangc7a1d1f2022-07-29 13:36:29 -0700371 LibcurlHttpFetcher* libcurl_fetcher = new LibcurlHttpFetcher(hardware_);
Kelvin Zhang3cc4fa32022-09-27 16:15:10 -0700372 if (!headers[kPayloadDownloadRetry].empty()) {
373 libcurl_fetcher->set_max_retry_count(
374 atoi(headers[kPayloadDownloadRetry].c_str()));
375 }
Amin Hassani667cf7b2018-07-25 14:32:00 -0700376 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
377 fetcher = libcurl_fetcher;
378#endif // _UE_SIDELOAD
379 }
Alex Deymofdd6dec2016-03-03 22:35:43 -0800380 // Setup extra headers.
Alex Deymofdd6dec2016-03-03 22:35:43 -0800381 if (!headers[kPayloadPropertyAuthorization].empty())
382 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
383 if (!headers[kPayloadPropertyUserAgent].empty())
384 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
385
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700386 if (!headers[kPayloadPropertyNetworkProxy].empty()) {
387 LOG(INFO) << "Using proxy url from payload headers: "
388 << headers[kPayloadPropertyNetworkProxy];
389 fetcher->SetProxies({headers[kPayloadPropertyNetworkProxy]});
390 }
Kelvin Zhanga7407b52023-03-13 15:05:14 -0700391 if (!headers[kPayloadVABCNone].empty()) {
392 install_plan_.vabc_none = true;
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000393 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800394 if (!headers[kPayloadEnableThreading].empty()) {
Kelvin Zhang944cdac2023-12-12 12:55:27 -0800395 const auto res = android::base::ParseBool(headers[kPayloadEnableThreading]);
396 if (res != android::base::ParseBoolResult::kError) {
397 install_plan_.enable_threading =
398 res == android::base::ParseBoolResult::kTrue;
399 }
Kelvin Zhang6bef4902023-02-22 12:43:27 -0800400 }
401 if (!headers[kPayloadBatchedWrites].empty()) {
402 install_plan_.batched_writes = true;
403 }
Kelvin Zhang98cb8f72022-08-03 12:42:02 -0700404
Amin Hassani667cf7b2018-07-25 14:32:00 -0700405 BuildUpdateActions(fetcher);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800406
Alex Deymo5e3ea272016-01-28 13:42:23 -0800407 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700408
409 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
410 // TODO(xunchang) report the metrics for unresumable updates
411
Amin Hassani667cf7b2018-07-25 14:32:00 -0700412 ScheduleProcessingStart();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800413 return true;
414}
415
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900416bool UpdateAttempterAndroid::ApplyPayload(
417 int fd,
418 int64_t payload_offset,
419 int64_t payload_size,
420 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700421 Error* error) {
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100422 // update_engine state must be checked before modifying payload_fd_ otherwise
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +0000423 // already running update will be terminated (existing file descriptor will be
424 // closed)
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100425 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700426 return LogAndSetGenericError(
427 error,
428 __LINE__,
429 __FILE__,
430 "An update already applied, waiting for reboot");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100431 }
432 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700433 return LogAndSetGenericError(
434 error,
435 __LINE__,
436 __FILE__,
437 "Already processing an update, cancel it first.");
HÃ¥kan Kvistb00089b2021-01-29 14:09:49 +0100438 }
439 DCHECK_EQ(status_, UpdateStatus::IDLE);
440
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900441 payload_fd_.reset(dup(fd));
442 const string payload_url = "fd://" + std::to_string(payload_fd_.get());
443
444 return ApplyPayload(
445 payload_url, payload_offset, payload_size, key_value_pair_headers, error);
446}
447
Daniel Zheng92f7d172023-06-22 14:31:37 -0700448bool UpdateAttempterAndroid::SuspendUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700449 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700450 return LogAndSetGenericError(
451 error, __LINE__, __FILE__, "No ongoing update to suspend.");
Alex Deymof2858572016-02-25 11:20:13 -0800452 processor_->SuspendProcessing();
453 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800454}
455
Daniel Zheng92f7d172023-06-22 14:31:37 -0700456bool UpdateAttempterAndroid::ResumeUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700457 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700458 return LogAndSetGenericError(
459 error, __LINE__, __FILE__, "No ongoing update to resume.");
Alex Deymof2858572016-02-25 11:20:13 -0800460 processor_->ResumeProcessing();
461 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800462}
463
Daniel Zheng92f7d172023-06-22 14:31:37 -0700464bool UpdateAttempterAndroid::CancelUpdate(Error* error) {
Sen Jiang91f8d2a2018-07-12 14:27:04 -0700465 if (!processor_->IsRunning())
Daniel Zheng92f7d172023-06-22 14:31:37 -0700466 return LogAndSetGenericError(
467 error, __LINE__, __FILE__, "No ongoing update to cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800468 processor_->StopProcessing();
469 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800470}
471
Daniel Zheng92f7d172023-06-22 14:31:37 -0700472bool UpdateAttempterAndroid::ResetStatus(Error* error) {
Alex Deymo3b678db2016-02-09 11:50:06 -0800473 LOG(INFO) << "Attempting to reset state from "
474 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700475 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700476 return LogAndSetGenericError(
477 error,
478 __LINE__,
479 __FILE__,
480 "Already processing an update, cancel it first.");
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700481 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700482 if (status_ != UpdateStatus::IDLE &&
483 status_ != UpdateStatus::UPDATED_NEED_REBOOT) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700484 return LogAndSetGenericError(
485 error,
486 __LINE__,
487 __FILE__,
488 "Status reset not allowed in this state, please "
489 "cancel on going OTA first.");
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700490 }
Alex Deymo3b678db2016-02-09 11:50:06 -0800491
Mohammad Samiul Islamb5c07bf2021-03-05 10:02:46 +0000492 if (apex_handler_android_ != nullptr) {
493 LOG(INFO) << "Cleaning up reserved space for compressed APEX (if any)";
494 std::vector<ApexInfo> apex_infos_blank;
495 apex_handler_android_->AllocateSpace(apex_infos_blank);
496 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400497 // Remove the reboot marker so that if the machine is rebooted
498 // after resetting to idle state, it doesn't go back to
499 // UpdateStatus::UPDATED_NEED_REBOOT state.
500 if (!ClearUpdateCompletedMarker()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700501 return LogAndSetGenericError(error,
502 __LINE__,
503 __FILE__,
504 "Failed to reset the status because "
505 "ClearUpdateCompletedMarker() failed");
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400506 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700507 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
508 if (!resetShouldSwitchSlotOnReboot(error)) {
509 LOG(INFO) << "Failed to reset slot switch.";
510 return false;
511 }
512 LOG(INFO) << "Slot switch reset successful";
513 }
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700514 if (!boot_control_->GetDynamicPartitionControl()->ResetUpdate(prefs_)) {
515 LOG(WARNING) << "Failed to reset snapshots. UpdateStatus is IDLE but"
Daniel Zheng730ae9b2022-08-25 22:37:22 +0000516 << "space might not be freed.";
Kelvin Zhangff5380b2022-03-16 13:35:04 -0700517 }
Kelvin Zhangf92fe252023-03-28 10:55:47 -0700518 return true;
Alex Deymo3b678db2016-02-09 11:50:06 -0800519}
520
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700521bool operator==(const std::vector<unsigned char>& a, std::string_view b) {
522 if (a.size() != b.size()) {
523 return false;
524 }
525 return memcmp(a.data(), b.data(), a.size()) == 0;
526}
527bool operator!=(const std::vector<unsigned char>& a, std::string_view b) {
528 return !(a == b);
529}
530
Yifan Hongbd47d622019-12-13 14:59:58 -0800531bool UpdateAttempterAndroid::VerifyPayloadParseManifest(
532 const std::string& metadata_filename,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700533 std::string_view expected_metadata_hash,
Yifan Hongbd47d622019-12-13 14:59:58 -0800534 DeltaArchiveManifest* manifest,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700535 Error* error) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800536 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
537 if (!fd->Open(metadata_filename.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700538 return LogAndSetError(error,
539 __LINE__,
540 __FILE__,
541 "Failed to open " + metadata_filename,
542 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800543 }
544 brillo::Blob metadata(kMaxPayloadHeaderSize);
545 if (!fd->Read(metadata.data(), metadata.size())) {
546 return LogAndSetError(
547 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700548 __LINE__,
549 __FILE__,
550 "Failed to read payload header from " + metadata_filename,
551 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800552 }
Daniel Zhengda4f7292022-09-02 22:59:32 +0000553 ErrorCode errorcode{};
Sen Jiang8371c1c2018-02-01 13:46:39 -0800554 PayloadMetadata payload_metadata;
Sen Jiangf1236632018-05-11 16:03:23 -0700555 if (payload_metadata.ParsePayloadHeader(metadata, &errorcode) !=
Sen Jiang8371c1c2018-02-01 13:46:39 -0800556 MetadataParseResult::kSuccess) {
557 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700558 __LINE__,
559 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800560 "Failed to parse payload header: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700561 utils::ErrorCodeToString(errorcode),
562 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800563 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700564 uint64_t metadata_size = payload_metadata.GetMetadataSize() +
565 payload_metadata.GetMetadataSignatureSize();
566 if (metadata_size < kMaxPayloadHeaderSize ||
567 metadata_size >
568 static_cast<uint64_t>(utils::FileSize(metadata_filename))) {
Sen Jiang8371c1c2018-02-01 13:46:39 -0800569 return LogAndSetError(
570 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700571 __LINE__,
572 __FILE__,
573 "Invalid metadata size: " + std::to_string(metadata_size),
574 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800575 }
Sen Jiang840a7ea2018-09-19 14:29:44 -0700576 metadata.resize(metadata_size);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800577 if (!fd->Read(metadata.data() + kMaxPayloadHeaderSize,
578 metadata.size() - kMaxPayloadHeaderSize)) {
579 return LogAndSetError(
580 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700581 __LINE__,
582 __FILE__,
583 "Failed to read metadata and signature from " + metadata_filename,
584 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800585 }
586 fd->Close();
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700587 if (!expected_metadata_hash.empty()) {
588 brillo::Blob metadata_hash;
589 TEST_AND_RETURN_FALSE(HashCalculator::RawHashOfBytes(
590 metadata.data(), payload_metadata.GetMetadataSize(), &metadata_hash));
591 if (metadata_hash != expected_metadata_hash) {
592 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700593 __LINE__,
594 __FILE__,
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700595 "Metadata hash mismatch. Expected hash: " +
596 HexEncode(expected_metadata_hash) +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700597 " actual hash: " + HexEncode(metadata_hash),
598 ErrorCode::kDownloadManifestParseError);
Kelvin Zhangabb082f2023-04-27 20:46:06 -0700599 } else {
600 LOG(INFO) << "Payload metadata hash check passed : "
601 << HexEncode(metadata_hash);
602 }
603 }
Sen Jiang08c6da12019-01-07 18:28:56 -0800604
Tianjie Xu7a78d632019-10-08 16:32:39 -0700605 auto payload_verifier = PayloadVerifier::CreateInstanceFromZipPath(
606 constants::kUpdateCertificatesPath);
607 if (!payload_verifier) {
608 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700609 __LINE__,
610 __FILE__,
Tianjie Xu7a78d632019-10-08 16:32:39 -0700611 "Failed to create the payload verifier from " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700612 std::string(constants::kUpdateCertificatesPath),
613 ErrorCode::kDownloadManifestParseError);
Sen Jiang08c6da12019-01-07 18:28:56 -0800614 }
Tianjie Xu7a78d632019-10-08 16:32:39 -0700615 errorcode = payload_metadata.ValidateMetadataSignature(
616 metadata, "", *payload_verifier);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800617 if (errorcode != ErrorCode::kSuccess) {
618 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700619 __LINE__,
620 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800621 "Failed to validate metadata signature: " +
Daniel Zheng92f7d172023-06-22 14:31:37 -0700622 utils::ErrorCodeToString(errorcode),
623 errorcode);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800624 }
Yifan Hongbd47d622019-12-13 14:59:58 -0800625 if (!payload_metadata.GetManifest(metadata, manifest)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700626 return LogAndSetError(error,
627 __LINE__,
628 __FILE__,
629 "Failed to parse manifest.",
630 ErrorCode::kDownloadManifestParseError);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800631 }
632
Yifan Hongbd47d622019-12-13 14:59:58 -0800633 return true;
634}
635
636bool UpdateAttempterAndroid::VerifyPayloadApplicable(
Daniel Zheng92f7d172023-06-22 14:31:37 -0700637 const std::string& metadata_filename, Error* error) {
Yifan Hongbd47d622019-12-13 14:59:58 -0800638 DeltaArchiveManifest manifest;
639 TEST_AND_RETURN_FALSE(
640 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
641
642 FileDescriptorPtr fd(new EintrSafeFileDescriptor);
Daniel Zhengda4f7292022-09-02 22:59:32 +0000643 ErrorCode errorcode{};
Yifan Hongbd47d622019-12-13 14:59:58 -0800644
645 BootControlInterface::Slot current_slot = GetCurrentSlot();
Kelvin Zhang1815c4d2023-11-07 14:21:18 -0800646 if (current_slot < 0) {
647 return LogAndSetError(
648 error,
649 __LINE__,
650 __FILE__,
651 "Failed to get current slot " + std::to_string(current_slot),
652 ErrorCode::kDownloadStateInitializationError);
653 }
Sen Jiang8371c1c2018-02-01 13:46:39 -0800654 for (const PartitionUpdate& partition : manifest.partitions()) {
655 if (!partition.has_old_partition_info())
656 continue;
657 string partition_path;
658 if (!boot_control_->GetPartitionDevice(
659 partition.partition_name(), current_slot, &partition_path)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700660 return LogAndSetGenericError(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800661 error,
Daniel Zheng92f7d172023-06-22 14:31:37 -0700662 __LINE__,
663 __FILE__,
Sen Jiang8371c1c2018-02-01 13:46:39 -0800664 "Failed to get partition device for " + partition.partition_name());
665 }
666 if (!fd->Open(partition_path.c_str(), O_RDONLY)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700667 return LogAndSetGenericError(
668 error, __LINE__, __FILE__, "Failed to open " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800669 }
670 for (const InstallOperation& operation : partition.operations()) {
671 if (!operation.has_src_sha256_hash())
672 continue;
673 brillo::Blob source_hash;
674 if (!fd_utils::ReadAndHashExtents(fd,
675 operation.src_extents(),
676 manifest.block_size(),
677 &source_hash)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -0700678 return LogAndSetGenericError(
679 error, __LINE__, __FILE__, "Failed to hash " + partition_path);
Sen Jiang8371c1c2018-02-01 13:46:39 -0800680 }
Kelvin Zhang9bd519d2020-09-23 12:55:19 -0400681 if (!PartitionWriter::ValidateSourceHash(
Sen Jiang8371c1c2018-02-01 13:46:39 -0800682 source_hash, operation, fd, &errorcode)) {
683 return false;
684 }
685 }
686 fd->Close();
687 }
688 return true;
689}
690
Alex Deymo5e3ea272016-01-28 13:42:23 -0800691void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
692 ErrorCode code) {
693 LOG(INFO) << "Processing Done.";
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800694 metric_bytes_downloaded_.Flush(true);
695 metric_total_bytes_downloaded_.Flush(true);
Kelvin Zhangf8441982022-12-07 18:18:47 -0800696 last_error_ = code;
Yifan Hong90965502020-02-19 15:22:47 -0800697 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
698 TerminateUpdateAndNotify(code);
699 return;
700 }
701
Alex Deymo5990bf32016-07-19 17:01:41 -0700702 switch (code) {
703 case ErrorCode::kSuccess:
704 // Update succeeded.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400705 if (!WriteUpdateCompletedMarker()) {
706 LOG(ERROR) << "Failed to write update completion marker";
707 }
Alex Deymo5990bf32016-07-19 17:01:41 -0700708 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800709
Alex Deymo5990bf32016-07-19 17:01:41 -0700710 LOG(INFO) << "Update successfully applied, waiting to reboot.";
711 break;
712
713 case ErrorCode::kFilesystemCopierError:
714 case ErrorCode::kNewRootfsVerificationError:
715 case ErrorCode::kNewKernelVerificationError:
716 case ErrorCode::kFilesystemVerifierError:
717 case ErrorCode::kDownloadStateInitializationError:
718 // Reset the ongoing update for these errors so it starts from the
719 // beginning next time.
720 DeltaPerformer::ResetUpdateProgress(prefs_, false);
721 LOG(INFO) << "Resetting update progress.";
722 break;
723
Sen Jiangacbdd1c2017-10-19 13:30:19 -0700724 case ErrorCode::kPayloadTimestampError:
725 // SafetyNet logging, b/36232423
726 android_errorWriteLog(0x534e4554, "36232423");
727 break;
728
Alex Deymo5990bf32016-07-19 17:01:41 -0700729 default:
730 // Ignore all other error codes.
731 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700732 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800733
734 TerminateUpdateAndNotify(code);
735}
736
737void UpdateAttempterAndroid::ProcessingStopped(
738 const ActionProcessor* processor) {
739 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
740}
741
742void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
743 AbstractAction* action,
744 ErrorCode code) {
745 // Reset download progress regardless of whether or not the download
746 // action succeeded.
747 const string type = action->Type();
Yifan Hong40bb0d02020-02-24 17:33:14 -0800748 if (type == CleanupPreviousUpdateAction::StaticType() ||
749 (type == NoOpAction::StaticType() &&
750 status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE)) {
751 cleanup_previous_update_code_ = code;
752 NotifyCleanupPreviousUpdateCallbacksAndClear();
753 }
Kelvin Zhang70eef232020-06-12 20:32:40 +0000754 // download_progress_ is actually used by other actions, such as
755 // filesystem_verify_action. Therefore we always clear it.
756 download_progress_ = 0;
Sen Jiangfe522822017-10-31 15:14:11 -0700757 if (type == PostinstallRunnerAction::StaticType()) {
758 bool succeeded =
759 code == ErrorCode::kSuccess || code == ErrorCode::kUpdatedButNotActive;
760 prefs_->SetBoolean(kPrefsPostInstallSucceeded, succeeded);
761 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800762 if (code != ErrorCode::kSuccess) {
763 // If an action failed, the ActionProcessor will cancel the whole thing.
764 return;
765 }
Yifan Hong83517502020-02-19 15:34:13 -0800766 if (type == UpdateBootFlagsAction::StaticType()) {
767 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
768 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800769 if (type == DownloadAction::StaticType()) {
Kelvin Zhangd2da7b12020-07-07 17:19:21 -0400770 auto download_action = static_cast<DownloadAction*>(action);
771 install_plan_ = *download_action->install_plan();
Kelvin Zhang70eef232020-06-12 20:32:40 +0000772 SetStatusAndNotify(UpdateStatus::VERIFYING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700773 } else if (type == FilesystemVerifierAction::StaticType()) {
Kelvin Zhang70eef232020-06-12 20:32:40 +0000774 SetStatusAndNotify(UpdateStatus::FINALIZING);
Sen Jiang3eeaf7d2018-10-11 13:55:32 -0700775 prefs_->SetBoolean(kPrefsVerityWritten, true);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800776 }
777}
778
779void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
780 uint64_t bytes_received,
781 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700782 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800783 if (total)
784 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700785 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800786 download_progress_ = progress;
787 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700788 } else {
789 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800790 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700791
792 // Update the bytes downloaded in prefs.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800793 metric_bytes_downloaded_ += bytes_progressed;
794 metric_total_bytes_downloaded_ += bytes_progressed;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800795}
796
797bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
798 // TODO(deymo): Notify the DownloadAction that it should cancel the update
799 // download.
800 return false;
801}
802
803void UpdateAttempterAndroid::DownloadComplete() {
804 // Nothing needs to be done when the download completes.
805}
806
Alex Deymo0d298542016-03-30 18:31:49 -0700807void UpdateAttempterAndroid::ProgressUpdate(double progress) {
808 // Self throttle based on progress. Also send notifications if progress is
809 // too slow.
810 if (progress == 1.0 ||
811 progress - download_progress_ >= kBroadcastThresholdProgress ||
812 TimeTicks::Now() - last_notify_time_ >=
813 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
814 download_progress_ = progress;
815 SetStatusAndNotify(status_);
816 }
817}
818
Kelvin Zhang70eef232020-06-12 20:32:40 +0000819void UpdateAttempterAndroid::OnVerifyProgressUpdate(double progress) {
820 assert(status_ == UpdateStatus::VERIFYING);
821 ProgressUpdate(progress);
822}
823
Alex Deymo5e3ea272016-01-28 13:42:23 -0800824void UpdateAttempterAndroid::ScheduleProcessingStart() {
825 LOG(INFO) << "Scheduling an action processor start.";
Kelvin Zhang20982a52021-08-13 12:31:16 -0700826 processor_->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800827 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700828 FROM_HERE,
829 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
830 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800831}
832
833void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
834 if (status_ == UpdateStatus::IDLE) {
835 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
836 return;
837 }
838
Yifan Hong90965502020-02-19 15:22:47 -0800839 if (status_ == UpdateStatus::CLEANUP_PREVIOUS_UPDATE) {
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400840 ClearUpdateCompletedMarker();
Yifan Hong90965502020-02-19 15:22:47 -0800841 LOG(INFO) << "Terminating cleanup previous update.";
842 SetStatusAndNotify(UpdateStatus::IDLE);
Yifan Hong5cd63fa2020-03-16 12:31:16 -0700843 for (auto observer : daemon_state_->service_observers())
844 observer->SendPayloadApplicationComplete(error_code);
Yifan Hong90965502020-02-19 15:22:47 -0800845 return;
846 }
847
Yifan Hong9194ce82019-11-07 11:03:42 -0800848 boot_control_->GetDynamicPartitionControl()->Cleanup();
Yifan Hong537802d2018-08-15 13:15:42 -0700849
Alex Deymo0d298542016-03-30 18:31:49 -0700850 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800851 UpdateStatus new_status =
852 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
853 : UpdateStatus::IDLE);
854 SetStatusAndNotify(new_status);
Kyeongkab.Nam500ca132019-06-26 13:48:07 +0900855 payload_fd_.reset();
Alex Deymo5e3ea272016-01-28 13:42:23 -0800856
Sen Jiangb19c3ec2017-10-06 15:18:46 -0700857 // The network id is only applicable to one download attempt and once it's
858 // done the network id should not be re-used anymore.
859 if (!network_selector_->SetProcessNetwork(kDefaultNetworkId)) {
860 LOG(WARNING) << "Unable to unbind network.";
861 }
862
Alex Deymo5e3ea272016-01-28 13:42:23 -0800863 for (auto observer : daemon_state_->service_observers())
864 observer->SendPayloadApplicationComplete(error_code);
Tianjie Xu1b661142017-09-28 14:03:42 -0700865
Tianjie Xu90aaa102017-10-10 17:39:03 -0700866 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
867 ClearMetricsPrefs();
868 if (error_code == ErrorCode::kSuccess) {
xunchang9cf52622019-01-25 11:04:58 -0800869 // We should only reset the PayloadAttemptNumber if the update succeeds, or
870 // we switch to a different payload.
871 prefs_->Delete(kPrefsPayloadAttemptNumber);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700872 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700873 // Clear the total bytes downloaded if and only if the update succeeds.
Kelvin Zhang32a73a92022-12-19 12:27:41 -0800874 metric_total_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700875 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800876}
877
878void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
879 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700880 size_t payload_size =
881 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700882 UpdateEngineStatus status_to_send = {.status = status_,
883 .progress = download_progress_,
884 .new_size_bytes = payload_size};
885
Alex Deymo5e3ea272016-01-28 13:42:23 -0800886 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700887 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800888 }
889 last_notify_time_ = TimeTicks::Now();
890}
891
Amin Hassani667cf7b2018-07-25 14:32:00 -0700892void UpdateAttempterAndroid::BuildUpdateActions(HttpFetcher* fetcher) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800893 CHECK(!processor_->IsRunning());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800894
895 // Actions:
Amin Hassani667cf7b2018-07-25 14:32:00 -0700896 auto update_boot_flags_action =
897 std::make_unique<UpdateBootFlagsAction>(boot_control_);
Yifan Hong83517502020-02-19 15:34:13 -0800898 auto cleanup_previous_update_action =
899 boot_control_->GetDynamicPartitionControl()
900 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
Amin Hassani667cf7b2018-07-25 14:32:00 -0700901 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
902 auto download_action =
903 std::make_unique<DownloadAction>(prefs_,
904 boot_control_,
905 hardware_,
Amin Hassani667cf7b2018-07-25 14:32:00 -0700906 fetcher, // passes ownership
Kelvin Zhang1304fe72021-10-06 19:12:12 -0700907 true /* interactive */,
908 update_certificates_path_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800909 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700910 download_action->set_base_offset(base_offset_);
Tianjie24f96092020-06-30 12:26:25 -0700911 auto filesystem_verifier_action = std::make_unique<FilesystemVerifierAction>(
912 boot_control_->GetDynamicPartitionControl());
Amin Hassani667cf7b2018-07-25 14:32:00 -0700913 auto postinstall_runner_action =
914 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
Kelvin Zhang70eef232020-06-12 20:32:40 +0000915 filesystem_verifier_action->set_delegate(this);
Alex Deymob6eef732016-06-10 12:58:11 -0700916 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800917
Alex Deymo5e3ea272016-01-28 13:42:23 -0800918 // Bond them together. We have to use the leaf-types when calling
919 // BondActions().
920 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700921 BondActions(download_action.get(), filesystem_verifier_action.get());
922 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800923 postinstall_runner_action.get());
924
Amin Hassani667cf7b2018-07-25 14:32:00 -0700925 processor_->EnqueueAction(std::move(update_boot_flags_action));
Yifan Hong83517502020-02-19 15:34:13 -0800926 processor_->EnqueueAction(std::move(cleanup_previous_update_action));
Amin Hassani667cf7b2018-07-25 14:32:00 -0700927 processor_->EnqueueAction(std::move(install_plan_action));
928 processor_->EnqueueAction(std::move(download_action));
929 processor_->EnqueueAction(std::move(filesystem_verifier_action));
930 processor_->EnqueueAction(std::move(postinstall_runner_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800931}
932
Alex Deymo5e3ea272016-01-28 13:42:23 -0800933bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
934 string boot_id;
935 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800936 LOG(INFO) << "Writing update complete marker, slot "
937 << boot_control_->GetCurrentSlot() << ", boot id: " << boot_id;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -0400938 TEST_AND_RETURN_FALSE(
939 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id));
940 TEST_AND_RETURN_FALSE(
941 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot()));
942 return true;
943}
944
945bool UpdateAttempterAndroid::ClearUpdateCompletedMarker() {
946 LOG(INFO) << "Clearing update complete marker.";
947 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsUpdateCompletedOnBootId));
948 TEST_AND_RETURN_FALSE(prefs_->Delete(kPrefsPreviousSlot));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800949 return true;
950}
951
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -0800952bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() const {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800953 // In case of an update_engine restart without a reboot, we stored the boot_id
954 // when the update was completed by setting a pref, so we can check whether
955 // the last update was on this boot or a previous one.
956 string boot_id;
957 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
958
959 string update_completed_on_boot_id;
960 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
961 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
962 &update_completed_on_boot_id) &&
963 update_completed_on_boot_id == boot_id);
964}
965
Tianjie Xu90aaa102017-10-10 17:39:03 -0700966// Collect and report the android metrics when we terminate the update.
967void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
968 ErrorCode error_code) {
969 int64_t attempt_number =
970 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
971 PayloadType payload_type = kPayloadTypeFull;
972 int64_t payload_size = 0;
973 for (const auto& p : install_plan_.payloads) {
974 if (p.type == InstallPayloadType::kDelta)
975 payload_type = kPayloadTypeDelta;
976 payload_size += p.size;
977 }
Kelvin Zhang20982a52021-08-13 12:31:16 -0700978 // In some cases, e.g. after calling |setShouldSwitchSlotOnReboot()|, this
979 // function will be triggered, but payload_size in this case might be 0, if so
980 // skip reporting any metrics.
981 if (payload_size == 0) {
982 return;
983 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700984
985 metrics::AttemptResult attempt_result =
986 metrics_utils::GetAttemptResult(error_code);
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700987 Time boot_time_start = Time::FromInternalValue(
988 metrics_utils::GetPersistedValue(kPrefsUpdateBootTimestampStart, prefs_));
989 Time monotonic_time_start = Time::FromInternalValue(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700990 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu2a0ea632018-08-06 12:59:23 -0700991 TimeDelta duration = clock_->GetBootTime() - boot_time_start;
992 TimeDelta duration_uptime = clock_->GetMonotonicTime() - monotonic_time_start;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700993
994 metrics_reporter_->ReportUpdateAttemptMetrics(
Tianjie Xu90aaa102017-10-10 17:39:03 -0700995 static_cast<int>(attempt_number),
996 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700997 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700998 duration_uptime,
999 payload_size,
1000 attempt_result,
1001 error_code);
1002
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001003 int64_t current_bytes_downloaded = metric_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -07001004 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
1005 current_bytes_downloaded,
1006 0,
1007 DownloadSource::kNumDownloadSources,
1008 metrics::DownloadErrorCode::kUnset,
1009 metrics::ConnectionType::kUnset);
1010
Tianjie Xu90aaa102017-10-10 17:39:03 -07001011 if (error_code == ErrorCode::kSuccess) {
1012 int64_t reboot_count =
1013 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1014 string build_version;
1015 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -07001016
1017 // For android metrics, we only care about the total bytes downloaded
1018 // for all sources; for now we assume the only download source is
1019 // HttpsServer.
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001020 int64_t total_bytes_downloaded = metric_total_bytes_downloaded_.get();
Tianjie Xud4777a12017-10-24 14:54:18 -07001021 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
1022 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
1023 total_bytes_downloaded;
1024
1025 int download_overhead_percentage = 0;
Tianjie Xu21030c12019-08-14 13:00:23 -07001026 if (total_bytes_downloaded >= payload_size) {
1027 CHECK_GT(payload_size, 0);
Tianjie Xud4777a12017-10-24 14:54:18 -07001028 download_overhead_percentage =
Tianjie Xu21030c12019-08-14 13:00:23 -07001029 (total_bytes_downloaded - payload_size) * 100ull / payload_size;
1030 } else {
1031 LOG(WARNING) << "Downloaded bytes " << total_bytes_downloaded
1032 << " is smaller than the payload size " << payload_size;
Tianjie Xud4777a12017-10-24 14:54:18 -07001033 }
Tianjie Xu21030c12019-08-14 13:00:23 -07001034
Tianjie Xu90aaa102017-10-10 17:39:03 -07001035 metrics_reporter_->ReportSuccessfulUpdateMetrics(
1036 static_cast<int>(attempt_number),
1037 0, // update abandoned count
1038 payload_type,
1039 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -07001040 num_bytes_downloaded,
1041 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -07001042 duration,
Sen Jiang8712e962018-05-08 12:12:28 -07001043 duration_uptime,
Tianjie Xu90aaa102017-10-10 17:39:03 -07001044 static_cast<int>(reboot_count),
1045 0); // url_switch_count
1046 }
1047}
1048
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001049bool UpdateAttempterAndroid::OTARebootSucceeded() const {
1050 const auto current_slot = boot_control_->GetCurrentSlot();
Kelvin Zhang13020502023-08-02 15:18:40 -07001051 const string current_version = GetCurrentBuildVersion();
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001052 int64_t previous_slot = -1;
1053 TEST_AND_RETURN_FALSE(prefs_->GetInt64(kPrefsPreviousSlot, &previous_slot));
1054 string previous_version;
1055 TEST_AND_RETURN_FALSE(
1056 prefs_->GetString(kPrefsPreviousVersion, &previous_version));
1057 if (previous_slot != current_slot) {
1058 LOG(INFO) << "Detected a slot switch, OTA succeeded, device updated from "
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001059 << previous_version << " to " << current_version
1060 << ", previous slot: " << previous_slot
1061 << " current slot: " << current_slot;
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001062 if (previous_version == current_version) {
1063 LOG(INFO) << "Previous version is the same as current version, this is "
1064 "possibly a self-OTA.";
1065 }
1066 return true;
1067 } else {
1068 LOG(INFO) << "Slot didn't switch, either the OTA is rolled back, or slot "
1069 "switch never happened, or system not rebooted at all.";
1070 if (previous_version != current_version) {
1071 LOG(INFO) << "Slot didn't change, but version changed from "
1072 << previous_version << " to " << current_version
1073 << " device could be flashed.";
1074 }
1075 return false;
1076 }
1077}
1078
1079OTAResult UpdateAttempterAndroid::GetOTAUpdateResult() const {
1080 // We only set |kPrefsSystemUpdatedMarker| if slot is actually switched, so
1081 // existence of this pref is sufficient indicator. Given that we have to
1082 // delete this pref after checking it. This is done in
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001083 // |DeltaPerformer::ResetUpdateProgress| and
1084 // |UpdateAttempterAndroid::UpdateStateAfterReboot|
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001085 auto slot_switch_attempted = prefs_->Exists(kPrefsUpdateCompletedOnBootId);
1086 auto system_rebooted = DidSystemReboot(prefs_);
1087 auto ota_successful = OTARebootSucceeded();
1088 if (ota_successful) {
1089 return OTAResult::OTA_SUCCESSFUL;
1090 }
1091 if (slot_switch_attempted) {
1092 if (system_rebooted) {
1093 // If we attempted slot switch, but still end up on the same slot, we
1094 // probably rolled back.
1095 return OTAResult::ROLLED_BACK;
1096 } else {
1097 return OTAResult::UPDATED_NEED_REBOOT;
1098 }
1099 }
1100 return OTAResult::NOT_ATTEMPTED;
1101}
1102
1103void UpdateAttempterAndroid::UpdateStateAfterReboot(const OTAResult result) {
Kelvin Zhang13020502023-08-02 15:18:40 -07001104 const string current_version = GetCurrentBuildVersion();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001105 TEST_AND_RETURN(!current_version.empty());
1106
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001107 // |UpdateStateAfterReboot()| is only called after system reboot, so record
1108 // boot id unconditionally
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001109 string current_boot_id;
1110 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
1111 prefs_->SetString(kPrefsBootId, current_boot_id);
Kelvin Zhang1bcd7d72023-02-14 16:43:34 -08001112 std::string slot_switch_indicator;
1113 prefs_->GetString(kPrefsUpdateCompletedOnBootId, &slot_switch_indicator);
1114 if (slot_switch_indicator != current_boot_id) {
1115 ClearUpdateCompletedMarker();
1116 }
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001117
Tianjie Xu90aaa102017-10-10 17:39:03 -07001118 // If there's no record of previous version (e.g. due to a data wipe), we
1119 // save the info of current boot and skip the metrics report.
1120 if (!prefs_->Exists(kPrefsPreviousVersion)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001121 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001122 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001123 ClearMetricsPrefs();
1124 return;
1125 }
Kelvin Zhang86603472021-05-11 12:16:27 -04001126 // update_engine restarted under the same build and same slot.
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001127 if (result != OTAResult::OTA_SUCCESSFUL) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001128 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
1129 // set when we start a new update.
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001130 if (prefs_->Exists(kPrefsNumReboots)) {
Tianjie Xu90aaa102017-10-10 17:39:03 -07001131 int64_t reboot_count =
1132 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
1133 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
1134 }
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001135
1136 if (result == OTAResult::ROLLED_BACK) {
1137 // This will release all space previously allocated for apex
1138 // decompression. If we detect a rollback, we should release space and
1139 // return the space to user. Any subsequent attempt to install OTA will
1140 // allocate space again anyway.
1141 LOG(INFO) << "Detected a rollback, releasing space allocated for apex "
1142 "deompression.";
1143 apex_handler_android_->AllocateSpace({});
1144 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1145 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001146 return;
1147 }
1148
1149 // Now that the build version changes, report the update metrics.
1150 // TODO(xunchang) check the build version is larger than the previous one.
Tianjie Xu90aaa102017-10-10 17:39:03 -07001151 prefs_->SetString(kPrefsPreviousVersion, current_version);
Kelvin Zhangd6fd6822021-05-26 09:50:56 -04001152 prefs_->SetInt64(kPrefsPreviousSlot, boot_control_->GetCurrentSlot());
Tianjie Xu90aaa102017-10-10 17:39:03 -07001153
1154 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
1155 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
1156 if (previous_attempt_exists) {
1157 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
1158 }
1159
1160 metrics_utils::LoadAndReportTimeToReboot(
1161 metrics_reporter_.get(), prefs_, clock_.get());
1162 ClearMetricsPrefs();
Sen Jiang1bafff82019-01-02 15:54:40 -08001163
1164 // Also reset the update progress if the build version has changed.
1165 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
1166 LOG(WARNING) << "Unable to reset the update progress.";
1167 }
Tianjie Xu90aaa102017-10-10 17:39:03 -07001168}
1169
1170// Save the update start time. Reset the reboot count and attempt number if the
1171// update isn't a resume; otherwise increment the attempt number.
1172void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
1173 if (!is_resume) {
1174 metrics_utils::SetNumReboots(0, prefs_);
1175 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
1176 } else {
1177 int64_t attempt_number =
1178 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
1179 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
1180 }
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001181 metrics_utils::SetUpdateTimestampStart(clock_->GetMonotonicTime(), prefs_);
1182 metrics_utils::SetUpdateBootTimestampStart(clock_->GetBootTime(), prefs_);
Kelvin Zhanga43d6e82021-05-26 10:14:42 -04001183 ClearUpdateCompletedMarker();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001184}
1185
1186void UpdateAttempterAndroid::ClearMetricsPrefs() {
1187 CHECK(prefs_);
Kelvin Zhang32a73a92022-12-19 12:27:41 -08001188 metric_bytes_downloaded_.Delete();
Tianjie Xu90aaa102017-10-10 17:39:03 -07001189 prefs_->Delete(kPrefsNumReboots);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001190 prefs_->Delete(kPrefsSystemUpdatedMarker);
1191 prefs_->Delete(kPrefsUpdateTimestampStart);
Tianjie Xu2a0ea632018-08-06 12:59:23 -07001192 prefs_->Delete(kPrefsUpdateBootTimestampStart);
Tianjie Xu90aaa102017-10-10 17:39:03 -07001193}
1194
Yifan Hongbd47d622019-12-13 14:59:58 -08001195BootControlInterface::Slot UpdateAttempterAndroid::GetCurrentSlot() const {
1196 return boot_control_->GetCurrentSlot();
1197}
1198
1199BootControlInterface::Slot UpdateAttempterAndroid::GetTargetSlot() const {
1200 return GetCurrentSlot() == 0 ? 1 : 0;
1201}
1202
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001203uint64_t UpdateAttempterAndroid::AllocateSpaceForPayload(
1204 const std::string& metadata_filename,
1205 const vector<string>& key_value_pair_headers,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001206 Error* error) {
Yifan Hong65613032020-01-09 17:52:13 -08001207 std::map<string, string> headers;
1208 if (!ParseKeyValuePairHeaders(key_value_pair_headers, &headers, error)) {
1209 return 0;
1210 }
Kelvin Zhangabb082f2023-04-27 20:46:06 -07001211 DeltaArchiveManifest manifest;
1212 brillo::Blob metadata_hash;
1213 if (!brillo::data_encoding::Base64Decode(
1214 headers[kPayloadPropertyMetadataHash], &metadata_hash)) {
1215 metadata_hash.clear();
1216 }
1217 if (!VerifyPayloadParseManifest(
1218 metadata_filename, ToStringView(metadata_hash), &manifest, error)) {
1219 return 0;
1220 }
Yifan Hong65613032020-01-09 17:52:13 -08001221
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001222 std::vector<ApexInfo> apex_infos(manifest.apex_info().begin(),
1223 manifest.apex_info().end());
1224 uint64_t apex_size_required = 0;
1225 if (apex_handler_android_ != nullptr) {
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001226 auto result = apex_handler_android_->CalculateSize(apex_infos);
1227 if (!result.ok()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001228 LogAndSetGenericError(
1229 error,
1230 __LINE__,
1231 __FILE__,
1232 "Failed to calculate size required for compressed APEX");
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001233 return 0;
1234 }
1235 apex_size_required = *result;
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001236 }
1237
Yifan Hong65613032020-01-09 17:52:13 -08001238 string payload_id = GetPayloadId(headers);
1239 uint64_t required_size = 0;
Daniel Zhengeede4c82023-06-13 11:21:06 -07001240 ErrorCode error_code{};
1241
Yifan Hong65613032020-01-09 17:52:13 -08001242 if (!DeltaPerformer::PreparePartitionsForUpdate(prefs_,
1243 boot_control_,
1244 GetTargetSlot(),
1245 manifest,
1246 payload_id,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001247 &required_size,
1248 &error_code)) {
1249 if (error_code == ErrorCode::kOverlayfsenabledError) {
1250 LogAndSetError(error,
1251 __LINE__,
1252 __FILE__,
1253 "OverlayFS Shouldn't be enabled for OTA.",
1254 error_code);
1255 return 0;
1256 }
Yifan Hong65613032020-01-09 17:52:13 -08001257 if (required_size == 0) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001258 LogAndSetGenericError(
1259 error, __LINE__, __FILE__, "Failed to allocate space for payload.");
Yifan Hong65613032020-01-09 17:52:13 -08001260 return 0;
1261 } else {
1262 LOG(ERROR) << "Insufficient space for payload: " << required_size
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001263 << " bytes, apex decompression: " << apex_size_required
Yifan Hong65613032020-01-09 17:52:13 -08001264 << " bytes";
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001265 return required_size + apex_size_required;
Yifan Hong65613032020-01-09 17:52:13 -08001266 }
1267 }
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001268
1269 if (apex_size_required > 0 && apex_handler_android_ != nullptr &&
Mohammad Samiul Islamb0ab8652021-02-26 14:04:17 +00001270 !apex_handler_android_->AllocateSpace(apex_infos)) {
Mohammad Samiul Islam24a82792021-02-12 16:52:36 +00001271 LOG(ERROR) << "Insufficient space for apex decompression: "
1272 << apex_size_required << " bytes";
1273 return apex_size_required;
Kelvin Zhang8933d572021-01-28 10:17:34 -05001274 }
Yifan Hong65613032020-01-09 17:52:13 -08001275
1276 LOG(INFO) << "Successfully allocated space for payload.";
Yifan Hong6f7e29f2019-12-13 14:41:06 -08001277 return 0;
1278}
1279
Yifan Hong40bb0d02020-02-24 17:33:14 -08001280void UpdateAttempterAndroid::CleanupSuccessfulUpdate(
1281 std::unique_ptr<CleanupSuccessfulUpdateCallbackInterface> callback,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001282 Error* error) {
Yifan Hong40bb0d02020-02-24 17:33:14 -08001283 if (cleanup_previous_update_code_.has_value()) {
1284 LOG(INFO) << "CleanupSuccessfulUpdate has previously completed with "
1285 << utils::ErrorCodeToString(*cleanup_previous_update_code_);
1286 if (callback) {
1287 callback->OnCleanupComplete(
1288 static_cast<int32_t>(*cleanup_previous_update_code_));
1289 }
1290 return;
Yifan Hong4f611562020-01-15 23:41:33 -08001291 }
Yifan Hong40bb0d02020-02-24 17:33:14 -08001292 if (callback) {
1293 auto callback_ptr = callback.get();
1294 cleanup_previous_update_callbacks_.emplace_back(std::move(callback));
Kelvin Zhang2f6c25a2023-07-05 12:49:34 -07001295 callback_ptr->RegisterForDeathNotifications([this, callback_ptr]() {
1296 RemoveCleanupPreviousUpdateCallback(callback_ptr);
1297 });
Yifan Hong40bb0d02020-02-24 17:33:14 -08001298 }
1299 ScheduleCleanupPreviousUpdate();
Yifan Hong2236ea02019-12-13 16:11:22 -08001300}
1301
Tianjie7f8f2ab2021-07-23 17:08:50 -07001302bool UpdateAttempterAndroid::setShouldSwitchSlotOnReboot(
Daniel Zheng92f7d172023-06-22 14:31:37 -07001303 const std::string& metadata_filename, Error* error) {
Kelvin Zhang20982a52021-08-13 12:31:16 -07001304 LOG(INFO) << "setShouldSwitchSlotOnReboot(" << metadata_filename << ")";
Tianjie7f8f2ab2021-07-23 17:08:50 -07001305 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001306 return LogAndSetGenericError(
1307 error,
1308 __LINE__,
1309 __FILE__,
1310 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001311 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001312 DeltaArchiveManifest manifest;
1313 TEST_AND_RETURN_FALSE(
1314 VerifyPayloadParseManifest(metadata_filename, &manifest, error));
1315
Kelvin Zhang20982a52021-08-13 12:31:16 -07001316 InstallPlan install_plan_;
1317 install_plan_.source_slot = GetCurrentSlot();
1318 install_plan_.target_slot = GetTargetSlot();
1319 // Don't do verity computation, just hash the partitions
1320 install_plan_.write_verity = false;
1321 // Don't run postinstall, we just need PostinstallAction to switch the slots.
1322 install_plan_.run_post_install = false;
1323 install_plan_.is_resume = true;
1324
1325 CHECK_NE(install_plan_.source_slot, UINT32_MAX);
1326 CHECK_NE(install_plan_.target_slot, UINT32_MAX);
1327
Kelvin Zhang20982a52021-08-13 12:31:16 -07001328 auto install_plan_action = std::make_unique<InstallPlanAction>(install_plan_);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001329 auto postinstall_runner_action =
1330 std::make_unique<PostinstallRunnerAction>(boot_control_, hardware_);
1331 SetStatusAndNotify(UpdateStatus::VERIFYING);
Kelvin Zhang20982a52021-08-13 12:31:16 -07001332 postinstall_runner_action->set_delegate(this);
Daniel Zhengeede4c82023-06-13 11:21:06 -07001333 ErrorCode error_code{};
Kelvin Zhang20982a52021-08-13 12:31:16 -07001334
Kelvin Zhangf8441982022-12-07 18:18:47 -08001335 // If last error code is kUpdatedButNotActive, we know that we reached this
1336 // state by calling applyPayload() with switch_slot=false. That applyPayload()
1337 // call would have already performed filesystem verification, therefore, we
1338 // can safely skip the verification to save time.
1339 if (last_error_ == ErrorCode::kUpdatedButNotActive) {
1340 BondActions(install_plan_action.get(), postinstall_runner_action.get());
1341 processor_->EnqueueAction(std::move(install_plan_action));
1342 } else {
Kelvin Zhang263a5402022-12-08 23:03:32 -08001343 if (!boot_control_->GetDynamicPartitionControl()
1344 ->PreparePartitionsForUpdate(GetCurrentSlot(),
1345 GetTargetSlot(),
1346 manifest,
1347 false /* should update */,
Daniel Zhengeede4c82023-06-13 11:21:06 -07001348 nullptr,
1349 &error_code)) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001350 return LogAndSetGenericError(
1351 error, __LINE__, __FILE__, "Failed to PreparePartitionsForUpdate");
Kelvin Zhang263a5402022-12-08 23:03:32 -08001352 }
Kelvin Zhang263a5402022-12-08 23:03:32 -08001353 if (!install_plan_.ParsePartitions(manifest.partitions(),
1354 boot_control_,
1355 manifest.block_size(),
1356 &error_code)) {
1357 return LogAndSetError(error,
Daniel Zheng92f7d172023-06-22 14:31:37 -07001358 __LINE__,
1359 __FILE__,
Kelvin Zhang263a5402022-12-08 23:03:32 -08001360 "Failed to LoadPartitionsFromSlots " +
Daniel Zheng92f7d172023-06-22 14:31:37 -07001361 utils::ErrorCodeToString(error_code),
1362 error_code);
Kelvin Zhang263a5402022-12-08 23:03:32 -08001363 }
1364
Kelvin Zhangf8441982022-12-07 18:18:47 -08001365 auto filesystem_verifier_action =
1366 std::make_unique<FilesystemVerifierAction>(
1367 boot_control_->GetDynamicPartitionControl());
1368 filesystem_verifier_action->set_delegate(this);
1369 BondActions(install_plan_action.get(), filesystem_verifier_action.get());
1370 BondActions(filesystem_verifier_action.get(),
1371 postinstall_runner_action.get());
1372 processor_->EnqueueAction(std::move(install_plan_action));
1373 processor_->EnqueueAction(std::move(filesystem_verifier_action));
1374 }
Kelvin Zhang20982a52021-08-13 12:31:16 -07001375
Kelvin Zhang20982a52021-08-13 12:31:16 -07001376 processor_->EnqueueAction(std::move(postinstall_runner_action));
1377 ScheduleProcessingStart();
1378 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001379}
1380
Daniel Zheng92f7d172023-06-22 14:31:37 -07001381bool UpdateAttempterAndroid::resetShouldSwitchSlotOnReboot(Error* error) {
Tianjie7f8f2ab2021-07-23 17:08:50 -07001382 if (processor_->IsRunning()) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001383 return LogAndSetGenericError(
1384 error,
1385 __LINE__,
1386 __FILE__,
1387 "Already processing an update, cancel it first.");
Tianjie7f8f2ab2021-07-23 17:08:50 -07001388 }
Daniel Zhenge76cf562022-11-08 17:32:10 +00001389 TEST_AND_RETURN_FALSE(ClearUpdateCompletedMarker());
Kelvin Zhang20982a52021-08-13 12:31:16 -07001390 // Update the boot flags so the current slot has higher priority.
1391 if (!boot_control_->SetActiveBootSlot(GetCurrentSlot())) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001392 return LogAndSetGenericError(
1393 error, __LINE__, __FILE__, "Failed to SetActiveBootSlot");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001394 }
1395
1396 // Mark the current slot as successful again, since marking it as active
1397 // may reset the successful bit. We ignore the result of whether marking
1398 // the current slot as successful worked.
1399 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful) {}))) {
Daniel Zheng92f7d172023-06-22 14:31:37 -07001400 return LogAndSetGenericError(
1401 error, __LINE__, __FILE__, "Failed to MarkBootSuccessfulAsync");
Kelvin Zhang20982a52021-08-13 12:31:16 -07001402 }
1403
1404 // Resets the warm reset property since we won't switch the slot.
1405 hardware_->SetWarmReset(false);
1406
1407 // Resets the vbmeta digest.
1408 hardware_->SetVbmetaDigestForInactiveSlot(true /* reset */);
1409 LOG(INFO) << "Slot switch cancelled.";
1410 SetStatusAndNotify(UpdateStatus::IDLE);
1411 return true;
Tianjie7f8f2ab2021-07-23 17:08:50 -07001412}
1413
Yifan Hong90965502020-02-19 15:22:47 -08001414void UpdateAttempterAndroid::ScheduleCleanupPreviousUpdate() {
1415 // If a previous CleanupSuccessfulUpdate call has not finished, or an update
1416 // is in progress, skip enqueueing the action.
1417 if (processor_->IsRunning()) {
1418 LOG(INFO) << "Already processing an update. CleanupPreviousUpdate should "
1419 << "be done when the current update finishes.";
1420 return;
1421 }
1422 LOG(INFO) << "Scheduling CleanupPreviousUpdateAction.";
1423 auto action =
1424 boot_control_->GetDynamicPartitionControl()
1425 ->GetCleanupPreviousUpdateAction(boot_control_, prefs_, this);
1426 processor_->EnqueueAction(std::move(action));
1427 processor_->set_delegate(this);
1428 SetStatusAndNotify(UpdateStatus::CLEANUP_PREVIOUS_UPDATE);
1429 processor_->StartProcessing();
1430}
1431
Yifan Hong40bb0d02020-02-24 17:33:14 -08001432void UpdateAttempterAndroid::OnCleanupProgressUpdate(double progress) {
1433 for (auto&& callback : cleanup_previous_update_callbacks_) {
1434 callback->OnCleanupProgressUpdate(progress);
1435 }
1436}
1437
1438void UpdateAttempterAndroid::NotifyCleanupPreviousUpdateCallbacksAndClear() {
1439 CHECK(cleanup_previous_update_code_.has_value());
1440 for (auto&& callback : cleanup_previous_update_callbacks_) {
1441 callback->OnCleanupComplete(
1442 static_cast<int32_t>(*cleanup_previous_update_code_));
1443 }
1444 cleanup_previous_update_callbacks_.clear();
1445}
1446
1447void UpdateAttempterAndroid::RemoveCleanupPreviousUpdateCallback(
1448 CleanupSuccessfulUpdateCallbackInterface* callback) {
1449 auto end_it =
1450 std::remove_if(cleanup_previous_update_callbacks_.begin(),
1451 cleanup_previous_update_callbacks_.end(),
1452 [&](const auto& e) { return e.get() == callback; });
1453 cleanup_previous_update_callbacks_.erase(
1454 end_it, cleanup_previous_update_callbacks_.end());
1455}
Yifan Hong90965502020-02-19 15:22:47 -08001456
Daniel Zheng9fc62b82023-03-24 22:57:20 +00001457bool UpdateAttempterAndroid::IsProductionBuild() {
1458 if (android::base::GetProperty("ro.build.type", "") != "userdebug" ||
1459 android::base::GetProperty("ro.build.tags", "") == "release-keys" ||
1460 android::base::GetProperty("ro.boot.verifiedbootstate", "") == "green") {
1461 return true;
1462 }
1463 return false;
1464}
1465
Alex Deymo5e3ea272016-01-28 13:42:23 -08001466} // namespace chromeos_update_engine