1 // 2 // Copyright (C) 2014 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 #ifndef UPDATE_ENGINE_UPDATE_MANAGER_UPDATER_PROVIDER_H_ 18 #define UPDATE_ENGINE_UPDATE_MANAGER_UPDATER_PROVIDER_H_ 19 20 #include <string> 21 22 #include <base/time/time.h> 23 24 #include "update_engine/update_manager/provider.h" 25 #include "update_engine/update_manager/variable.h" 26 27 namespace chromeos_update_manager { 28 29 enum class Stage { 30 kIdle, 31 kCheckingForUpdate, 32 kUpdateAvailable, 33 kDownloading, 34 kVerifying, 35 kFinalizing, 36 kUpdatedNeedReboot, 37 kReportingErrorEvent, 38 kAttemptingRollback, 39 kCleanupPreviousUpdate, 40 }; 41 42 enum class UpdateRequestStatus { 43 kNone, 44 kInteractive, 45 kPeriodic, 46 }; 47 48 // These enum values are a bit-field. 49 enum UpdateRestrictions : int { 50 kNone, 51 kRestrictDownloading = (1 << 0), 52 }; 53 54 // Provider for Chrome OS update related information. 55 class UpdaterProvider : public Provider { 56 public: ~UpdaterProvider()57 ~UpdaterProvider() override {} 58 59 // A variable returning the timestamp when the update engine was started in 60 // wallclock time. 61 virtual Variable<base::Time>* var_updater_started_time() = 0; 62 63 // A variable returning the last update check time. 64 virtual Variable<base::Time>* var_last_checked_time() = 0; 65 66 // A variable reporting the time when an update was last completed in the 67 // current boot cycle. Returns an error if an update completed time could not 68 // be read (e.g. no update was completed in the current boot cycle) or is 69 // invalid. 70 // 71 // IMPORTANT: The time reported is not the wallclock time reading at the time 72 // of the update, rather it is the point in time when the update completed 73 // relative to the current wallclock time reading. Therefore, the gap between 74 // the reported value and the current wallclock time is guaranteed to be 75 // monotonically increasing. 76 virtual Variable<base::Time>* var_update_completed_time() = 0; 77 78 // A variable returning the update progress (0.0 to 1.0). 79 virtual Variable<double>* var_progress() = 0; 80 81 // A variable returning the current update status. 82 virtual Variable<Stage>* var_stage() = 0; 83 84 // A variable returning the update target version. 85 virtual Variable<std::string>* var_new_version() = 0; 86 87 // A variable returning the update payload size. The payload size is 88 // guaranteed to be non-negative. 89 virtual Variable<uint64_t>* var_payload_size() = 0; 90 91 // A variable returning the current channel. 92 virtual Variable<std::string>* var_curr_channel() = 0; 93 94 // A variable returning the update target channel. 95 virtual Variable<std::string>* var_new_channel() = 0; 96 97 // A variable indicating whether user settings allow P2P updates. 98 virtual Variable<bool>* var_p2p_enabled() = 0; 99 100 // A variable indicating whether user settings allow updates over a cellular 101 // network. 102 virtual Variable<bool>* var_cellular_enabled() = 0; 103 104 // A variable returning the number of consecutive failed update checks. 105 virtual Variable<unsigned int>* var_consecutive_failed_update_checks() = 0; 106 107 // A server-dictated update check interval in seconds, if one was given. 108 virtual Variable<unsigned int>* var_server_dictated_poll_interval() = 0; 109 110 // A variable denoting whether a forced update was request but no update check 111 // performed yet; also tells whether this request is for an interactive or 112 // scheduled update. 113 virtual Variable<UpdateRequestStatus>* var_forced_update_requested() = 0; 114 115 // A variable that returns the update restriction flags that are set 116 // for all updates. 117 virtual Variable<UpdateRestrictions>* var_update_restrictions() = 0; 118 119 // A variable that returns the number of seconds for the first update check to 120 // happen. 121 virtual Variable<int64_t>* var_test_update_check_interval_timeout() = 0; 122 123 protected: UpdaterProvider()124 UpdaterProvider() {} 125 126 private: 127 DISALLOW_COPY_AND_ASSIGN(UpdaterProvider); 128 }; 129 130 } // namespace chromeos_update_manager 131 132 #endif // UPDATE_ENGINE_UPDATE_MANAGER_UPDATER_PROVIDER_H_ 133