blob: 7dcbeec18602a10652be52de36755a120edb4787 [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
17#include "update_engine/update_attempter_android.h"
18
19#include <algorithm>
Alex Deymo218397f2016-02-04 23:55:10 -080020#include <map>
Tianjie Xu90aaa102017-10-10 17:39:03 -070021#include <memory>
Alex Deymo5e3ea272016-01-28 13:42:23 -080022#include <utility>
23
Tianjie Xu90aaa102017-10-10 17:39:03 -070024#include <android-base/properties.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080025#include <base/bind.h>
26#include <base/logging.h>
Alex Deymo218397f2016-02-04 23:55:10 -080027#include <base/strings/string_number_conversions.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080028#include <brillo/bind_lambda.h>
Sen Jiang2703ef42017-03-16 13:36:21 -070029#include <brillo/data_encoding.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080030#include <brillo/message_loops/message_loop.h>
Alex Deymo218397f2016-02-04 23:55:10 -080031#include <brillo/strings/string_utils.h>
Alex Deymo5e3ea272016-01-28 13:42:23 -080032
33#include "update_engine/common/constants.h"
Alex Deymo2c131bb2016-05-26 16:43:13 -070034#include "update_engine/common/file_fetcher.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080035#include "update_engine/common/utils.h"
Alex Deymo03a4de72016-07-20 16:08:23 -070036#include "update_engine/daemon_state_interface.h"
Tianjie Xud4c5deb2017-10-24 11:17:03 -070037#include "update_engine/metrics_reporter_interface.h"
Tianjie Xu1b661142017-09-28 14:03:42 -070038#include "update_engine/metrics_utils.h"
Alex Deymo87792ea2016-07-25 15:40:36 -070039#include "update_engine/network_selector.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080040#include "update_engine/payload_consumer/download_action.h"
41#include "update_engine/payload_consumer/filesystem_verifier_action.h"
42#include "update_engine/payload_consumer/postinstall_runner_action.h"
Alex Deymo3b678db2016-02-09 11:50:06 -080043#include "update_engine/update_status_utils.h"
Alex Deymo5e3ea272016-01-28 13:42:23 -080044
Alex Deymo14c0da82016-07-20 16:45:45 -070045#ifndef _UE_SIDELOAD
46// Do not include support for external HTTP(s) urls when building
47// update_engine_sideload.
48#include "update_engine/libcurl_http_fetcher.h"
49#endif
50
Alex Deymo5e3ea272016-01-28 13:42:23 -080051using base::Bind;
Tianjie Xu90aaa102017-10-10 17:39:03 -070052using base::Time;
Alex Deymo5e3ea272016-01-28 13:42:23 -080053using base::TimeDelta;
54using base::TimeTicks;
55using std::shared_ptr;
56using std::string;
57using std::vector;
Aaron Wood7f92e2b2017-08-28 14:51:21 -070058using update_engine::UpdateEngineStatus;
Alex Deymo5e3ea272016-01-28 13:42:23 -080059
60namespace chromeos_update_engine {
61
62namespace {
63
Alex Deymo0d298542016-03-30 18:31:49 -070064// Minimum threshold to broadcast an status update in progress and time.
65const double kBroadcastThresholdProgress = 0.01; // 1%
66const int kBroadcastThresholdSeconds = 10;
67
Alex Deymo5e3ea272016-01-28 13:42:23 -080068const char* const kErrorDomain = "update_engine";
69// TODO(deymo): Convert the different errors to a numeric value to report them
70// back on the service error.
71const char* const kGenericError = "generic_error";
72
73// Log and set the error on the passed ErrorPtr.
74bool LogAndSetError(brillo::ErrorPtr* error,
75 const tracked_objects::Location& location,
76 const string& reason) {
77 brillo::Error::AddTo(error, location, kErrorDomain, kGenericError, reason);
78 LOG(ERROR) << "Replying with failure: " << location.ToString() << ": "
79 << reason;
80 return false;
81}
82
83} // namespace
84
85UpdateAttempterAndroid::UpdateAttempterAndroid(
Alex Deymo03a4de72016-07-20 16:08:23 -070086 DaemonStateInterface* daemon_state,
Alex Deymo5e3ea272016-01-28 13:42:23 -080087 PrefsInterface* prefs,
88 BootControlInterface* boot_control,
89 HardwareInterface* hardware)
90 : daemon_state_(daemon_state),
91 prefs_(prefs),
92 boot_control_(boot_control),
93 hardware_(hardware),
Tianjie Xu1b661142017-09-28 14:03:42 -070094 processor_(new ActionProcessor()),
Tianjie Xud4c5deb2017-10-24 11:17:03 -070095 clock_(new Clock()) {
96 metrics_reporter_ = metrics::CreateMetricsReporter();
Alex Deymo87792ea2016-07-25 15:40:36 -070097 network_selector_ = network::CreateNetworkSelector();
Alex Deymo5e3ea272016-01-28 13:42:23 -080098}
99
100UpdateAttempterAndroid::~UpdateAttempterAndroid() {
101 // Release ourselves as the ActionProcessor's delegate to prevent
102 // re-scheduling the updates due to the processing stopped.
103 processor_->set_delegate(nullptr);
104}
105
106void UpdateAttempterAndroid::Init() {
107 // In case of update_engine restart without a reboot we need to restore the
108 // reboot needed state.
Tianjie Xu90aaa102017-10-10 17:39:03 -0700109 if (UpdateCompletedOnThisBoot()) {
Alex Deymo0e061ae2016-02-09 17:49:03 -0800110 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700111 } else {
Alex Deymo0e061ae2016-02-09 17:49:03 -0800112 SetStatusAndNotify(UpdateStatus::IDLE);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700113 UpdatePrefsAndReportUpdateMetricsOnReboot();
114 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800115}
116
117bool UpdateAttempterAndroid::ApplyPayload(
118 const string& payload_url,
119 int64_t payload_offset,
120 int64_t payload_size,
121 const vector<string>& key_value_pair_headers,
122 brillo::ErrorPtr* error) {
123 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
124 return LogAndSetError(
125 error, FROM_HERE, "An update already applied, waiting for reboot");
126 }
127 if (ongoing_update_) {
128 return LogAndSetError(
129 error, FROM_HERE, "Already processing an update, cancel it first.");
130 }
131 DCHECK(status_ == UpdateStatus::IDLE);
132
Alex Deymo218397f2016-02-04 23:55:10 -0800133 std::map<string, string> headers;
134 for (const string& key_value_pair : key_value_pair_headers) {
135 string key;
136 string value;
137 if (!brillo::string_utils::SplitAtFirst(
138 key_value_pair, "=", &key, &value, false)) {
139 return LogAndSetError(
140 error, FROM_HERE, "Passed invalid header: " + key_value_pair);
141 }
142 if (!headers.emplace(key, value).second)
143 return LogAndSetError(error, FROM_HERE, "Passed repeated key: " + key);
144 }
145
146 // Unique identifier for the payload. An empty string means that the payload
147 // can't be resumed.
148 string payload_id = (headers[kPayloadPropertyFileHash] +
149 headers[kPayloadPropertyMetadataHash]);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800150
151 // Setup the InstallPlan based on the request.
152 install_plan_ = InstallPlan();
153
154 install_plan_.download_url = payload_url;
155 install_plan_.version = "";
Alex Deymo0fd51ff2016-02-03 14:22:43 -0800156 base_offset_ = payload_offset;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800157 InstallPlan::Payload payload;
158 payload.size = payload_size;
159 if (!payload.size) {
Alex Deymo218397f2016-02-04 23:55:10 -0800160 if (!base::StringToUint64(headers[kPayloadPropertyFileSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800161 &payload.size)) {
162 payload.size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800163 }
164 }
Sen Jiang2703ef42017-03-16 13:36:21 -0700165 if (!brillo::data_encoding::Base64Decode(headers[kPayloadPropertyFileHash],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800166 &payload.hash)) {
Sen Jiang2703ef42017-03-16 13:36:21 -0700167 LOG(WARNING) << "Unable to decode base64 file hash: "
168 << headers[kPayloadPropertyFileHash];
169 }
Alex Deymo218397f2016-02-04 23:55:10 -0800170 if (!base::StringToUint64(headers[kPayloadPropertyMetadataSize],
Sen Jiang0affc2c2017-02-10 15:55:05 -0800171 &payload.metadata_size)) {
172 payload.metadata_size = 0;
Alex Deymo218397f2016-02-04 23:55:10 -0800173 }
Sen Jiangcdd52062017-05-18 15:33:10 -0700174 // The |payload.type| is not used anymore since minor_version 3.
175 payload.type = InstallPayloadType::kUnknown;
Sen Jiang0affc2c2017-02-10 15:55:05 -0800176 install_plan_.payloads.push_back(payload);
177
Alex Deymo5e3ea272016-01-28 13:42:23 -0800178 // The |public_key_rsa| key would override the public key stored on disk.
179 install_plan_.public_key_rsa = "";
180
181 install_plan_.hash_checks_mandatory = hardware_->IsOfficialBuild();
182 install_plan_.is_resume = !payload_id.empty() &&
183 DeltaPerformer::CanResumeUpdate(prefs_, payload_id);
184 if (!install_plan_.is_resume) {
185 if (!DeltaPerformer::ResetUpdateProgress(prefs_, false)) {
186 LOG(WARNING) << "Unable to reset the update progress.";
187 }
188 if (!prefs_->SetString(kPrefsUpdateCheckResponseHash, payload_id)) {
189 LOG(WARNING) << "Unable to save the update check response hash.";
190 }
191 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800192 install_plan_.source_slot = boot_control_->GetCurrentSlot();
193 install_plan_.target_slot = install_plan_.source_slot == 0 ? 1 : 0;
Alex Deymofb905d92016-06-03 19:26:58 -0700194
195 int data_wipe = 0;
196 install_plan_.powerwash_required =
197 base::StringToInt(headers[kPayloadPropertyPowerwash], &data_wipe) &&
198 data_wipe != 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800199
Alex Deymo87792ea2016-07-25 15:40:36 -0700200 NetworkId network_id = kDefaultNetworkId;
201 if (!headers[kPayloadPropertyNetworkId].empty()) {
202 if (!base::StringToUint64(headers[kPayloadPropertyNetworkId],
203 &network_id)) {
204 return LogAndSetError(
205 error,
206 FROM_HERE,
207 "Invalid network_id: " + headers[kPayloadPropertyNetworkId]);
208 }
209 if (!network_selector_->SetProcessNetwork(network_id)) {
Sen Jiangcbd37c62017-09-12 15:04:35 -0700210 return LogAndSetError(
211 error,
212 FROM_HERE,
213 "Unable to set network_id: " + headers[kPayloadPropertyNetworkId]);
Alex Deymo87792ea2016-07-25 15:40:36 -0700214 }
215 }
216
Alex Deymo5e3ea272016-01-28 13:42:23 -0800217 LOG(INFO) << "Using this install plan:";
218 install_plan_.Dump();
219
Alex Deymo2c131bb2016-05-26 16:43:13 -0700220 BuildUpdateActions(payload_url);
Alex Deymofdd6dec2016-03-03 22:35:43 -0800221 // Setup extra headers.
222 HttpFetcher* fetcher = download_action_->http_fetcher();
223 if (!headers[kPayloadPropertyAuthorization].empty())
224 fetcher->SetHeader("Authorization", headers[kPayloadPropertyAuthorization]);
225 if (!headers[kPayloadPropertyUserAgent].empty())
226 fetcher->SetHeader("User-Agent", headers[kPayloadPropertyUserAgent]);
227
Alex Deymo5e3ea272016-01-28 13:42:23 -0800228 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
Alex Deymof2858572016-02-25 11:20:13 -0800229 ongoing_update_ = true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800230
231 // Just in case we didn't update boot flags yet, make sure they're updated
232 // before any update processing starts. This will start the update process.
233 UpdateBootFlags();
Tianjie Xu90aaa102017-10-10 17:39:03 -0700234
235 UpdatePrefsOnUpdateStart(install_plan_.is_resume);
236 // TODO(xunchang) report the metrics for unresumable updates
237
Alex Deymo5e3ea272016-01-28 13:42:23 -0800238 return true;
239}
240
241bool UpdateAttempterAndroid::SuspendUpdate(brillo::ErrorPtr* error) {
Alex Deymof2858572016-02-25 11:20:13 -0800242 if (!ongoing_update_)
243 return LogAndSetError(error, FROM_HERE, "No ongoing update to suspend.");
244 processor_->SuspendProcessing();
245 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800246}
247
248bool UpdateAttempterAndroid::ResumeUpdate(brillo::ErrorPtr* error) {
Alex Deymof2858572016-02-25 11:20:13 -0800249 if (!ongoing_update_)
250 return LogAndSetError(error, FROM_HERE, "No ongoing update to resume.");
251 processor_->ResumeProcessing();
252 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800253}
254
255bool UpdateAttempterAndroid::CancelUpdate(brillo::ErrorPtr* error) {
Alex Deymof2858572016-02-25 11:20:13 -0800256 if (!ongoing_update_)
Alex Deymo5e3ea272016-01-28 13:42:23 -0800257 return LogAndSetError(error, FROM_HERE, "No ongoing update to cancel.");
Alex Deymof2858572016-02-25 11:20:13 -0800258 processor_->StopProcessing();
259 return true;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800260}
261
Alex Deymo3b678db2016-02-09 11:50:06 -0800262bool UpdateAttempterAndroid::ResetStatus(brillo::ErrorPtr* error) {
263 LOG(INFO) << "Attempting to reset state from "
264 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
265
266 switch (status_) {
267 case UpdateStatus::IDLE:
268 return true;
269
270 case UpdateStatus::UPDATED_NEED_REBOOT: {
271 // Remove the reboot marker so that if the machine is rebooted
272 // after resetting to idle state, it doesn't go back to
273 // UpdateStatus::UPDATED_NEED_REBOOT state.
274 bool ret_value = prefs_->Delete(kPrefsUpdateCompletedOnBootId);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700275 ClearMetricsPrefs();
Alex Deymo3b678db2016-02-09 11:50:06 -0800276
277 // Update the boot flags so the current slot has higher priority.
278 if (!boot_control_->SetActiveBootSlot(boot_control_->GetCurrentSlot()))
279 ret_value = false;
280
Alex Deymo52590332016-11-29 18:29:13 -0800281 // Mark the current slot as successful again, since marking it as active
282 // may reset the successful bit. We ignore the result of whether marking
283 // the current slot as successful worked.
284 if (!boot_control_->MarkBootSuccessfulAsync(Bind([](bool successful){})))
285 ret_value = false;
286
Alex Deymo3b678db2016-02-09 11:50:06 -0800287 if (!ret_value) {
288 return LogAndSetError(
289 error,
290 FROM_HERE,
291 "Failed to reset the status to ");
292 }
293
294 SetStatusAndNotify(UpdateStatus::IDLE);
295 LOG(INFO) << "Reset status successful";
296 return true;
297 }
298
299 default:
300 return LogAndSetError(
301 error,
302 FROM_HERE,
303 "Reset not allowed in this state. Cancel the ongoing update first");
304 }
305}
306
Alex Deymo5e3ea272016-01-28 13:42:23 -0800307void UpdateAttempterAndroid::ProcessingDone(const ActionProcessor* processor,
308 ErrorCode code) {
309 LOG(INFO) << "Processing Done.";
310
Alex Deymo5990bf32016-07-19 17:01:41 -0700311 switch (code) {
312 case ErrorCode::kSuccess:
313 // Update succeeded.
314 WriteUpdateCompletedMarker();
315 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
316 DeltaPerformer::ResetUpdateProgress(prefs_, false);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800317
Alex Deymo5990bf32016-07-19 17:01:41 -0700318 LOG(INFO) << "Update successfully applied, waiting to reboot.";
319 break;
320
321 case ErrorCode::kFilesystemCopierError:
322 case ErrorCode::kNewRootfsVerificationError:
323 case ErrorCode::kNewKernelVerificationError:
324 case ErrorCode::kFilesystemVerifierError:
325 case ErrorCode::kDownloadStateInitializationError:
326 // Reset the ongoing update for these errors so it starts from the
327 // beginning next time.
328 DeltaPerformer::ResetUpdateProgress(prefs_, false);
329 LOG(INFO) << "Resetting update progress.";
330 break;
331
332 default:
333 // Ignore all other error codes.
334 break;
Alex Deymo03a4de72016-07-20 16:08:23 -0700335 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800336
337 TerminateUpdateAndNotify(code);
338}
339
340void UpdateAttempterAndroid::ProcessingStopped(
341 const ActionProcessor* processor) {
342 TerminateUpdateAndNotify(ErrorCode::kUserCanceled);
343}
344
345void UpdateAttempterAndroid::ActionCompleted(ActionProcessor* processor,
346 AbstractAction* action,
347 ErrorCode code) {
348 // Reset download progress regardless of whether or not the download
349 // action succeeded.
350 const string type = action->Type();
351 if (type == DownloadAction::StaticType()) {
Alex Deymo0d298542016-03-30 18:31:49 -0700352 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800353 }
354 if (code != ErrorCode::kSuccess) {
355 // If an action failed, the ActionProcessor will cancel the whole thing.
356 return;
357 }
358 if (type == DownloadAction::StaticType()) {
359 SetStatusAndNotify(UpdateStatus::FINALIZING);
360 }
361}
362
363void UpdateAttempterAndroid::BytesReceived(uint64_t bytes_progressed,
364 uint64_t bytes_received,
365 uint64_t total) {
Alex Deymo0d298542016-03-30 18:31:49 -0700366 double progress = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800367 if (total)
368 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
Alex Deymo0d298542016-03-30 18:31:49 -0700369 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800370 download_progress_ = progress;
371 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
Alex Deymo0d298542016-03-30 18:31:49 -0700372 } else {
373 ProgressUpdate(progress);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800374 }
Tianjie Xud4777a12017-10-24 14:54:18 -0700375
376 // Update the bytes downloaded in prefs.
377 int64_t current_bytes_downloaded =
378 metrics_utils::GetPersistedValue(kPrefsCurrentBytesDownloaded, prefs_);
379 int64_t total_bytes_downloaded =
380 metrics_utils::GetPersistedValue(kPrefsTotalBytesDownloaded, prefs_);
381 prefs_->SetInt64(kPrefsCurrentBytesDownloaded,
382 current_bytes_downloaded + bytes_progressed);
383 prefs_->SetInt64(kPrefsTotalBytesDownloaded,
384 total_bytes_downloaded + bytes_progressed);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800385}
386
387bool UpdateAttempterAndroid::ShouldCancel(ErrorCode* cancel_reason) {
388 // TODO(deymo): Notify the DownloadAction that it should cancel the update
389 // download.
390 return false;
391}
392
393void UpdateAttempterAndroid::DownloadComplete() {
394 // Nothing needs to be done when the download completes.
395}
396
Alex Deymo0d298542016-03-30 18:31:49 -0700397void UpdateAttempterAndroid::ProgressUpdate(double progress) {
398 // Self throttle based on progress. Also send notifications if progress is
399 // too slow.
400 if (progress == 1.0 ||
401 progress - download_progress_ >= kBroadcastThresholdProgress ||
402 TimeTicks::Now() - last_notify_time_ >=
403 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
404 download_progress_ = progress;
405 SetStatusAndNotify(status_);
406 }
407}
408
Alex Deymo5e3ea272016-01-28 13:42:23 -0800409void UpdateAttempterAndroid::UpdateBootFlags() {
410 if (updated_boot_flags_) {
411 LOG(INFO) << "Already updated boot flags. Skipping.";
412 CompleteUpdateBootFlags(true);
413 return;
414 }
415 // This is purely best effort.
416 LOG(INFO) << "Marking booted slot as good.";
417 if (!boot_control_->MarkBootSuccessfulAsync(
418 Bind(&UpdateAttempterAndroid::CompleteUpdateBootFlags,
419 base::Unretained(this)))) {
420 LOG(ERROR) << "Failed to mark current boot as successful.";
421 CompleteUpdateBootFlags(false);
422 }
423}
424
425void UpdateAttempterAndroid::CompleteUpdateBootFlags(bool successful) {
426 updated_boot_flags_ = true;
427 ScheduleProcessingStart();
428}
429
430void UpdateAttempterAndroid::ScheduleProcessingStart() {
431 LOG(INFO) << "Scheduling an action processor start.";
432 brillo::MessageLoop::current()->PostTask(
Luis Hector Chavezf1cf3482016-07-19 14:29:19 -0700433 FROM_HERE,
434 Bind([](ActionProcessor* processor) { processor->StartProcessing(); },
435 base::Unretained(processor_.get())));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800436}
437
438void UpdateAttempterAndroid::TerminateUpdateAndNotify(ErrorCode error_code) {
439 if (status_ == UpdateStatus::IDLE) {
440 LOG(ERROR) << "No ongoing update, but TerminatedUpdate() called.";
441 return;
442 }
443
Alex Deymo0d298542016-03-30 18:31:49 -0700444 download_progress_ = 0;
Alex Deymo5e3ea272016-01-28 13:42:23 -0800445 actions_.clear();
446 UpdateStatus new_status =
447 (error_code == ErrorCode::kSuccess ? UpdateStatus::UPDATED_NEED_REBOOT
448 : UpdateStatus::IDLE);
449 SetStatusAndNotify(new_status);
450 ongoing_update_ = false;
451
452 for (auto observer : daemon_state_->service_observers())
453 observer->SendPayloadApplicationComplete(error_code);
Tianjie Xu1b661142017-09-28 14:03:42 -0700454
Tianjie Xu90aaa102017-10-10 17:39:03 -0700455 CollectAndReportUpdateMetricsOnUpdateFinished(error_code);
456 ClearMetricsPrefs();
457 if (error_code == ErrorCode::kSuccess) {
458 metrics_utils::SetSystemUpdatedMarker(clock_.get(), prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700459 // Clear the total bytes downloaded if and only if the update succeeds.
460 prefs_->SetInt64(kPrefsTotalBytesDownloaded, 0);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700461 }
Alex Deymo5e3ea272016-01-28 13:42:23 -0800462}
463
464void UpdateAttempterAndroid::SetStatusAndNotify(UpdateStatus status) {
465 status_ = status;
Sen Jiang2d1c87b2017-07-14 10:46:14 -0700466 size_t payload_size =
467 install_plan_.payloads.empty() ? 0 : install_plan_.payloads[0].size;
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700468 UpdateEngineStatus status_to_send = {.status = status_,
469 .progress = download_progress_,
470 .new_size_bytes = payload_size};
471
Alex Deymo5e3ea272016-01-28 13:42:23 -0800472 for (auto observer : daemon_state_->service_observers()) {
Aaron Wood7f92e2b2017-08-28 14:51:21 -0700473 observer->SendStatusUpdate(status_to_send);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800474 }
475 last_notify_time_ = TimeTicks::Now();
476}
477
Alex Deymo2c131bb2016-05-26 16:43:13 -0700478void UpdateAttempterAndroid::BuildUpdateActions(const string& url) {
Alex Deymo5e3ea272016-01-28 13:42:23 -0800479 CHECK(!processor_->IsRunning());
480 processor_->set_delegate(this);
481
482 // Actions:
483 shared_ptr<InstallPlanAction> install_plan_action(
484 new InstallPlanAction(install_plan_));
485
Alex Deymo2c131bb2016-05-26 16:43:13 -0700486 HttpFetcher* download_fetcher = nullptr;
487 if (FileFetcher::SupportedUrl(url)) {
488 DLOG(INFO) << "Using FileFetcher for file URL.";
489 download_fetcher = new FileFetcher();
490 } else {
Alex Deymo14c0da82016-07-20 16:45:45 -0700491#ifdef _UE_SIDELOAD
492 LOG(FATAL) << "Unsupported sideload URI: " << url;
493#else
Alex Deymo2c131bb2016-05-26 16:43:13 -0700494 LibcurlHttpFetcher* libcurl_fetcher =
495 new LibcurlHttpFetcher(&proxy_resolver_, hardware_);
496 libcurl_fetcher->set_server_to_check(ServerToCheck::kDownload);
497 download_fetcher = libcurl_fetcher;
Alex Deymo14c0da82016-07-20 16:45:45 -0700498#endif // _UE_SIDELOAD
Alex Deymo2c131bb2016-05-26 16:43:13 -0700499 }
Sen Jiang5ae865b2017-04-18 14:24:40 -0700500 shared_ptr<DownloadAction> download_action(
501 new DownloadAction(prefs_,
502 boot_control_,
503 hardware_,
504 nullptr, // system_state, not used.
505 download_fetcher)); // passes ownership
Sen Jiangfef85fd2016-03-25 15:32:49 -0700506 shared_ptr<FilesystemVerifierAction> filesystem_verifier_action(
Sen Jiange6e4bb92016-04-05 14:59:12 -0700507 new FilesystemVerifierAction());
Alex Deymo5e3ea272016-01-28 13:42:23 -0800508
509 shared_ptr<PostinstallRunnerAction> postinstall_runner_action(
Alex Deymofb905d92016-06-03 19:26:58 -0700510 new PostinstallRunnerAction(boot_control_, hardware_));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800511
512 download_action->set_delegate(this);
Sen Jiang5ae865b2017-04-18 14:24:40 -0700513 download_action->set_base_offset(base_offset_);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800514 download_action_ = download_action;
Alex Deymob6eef732016-06-10 12:58:11 -0700515 postinstall_runner_action->set_delegate(this);
Alex Deymo5e3ea272016-01-28 13:42:23 -0800516
517 actions_.push_back(shared_ptr<AbstractAction>(install_plan_action));
518 actions_.push_back(shared_ptr<AbstractAction>(download_action));
Sen Jiangfef85fd2016-03-25 15:32:49 -0700519 actions_.push_back(shared_ptr<AbstractAction>(filesystem_verifier_action));
Alex Deymo5e3ea272016-01-28 13:42:23 -0800520 actions_.push_back(shared_ptr<AbstractAction>(postinstall_runner_action));
521
522 // Bond them together. We have to use the leaf-types when calling
523 // BondActions().
524 BondActions(install_plan_action.get(), download_action.get());
Sen Jiangfef85fd2016-03-25 15:32:49 -0700525 BondActions(download_action.get(), filesystem_verifier_action.get());
526 BondActions(filesystem_verifier_action.get(),
Alex Deymo5e3ea272016-01-28 13:42:23 -0800527 postinstall_runner_action.get());
528
529 // Enqueue the actions.
530 for (const shared_ptr<AbstractAction>& action : actions_)
531 processor_->EnqueueAction(action.get());
532}
533
Alex Deymo5e3ea272016-01-28 13:42:23 -0800534bool UpdateAttempterAndroid::WriteUpdateCompletedMarker() {
535 string boot_id;
536 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
537 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id);
538 return true;
539}
540
541bool UpdateAttempterAndroid::UpdateCompletedOnThisBoot() {
542 // In case of an update_engine restart without a reboot, we stored the boot_id
543 // when the update was completed by setting a pref, so we can check whether
544 // the last update was on this boot or a previous one.
545 string boot_id;
546 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
547
548 string update_completed_on_boot_id;
549 return (prefs_->Exists(kPrefsUpdateCompletedOnBootId) &&
550 prefs_->GetString(kPrefsUpdateCompletedOnBootId,
551 &update_completed_on_boot_id) &&
552 update_completed_on_boot_id == boot_id);
553}
554
Tianjie Xu90aaa102017-10-10 17:39:03 -0700555// Collect and report the android metrics when we terminate the update.
556void UpdateAttempterAndroid::CollectAndReportUpdateMetricsOnUpdateFinished(
557 ErrorCode error_code) {
558 int64_t attempt_number =
559 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
560 PayloadType payload_type = kPayloadTypeFull;
561 int64_t payload_size = 0;
562 for (const auto& p : install_plan_.payloads) {
563 if (p.type == InstallPayloadType::kDelta)
564 payload_type = kPayloadTypeDelta;
565 payload_size += p.size;
566 }
567
568 metrics::AttemptResult attempt_result =
569 metrics_utils::GetAttemptResult(error_code);
570 Time attempt_start_time = Time::FromInternalValue(
571 metrics_utils::GetPersistedValue(kPrefsUpdateTimestampStart, prefs_));
Tianjie Xu52c678c2017-10-18 15:52:27 -0700572 TimeDelta duration = clock_->GetBootTime() - attempt_start_time;
Tianjie Xu90aaa102017-10-10 17:39:03 -0700573 TimeDelta duration_uptime = clock_->GetMonotonicTime() - attempt_start_time;
574
575 metrics_reporter_->ReportUpdateAttemptMetrics(
576 nullptr, // system_state
577 static_cast<int>(attempt_number),
578 payload_type,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700579 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700580 duration_uptime,
581 payload_size,
582 attempt_result,
583 error_code);
584
Tianjie Xud4777a12017-10-24 14:54:18 -0700585 int64_t current_bytes_downloaded =
586 metrics_utils::GetPersistedValue(kPrefsCurrentBytesDownloaded, prefs_);
587 metrics_reporter_->ReportUpdateAttemptDownloadMetrics(
588 current_bytes_downloaded,
589 0,
590 DownloadSource::kNumDownloadSources,
591 metrics::DownloadErrorCode::kUnset,
592 metrics::ConnectionType::kUnset);
593
Tianjie Xu90aaa102017-10-10 17:39:03 -0700594 if (error_code == ErrorCode::kSuccess) {
595 int64_t reboot_count =
596 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
597 string build_version;
598 prefs_->GetString(kPrefsPreviousVersion, &build_version);
Tianjie Xud4777a12017-10-24 14:54:18 -0700599
600 // For android metrics, we only care about the total bytes downloaded
601 // for all sources; for now we assume the only download source is
602 // HttpsServer.
603 int64_t total_bytes_downloaded =
604 metrics_utils::GetPersistedValue(kPrefsTotalBytesDownloaded, prefs_);
605 int64_t num_bytes_downloaded[kNumDownloadSources] = {};
606 num_bytes_downloaded[DownloadSource::kDownloadSourceHttpsServer] =
607 total_bytes_downloaded;
608
609 int download_overhead_percentage = 0;
610 if (current_bytes_downloaded > 0) {
611 download_overhead_percentage =
612 (total_bytes_downloaded - current_bytes_downloaded) * 100ull /
613 current_bytes_downloaded;
614 }
Tianjie Xu90aaa102017-10-10 17:39:03 -0700615 metrics_reporter_->ReportSuccessfulUpdateMetrics(
616 static_cast<int>(attempt_number),
617 0, // update abandoned count
618 payload_type,
619 payload_size,
Tianjie Xud4777a12017-10-24 14:54:18 -0700620 num_bytes_downloaded,
621 download_overhead_percentage,
Tianjie Xu52c678c2017-10-18 15:52:27 -0700622 duration,
Tianjie Xu90aaa102017-10-10 17:39:03 -0700623 static_cast<int>(reboot_count),
624 0); // url_switch_count
625 }
626}
627
628void UpdateAttempterAndroid::UpdatePrefsAndReportUpdateMetricsOnReboot() {
629 string current_boot_id;
630 TEST_AND_RETURN(utils::GetBootId(&current_boot_id));
631 // Example: [ro.build.version.incremental]: [4292972]
632 string current_version =
633 android::base::GetProperty("ro.build.version.incremental", "");
634 TEST_AND_RETURN(!current_version.empty());
635
636 // If there's no record of previous version (e.g. due to a data wipe), we
637 // save the info of current boot and skip the metrics report.
638 if (!prefs_->Exists(kPrefsPreviousVersion)) {
639 prefs_->SetString(kPrefsBootId, current_boot_id);
640 prefs_->SetString(kPrefsPreviousVersion, current_version);
641 ClearMetricsPrefs();
642 return;
643 }
644 string previous_version;
645 // update_engine restarted under the same build.
646 // TODO(xunchang) identify and report rollback by checking UpdateMarker.
647 if (prefs_->GetString(kPrefsPreviousVersion, &previous_version) &&
648 previous_version == current_version) {
649 string last_boot_id;
650 bool is_reboot = prefs_->Exists(kPrefsBootId) &&
651 (prefs_->GetString(kPrefsBootId, &last_boot_id) &&
652 last_boot_id != current_boot_id);
653 // Increment the reboot number if |kPrefsNumReboots| exists. That pref is
654 // set when we start a new update.
655 if (is_reboot && prefs_->Exists(kPrefsNumReboots)) {
656 prefs_->SetString(kPrefsBootId, current_boot_id);
657 int64_t reboot_count =
658 metrics_utils::GetPersistedValue(kPrefsNumReboots, prefs_);
659 metrics_utils::SetNumReboots(reboot_count + 1, prefs_);
660 }
661 return;
662 }
663
664 // Now that the build version changes, report the update metrics.
665 // TODO(xunchang) check the build version is larger than the previous one.
666 prefs_->SetString(kPrefsBootId, current_boot_id);
667 prefs_->SetString(kPrefsPreviousVersion, current_version);
668
669 bool previous_attempt_exists = prefs_->Exists(kPrefsPayloadAttemptNumber);
670 // |kPrefsPayloadAttemptNumber| should be cleared upon successful update.
671 if (previous_attempt_exists) {
672 metrics_reporter_->ReportAbnormallyTerminatedUpdateAttemptMetrics();
673 }
674
675 metrics_utils::LoadAndReportTimeToReboot(
676 metrics_reporter_.get(), prefs_, clock_.get());
677 ClearMetricsPrefs();
678}
679
680// Save the update start time. Reset the reboot count and attempt number if the
681// update isn't a resume; otherwise increment the attempt number.
682void UpdateAttempterAndroid::UpdatePrefsOnUpdateStart(bool is_resume) {
683 if (!is_resume) {
684 metrics_utils::SetNumReboots(0, prefs_);
685 metrics_utils::SetPayloadAttemptNumber(1, prefs_);
686 } else {
687 int64_t attempt_number =
688 metrics_utils::GetPersistedValue(kPrefsPayloadAttemptNumber, prefs_);
689 metrics_utils::SetPayloadAttemptNumber(attempt_number + 1, prefs_);
690 }
691 Time update_start_time = clock_->GetMonotonicTime();
692 metrics_utils::SetUpdateTimestampStart(update_start_time, prefs_);
693}
694
695void UpdateAttempterAndroid::ClearMetricsPrefs() {
696 CHECK(prefs_);
Tianjie Xud4777a12017-10-24 14:54:18 -0700697 prefs_->Delete(kPrefsCurrentBytesDownloaded);
Tianjie Xu90aaa102017-10-10 17:39:03 -0700698 prefs_->Delete(kPrefsNumReboots);
699 prefs_->Delete(kPrefsPayloadAttemptNumber);
700 prefs_->Delete(kPrefsSystemUpdatedMarker);
701 prefs_->Delete(kPrefsUpdateTimestampStart);
702}
703
Alex Deymo5e3ea272016-01-28 13:42:23 -0800704} // namespace chromeos_update_engine