Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 1 | // Copyright (c) 2010 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_UPDATE_CHECK_SCHEDULER_H__ |
| 6 | #define CHROMEOS_PLATFORM_UPDATE_ENGINE_UPDATE_CHECK_SCHEDULER_H__ |
| 7 | |
| 8 | #include <base/basictypes.h> |
| 9 | #include <glib.h> |
| 10 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| 11 | |
| 12 | #include "update_engine/update_attempter.h" |
| 13 | |
| 14 | namespace chromeos_update_engine { |
| 15 | |
| 16 | // UpdateCheckScheduler manages the periodic background update checks. This is |
| 17 | // the basic update check cycle: |
| 18 | // |
| 19 | // Run |
| 20 | // | |
| 21 | // v |
| 22 | // /->ScheduleCheck |
| 23 | // | | |
| 24 | // | v |
| 25 | // | StaticCheck (invoked through a GLib timeout source) |
| 26 | // | | |
| 27 | // | v |
| 28 | // | UpdateAttempter::Update |
| 29 | // | | |
| 30 | // | v |
| 31 | // | SetUpdateStatus (invoked by UpdateAttempter on state transitions) |
| 32 | // | | |
| 33 | // | v |
| 34 | // | ScheduleNextCheck (invoked when UpdateAttempter becomes idle) |
| 35 | // \---/ |
| 36 | class UpdateCheckScheduler { |
| 37 | public: |
Gilad Arnold | 1ebd813 | 2012-03-05 10:19:29 -0800 | [diff] [blame] | 38 | static const int kTimeoutInitialInterval; |
| 39 | static const int kTimeoutPeriodicInterval; |
| 40 | static const int kTimeoutQuickInterval; |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 41 | static const int kTimeoutRegularFuzz; |
Gilad Arnold | 1ebd813 | 2012-03-05 10:19:29 -0800 | [diff] [blame] | 42 | static const int kTimeoutMaxBackoffInterval; |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 43 | |
Gilad Arnold | 4d740eb | 2012-05-15 08:48:13 -0700 | [diff] [blame] | 44 | UpdateCheckScheduler(UpdateAttempter* update_attempter, |
Jay Srinivasan | 08fce04 | 2012-06-07 16:31:01 -0700 | [diff] [blame^] | 45 | GpioHandler* gpio_handler, |
| 46 | SystemState* system_state); |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 47 | virtual ~UpdateCheckScheduler(); |
| 48 | |
| 49 | // Initiates the periodic update checks, if necessary. |
| 50 | void Run(); |
| 51 | |
Gilad Arnold | 1ebd813 | 2012-03-05 10:19:29 -0800 | [diff] [blame] | 52 | // Sets the new update status. This is invoked by UpdateAttempter. |notice| |
| 53 | // is used for passing supplemental information about recent update events, |
| 54 | // which may influence scheduling decisions. |
| 55 | void SetUpdateStatus(UpdateStatus status, UpdateNotice notice); |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 56 | |
Darin Petkov | 85ced13 | 2010-09-01 10:20:56 -0700 | [diff] [blame] | 57 | void set_poll_interval(int interval) { poll_interval_ = interval; } |
Darin Petkov | 1b00310 | 2010-11-30 10:18:36 -0800 | [diff] [blame] | 58 | int poll_interval() const { return poll_interval_; } |
Darin Petkov | 85ced13 | 2010-09-01 10:20:56 -0700 | [diff] [blame] | 59 | |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 60 | private: |
| 61 | friend class UpdateCheckSchedulerTest; |
| 62 | FRIEND_TEST(UpdateCheckSchedulerTest, CanScheduleTest); |
| 63 | FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzBackoffTest); |
Darin Petkov | 85ced13 | 2010-09-01 10:20:56 -0700 | [diff] [blame] | 64 | FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzPollTest); |
| 65 | FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzPriorityTest); |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 66 | FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzTest); |
| 67 | FRIEND_TEST(UpdateCheckSchedulerTest, GTimeoutAddSecondsTest); |
| 68 | FRIEND_TEST(UpdateCheckSchedulerTest, IsBootDeviceRemovableTest); |
| 69 | FRIEND_TEST(UpdateCheckSchedulerTest, IsOfficialBuildTest); |
| 70 | FRIEND_TEST(UpdateCheckSchedulerTest, RunBootDeviceRemovableTest); |
| 71 | FRIEND_TEST(UpdateCheckSchedulerTest, RunNonOfficialBuildTest); |
| 72 | FRIEND_TEST(UpdateCheckSchedulerTest, RunTest); |
| 73 | FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleCheckDisabledTest); |
| 74 | FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleCheckEnabledTest); |
| 75 | FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleCheckNegativeIntervalTest); |
| 76 | FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleNextCheckDisabledTest); |
| 77 | FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleNextCheckEnabledTest); |
| 78 | FRIEND_TEST(UpdateCheckSchedulerTest, SetUpdateStatusIdleDisabledTest); |
| 79 | FRIEND_TEST(UpdateCheckSchedulerTest, SetUpdateStatusIdleEnabledTest); |
| 80 | FRIEND_TEST(UpdateCheckSchedulerTest, SetUpdateStatusNonIdleTest); |
Darin Petkov | 2a0e633 | 2010-09-24 14:43:41 -0700 | [diff] [blame] | 81 | FRIEND_TEST(UpdateCheckSchedulerTest, StaticCheckOOBECompleteTest); |
| 82 | FRIEND_TEST(UpdateCheckSchedulerTest, StaticCheckOOBENotCompleteTest); |
Thieu Le | 116fda3 | 2011-04-19 11:01:54 -0700 | [diff] [blame] | 83 | FRIEND_TEST(UpdateAttempterTest, PingOmahaTest); |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 84 | |
| 85 | // Wraps GLib's g_timeout_add_seconds so that it can be mocked in tests. |
| 86 | virtual guint GTimeoutAddSeconds(guint interval, GSourceFunc function); |
| 87 | |
| 88 | // Wrappers for utils functions so that they can be mocked in tests. |
| 89 | virtual bool IsBootDeviceRemovable(); |
| 90 | virtual bool IsOfficialBuild(); |
| 91 | |
| 92 | // Returns true if an update check can be scheduled. An update check should |
| 93 | // not be scheduled if periodic update checks are disabled or if one is |
| 94 | // already scheduled. |
| 95 | bool CanSchedule() { return enabled_ && !scheduled_; } |
| 96 | |
| 97 | // Schedules the next periodic update check |interval| seconds from now |
| 98 | // randomized by +/- |fuzz|/2. |
| 99 | void ScheduleCheck(int interval, int fuzz); |
| 100 | |
| 101 | // GLib timeout source callback. Initiates an update check through the update |
| 102 | // attempter. |
| 103 | static gboolean StaticCheck(void* scheduler); |
| 104 | |
Gilad Arnold | 1ebd813 | 2012-03-05 10:19:29 -0800 | [diff] [blame] | 105 | // Schedules the next update check by setting up a timeout source; |
| 106 | // |is_force_quick| will enforce a quick subsequent update check interval. |
| 107 | void ScheduleNextCheck(bool is_force_quick); |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 108 | |
| 109 | // Computes the timeout interval along with its random fuzz range for the next |
| 110 | // update check by taking into account the last timeout interval as well as |
Gilad Arnold | 1ebd813 | 2012-03-05 10:19:29 -0800 | [diff] [blame] | 111 | // the last update status. A nonzero |forced_interval|, however, will override |
| 112 | // all other considerations. |
| 113 | void ComputeNextIntervalAndFuzz(const int forced_interval, |
| 114 | int* next_interval, int* next_fuzz); |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 115 | |
| 116 | // The UpdateAttempter to use for update checks. |
| 117 | UpdateAttempter* update_attempter_; |
| 118 | |
| 119 | // True if automatic update checks should be scheduled, false otherwise. |
| 120 | bool enabled_; |
| 121 | |
| 122 | // True if there's an update check scheduled already, false otherwise. |
| 123 | bool scheduled_; |
| 124 | |
| 125 | // The timeout interval (before fuzzing) for the last update check. |
| 126 | int last_interval_; |
| 127 | |
Darin Petkov | 85ced13 | 2010-09-01 10:20:56 -0700 | [diff] [blame] | 128 | // Server dictated poll interval in seconds, if positive. |
| 129 | int poll_interval_; |
| 130 | |
Gilad Arnold | 4d740eb | 2012-05-15 08:48:13 -0700 | [diff] [blame] | 131 | // A flag indicating whether a test update cycle was already attempted. |
| 132 | bool is_test_update_attempted_; |
| 133 | |
| 134 | // GPIO handler object. |
| 135 | GpioHandler* gpio_handler_; |
| 136 | |
Jay Srinivasan | 08fce04 | 2012-06-07 16:31:01 -0700 | [diff] [blame^] | 137 | // The external state of the system outside the update_engine process. |
| 138 | SystemState* system_state_; |
| 139 | |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 140 | DISALLOW_COPY_AND_ASSIGN(UpdateCheckScheduler); |
| 141 | }; |
| 142 | |
| 143 | } // namespace chromeos_update_engine |
| 144 | |
| 145 | #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_CHECK_SCHEDULER_H__ |