Home | History | Annotate | Download | only in update_engine 
      1 //
      2 // Copyright (C) 2016 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_COMMON_SERVICE_H_
     18 #define UPDATE_ENGINE_COMMON_SERVICE_H_
     19 
     20 #include <inttypes.h>
     21 
     22 #include <string>
     23 
     24 #include <base/memory/ref_counted.h>
     25 #include <brillo/errors/error.h>
     26 
     27 #include "update_engine/client_library/include/update_engine/update_status.h"
     28 #include "update_engine/system_state.h"
     29 
     30 namespace chromeos_update_engine {
     31 
     32 class UpdateEngineService {
     33  public:
     34   // Error domain for all the service errors.
     35   static const char* const kErrorDomain;
     36 
     37   // Generic service error.
     38   static const char* const kErrorFailed;
     39 
     40   explicit UpdateEngineService(SystemState* system_state);
     41   virtual ~UpdateEngineService() = default;
     42 
     43   // Set flags that influence how updates and checks are performed.  These
     44   // influence all future checks and updates until changed or the device
     45   // reboots.  The |in_flags_as_int| values are a union of values from
     46   // |UpdateAttemptFlags|
     47   bool SetUpdateAttemptFlags(brillo::ErrorPtr* error, int32_t in_flags_as_int);
     48 
     49   bool AttemptUpdate(brillo::ErrorPtr* error,
     50                      const std::string& in_app_version,
     51                      const std::string& in_omaha_url,
     52                      int32_t in_flags_as_int,
     53                      bool* out_result);
     54 
     55   bool AttemptRollback(brillo::ErrorPtr* error, bool in_powerwash);
     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);
     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);
     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                  update_engine::UpdateEngineStatus* out_status);
     70 
     71   // Reboots the device if an update is applied and a reboot is required.
     72   bool RebootIfNeeded(brillo::ErrorPtr* error);
     73 
     74   // Changes the current channel of the device to the target channel. If the
     75   // target channel is a less stable channel than the current channel, then the
     76   // channel change happens immediately (at the next update check).  If the
     77   // target channel is a more stable channel, then if is_powerwash_allowed is
     78   // set to true, then also the change happens immediately but with a powerwash
     79   // if required. Otherwise, the change takes effect eventually (when the
     80   // version on the target channel goes above the version number of what the
     81   // device currently has).
     82   bool SetChannel(brillo::ErrorPtr* error,
     83                   const std::string& in_target_channel,
     84                   bool in_is_powerwash_allowed);
     85 
     86   // If get_current_channel is set to true, populates |channel| with the name of
     87   // the channel that the device is currently on. Otherwise, it populates it
     88   // with the name of the channel the device is supposed to be (in case of a
     89   // pending channel change).
     90   bool GetChannel(brillo::ErrorPtr* error,
     91                   bool in_get_current_channel,
     92                   std::string* out_channel);
     93 
     94   // Sets the current "cohort hint" value to |in_cohort_hint|. The cohort hint
     95   // is sent back to Omaha on every request and can be used as a hint of what
     96   // cohort should we be put on.
     97   bool SetCohortHint(brillo::ErrorPtr* error, std::string in_cohort_hint);
     98 
     99   // Return the current cohort hint. This value can be set with SetCohortHint()
    100   // and can also be updated from Omaha on every update check request.
    101   bool GetCohortHint(brillo::ErrorPtr* error, std::string* out_cohort_hint);
    102 
    103   // Enables or disables the sharing and consuming updates over P2P feature
    104   // according to the |enabled| argument passed.
    105   bool SetP2PUpdatePermission(brillo::ErrorPtr* error, bool in_enabled);
    106 
    107   // Returns the current value for the P2P enabled setting. This involves both
    108   // sharing and consuming updates over P2P.
    109   bool GetP2PUpdatePermission(brillo::ErrorPtr* error, bool* out_enabled);
    110 
    111   // If there's no device policy installed, sets the update over cellular
    112   // networks permission to the |allowed| value. Otherwise, this method returns
    113   // with an error since this setting is overridden by the applied policy.
    114   bool SetUpdateOverCellularPermission(brillo::ErrorPtr* error,
    115                                        bool in_allowed);
    116 
    117   // Returns the current value of the update over cellular network setting,
    118   // either forced by the device policy if the device is enrolled or the current
    119   // user preference otherwise.
    120   bool GetUpdateOverCellularPermission(brillo::ErrorPtr* error,
    121                                        bool* out_allowed);
    122 
    123   // Returns the duration since the last successful update, as the
    124   // duration on the wallclock. Returns an error if the device has not
    125   // updated.
    126   bool GetDurationSinceUpdate(brillo::ErrorPtr* error,
    127                               int64_t* out_usec_wallclock);
    128 
    129   // Returns the version string of OS that was used before the last reboot
    130   // into an updated version. This is available only when rebooting into an
    131   // update from previous version, otherwise an empty string is returned.
    132   bool GetPrevVersion(brillo::ErrorPtr* error, std::string* out_prev_version);
    133 
    134   // Returns the name of kernel partition that can be rolled back into.
    135   bool GetRollbackPartition(brillo::ErrorPtr* error,
    136                             std::string* out_rollback_partition_name);
    137 
    138   // Returns the last UpdateAttempt error.
    139   bool GetLastAttemptError(brillo::ErrorPtr* error,
    140                            int32_t* out_last_attempt_error);
    141 
    142   // Returns the current end-of-life status of the device. This value is updated
    143   // on every update check and persisted on disk across reboots.
    144   bool GetEolStatus(brillo::ErrorPtr* error, int32_t* out_eol_status);
    145 
    146  private:
    147   SystemState* system_state_;
    148 };
    149 
    150 }  // namespace chromeos_update_engine
    151 
    152 #endif  // UPDATE_ENGINE_COMMON_SERVICE_H_
    153