1 //
2 // Copyright (C) 2012 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.h"
18
19 #include <stdint.h>
20
21 #include <algorithm>
22 #include <memory>
23 #include <set>
24 #include <string>
25 #include <utility>
26 #include <vector>
27
28 #include <base/bind.h>
29 #include <base/files/file_util.h>
30 #include <base/logging.h>
31 #include <base/rand_util.h>
32 #include <base/strings/string_util.h>
33 #include <base/strings/stringprintf.h>
34 #include <brillo/bind_lambda.h>
35 #include <brillo/make_unique_ptr.h>
36 #include <brillo/message_loops/message_loop.h>
37 #include <debugd/dbus-constants.h>
38 #include <policy/device_policy.h>
39 #include <policy/libpolicy.h>
40 #include <power_manager/dbus-constants.h>
41 #include <power_manager/dbus-proxies.h>
42 #include <update_engine/dbus-constants.h>
43
44 #include "update_engine/common/boot_control_interface.h"
45 #include "update_engine/common/certificate_checker.h"
46 #include "update_engine/common/clock_interface.h"
47 #include "update_engine/common/constants.h"
48 #include "update_engine/common/hardware_interface.h"
49 #include "update_engine/common/libcurl_http_fetcher.h"
50 #include "update_engine/common/multi_range_http_fetcher.h"
51 #include "update_engine/common/platform_constants.h"
52 #include "update_engine/common/prefs_interface.h"
53 #include "update_engine/common/subprocess.h"
54 #include "update_engine/common/utils.h"
55 #include "update_engine/dbus_service.h"
56 #include "update_engine/metrics.h"
57 #include "update_engine/omaha_request_action.h"
58 #include "update_engine/omaha_request_params.h"
59 #include "update_engine/omaha_response_handler_action.h"
60 #include "update_engine/p2p_manager.h"
61 #include "update_engine/payload_consumer/download_action.h"
62 #include "update_engine/payload_consumer/filesystem_verifier_action.h"
63 #include "update_engine/payload_consumer/postinstall_runner_action.h"
64 #include "update_engine/payload_state_interface.h"
65 #include "update_engine/system_state.h"
66 #include "update_engine/update_manager/policy.h"
67 #include "update_engine/update_manager/update_manager.h"
68 #include "update_engine/update_status_utils.h"
69
70 using base::Bind;
71 using base::Callback;
72 using base::Time;
73 using base::TimeDelta;
74 using base::TimeTicks;
75 using brillo::MessageLoop;
76 using chromeos_update_manager::EvalStatus;
77 using chromeos_update_manager::Policy;
78 using chromeos_update_manager::UpdateCheckParams;
79 using std::set;
80 using std::shared_ptr;
81 using std::string;
82 using std::vector;
83
84 namespace chromeos_update_engine {
85
86 const int UpdateAttempter::kMaxDeltaUpdateFailures = 3;
87
88 namespace {
89 const int kMaxConsecutiveObeyProxyRequests = 20;
90
91 // Minimum threshold to broadcast an status update in progress and time.
92 const double kBroadcastThresholdProgress = 0.01; // 1%
93 const int kBroadcastThresholdSeconds = 10;
94
95 // By default autest bypasses scattering. If we want to test scattering,
96 // use kScheduledAUTestURLRequest. The URL used is same in both cases, but
97 // different params are passed to CheckForUpdate().
98 const char kAUTestURLRequest[] = "autest";
99 const char kScheduledAUTestURLRequest[] = "autest-scheduled";
100 } // namespace
101
102 // Turns a generic ErrorCode::kError to a generic error code specific
103 // to |action| (e.g., ErrorCode::kFilesystemVerifierError). If |code| is
104 // not ErrorCode::kError, or the action is not matched, returns |code|
105 // unchanged.
GetErrorCodeForAction(AbstractAction * action,ErrorCode code)106 ErrorCode GetErrorCodeForAction(AbstractAction* action,
107 ErrorCode code) {
108 if (code != ErrorCode::kError)
109 return code;
110
111 const string type = action->Type();
112 if (type == OmahaRequestAction::StaticType())
113 return ErrorCode::kOmahaRequestError;
114 if (type == OmahaResponseHandlerAction::StaticType())
115 return ErrorCode::kOmahaResponseHandlerError;
116 if (type == FilesystemVerifierAction::StaticType())
117 return ErrorCode::kFilesystemVerifierError;
118 if (type == PostinstallRunnerAction::StaticType())
119 return ErrorCode::kPostinstallRunnerError;
120
121 return code;
122 }
123
UpdateAttempter(SystemState * system_state,CertificateChecker * cert_checker,LibCrosProxy * libcros_proxy,org::chromium::debugdProxyInterface * debugd_proxy)124 UpdateAttempter::UpdateAttempter(
125 SystemState* system_state,
126 CertificateChecker* cert_checker,
127 LibCrosProxy* libcros_proxy,
128 org::chromium::debugdProxyInterface* debugd_proxy)
129 : processor_(new ActionProcessor()),
130 system_state_(system_state),
131 cert_checker_(cert_checker),
132 #if USE_LIBCROS
133 chrome_proxy_resolver_(libcros_proxy),
134 #endif // USE_LIBCROS
135 debugd_proxy_(debugd_proxy) {
136 }
137
~UpdateAttempter()138 UpdateAttempter::~UpdateAttempter() {
139 // CertificateChecker might not be initialized in unittests.
140 if (cert_checker_)
141 cert_checker_->SetObserver(nullptr);
142 // Release ourselves as the ActionProcessor's delegate to prevent
143 // re-scheduling the updates due to the processing stopped.
144 processor_->set_delegate(nullptr);
145 }
146
Init()147 void UpdateAttempter::Init() {
148 // Pulling from the SystemState can only be done after construction, since
149 // this is an aggregate of various objects (such as the UpdateAttempter),
150 // which requires them all to be constructed prior to it being used.
151 prefs_ = system_state_->prefs();
152 omaha_request_params_ = system_state_->request_params();
153
154 if (cert_checker_)
155 cert_checker_->SetObserver(this);
156
157 // In case of update_engine restart without a reboot we need to restore the
158 // reboot needed state.
159 if (GetBootTimeAtUpdate(nullptr))
160 status_ = UpdateStatus::UPDATED_NEED_REBOOT;
161 else
162 status_ = UpdateStatus::IDLE;
163
164 #if USE_LIBCROS
165 chrome_proxy_resolver_.Init();
166 #endif // USE_LIBCROS
167 }
168
ScheduleUpdates()169 void UpdateAttempter::ScheduleUpdates() {
170 if (IsUpdateRunningOrScheduled())
171 return;
172
173 chromeos_update_manager::UpdateManager* const update_manager =
174 system_state_->update_manager();
175 CHECK(update_manager);
176 Callback<void(EvalStatus, const UpdateCheckParams&)> callback = Bind(
177 &UpdateAttempter::OnUpdateScheduled, base::Unretained(this));
178 // We limit the async policy request to a reasonably short time, to avoid a
179 // starvation due to a transient bug.
180 update_manager->AsyncPolicyRequest(callback, &Policy::UpdateCheckAllowed);
181 waiting_for_scheduled_check_ = true;
182 }
183
CertificateChecked(ServerToCheck server_to_check,CertificateCheckResult result)184 void UpdateAttempter::CertificateChecked(ServerToCheck server_to_check,
185 CertificateCheckResult result) {
186 metrics::ReportCertificateCheckMetrics(system_state_,
187 server_to_check,
188 result);
189 }
190
CheckAndReportDailyMetrics()191 bool UpdateAttempter::CheckAndReportDailyMetrics() {
192 int64_t stored_value;
193 Time now = system_state_->clock()->GetWallclockTime();
194 if (system_state_->prefs()->Exists(kPrefsDailyMetricsLastReportedAt) &&
195 system_state_->prefs()->GetInt64(kPrefsDailyMetricsLastReportedAt,
196 &stored_value)) {
197 Time last_reported_at = Time::FromInternalValue(stored_value);
198 TimeDelta time_reported_since = now - last_reported_at;
199 if (time_reported_since.InSeconds() < 0) {
200 LOG(WARNING) << "Last reported daily metrics "
201 << utils::FormatTimeDelta(time_reported_since) << " ago "
202 << "which is negative. Either the system clock is wrong or "
203 << "the kPrefsDailyMetricsLastReportedAt state variable "
204 << "is wrong.";
205 // In this case, report daily metrics to reset.
206 } else {
207 if (time_reported_since.InSeconds() < 24*60*60) {
208 LOG(INFO) << "Last reported daily metrics "
209 << utils::FormatTimeDelta(time_reported_since) << " ago.";
210 return false;
211 }
212 LOG(INFO) << "Last reported daily metrics "
213 << utils::FormatTimeDelta(time_reported_since) << " ago, "
214 << "which is more than 24 hours ago.";
215 }
216 }
217
218 LOG(INFO) << "Reporting daily metrics.";
219 system_state_->prefs()->SetInt64(kPrefsDailyMetricsLastReportedAt,
220 now.ToInternalValue());
221
222 ReportOSAge();
223
224 return true;
225 }
226
ReportOSAge()227 void UpdateAttempter::ReportOSAge() {
228 struct stat sb;
229
230 if (system_state_ == nullptr)
231 return;
232
233 if (stat("/etc/lsb-release", &sb) != 0) {
234 PLOG(ERROR) << "Error getting file status for /etc/lsb-release "
235 << "(Note: this may happen in some unit tests)";
236 return;
237 }
238
239 Time lsb_release_timestamp = utils::TimeFromStructTimespec(&sb.st_ctim);
240 Time now = system_state_->clock()->GetWallclockTime();
241 TimeDelta age = now - lsb_release_timestamp;
242 if (age.InSeconds() < 0) {
243 LOG(ERROR) << "The OS age (" << utils::FormatTimeDelta(age)
244 << ") is negative. Maybe the clock is wrong? "
245 << "(Note: this may happen in some unit tests.)";
246 return;
247 }
248
249 metrics::ReportDailyMetrics(system_state_, age);
250 }
251
Update(const string & app_version,const string & omaha_url,const string & target_channel,const string & target_version_prefix,bool obey_proxies,bool interactive)252 void UpdateAttempter::Update(const string& app_version,
253 const string& omaha_url,
254 const string& target_channel,
255 const string& target_version_prefix,
256 bool obey_proxies,
257 bool interactive) {
258 // This is normally called frequently enough so it's appropriate to use as a
259 // hook for reporting daily metrics.
260 // TODO(garnold) This should be hooked to a separate (reliable and consistent)
261 // timeout event.
262 CheckAndReportDailyMetrics();
263
264 // Notify of the new update attempt, clearing prior interactive requests.
265 if (forced_update_pending_callback_.get())
266 forced_update_pending_callback_->Run(false, false);
267
268 fake_update_success_ = false;
269 if (status_ == UpdateStatus::UPDATED_NEED_REBOOT) {
270 // Although we have applied an update, we still want to ping Omaha
271 // to ensure the number of active statistics is accurate.
272 //
273 // Also convey to the UpdateEngine.Check.Result metric that we're
274 // not performing an update check because of this.
275 LOG(INFO) << "Not updating b/c we already updated and we're waiting for "
276 << "reboot, we'll ping Omaha instead";
277 metrics::ReportUpdateCheckMetrics(system_state_,
278 metrics::CheckResult::kRebootPending,
279 metrics::CheckReaction::kUnset,
280 metrics::DownloadErrorCode::kUnset);
281 PingOmaha();
282 return;
283 }
284 if (status_ != UpdateStatus::IDLE) {
285 // Update in progress. Do nothing
286 return;
287 }
288
289 if (!CalculateUpdateParams(app_version,
290 omaha_url,
291 target_channel,
292 target_version_prefix,
293 obey_proxies,
294 interactive)) {
295 return;
296 }
297
298 BuildUpdateActions(interactive);
299
300 SetStatusAndNotify(UpdateStatus::CHECKING_FOR_UPDATE);
301
302 // Update the last check time here; it may be re-updated when an Omaha
303 // response is received, but this will prevent us from repeatedly scheduling
304 // checks in the case where a response is not received.
305 UpdateLastCheckedTime();
306
307 // Just in case we didn't update boot flags yet, make sure they're updated
308 // before any update processing starts.
309 start_action_processor_ = true;
310 UpdateBootFlags();
311 }
312
RefreshDevicePolicy()313 void UpdateAttempter::RefreshDevicePolicy() {
314 // Lazy initialize the policy provider, or reload the latest policy data.
315 if (!policy_provider_.get())
316 policy_provider_.reset(new policy::PolicyProvider());
317 policy_provider_->Reload();
318
319 const policy::DevicePolicy* device_policy = nullptr;
320 if (policy_provider_->device_policy_is_loaded())
321 device_policy = &policy_provider_->GetDevicePolicy();
322
323 if (device_policy)
324 LOG(INFO) << "Device policies/settings present";
325 else
326 LOG(INFO) << "No device policies/settings present.";
327
328 system_state_->set_device_policy(device_policy);
329 system_state_->p2p_manager()->SetDevicePolicy(device_policy);
330 }
331
CalculateP2PParams(bool interactive)332 void UpdateAttempter::CalculateP2PParams(bool interactive) {
333 bool use_p2p_for_downloading = false;
334 bool use_p2p_for_sharing = false;
335
336 // Never use p2p for downloading in interactive checks unless the
337 // developer has opted in for it via a marker file.
338 //
339 // (Why would a developer want to opt in? If he's working on the
340 // update_engine or p2p codebases so he can actually test his
341 // code.).
342
343 if (system_state_ != nullptr) {
344 if (!system_state_->p2p_manager()->IsP2PEnabled()) {
345 LOG(INFO) << "p2p is not enabled - disallowing p2p for both"
346 << " downloading and sharing.";
347 } else {
348 // Allow p2p for sharing, even in interactive checks.
349 use_p2p_for_sharing = true;
350 if (!interactive) {
351 LOG(INFO) << "Non-interactive check - allowing p2p for downloading";
352 use_p2p_for_downloading = true;
353 } else {
354 LOG(INFO) << "Forcibly disabling use of p2p for downloading "
355 << "since this update attempt is interactive.";
356 }
357 }
358 }
359
360 PayloadStateInterface* const payload_state = system_state_->payload_state();
361 payload_state->SetUsingP2PForDownloading(use_p2p_for_downloading);
362 payload_state->SetUsingP2PForSharing(use_p2p_for_sharing);
363 }
364
CalculateUpdateParams(const string & app_version,const string & omaha_url,const string & target_channel,const string & target_version_prefix,bool obey_proxies,bool interactive)365 bool UpdateAttempter::CalculateUpdateParams(const string& app_version,
366 const string& omaha_url,
367 const string& target_channel,
368 const string& target_version_prefix,
369 bool obey_proxies,
370 bool interactive) {
371 http_response_code_ = 0;
372 PayloadStateInterface* const payload_state = system_state_->payload_state();
373
374 // Refresh the policy before computing all the update parameters.
375 RefreshDevicePolicy();
376
377 // Set the target version prefix, if provided.
378 if (!target_version_prefix.empty())
379 omaha_request_params_->set_target_version_prefix(target_version_prefix);
380
381 CalculateScatteringParams(interactive);
382
383 CalculateP2PParams(interactive);
384 if (payload_state->GetUsingP2PForDownloading() ||
385 payload_state->GetUsingP2PForSharing()) {
386 // OK, p2p is to be used - start it and perform housekeeping.
387 if (!StartP2PAndPerformHousekeeping()) {
388 // If this fails, disable p2p for this attempt
389 LOG(INFO) << "Forcibly disabling use of p2p since starting p2p or "
390 << "performing housekeeping failed.";
391 payload_state->SetUsingP2PForDownloading(false);
392 payload_state->SetUsingP2PForSharing(false);
393 }
394 }
395
396 if (!omaha_request_params_->Init(app_version,
397 omaha_url,
398 interactive)) {
399 LOG(ERROR) << "Unable to initialize Omaha request params.";
400 return false;
401 }
402
403 // Set the target channel, if one was provided.
404 if (target_channel.empty()) {
405 LOG(INFO) << "No target channel mandated by policy.";
406 } else {
407 LOG(INFO) << "Setting target channel as mandated: " << target_channel;
408 // Pass in false for powerwash_allowed until we add it to the policy
409 // protobuf.
410 string error_message;
411 if (!omaha_request_params_->SetTargetChannel(target_channel, false,
412 &error_message)) {
413 LOG(ERROR) << "Setting the channel failed: " << error_message;
414 }
415 // Notify observers the target channel change.
416 BroadcastChannel();
417
418 // Since this is the beginning of a new attempt, update the download
419 // channel. The download channel won't be updated until the next attempt,
420 // even if target channel changes meanwhile, so that how we'll know if we
421 // should cancel the current download attempt if there's such a change in
422 // target channel.
423 omaha_request_params_->UpdateDownloadChannel();
424 }
425
426 LOG(INFO) << "target_version_prefix = "
427 << omaha_request_params_->target_version_prefix()
428 << ", scatter_factor_in_seconds = "
429 << utils::FormatSecs(scatter_factor_.InSeconds());
430
431 LOG(INFO) << "Wall Clock Based Wait Enabled = "
432 << omaha_request_params_->wall_clock_based_wait_enabled()
433 << ", Update Check Count Wait Enabled = "
434 << omaha_request_params_->update_check_count_wait_enabled()
435 << ", Waiting Period = " << utils::FormatSecs(
436 omaha_request_params_->waiting_period().InSeconds());
437
438 LOG(INFO) << "Use p2p For Downloading = "
439 << payload_state->GetUsingP2PForDownloading()
440 << ", Use p2p For Sharing = "
441 << payload_state->GetUsingP2PForSharing();
442
443 obeying_proxies_ = true;
444 if (obey_proxies || proxy_manual_checks_ == 0) {
445 LOG(INFO) << "forced to obey proxies";
446 // If forced to obey proxies, every 20th request will not use proxies
447 proxy_manual_checks_++;
448 LOG(INFO) << "proxy manual checks: " << proxy_manual_checks_;
449 if (proxy_manual_checks_ >= kMaxConsecutiveObeyProxyRequests) {
450 proxy_manual_checks_ = 0;
451 obeying_proxies_ = false;
452 }
453 } else if (base::RandInt(0, 4) == 0) {
454 obeying_proxies_ = false;
455 }
456 LOG_IF(INFO, !obeying_proxies_) << "To help ensure updates work, this update "
457 "check we are ignoring the proxy settings and using "
458 "direct connections.";
459
460 DisableDeltaUpdateIfNeeded();
461 return true;
462 }
463
CalculateScatteringParams(bool interactive)464 void UpdateAttempter::CalculateScatteringParams(bool interactive) {
465 // Take a copy of the old scatter value before we update it, as
466 // we need to update the waiting period if this value changes.
467 TimeDelta old_scatter_factor = scatter_factor_;
468 const policy::DevicePolicy* device_policy = system_state_->device_policy();
469 if (device_policy) {
470 int64_t new_scatter_factor_in_secs = 0;
471 device_policy->GetScatterFactorInSeconds(&new_scatter_factor_in_secs);
472 if (new_scatter_factor_in_secs < 0) // sanitize input, just in case.
473 new_scatter_factor_in_secs = 0;
474 scatter_factor_ = TimeDelta::FromSeconds(new_scatter_factor_in_secs);
475 }
476
477 bool is_scatter_enabled = false;
478 if (scatter_factor_.InSeconds() == 0) {
479 LOG(INFO) << "Scattering disabled since scatter factor is set to 0";
480 } else if (interactive) {
481 LOG(INFO) << "Scattering disabled as this is an interactive update check";
482 } else if (!system_state_->hardware()->IsOOBEComplete(nullptr)) {
483 LOG(INFO) << "Scattering disabled since OOBE is not complete yet";
484 } else {
485 is_scatter_enabled = true;
486 LOG(INFO) << "Scattering is enabled";
487 }
488
489 if (is_scatter_enabled) {
490 // This means the scattering policy is turned on.
491 // Now check if we need to update the waiting period. The two cases
492 // in which we'd need to update the waiting period are:
493 // 1. First time in process or a scheduled check after a user-initiated one.
494 // (omaha_request_params_->waiting_period will be zero in this case).
495 // 2. Admin has changed the scattering policy value.
496 // (new scattering value will be different from old one in this case).
497 int64_t wait_period_in_secs = 0;
498 if (omaha_request_params_->waiting_period().InSeconds() == 0) {
499 // First case. Check if we have a suitable value to set for
500 // the waiting period.
501 if (prefs_->GetInt64(kPrefsWallClockWaitPeriod, &wait_period_in_secs) &&
502 wait_period_in_secs > 0 &&
503 wait_period_in_secs <= scatter_factor_.InSeconds()) {
504 // This means:
505 // 1. There's a persisted value for the waiting period available.
506 // 2. And that persisted value is still valid.
507 // So, in this case, we should reuse the persisted value instead of
508 // generating a new random value to improve the chances of a good
509 // distribution for scattering.
510 omaha_request_params_->set_waiting_period(
511 TimeDelta::FromSeconds(wait_period_in_secs));
512 LOG(INFO) << "Using persisted wall-clock waiting period: " <<
513 utils::FormatSecs(
514 omaha_request_params_->waiting_period().InSeconds());
515 } else {
516 // This means there's no persisted value for the waiting period
517 // available or its value is invalid given the new scatter_factor value.
518 // So, we should go ahead and regenerate a new value for the
519 // waiting period.
520 LOG(INFO) << "Persisted value not present or not valid ("
521 << utils::FormatSecs(wait_period_in_secs)
522 << ") for wall-clock waiting period.";
523 GenerateNewWaitingPeriod();
524 }
525 } else if (scatter_factor_ != old_scatter_factor) {
526 // This means there's already a waiting period value, but we detected
527 // a change in the scattering policy value. So, we should regenerate the
528 // waiting period to make sure it's within the bounds of the new scatter
529 // factor value.
530 GenerateNewWaitingPeriod();
531 } else {
532 // Neither the first time scattering is enabled nor the scattering value
533 // changed. Nothing to do.
534 LOG(INFO) << "Keeping current wall-clock waiting period: " <<
535 utils::FormatSecs(
536 omaha_request_params_->waiting_period().InSeconds());
537 }
538
539 // The invariant at this point is that omaha_request_params_->waiting_period
540 // is non-zero no matter which path we took above.
541 LOG_IF(ERROR, omaha_request_params_->waiting_period().InSeconds() == 0)
542 << "Waiting Period should NOT be zero at this point!!!";
543
544 // Since scattering is enabled, wall clock based wait will always be
545 // enabled.
546 omaha_request_params_->set_wall_clock_based_wait_enabled(true);
547
548 // If we don't have any issues in accessing the file system to update
549 // the update check count value, we'll turn that on as well.
550 bool decrement_succeeded = DecrementUpdateCheckCount();
551 omaha_request_params_->set_update_check_count_wait_enabled(
552 decrement_succeeded);
553 } else {
554 // This means the scattering feature is turned off or disabled for
555 // this particular update check. Make sure to disable
556 // all the knobs and artifacts so that we don't invoke any scattering
557 // related code.
558 omaha_request_params_->set_wall_clock_based_wait_enabled(false);
559 omaha_request_params_->set_update_check_count_wait_enabled(false);
560 omaha_request_params_->set_waiting_period(TimeDelta::FromSeconds(0));
561 prefs_->Delete(kPrefsWallClockWaitPeriod);
562 prefs_->Delete(kPrefsUpdateCheckCount);
563 // Don't delete the UpdateFirstSeenAt file as we don't want manual checks
564 // that result in no-updates (e.g. due to server side throttling) to
565 // cause update starvation by having the client generate a new
566 // UpdateFirstSeenAt for each scheduled check that follows a manual check.
567 }
568 }
569
GenerateNewWaitingPeriod()570 void UpdateAttempter::GenerateNewWaitingPeriod() {
571 omaha_request_params_->set_waiting_period(TimeDelta::FromSeconds(
572 base::RandInt(1, scatter_factor_.InSeconds())));
573
574 LOG(INFO) << "Generated new wall-clock waiting period: " << utils::FormatSecs(
575 omaha_request_params_->waiting_period().InSeconds());
576
577 // Do a best-effort to persist this in all cases. Even if the persistence
578 // fails, we'll still be able to scatter based on our in-memory value.
579 // The persistence only helps in ensuring a good overall distribution
580 // across multiple devices if they tend to reboot too often.
581 system_state_->payload_state()->SetScatteringWaitPeriod(
582 omaha_request_params_->waiting_period());
583 }
584
BuildPostInstallActions(InstallPlanAction * previous_action)585 void UpdateAttempter::BuildPostInstallActions(
586 InstallPlanAction* previous_action) {
587 shared_ptr<PostinstallRunnerAction> postinstall_runner_action(
588 new PostinstallRunnerAction(system_state_->boot_control()));
589 postinstall_runner_action->set_delegate(this);
590 actions_.push_back(shared_ptr<AbstractAction>(postinstall_runner_action));
591 BondActions(previous_action,
592 postinstall_runner_action.get());
593 }
594
BuildUpdateActions(bool interactive)595 void UpdateAttempter::BuildUpdateActions(bool interactive) {
596 CHECK(!processor_->IsRunning());
597 processor_->set_delegate(this);
598
599 // Actions:
600 std::unique_ptr<LibcurlHttpFetcher> update_check_fetcher(
601 new LibcurlHttpFetcher(GetProxyResolver(), system_state_->hardware()));
602 update_check_fetcher->set_server_to_check(ServerToCheck::kUpdate);
603 // Try harder to connect to the network, esp when not interactive.
604 // See comment in libcurl_http_fetcher.cc.
605 update_check_fetcher->set_no_network_max_retries(interactive ? 1 : 3);
606 shared_ptr<OmahaRequestAction> update_check_action(
607 new OmahaRequestAction(system_state_,
608 nullptr,
609 std::move(update_check_fetcher),
610 false));
611 shared_ptr<OmahaResponseHandlerAction> response_handler_action(
612 new OmahaResponseHandlerAction(system_state_));
613 shared_ptr<FilesystemVerifierAction> src_filesystem_verifier_action(
614 new FilesystemVerifierAction(system_state_->boot_control(),
615 VerifierMode::kComputeSourceHash));
616
617 shared_ptr<OmahaRequestAction> download_started_action(
618 new OmahaRequestAction(system_state_,
619 new OmahaEvent(
620 OmahaEvent::kTypeUpdateDownloadStarted),
621 brillo::make_unique_ptr(new LibcurlHttpFetcher(
622 GetProxyResolver(),
623 system_state_->hardware())),
624 false));
625
626 LibcurlHttpFetcher* download_fetcher =
627 new LibcurlHttpFetcher(GetProxyResolver(), system_state_->hardware());
628 download_fetcher->set_server_to_check(ServerToCheck::kDownload);
629 shared_ptr<DownloadAction> download_action(new DownloadAction(
630 prefs_,
631 system_state_->boot_control(),
632 system_state_->hardware(),
633 system_state_,
634 new MultiRangeHttpFetcher(download_fetcher))); // passes ownership
635 shared_ptr<OmahaRequestAction> download_finished_action(
636 new OmahaRequestAction(
637 system_state_,
638 new OmahaEvent(OmahaEvent::kTypeUpdateDownloadFinished),
639 brillo::make_unique_ptr(
640 new LibcurlHttpFetcher(GetProxyResolver(),
641 system_state_->hardware())),
642 false));
643 shared_ptr<FilesystemVerifierAction> dst_filesystem_verifier_action(
644 new FilesystemVerifierAction(system_state_->boot_control(),
645 VerifierMode::kVerifyTargetHash));
646 shared_ptr<OmahaRequestAction> update_complete_action(
647 new OmahaRequestAction(
648 system_state_,
649 new OmahaEvent(OmahaEvent::kTypeUpdateComplete),
650 brillo::make_unique_ptr(
651 new LibcurlHttpFetcher(GetProxyResolver(),
652 system_state_->hardware())),
653 false));
654
655 download_action->set_delegate(this);
656 response_handler_action_ = response_handler_action;
657 download_action_ = download_action;
658
659 actions_.push_back(shared_ptr<AbstractAction>(update_check_action));
660 actions_.push_back(shared_ptr<AbstractAction>(response_handler_action));
661 actions_.push_back(shared_ptr<AbstractAction>(
662 src_filesystem_verifier_action));
663 actions_.push_back(shared_ptr<AbstractAction>(download_started_action));
664 actions_.push_back(shared_ptr<AbstractAction>(download_action));
665 actions_.push_back(shared_ptr<AbstractAction>(download_finished_action));
666 actions_.push_back(shared_ptr<AbstractAction>(
667 dst_filesystem_verifier_action));
668
669 // Bond them together. We have to use the leaf-types when calling
670 // BondActions().
671 BondActions(update_check_action.get(),
672 response_handler_action.get());
673 BondActions(response_handler_action.get(),
674 src_filesystem_verifier_action.get());
675 BondActions(src_filesystem_verifier_action.get(),
676 download_action.get());
677 BondActions(download_action.get(),
678 dst_filesystem_verifier_action.get());
679 BuildPostInstallActions(dst_filesystem_verifier_action.get());
680
681 actions_.push_back(shared_ptr<AbstractAction>(update_complete_action));
682
683 // Enqueue the actions
684 for (const shared_ptr<AbstractAction>& action : actions_) {
685 processor_->EnqueueAction(action.get());
686 }
687 }
688
Rollback(bool powerwash)689 bool UpdateAttempter::Rollback(bool powerwash) {
690 if (!CanRollback()) {
691 return false;
692 }
693
694 // Extra check for enterprise-enrolled devices since they don't support
695 // powerwash.
696 if (powerwash) {
697 // Enterprise-enrolled devices have an empty owner in their device policy.
698 string owner;
699 RefreshDevicePolicy();
700 const policy::DevicePolicy* device_policy = system_state_->device_policy();
701 if (device_policy && (!device_policy->GetOwner(&owner) || owner.empty())) {
702 LOG(ERROR) << "Enterprise device detected. "
703 << "Cannot perform a powerwash for enterprise devices.";
704 return false;
705 }
706 }
707
708 processor_->set_delegate(this);
709
710 // Initialize the default request params.
711 if (!omaha_request_params_->Init("", "", true)) {
712 LOG(ERROR) << "Unable to initialize Omaha request params.";
713 return false;
714 }
715
716 LOG(INFO) << "Setting rollback options.";
717 InstallPlan install_plan;
718
719 install_plan.target_slot = GetRollbackSlot();
720 install_plan.source_slot = system_state_->boot_control()->GetCurrentSlot();
721
722 TEST_AND_RETURN_FALSE(
723 install_plan.LoadPartitionsFromSlots(system_state_->boot_control()));
724 install_plan.powerwash_required = powerwash;
725
726 LOG(INFO) << "Using this install plan:";
727 install_plan.Dump();
728
729 shared_ptr<InstallPlanAction> install_plan_action(
730 new InstallPlanAction(install_plan));
731 actions_.push_back(shared_ptr<AbstractAction>(install_plan_action));
732
733 BuildPostInstallActions(install_plan_action.get());
734
735 // Enqueue the actions
736 for (const shared_ptr<AbstractAction>& action : actions_) {
737 processor_->EnqueueAction(action.get());
738 }
739
740 // Update the payload state for Rollback.
741 system_state_->payload_state()->Rollback();
742
743 SetStatusAndNotify(UpdateStatus::ATTEMPTING_ROLLBACK);
744
745 // Just in case we didn't update boot flags yet, make sure they're updated
746 // before any update processing starts. This also schedules the start of the
747 // actions we just posted.
748 start_action_processor_ = true;
749 UpdateBootFlags();
750 return true;
751 }
752
CanRollback() const753 bool UpdateAttempter::CanRollback() const {
754 // We can only rollback if the update_engine isn't busy and we have a valid
755 // rollback partition.
756 return (status_ == UpdateStatus::IDLE &&
757 GetRollbackSlot() != BootControlInterface::kInvalidSlot);
758 }
759
GetRollbackSlot() const760 BootControlInterface::Slot UpdateAttempter::GetRollbackSlot() const {
761 LOG(INFO) << "UpdateAttempter::GetRollbackSlot";
762 const unsigned int num_slots = system_state_->boot_control()->GetNumSlots();
763 const BootControlInterface::Slot current_slot =
764 system_state_->boot_control()->GetCurrentSlot();
765
766 LOG(INFO) << " Installed slots: " << num_slots;
767 LOG(INFO) << " Booted from slot: "
768 << BootControlInterface::SlotName(current_slot);
769
770 if (current_slot == BootControlInterface::kInvalidSlot || num_slots < 2) {
771 LOG(INFO) << "Device is not updateable.";
772 return BootControlInterface::kInvalidSlot;
773 }
774
775 vector<BootControlInterface::Slot> bootable_slots;
776 for (BootControlInterface::Slot slot = 0; slot < num_slots; slot++) {
777 if (slot != current_slot &&
778 system_state_->boot_control()->IsSlotBootable(slot)) {
779 LOG(INFO) << "Found bootable slot "
780 << BootControlInterface::SlotName(slot);
781 return slot;
782 }
783 }
784 LOG(INFO) << "No other bootable slot found.";
785 return BootControlInterface::kInvalidSlot;
786 }
787
CheckForUpdate(const string & app_version,const string & omaha_url,bool interactive)788 void UpdateAttempter::CheckForUpdate(const string& app_version,
789 const string& omaha_url,
790 bool interactive) {
791 LOG(INFO) << "Forced update check requested.";
792 forced_app_version_.clear();
793 forced_omaha_url_.clear();
794
795 // Certain conditions must be met to allow setting custom version and update
796 // server URLs. However, kScheduledAUTestURLRequest and kAUTestURLRequest are
797 // always allowed regardless of device state.
798 if (IsAnyUpdateSourceAllowed()) {
799 forced_app_version_ = app_version;
800 forced_omaha_url_ = omaha_url;
801 }
802 if (omaha_url == kScheduledAUTestURLRequest) {
803 forced_omaha_url_ = constants::kOmahaDefaultAUTestURL;
804 // Pretend that it's not user-initiated even though it is,
805 // so as to test scattering logic, etc. which get kicked off
806 // only in scheduled update checks.
807 interactive = false;
808 } else if (omaha_url == kAUTestURLRequest) {
809 forced_omaha_url_ = constants::kOmahaDefaultAUTestURL;
810 }
811
812 if (forced_update_pending_callback_.get()) {
813 // Make sure that a scheduling request is made prior to calling the forced
814 // update pending callback.
815 ScheduleUpdates();
816 forced_update_pending_callback_->Run(true, interactive);
817 }
818 }
819
RebootIfNeeded()820 bool UpdateAttempter::RebootIfNeeded() {
821 if (status_ != UpdateStatus::UPDATED_NEED_REBOOT) {
822 LOG(INFO) << "Reboot requested, but status is "
823 << UpdateStatusToString(status_) << ", so not rebooting.";
824 return false;
825 }
826
827 if (USE_POWER_MANAGEMENT && RequestPowerManagerReboot())
828 return true;
829
830 return RebootDirectly();
831 }
832
WriteUpdateCompletedMarker()833 void UpdateAttempter::WriteUpdateCompletedMarker() {
834 string boot_id;
835 if (!utils::GetBootId(&boot_id))
836 return;
837 prefs_->SetString(kPrefsUpdateCompletedOnBootId, boot_id);
838
839 int64_t value = system_state_->clock()->GetBootTime().ToInternalValue();
840 prefs_->SetInt64(kPrefsUpdateCompletedBootTime, value);
841 }
842
RequestPowerManagerReboot()843 bool UpdateAttempter::RequestPowerManagerReboot() {
844 org::chromium::PowerManagerProxyInterface* power_manager_proxy =
845 system_state_->power_manager_proxy();
846 if (!power_manager_proxy) {
847 LOG(WARNING) << "No PowerManager proxy defined, skipping reboot.";
848 return false;
849 }
850 LOG(INFO) << "Calling " << power_manager::kPowerManagerInterface << "."
851 << power_manager::kRequestRestartMethod;
852 brillo::ErrorPtr error;
853 return power_manager_proxy->RequestRestart(
854 power_manager::REQUEST_RESTART_FOR_UPDATE, &error);
855 }
856
RebootDirectly()857 bool UpdateAttempter::RebootDirectly() {
858 vector<string> command;
859 command.push_back("/sbin/shutdown");
860 command.push_back("-r");
861 command.push_back("now");
862 LOG(INFO) << "Running \"" << base::JoinString(command, " ") << "\"";
863 int rc = 0;
864 Subprocess::SynchronousExec(command, &rc, nullptr);
865 return rc == 0;
866 }
867
OnUpdateScheduled(EvalStatus status,const UpdateCheckParams & params)868 void UpdateAttempter::OnUpdateScheduled(EvalStatus status,
869 const UpdateCheckParams& params) {
870 waiting_for_scheduled_check_ = false;
871
872 if (status == EvalStatus::kSucceeded) {
873 if (!params.updates_enabled) {
874 LOG(WARNING) << "Updates permanently disabled.";
875 // Signal disabled status, then switch right back to idle. This is
876 // necessary for ensuring that observers waiting for a signal change will
877 // actually notice one on subsequent calls. Note that we don't need to
878 // re-schedule a check in this case as updates are permanently disabled;
879 // further (forced) checks may still initiate a scheduling call.
880 SetStatusAndNotify(UpdateStatus::DISABLED);
881 SetStatusAndNotify(UpdateStatus::IDLE);
882 return;
883 }
884
885 LOG(INFO) << "Running "
886 << (params.is_interactive ? "interactive" : "periodic")
887 << " update.";
888
889 string app_version, omaha_url;
890 if (params.is_interactive) {
891 app_version = forced_app_version_;
892 omaha_url = forced_omaha_url_;
893 }
894
895 Update(app_version, omaha_url, params.target_channel,
896 params.target_version_prefix, false, params.is_interactive);
897 } else {
898 LOG(WARNING)
899 << "Update check scheduling failed (possibly timed out); retrying.";
900 ScheduleUpdates();
901 }
902
903 // This check ensures that future update checks will be or are already
904 // scheduled. The check should never fail. A check failure means that there's
905 // a bug that will most likely prevent further automatic update checks. It
906 // seems better to crash in such cases and restart the update_engine daemon
907 // into, hopefully, a known good state.
908 CHECK(IsUpdateRunningOrScheduled());
909 }
910
UpdateLastCheckedTime()911 void UpdateAttempter::UpdateLastCheckedTime() {
912 last_checked_time_ = system_state_->clock()->GetWallclockTime().ToTimeT();
913 }
914
915 // Delegate methods:
ProcessingDone(const ActionProcessor * processor,ErrorCode code)916 void UpdateAttempter::ProcessingDone(const ActionProcessor* processor,
917 ErrorCode code) {
918 LOG(INFO) << "Processing Done.";
919 actions_.clear();
920
921 // Reset cpu shares back to normal.
922 cpu_limiter_.StopLimiter();
923
924 if (status_ == UpdateStatus::REPORTING_ERROR_EVENT) {
925 LOG(INFO) << "Error event sent.";
926
927 // Inform scheduler of new status;
928 SetStatusAndNotify(UpdateStatus::IDLE);
929 ScheduleUpdates();
930
931 if (!fake_update_success_) {
932 return;
933 }
934 LOG(INFO) << "Booted from FW B and tried to install new firmware, "
935 "so requesting reboot from user.";
936 }
937
938 if (code == ErrorCode::kSuccess) {
939 WriteUpdateCompletedMarker();
940 prefs_->SetInt64(kPrefsDeltaUpdateFailures, 0);
941 prefs_->SetString(kPrefsPreviousVersion,
942 omaha_request_params_->app_version());
943 DeltaPerformer::ResetUpdateProgress(prefs_, false);
944
945 system_state_->payload_state()->UpdateSucceeded();
946
947 // Since we're done with scattering fully at this point, this is the
948 // safest point delete the state files, as we're sure that the status is
949 // set to reboot (which means no more updates will be applied until reboot)
950 // This deletion is required for correctness as we want the next update
951 // check to re-create a new random number for the update check count.
952 // Similarly, we also delete the wall-clock-wait period that was persisted
953 // so that we start with a new random value for the next update check
954 // after reboot so that the same device is not favored or punished in any
955 // way.
956 prefs_->Delete(kPrefsUpdateCheckCount);
957 system_state_->payload_state()->SetScatteringWaitPeriod(TimeDelta());
958 prefs_->Delete(kPrefsUpdateFirstSeenAt);
959
960 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
961 ScheduleUpdates();
962 LOG(INFO) << "Update successfully applied, waiting to reboot.";
963
964 // This pointer is null during rollback operations, and the stats
965 // don't make much sense then anyway.
966 if (response_handler_action_) {
967 const InstallPlan& install_plan =
968 response_handler_action_->install_plan();
969
970 // Generate an unique payload identifier.
971 const string target_version_uid =
972 install_plan.payload_hash + ":" + install_plan.metadata_signature;
973
974 // Expect to reboot into the new version to send the proper metric during
975 // next boot.
976 system_state_->payload_state()->ExpectRebootInNewVersion(
977 target_version_uid);
978 } else {
979 // If we just finished a rollback, then we expect to have no Omaha
980 // response. Otherwise, it's an error.
981 if (system_state_->payload_state()->GetRollbackVersion().empty()) {
982 LOG(ERROR) << "Can't send metrics because expected "
983 "response_handler_action_ missing.";
984 }
985 }
986 return;
987 }
988
989 if (ScheduleErrorEventAction()) {
990 return;
991 }
992 LOG(INFO) << "No update.";
993 SetStatusAndNotify(UpdateStatus::IDLE);
994 ScheduleUpdates();
995 }
996
ProcessingStopped(const ActionProcessor * processor)997 void UpdateAttempter::ProcessingStopped(const ActionProcessor* processor) {
998 // Reset cpu shares back to normal.
999 cpu_limiter_.StopLimiter();
1000 download_progress_ = 0.0;
1001 SetStatusAndNotify(UpdateStatus::IDLE);
1002 ScheduleUpdates();
1003 actions_.clear();
1004 error_event_.reset(nullptr);
1005 }
1006
1007 // Called whenever an action has finished processing, either successfully
1008 // or otherwise.
ActionCompleted(ActionProcessor * processor,AbstractAction * action,ErrorCode code)1009 void UpdateAttempter::ActionCompleted(ActionProcessor* processor,
1010 AbstractAction* action,
1011 ErrorCode code) {
1012 // Reset download progress regardless of whether or not the download
1013 // action succeeded. Also, get the response code from HTTP request
1014 // actions (update download as well as the initial update check
1015 // actions).
1016 const string type = action->Type();
1017 if (type == DownloadAction::StaticType()) {
1018 download_progress_ = 0.0;
1019 DownloadAction* download_action = static_cast<DownloadAction*>(action);
1020 http_response_code_ = download_action->GetHTTPResponseCode();
1021 } else if (type == OmahaRequestAction::StaticType()) {
1022 OmahaRequestAction* omaha_request_action =
1023 static_cast<OmahaRequestAction*>(action);
1024 // If the request is not an event, then it's the update-check.
1025 if (!omaha_request_action->IsEvent()) {
1026 http_response_code_ = omaha_request_action->GetHTTPResponseCode();
1027
1028 // Record the number of consecutive failed update checks.
1029 if (http_response_code_ == kHttpResponseInternalServerError ||
1030 http_response_code_ == kHttpResponseServiceUnavailable) {
1031 consecutive_failed_update_checks_++;
1032 } else {
1033 consecutive_failed_update_checks_ = 0;
1034 }
1035
1036 // Store the server-dictated poll interval, if any.
1037 server_dictated_poll_interval_ =
1038 std::max(0, omaha_request_action->GetOutputObject().poll_interval);
1039 }
1040 }
1041 if (code != ErrorCode::kSuccess) {
1042 // If the current state is at or past the download phase, count the failure
1043 // in case a switch to full update becomes necessary. Ignore network
1044 // transfer timeouts and failures.
1045 if (status_ >= UpdateStatus::DOWNLOADING &&
1046 code != ErrorCode::kDownloadTransferError) {
1047 MarkDeltaUpdateFailure();
1048 }
1049 // On failure, schedule an error event to be sent to Omaha.
1050 CreatePendingErrorEvent(action, code);
1051 return;
1052 }
1053 // Find out which action completed.
1054 if (type == OmahaResponseHandlerAction::StaticType()) {
1055 // Note that the status will be updated to DOWNLOADING when some bytes get
1056 // actually downloaded from the server and the BytesReceived callback is
1057 // invoked. This avoids notifying the user that a download has started in
1058 // cases when the server and the client are unable to initiate the download.
1059 CHECK(action == response_handler_action_.get());
1060 const InstallPlan& plan = response_handler_action_->install_plan();
1061 UpdateLastCheckedTime();
1062 new_version_ = plan.version;
1063 new_payload_size_ = plan.payload_size;
1064 SetupDownload();
1065 cpu_limiter_.StartLimiter();
1066 SetStatusAndNotify(UpdateStatus::UPDATE_AVAILABLE);
1067 } else if (type == DownloadAction::StaticType()) {
1068 SetStatusAndNotify(UpdateStatus::FINALIZING);
1069 }
1070 }
1071
BytesReceived(uint64_t bytes_progressed,uint64_t bytes_received,uint64_t total)1072 void UpdateAttempter::BytesReceived(uint64_t bytes_progressed,
1073 uint64_t bytes_received,
1074 uint64_t total) {
1075 // The PayloadState keeps track of how many bytes were actually downloaded
1076 // from a given URL for the URL skipping logic.
1077 system_state_->payload_state()->DownloadProgress(bytes_progressed);
1078
1079 double progress = 0;
1080 if (total)
1081 progress = static_cast<double>(bytes_received) / static_cast<double>(total);
1082 if (status_ != UpdateStatus::DOWNLOADING || bytes_received == total) {
1083 download_progress_ = progress;
1084 SetStatusAndNotify(UpdateStatus::DOWNLOADING);
1085 } else {
1086 ProgressUpdate(progress);
1087 }
1088 }
1089
DownloadComplete()1090 void UpdateAttempter::DownloadComplete() {
1091 system_state_->payload_state()->DownloadComplete();
1092 }
1093
OnCheckForUpdates(brillo::ErrorPtr * error)1094 bool UpdateAttempter::OnCheckForUpdates(brillo::ErrorPtr* error) {
1095 CheckForUpdate(
1096 "" /* app_version */, "" /* omaha_url */, true /* interactive */);
1097 return true;
1098 }
1099
OnTrackChannel(const string & channel,brillo::ErrorPtr * error)1100 bool UpdateAttempter::OnTrackChannel(const string& channel,
1101 brillo::ErrorPtr* error) {
1102 LOG(INFO) << "Setting destination channel to: " << channel;
1103 string error_message;
1104 if (!system_state_->request_params()->SetTargetChannel(
1105 channel, false /* powerwash_allowed */, &error_message)) {
1106 brillo::Error::AddTo(error,
1107 FROM_HERE,
1108 brillo::errors::dbus::kDomain,
1109 "set_target_error",
1110 error_message);
1111 return false;
1112 }
1113 // Notify observers the target channel change.
1114 BroadcastChannel();
1115 return true;
1116 }
1117
GetWeaveState(int64_t * last_checked_time,double * progress,UpdateStatus * update_status,string * current_channel,string * tracking_channel)1118 bool UpdateAttempter::GetWeaveState(int64_t* last_checked_time,
1119 double* progress,
1120 UpdateStatus* update_status,
1121 string* current_channel,
1122 string* tracking_channel) {
1123 *last_checked_time = last_checked_time_;
1124 *progress = download_progress_;
1125 *update_status = status_;
1126 OmahaRequestParams* rp = system_state_->request_params();
1127 *current_channel = rp->current_channel();
1128 *tracking_channel = rp->target_channel();
1129 return true;
1130 }
1131
ProgressUpdate(double progress)1132 void UpdateAttempter::ProgressUpdate(double progress) {
1133 // Self throttle based on progress. Also send notifications if progress is
1134 // too slow.
1135 if (progress == 1.0 ||
1136 progress - download_progress_ >= kBroadcastThresholdProgress ||
1137 TimeTicks::Now() - last_notify_time_ >=
1138 TimeDelta::FromSeconds(kBroadcastThresholdSeconds)) {
1139 download_progress_ = progress;
1140 BroadcastStatus();
1141 }
1142 }
1143
ResetStatus()1144 bool UpdateAttempter::ResetStatus() {
1145 LOG(INFO) << "Attempting to reset state from "
1146 << UpdateStatusToString(status_) << " to UpdateStatus::IDLE";
1147
1148 switch (status_) {
1149 case UpdateStatus::IDLE:
1150 // no-op.
1151 return true;
1152
1153 case UpdateStatus::UPDATED_NEED_REBOOT: {
1154 bool ret_value = true;
1155 status_ = UpdateStatus::IDLE;
1156
1157 // Remove the reboot marker so that if the machine is rebooted
1158 // after resetting to idle state, it doesn't go back to
1159 // UpdateStatus::UPDATED_NEED_REBOOT state.
1160 ret_value = prefs_->Delete(kPrefsUpdateCompletedOnBootId) && ret_value;
1161 ret_value = prefs_->Delete(kPrefsUpdateCompletedBootTime) && ret_value;
1162
1163 // Update the boot flags so the current slot has higher priority.
1164 BootControlInterface* boot_control = system_state_->boot_control();
1165 if (!boot_control->SetActiveBootSlot(boot_control->GetCurrentSlot()))
1166 ret_value = false;
1167
1168 // Notify the PayloadState that the successful payload was canceled.
1169 system_state_->payload_state()->ResetUpdateStatus();
1170
1171 // The previous version is used to report back to omaha after reboot that
1172 // we actually rebooted into the new version from this "prev-version". We
1173 // need to clear out this value now to prevent it being sent on the next
1174 // updatecheck request.
1175 ret_value = prefs_->SetString(kPrefsPreviousVersion, "") && ret_value;
1176
1177 LOG(INFO) << "Reset status " << (ret_value ? "successful" : "failed");
1178 return ret_value;
1179 }
1180
1181 default:
1182 LOG(ERROR) << "Reset not allowed in this state.";
1183 return false;
1184 }
1185 }
1186
GetStatus(int64_t * last_checked_time,double * progress,string * current_operation,string * new_version,int64_t * new_payload_size)1187 bool UpdateAttempter::GetStatus(int64_t* last_checked_time,
1188 double* progress,
1189 string* current_operation,
1190 string* new_version,
1191 int64_t* new_payload_size) {
1192 *last_checked_time = last_checked_time_;
1193 *progress = download_progress_;
1194 *current_operation = UpdateStatusToString(status_);
1195 *new_version = new_version_;
1196 *new_payload_size = new_payload_size_;
1197 return true;
1198 }
1199
UpdateBootFlags()1200 void UpdateAttempter::UpdateBootFlags() {
1201 if (update_boot_flags_running_) {
1202 LOG(INFO) << "Update boot flags running, nothing to do.";
1203 return;
1204 }
1205 if (updated_boot_flags_) {
1206 LOG(INFO) << "Already updated boot flags. Skipping.";
1207 if (start_action_processor_) {
1208 ScheduleProcessingStart();
1209 }
1210 return;
1211 }
1212 // This is purely best effort. Failures should be logged by Subprocess. Run
1213 // the script asynchronously to avoid blocking the event loop regardless of
1214 // the script runtime.
1215 update_boot_flags_running_ = true;
1216 LOG(INFO) << "Marking booted slot as good.";
1217 if (!system_state_->boot_control()->MarkBootSuccessfulAsync(Bind(
1218 &UpdateAttempter::CompleteUpdateBootFlags, base::Unretained(this)))) {
1219 LOG(ERROR) << "Failed to mark current boot as successful.";
1220 CompleteUpdateBootFlags(false);
1221 }
1222 }
1223
CompleteUpdateBootFlags(bool successful)1224 void UpdateAttempter::CompleteUpdateBootFlags(bool successful) {
1225 update_boot_flags_running_ = false;
1226 updated_boot_flags_ = true;
1227 if (start_action_processor_) {
1228 ScheduleProcessingStart();
1229 }
1230 }
1231
BroadcastStatus()1232 void UpdateAttempter::BroadcastStatus() {
1233 for (const auto& observer : service_observers_) {
1234 observer->SendStatusUpdate(last_checked_time_,
1235 download_progress_,
1236 status_,
1237 new_version_,
1238 new_payload_size_);
1239 }
1240 last_notify_time_ = TimeTicks::Now();
1241 }
1242
BroadcastChannel()1243 void UpdateAttempter::BroadcastChannel() {
1244 for (const auto& observer : service_observers_) {
1245 observer->SendChannelChangeUpdate(
1246 system_state_->request_params()->target_channel());
1247 }
1248 }
1249
GetErrorCodeFlags()1250 uint32_t UpdateAttempter::GetErrorCodeFlags() {
1251 uint32_t flags = 0;
1252
1253 if (!system_state_->hardware()->IsNormalBootMode())
1254 flags |= static_cast<uint32_t>(ErrorCode::kDevModeFlag);
1255
1256 if (response_handler_action_.get() &&
1257 response_handler_action_->install_plan().is_resume)
1258 flags |= static_cast<uint32_t>(ErrorCode::kResumedFlag);
1259
1260 if (!system_state_->hardware()->IsOfficialBuild())
1261 flags |= static_cast<uint32_t>(ErrorCode::kTestImageFlag);
1262
1263 if (omaha_request_params_->update_url() !=
1264 constants::kOmahaDefaultProductionURL) {
1265 flags |= static_cast<uint32_t>(ErrorCode::kTestOmahaUrlFlag);
1266 }
1267
1268 return flags;
1269 }
1270
ShouldCancel(ErrorCode * cancel_reason)1271 bool UpdateAttempter::ShouldCancel(ErrorCode* cancel_reason) {
1272 // Check if the channel we're attempting to update to is the same as the
1273 // target channel currently chosen by the user.
1274 OmahaRequestParams* params = system_state_->request_params();
1275 if (params->download_channel() != params->target_channel()) {
1276 LOG(ERROR) << "Aborting download as target channel: "
1277 << params->target_channel()
1278 << " is different from the download channel: "
1279 << params->download_channel();
1280 *cancel_reason = ErrorCode::kUpdateCanceledByChannelChange;
1281 return true;
1282 }
1283
1284 return false;
1285 }
1286
SetStatusAndNotify(UpdateStatus status)1287 void UpdateAttempter::SetStatusAndNotify(UpdateStatus status) {
1288 status_ = status;
1289 BroadcastStatus();
1290 }
1291
CreatePendingErrorEvent(AbstractAction * action,ErrorCode code)1292 void UpdateAttempter::CreatePendingErrorEvent(AbstractAction* action,
1293 ErrorCode code) {
1294 if (error_event_.get()) {
1295 // This shouldn't really happen.
1296 LOG(WARNING) << "There's already an existing pending error event.";
1297 return;
1298 }
1299
1300 // For now assume that a generic Omaha response action failure means that
1301 // there's no update so don't send an event. Also, double check that the
1302 // failure has not occurred while sending an error event -- in which case
1303 // don't schedule another. This shouldn't really happen but just in case...
1304 if ((action->Type() == OmahaResponseHandlerAction::StaticType() &&
1305 code == ErrorCode::kError) ||
1306 status_ == UpdateStatus::REPORTING_ERROR_EVENT) {
1307 return;
1308 }
1309
1310 // Classify the code to generate the appropriate result so that
1311 // the Borgmon charts show up the results correctly.
1312 // Do this before calling GetErrorCodeForAction which could potentially
1313 // augment the bit representation of code and thus cause no matches for
1314 // the switch cases below.
1315 OmahaEvent::Result event_result;
1316 switch (code) {
1317 case ErrorCode::kOmahaUpdateIgnoredPerPolicy:
1318 case ErrorCode::kOmahaUpdateDeferredPerPolicy:
1319 case ErrorCode::kOmahaUpdateDeferredForBackoff:
1320 event_result = OmahaEvent::kResultUpdateDeferred;
1321 break;
1322 default:
1323 event_result = OmahaEvent::kResultError;
1324 break;
1325 }
1326
1327 code = GetErrorCodeForAction(action, code);
1328 fake_update_success_ = code == ErrorCode::kPostinstallBootedFromFirmwareB;
1329
1330 // Compute the final error code with all the bit flags to be sent to Omaha.
1331 code = static_cast<ErrorCode>(
1332 static_cast<uint32_t>(code) | GetErrorCodeFlags());
1333 error_event_.reset(new OmahaEvent(OmahaEvent::kTypeUpdateComplete,
1334 event_result,
1335 code));
1336 }
1337
ScheduleErrorEventAction()1338 bool UpdateAttempter::ScheduleErrorEventAction() {
1339 if (error_event_.get() == nullptr)
1340 return false;
1341
1342 LOG(ERROR) << "Update failed.";
1343 system_state_->payload_state()->UpdateFailed(error_event_->error_code);
1344
1345 // Send it to Omaha.
1346 LOG(INFO) << "Reporting the error event";
1347 shared_ptr<OmahaRequestAction> error_event_action(
1348 new OmahaRequestAction(system_state_,
1349 error_event_.release(), // Pass ownership.
1350 brillo::make_unique_ptr(new LibcurlHttpFetcher(
1351 GetProxyResolver(),
1352 system_state_->hardware())),
1353 false));
1354 actions_.push_back(shared_ptr<AbstractAction>(error_event_action));
1355 processor_->EnqueueAction(error_event_action.get());
1356 SetStatusAndNotify(UpdateStatus::REPORTING_ERROR_EVENT);
1357 processor_->StartProcessing();
1358 return true;
1359 }
1360
ScheduleProcessingStart()1361 void UpdateAttempter::ScheduleProcessingStart() {
1362 LOG(INFO) << "Scheduling an action processor start.";
1363 start_action_processor_ = false;
1364 MessageLoop::current()->PostTask(
1365 FROM_HERE,
1366 Bind([this] { this->processor_->StartProcessing(); }));
1367 }
1368
DisableDeltaUpdateIfNeeded()1369 void UpdateAttempter::DisableDeltaUpdateIfNeeded() {
1370 int64_t delta_failures;
1371 if (omaha_request_params_->delta_okay() &&
1372 prefs_->GetInt64(kPrefsDeltaUpdateFailures, &delta_failures) &&
1373 delta_failures >= kMaxDeltaUpdateFailures) {
1374 LOG(WARNING) << "Too many delta update failures, forcing full update.";
1375 omaha_request_params_->set_delta_okay(false);
1376 }
1377 }
1378
MarkDeltaUpdateFailure()1379 void UpdateAttempter::MarkDeltaUpdateFailure() {
1380 // Don't try to resume a failed delta update.
1381 DeltaPerformer::ResetUpdateProgress(prefs_, false);
1382 int64_t delta_failures;
1383 if (!prefs_->GetInt64(kPrefsDeltaUpdateFailures, &delta_failures) ||
1384 delta_failures < 0) {
1385 delta_failures = 0;
1386 }
1387 prefs_->SetInt64(kPrefsDeltaUpdateFailures, ++delta_failures);
1388 }
1389
SetupDownload()1390 void UpdateAttempter::SetupDownload() {
1391 MultiRangeHttpFetcher* fetcher =
1392 static_cast<MultiRangeHttpFetcher*>(download_action_->http_fetcher());
1393 fetcher->ClearRanges();
1394 if (response_handler_action_->install_plan().is_resume) {
1395 // Resuming an update so fetch the update manifest metadata first.
1396 int64_t manifest_metadata_size = 0;
1397 int64_t manifest_signature_size = 0;
1398 prefs_->GetInt64(kPrefsManifestMetadataSize, &manifest_metadata_size);
1399 prefs_->GetInt64(kPrefsManifestSignatureSize, &manifest_signature_size);
1400 fetcher->AddRange(0, manifest_metadata_size + manifest_signature_size);
1401 // If there're remaining unprocessed data blobs, fetch them. Be careful not
1402 // to request data beyond the end of the payload to avoid 416 HTTP response
1403 // error codes.
1404 int64_t next_data_offset = 0;
1405 prefs_->GetInt64(kPrefsUpdateStateNextDataOffset, &next_data_offset);
1406 uint64_t resume_offset =
1407 manifest_metadata_size + manifest_signature_size + next_data_offset;
1408 if (resume_offset < response_handler_action_->install_plan().payload_size) {
1409 fetcher->AddRange(resume_offset);
1410 }
1411 } else {
1412 fetcher->AddRange(0);
1413 }
1414 }
1415
PingOmaha()1416 void UpdateAttempter::PingOmaha() {
1417 if (!processor_->IsRunning()) {
1418 shared_ptr<OmahaRequestAction> ping_action(new OmahaRequestAction(
1419 system_state_,
1420 nullptr,
1421 brillo::make_unique_ptr(new LibcurlHttpFetcher(
1422 GetProxyResolver(),
1423 system_state_->hardware())),
1424 true));
1425 actions_.push_back(shared_ptr<OmahaRequestAction>(ping_action));
1426 processor_->set_delegate(nullptr);
1427 processor_->EnqueueAction(ping_action.get());
1428 // Call StartProcessing() synchronously here to avoid any race conditions
1429 // caused by multiple outstanding ping Omaha requests. If we call
1430 // StartProcessing() asynchronously, the device can be suspended before we
1431 // get a chance to callback to StartProcessing(). When the device resumes
1432 // (assuming the device sleeps longer than the next update check period),
1433 // StartProcessing() is called back and at the same time, the next update
1434 // check is fired which eventually invokes StartProcessing(). A crash
1435 // can occur because StartProcessing() checks to make sure that the
1436 // processor is idle which it isn't due to the two concurrent ping Omaha
1437 // requests.
1438 processor_->StartProcessing();
1439 } else {
1440 LOG(WARNING) << "Action processor running, Omaha ping suppressed.";
1441 }
1442
1443 // Update the last check time here; it may be re-updated when an Omaha
1444 // response is received, but this will prevent us from repeatedly scheduling
1445 // checks in the case where a response is not received.
1446 UpdateLastCheckedTime();
1447
1448 // Update the status which will schedule the next update check
1449 SetStatusAndNotify(UpdateStatus::UPDATED_NEED_REBOOT);
1450 ScheduleUpdates();
1451 }
1452
1453
DecrementUpdateCheckCount()1454 bool UpdateAttempter::DecrementUpdateCheckCount() {
1455 int64_t update_check_count_value;
1456
1457 if (!prefs_->Exists(kPrefsUpdateCheckCount)) {
1458 // This file does not exist. This means we haven't started our update
1459 // check count down yet, so nothing more to do. This file will be created
1460 // later when we first satisfy the wall-clock-based-wait period.
1461 LOG(INFO) << "No existing update check count. That's normal.";
1462 return true;
1463 }
1464
1465 if (prefs_->GetInt64(kPrefsUpdateCheckCount, &update_check_count_value)) {
1466 // Only if we're able to read a proper integer value, then go ahead
1467 // and decrement and write back the result in the same file, if needed.
1468 LOG(INFO) << "Update check count = " << update_check_count_value;
1469
1470 if (update_check_count_value == 0) {
1471 // It could be 0, if, for some reason, the file didn't get deleted
1472 // when we set our status to waiting for reboot. so we just leave it
1473 // as is so that we can prevent another update_check wait for this client.
1474 LOG(INFO) << "Not decrementing update check count as it's already 0.";
1475 return true;
1476 }
1477
1478 if (update_check_count_value > 0)
1479 update_check_count_value--;
1480 else
1481 update_check_count_value = 0;
1482
1483 // Write out the new value of update_check_count_value.
1484 if (prefs_->SetInt64(kPrefsUpdateCheckCount, update_check_count_value)) {
1485 // We successfully wrote out te new value, so enable the
1486 // update check based wait.
1487 LOG(INFO) << "New update check count = " << update_check_count_value;
1488 return true;
1489 }
1490 }
1491
1492 LOG(INFO) << "Deleting update check count state due to read/write errors.";
1493
1494 // We cannot read/write to the file, so disable the update check based wait
1495 // so that we don't get stuck in this OS version by any chance (which could
1496 // happen if there's some bug that causes to read/write incorrectly).
1497 // Also attempt to delete the file to do our best effort to cleanup.
1498 prefs_->Delete(kPrefsUpdateCheckCount);
1499 return false;
1500 }
1501
1502
UpdateEngineStarted()1503 void UpdateAttempter::UpdateEngineStarted() {
1504 // If we just booted into a new update, keep the previous OS version
1505 // in case we rebooted because of a crash of the old version, so we
1506 // can do a proper crash report with correct information.
1507 // This must be done before calling
1508 // system_state_->payload_state()->UpdateEngineStarted() since it will
1509 // delete SystemUpdated marker file.
1510 if (system_state_->system_rebooted() &&
1511 prefs_->Exists(kPrefsSystemUpdatedMarker)) {
1512 if (!prefs_->GetString(kPrefsPreviousVersion, &prev_version_)) {
1513 // If we fail to get the version string, make sure it stays empty.
1514 prev_version_.clear();
1515 }
1516 }
1517
1518 system_state_->payload_state()->UpdateEngineStarted();
1519 StartP2PAtStartup();
1520 }
1521
StartP2PAtStartup()1522 bool UpdateAttempter::StartP2PAtStartup() {
1523 if (system_state_ == nullptr ||
1524 !system_state_->p2p_manager()->IsP2PEnabled()) {
1525 LOG(INFO) << "Not starting p2p at startup since it's not enabled.";
1526 return false;
1527 }
1528
1529 if (system_state_->p2p_manager()->CountSharedFiles() < 1) {
1530 LOG(INFO) << "Not starting p2p at startup since our application "
1531 << "is not sharing any files.";
1532 return false;
1533 }
1534
1535 return StartP2PAndPerformHousekeeping();
1536 }
1537
StartP2PAndPerformHousekeeping()1538 bool UpdateAttempter::StartP2PAndPerformHousekeeping() {
1539 if (system_state_ == nullptr)
1540 return false;
1541
1542 if (!system_state_->p2p_manager()->IsP2PEnabled()) {
1543 LOG(INFO) << "Not starting p2p since it's not enabled.";
1544 return false;
1545 }
1546
1547 LOG(INFO) << "Ensuring that p2p is running.";
1548 if (!system_state_->p2p_manager()->EnsureP2PRunning()) {
1549 LOG(ERROR) << "Error starting p2p.";
1550 return false;
1551 }
1552
1553 LOG(INFO) << "Performing p2p housekeeping.";
1554 if (!system_state_->p2p_manager()->PerformHousekeeping()) {
1555 LOG(ERROR) << "Error performing housekeeping for p2p.";
1556 return false;
1557 }
1558
1559 LOG(INFO) << "Done performing p2p housekeeping.";
1560 return true;
1561 }
1562
GetBootTimeAtUpdate(Time * out_boot_time)1563 bool UpdateAttempter::GetBootTimeAtUpdate(Time *out_boot_time) {
1564 // In case of an update_engine restart without a reboot, we stored the boot_id
1565 // when the update was completed by setting a pref, so we can check whether
1566 // the last update was on this boot or a previous one.
1567 string boot_id;
1568 TEST_AND_RETURN_FALSE(utils::GetBootId(&boot_id));
1569
1570 string update_completed_on_boot_id;
1571 if (!prefs_->Exists(kPrefsUpdateCompletedOnBootId) ||
1572 !prefs_->GetString(kPrefsUpdateCompletedOnBootId,
1573 &update_completed_on_boot_id) ||
1574 update_completed_on_boot_id != boot_id)
1575 return false;
1576
1577 // Short-circuit avoiding the read in case out_boot_time is nullptr.
1578 if (out_boot_time) {
1579 int64_t boot_time = 0;
1580 // Since the kPrefsUpdateCompletedOnBootId was correctly set, this pref
1581 // should not fail.
1582 TEST_AND_RETURN_FALSE(
1583 prefs_->GetInt64(kPrefsUpdateCompletedBootTime, &boot_time));
1584 *out_boot_time = Time::FromInternalValue(boot_time);
1585 }
1586 return true;
1587 }
1588
IsUpdateRunningOrScheduled()1589 bool UpdateAttempter::IsUpdateRunningOrScheduled() {
1590 return ((status_ != UpdateStatus::IDLE &&
1591 status_ != UpdateStatus::UPDATED_NEED_REBOOT) ||
1592 waiting_for_scheduled_check_);
1593 }
1594
IsAnyUpdateSourceAllowed()1595 bool UpdateAttempter::IsAnyUpdateSourceAllowed() {
1596 // We allow updates from any source if either of these are true:
1597 // * The device is running an unofficial (dev/test) image.
1598 // * The debugd dev features are accessible (i.e. in devmode with no owner).
1599 // This protects users running a base image, while still allowing a specific
1600 // window (gated by the debug dev features) where `cros flash` is usable.
1601 if (!system_state_->hardware()->IsOfficialBuild()) {
1602 LOG(INFO) << "Non-official build; allowing any update source.";
1603 return true;
1604 }
1605
1606 // Even though the debugd tools are also gated on devmode, checking here can
1607 // save us a D-Bus call so it's worth doing explicitly.
1608 if (system_state_->hardware()->IsNormalBootMode()) {
1609 LOG(INFO) << "Not in devmode; disallowing custom update sources.";
1610 return false;
1611 }
1612
1613 // Official images in devmode are allowed a custom update source iff the
1614 // debugd dev tools are enabled.
1615 if (!debugd_proxy_)
1616 return false;
1617 int32_t dev_features = debugd::DEV_FEATURES_DISABLED;
1618 brillo::ErrorPtr error;
1619 bool success = debugd_proxy_->QueryDevFeatures(&dev_features, &error);
1620
1621 // Some boards may not include debugd so it's expected that this may fail,
1622 // in which case we default to disallowing custom update sources.
1623 if (success && !(dev_features & debugd::DEV_FEATURES_DISABLED)) {
1624 LOG(INFO) << "Debugd dev tools enabled; allowing any update source.";
1625 return true;
1626 }
1627 LOG(INFO) << "Debugd dev tools disabled; disallowing custom update sources.";
1628 return false;
1629 }
1630
1631 } // namespace chromeos_update_engine
1632