1 // 2 // Copyright (C) 2010 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_DBUS_SERVICE_H_ 18 #define UPDATE_ENGINE_DBUS_SERVICE_H_ 19 20 #include <inttypes.h> 21 22 #include <memory> 23 #include <string> 24 25 #include <base/memory/ref_counted.h> 26 #include <brillo/errors/error.h> 27 28 #include "update_engine/common_service.h" 29 #include "update_engine/service_observer_interface.h" 30 #include "update_engine/update_attempter.h" 31 32 #include "dbus_bindings/org.chromium.UpdateEngineInterface.h" 33 34 namespace chromeos_update_engine { 35 36 class DBusUpdateEngineService 37 : public org::chromium::UpdateEngineInterfaceInterface { 38 public: 39 explicit DBusUpdateEngineService(SystemState* system_state); 40 virtual ~DBusUpdateEngineService() = default; 41 42 // Implementation of org::chromium::UpdateEngineInterfaceInterface. 43 bool AttemptUpdate(brillo::ErrorPtr* error, 44 const std::string& in_app_version, 45 const std::string& in_omaha_url) override; 46 47 bool AttemptUpdateWithFlags(brillo::ErrorPtr* error, 48 const std::string& in_app_version, 49 const std::string& in_omaha_url, 50 int32_t in_flags_as_int) override; 51 52 bool AttemptInstall(brillo::ErrorPtr* error, 53 const std::string& dlc_request) override; 54 55 bool AttemptRollback(brillo::ErrorPtr* error, bool in_powerwash) override; 56 57 // Checks if the system rollback is available by verifying if the secondary 58 // system partition is valid and bootable. 59 bool CanRollback(brillo::ErrorPtr* error, bool* out_can_rollback) override; 60 61 // Resets the status of the update_engine to idle, ignoring any applied 62 // update. This is used for development only. 63 bool ResetStatus(brillo::ErrorPtr* error) override; 64 65 // Returns the current status of the Update Engine. If an update is in 66 // progress, the number of operations, size to download and overall progress 67 // is reported. 68 bool GetStatus(brillo::ErrorPtr* error, 69 int64_t* out_last_checked_time, 70 double* out_progress, 71 std::string* out_current_operation, 72 std::string* out_new_version, 73 int64_t* out_new_size) override; 74 75 // Reboots the device if an update is applied and a reboot is required. 76 bool RebootIfNeeded(brillo::ErrorPtr* error) override; 77 78 // Changes the current channel of the device to the target channel. If the 79 // target channel is a less stable channel than the current channel, then the 80 // channel change happens immediately (at the next update check). If the 81 // target channel is a more stable channel, then if is_powerwash_allowed is 82 // set to true, then also the change happens immediately but with a powerwash 83 // if required. Otherwise, the change takes effect eventually (when the 84 // version on the target channel goes above the version number of what the 85 // device currently has). 86 bool SetChannel(brillo::ErrorPtr* error, 87 const std::string& in_target_channel, 88 bool in_is_powerwash_allowed) override; 89 90 // If get_current_channel is set to true, populates |channel| with the name of 91 // the channel that the device is currently on. Otherwise, it populates it 92 // with the name of the channel the device is supposed to be (in case of a 93 // pending channel change). 94 bool GetChannel(brillo::ErrorPtr* error, 95 bool in_get_current_channel, 96 std::string* out_channel) override; 97 98 bool SetCohortHint(brillo::ErrorPtr* error, 99 const std::string& in_cohort_hint) override; 100 101 bool GetCohortHint(brillo::ErrorPtr* error, 102 std::string* out_cohort_hint) override; 103 104 // Enables or disables the sharing and consuming updates over P2P feature 105 // according to the |enabled| argument passed. 106 bool SetP2PUpdatePermission(brillo::ErrorPtr* error, 107 bool in_enabled) override; 108 109 // Returns the current value for the P2P enabled setting. This involves both 110 // sharing and consuming updates over P2P. 111 bool GetP2PUpdatePermission(brillo::ErrorPtr* error, 112 bool* out_enabled) override; 113 114 // If there's no device policy installed, sets the update over cellular 115 // networks permission to the |allowed| value. Otherwise, this method returns 116 // with an error since this setting is overridden by the applied policy. 117 bool SetUpdateOverCellularPermission(brillo::ErrorPtr* error, 118 bool in_allowed) override; 119 120 // If there's no device policy installed, sets the update over cellular 121 // target. Otherwise, this method returns with an error. 122 bool SetUpdateOverCellularTarget(brillo::ErrorPtr* error, 123 const std::string& target_version, 124 int64_t target_size) override; 125 126 // Returns the current value of the update over cellular network setting, 127 // either forced by the device policy if the device is enrolled or the current 128 // user preference otherwise. 129 bool GetUpdateOverCellularPermission(brillo::ErrorPtr* error, 130 bool* out_allowed) override; 131 132 // Returns the duration since the last successful update, as the 133 // duration on the wallclock. Returns an error if the device has not 134 // updated. 135 bool GetDurationSinceUpdate(brillo::ErrorPtr* error, 136 int64_t* out_usec_wallclock) override; 137 138 // Returns the version string of OS that was used before the last reboot 139 // into an updated version. This is available only when rebooting into an 140 // update from previous version, otherwise an empty string is returned. 141 bool GetPrevVersion(brillo::ErrorPtr* error, 142 std::string* out_prev_version) override; 143 144 // Returns the name of kernel partition that can be rolled back into. 145 bool GetRollbackPartition(brillo::ErrorPtr* error, 146 std::string* out_rollback_partition_name) override; 147 148 // Returns the last UpdateAttempt error. If not updated yet, default success 149 // ErrorCode will be returned. 150 bool GetLastAttemptError(brillo::ErrorPtr* error, 151 int32_t* out_last_attempt_error) override; 152 153 // Returns the current end-of-life status of the device in |out_eol_status|. 154 bool GetEolStatus(brillo::ErrorPtr* error, int32_t* out_eol_status) override; 155 156 private: 157 std::unique_ptr<UpdateEngineService> common_; 158 }; 159 160 // The UpdateEngineAdaptor class runs the UpdateEngineInterface in the fixed 161 // object path, without an ObjectManager notifying the interfaces, since it is 162 // all static and clients don't expect it to be implemented. 163 class UpdateEngineAdaptor : public org::chromium::UpdateEngineInterfaceAdaptor, 164 public ServiceObserverInterface { 165 public: 166 explicit UpdateEngineAdaptor(SystemState* system_state); 167 ~UpdateEngineAdaptor() = default; 168 169 // Register the DBus object with the update engine service asynchronously. 170 // Calls |copmletion_callback| when done passing a boolean indicating if the 171 // registration succeeded. 172 void RegisterAsync(const base::Callback<void(bool)>& completion_callback); 173 174 // Takes ownership of the well-known DBus name and returns whether it 175 // succeeded. 176 bool RequestOwnership(); 177 178 // ServiceObserverInterface overrides. 179 void SendStatusUpdate( 180 const update_engine::UpdateEngineStatus& update_engine_status) override; 181 SendPayloadApplicationComplete(ErrorCode error_code)182 void SendPayloadApplicationComplete(ErrorCode error_code) override {} 183 184 private: 185 scoped_refptr<dbus::Bus> bus_; 186 DBusUpdateEngineService dbus_service_; 187 brillo::dbus_utils::DBusObject dbus_object_; 188 }; 189 190 } // namespace chromeos_update_engine 191 192 #endif // UPDATE_ENGINE_DBUS_SERVICE_H_ 193