| // Copyright (c) 2010 The Chromium OS Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_UPDATE_CHECK_SCHEDULER_H__ |
| #define CHROMEOS_PLATFORM_UPDATE_ENGINE_UPDATE_CHECK_SCHEDULER_H__ |
| |
| #include <base/basictypes.h> |
| #include <glib.h> |
| #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| |
| #include "update_engine/update_attempter.h" |
| |
| namespace chromeos_update_engine { |
| |
| // UpdateCheckScheduler manages the periodic background update checks. This is |
| // the basic update check cycle: |
| // |
| // Run |
| // | |
| // v |
| // /->ScheduleCheck |
| // | | |
| // | v |
| // | StaticCheck (invoked through a GLib timeout source) |
| // | | |
| // | v |
| // | UpdateAttempter::Update |
| // | | |
| // | v |
| // | SetUpdateStatus (invoked by UpdateAttempter on state transitions) |
| // | | |
| // | v |
| // | ScheduleNextCheck (invoked when UpdateAttempter becomes idle) |
| // \---/ |
| class UpdateCheckScheduler { |
| public: |
| static const int kTimeoutInitialInterval; |
| static const int kTimeoutPeriodicInterval; |
| static const int kTimeoutQuickInterval; |
| static const int kTimeoutRegularFuzz; |
| static const int kTimeoutMaxBackoffInterval; |
| |
| UpdateCheckScheduler(UpdateAttempter* update_attempter, |
| GpioHandler* gpio_handler); |
| virtual ~UpdateCheckScheduler(); |
| |
| // Initiates the periodic update checks, if necessary. |
| void Run(); |
| |
| // Sets the new update status. This is invoked by UpdateAttempter. |notice| |
| // is used for passing supplemental information about recent update events, |
| // which may influence scheduling decisions. |
| void SetUpdateStatus(UpdateStatus status, UpdateNotice notice); |
| |
| void set_poll_interval(int interval) { poll_interval_ = interval; } |
| int poll_interval() const { return poll_interval_; } |
| |
| private: |
| friend class UpdateCheckSchedulerTest; |
| FRIEND_TEST(UpdateCheckSchedulerTest, CanScheduleTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzBackoffTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzPollTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzPriorityTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ComputeNextIntervalAndFuzzTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, GTimeoutAddSecondsTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, IsBootDeviceRemovableTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, IsOOBECompleteTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, IsOfficialBuildTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, RunBootDeviceRemovableTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, RunNonOfficialBuildTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, RunTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleCheckDisabledTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleCheckEnabledTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleCheckNegativeIntervalTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleNextCheckDisabledTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, ScheduleNextCheckEnabledTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, SetUpdateStatusIdleDisabledTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, SetUpdateStatusIdleEnabledTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, SetUpdateStatusNonIdleTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, StaticCheckOOBECompleteTest); |
| FRIEND_TEST(UpdateCheckSchedulerTest, StaticCheckOOBENotCompleteTest); |
| FRIEND_TEST(UpdateAttempterTest, PingOmahaTest); |
| |
| // Wraps GLib's g_timeout_add_seconds so that it can be mocked in tests. |
| virtual guint GTimeoutAddSeconds(guint interval, GSourceFunc function); |
| |
| // Wrappers for utils functions so that they can be mocked in tests. |
| virtual bool IsBootDeviceRemovable(); |
| virtual bool IsOOBEComplete(); |
| virtual bool IsOfficialBuild(); |
| |
| // Returns true if an update check can be scheduled. An update check should |
| // not be scheduled if periodic update checks are disabled or if one is |
| // already scheduled. |
| bool CanSchedule() { return enabled_ && !scheduled_; } |
| |
| // Schedules the next periodic update check |interval| seconds from now |
| // randomized by +/- |fuzz|/2. |
| void ScheduleCheck(int interval, int fuzz); |
| |
| // GLib timeout source callback. Initiates an update check through the update |
| // attempter. |
| static gboolean StaticCheck(void* scheduler); |
| |
| // Schedules the next update check by setting up a timeout source; |
| // |is_force_quick| will enforce a quick subsequent update check interval. |
| void ScheduleNextCheck(bool is_force_quick); |
| |
| // Computes the timeout interval along with its random fuzz range for the next |
| // update check by taking into account the last timeout interval as well as |
| // the last update status. A nonzero |forced_interval|, however, will override |
| // all other considerations. |
| void ComputeNextIntervalAndFuzz(const int forced_interval, |
| int* next_interval, int* next_fuzz); |
| |
| // The UpdateAttempter to use for update checks. |
| UpdateAttempter* update_attempter_; |
| |
| // True if automatic update checks should be scheduled, false otherwise. |
| bool enabled_; |
| |
| // True if there's an update check scheduled already, false otherwise. |
| bool scheduled_; |
| |
| // The timeout interval (before fuzzing) for the last update check. |
| int last_interval_; |
| |
| // Server dictated poll interval in seconds, if positive. |
| int poll_interval_; |
| |
| // A flag indicating whether a test update cycle was already attempted. |
| bool is_test_update_attempted_; |
| |
| // GPIO handler object. |
| GpioHandler* gpio_handler_; |
| |
| DISALLOW_COPY_AND_ASSIGN(UpdateCheckScheduler); |
| }; |
| |
| } // namespace chromeos_update_engine |
| |
| #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_CHECK_SCHEDULER_H__ |