blob: 69368fb6c0c9412089cc139ea9f746dc27ad25fe [file] [log] [blame]
Casey Dahlina93cd532016-01-14 16:55:11 -08001//
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/system_state.h"
28
29namespace chromeos_update_engine {
30
31class UpdateEngineService {
32 public:
33 // Flags used in the AttemptUpdateWithFlags() D-Bus method.
34 typedef enum {
35 kAttemptUpdateFlagNonInteractive = (1<<0)
36 } AttemptUpdateFlags;
37
38 // Error domain for all the service errors.
39 static const char* const kErrorDomain;
40
41 // Generic service error.
42 static const char* const kErrorFailed;
43
44 explicit UpdateEngineService(SystemState* system_state);
45 virtual ~UpdateEngineService() = default;
46
47 bool AttemptUpdate(brillo::ErrorPtr* error,
48 const std::string& in_app_version,
49 const std::string& in_omaha_url,
50 int32_t in_flags_as_int);
51
52 bool AttemptRollback(brillo::ErrorPtr* error, bool in_powerwash);
53
54 // Checks if the system rollback is available by verifying if the secondary
55 // system partition is valid and bootable.
56 bool CanRollback(brillo::ErrorPtr* error, bool* out_can_rollback);
57
58 // Resets the status of the update_engine to idle, ignoring any applied
59 // update. This is used for development only.
60 bool ResetStatus(brillo::ErrorPtr* error);
61
62 // Returns the current status of the Update Engine. If an update is in
63 // progress, the number of operations, size to download and overall progress
64 // is reported.
65 bool GetStatus(brillo::ErrorPtr* error,
66 int64_t* out_last_checked_time,
67 double* out_progress,
68 std::string* out_current_operation,
69 std::string* out_new_version,
70 int64_t* out_new_size);
71
72 // Reboots the device if an update is applied and a reboot is required.
73 bool RebootIfNeeded(brillo::ErrorPtr* error);
74
75 // Changes the current channel of the device to the target channel. If the
76 // target channel is a less stable channel than the current channel, then the
77 // channel change happens immediately (at the next update check). If the
78 // target channel is a more stable channel, then if is_powerwash_allowed is
79 // set to true, then also the change happens immediately but with a powerwash
80 // if required. Otherwise, the change takes effect eventually (when the
81 // version on the target channel goes above the version number of what the
82 // device currently has).
83 bool SetChannel(brillo::ErrorPtr* error,
84 const std::string& in_target_channel,
85 bool in_is_powerwash_allowed);
86
87 // If get_current_channel is set to true, populates |channel| with the name of
88 // the channel that the device is currently on. Otherwise, it populates it
89 // with the name of the channel the device is supposed to be (in case of a
90 // pending channel change).
91 bool GetChannel(brillo::ErrorPtr* error,
92 bool in_get_current_channel,
93 std::string* out_channel);
94
Alex Deymo5b5fa8b2016-10-06 15:40:49 -070095 // Sets the current "cohort hint" value to |in_cohort_hint|. The cohort hint
96 // is sent back to Omaha on every request and can be used as a hint of what
97 // cohort should we be put on.
98 bool SetCohortHint(brillo::ErrorPtr* error, std::string in_cohort_hint);
99
100 // Return the current cohort hint. This value can be set with SetCohortHint()
101 // and can also be updated from Omaha on every update check request.
102 bool GetCohortHint(brillo::ErrorPtr* error, std::string* out_cohort_hint);
103
Casey Dahlina93cd532016-01-14 16:55:11 -0800104 // Enables or disables the sharing and consuming updates over P2P feature
105 // according to the |enabled| argument passed.
106 bool SetP2PUpdatePermission(brillo::ErrorPtr* error, bool in_enabled);
107
108 // Returns the current value for the P2P enabled setting. This involves both
109 // sharing and consuming updates over P2P.
110 bool GetP2PUpdatePermission(brillo::ErrorPtr* error, bool* out_enabled);
111
112 // If there's no device policy installed, sets the update over cellular
113 // networks permission to the |allowed| value. Otherwise, this method returns
114 // with an error since this setting is overridden by the applied policy.
115 bool SetUpdateOverCellularPermission(brillo::ErrorPtr* error,
116 bool in_allowed);
117
118 // Returns the current value of the update over cellular network setting,
119 // either forced by the device policy if the device is enrolled or the current
120 // user preference otherwise.
121 bool GetUpdateOverCellularPermission(brillo::ErrorPtr* error,
122 bool* out_allowed);
123
124 // Returns the duration since the last successful update, as the
125 // duration on the wallclock. Returns an error if the device has not
126 // updated.
127 bool GetDurationSinceUpdate(brillo::ErrorPtr* error,
128 int64_t* out_usec_wallclock);
129
130 // Returns the version string of OS that was used before the last reboot
131 // into an updated version. This is available only when rebooting into an
132 // update from previous version, otherwise an empty string is returned.
133 bool GetPrevVersion(brillo::ErrorPtr* error, std::string* out_prev_version);
134
135 // Returns the name of kernel partition that can be rolled back into.
136 bool GetRollbackPartition(brillo::ErrorPtr* error,
137 std::string* out_rollback_partition_name);
138
Shuqian Zhao29971732016-02-05 11:29:32 -0800139 // Returns the last UpdateAttempt error.
140 bool GetLastAttemptError(brillo::ErrorPtr* error,
141 int32_t* out_last_attempt_error);
142
Alex Deymob3fa53b2016-04-18 19:57:58 -0700143 // Returns the current end-of-life status of the device. This value is updated
144 // on every update check and persisted on disk across reboots.
145 bool GetEolStatus(brillo::ErrorPtr* error, int32_t* out_eol_status);
146
Casey Dahlina93cd532016-01-14 16:55:11 -0800147 private:
148 SystemState* system_state_;
149};
150
151} // namespace chromeos_update_engine
152
153#endif // UPDATE_ENGINE_COMMON_SERVICE_H_