blob: 47953cb7a45afa148d49d94a7aac622305beb0ab [file] [log] [blame]
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -07001// Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Gilad Arnoldcf175a02014-07-10 16:48:47 -07005#ifndef UPDATE_ENGINE_DBUS_SERVICE_H_
6#define UPDATE_ENGINE_DBUS_SERVICE_H_
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -07007
8#include <inttypes.h>
9#include <dbus/dbus-glib.h>
10#include <dbus/dbus-glib-bindings.h>
11#include <dbus/dbus-glib-lowlevel.h>
12#include <glib-object.h>
13
14#include "update_engine/update_attempter.h"
15
16// Type macros:
17#define UPDATE_ENGINE_TYPE_SERVICE (update_engine_service_get_type())
Andrew de los Reyes63b96d72010-05-10 13:08:54 -070018#define UPDATE_ENGINE_SERVICE(obj) \
19 (G_TYPE_CHECK_INSTANCE_CAST((obj), UPDATE_ENGINE_TYPE_SERVICE, \
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070020 UpdateEngineService))
Andrew de los Reyes63b96d72010-05-10 13:08:54 -070021#define UPDATE_ENGINE_IS_SERVICE(obj) \
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070022 (G_TYPE_CHECK_INSTANCE_TYPE((obj), UPDATE_ENGINE_TYPE_SERVICE))
Andrew de los Reyes63b96d72010-05-10 13:08:54 -070023#define UPDATE_ENGINE_SERVICE_CLASS(klass) \
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070024 (G_TYPE_CHECK_CLASS_CAST((klass), UPDATE_ENGINE_TYPE_SERVICE, \
25 UpdateEngineService))
Andrew de los Reyes63b96d72010-05-10 13:08:54 -070026#define UPDATE_ENGINE_IS_SERVICE_CLASS(klass) \
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070027 (G_TYPE_CHECK_CLASS_TYPE((klass), UPDATE_ENGINE_TYPE_SERVICE))
Andrew de los Reyes63b96d72010-05-10 13:08:54 -070028#define UPDATE_ENGINE_SERVICE_GET_CLASS(obj) \
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070029 (G_TYPE_INSTANCE_GET_CLASS((obj), UPDATE_ENGINE_TYPE_SERVICE, \
30 UpdateEngineService))
31
32G_BEGIN_DECLS
33
34struct UpdateEngineService {
35 GObject parent_instance;
36
Jay Srinivasanae4697c2013-03-18 17:08:08 -070037 chromeos_update_engine::SystemState* system_state_;
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070038};
39
40struct UpdateEngineServiceClass {
41 GObjectClass parent_class;
42};
43
44UpdateEngineService* update_engine_service_new(void);
45GType update_engine_service_get_type(void);
46
47// Methods
48
Darin Petkov296889c2010-07-23 16:20:54 -070049gboolean update_engine_service_attempt_update(UpdateEngineService* self,
50 gchar* app_version,
51 gchar* omaha_url,
52 GError **error);
53
David Zeuthen75a4c3e2013-09-06 11:36:59 -070054gboolean update_engine_service_attempt_update_with_flags(
55 UpdateEngineService* self,
56 gchar* app_version,
57 gchar* omaha_url,
58 gint flags_as_int,
59 GError **error);
60
Chris Sosad317e402013-06-12 13:47:09 -070061gboolean update_engine_service_attempt_rollback(UpdateEngineService* self,
Alex Deymoad923732013-08-29 16:13:49 -070062 gboolean powerwash,
Chris Sosad317e402013-06-12 13:47:09 -070063 GError **error);
64
Alex Vakulenko59e253e2014-02-24 10:40:21 -080065// Checks if the system rollback is available by verifying if the secondary
66// system partition is valid and bootable.
67gboolean update_engine_service_can_rollback(
68 UpdateEngineService* self,
69 gboolean* out_can_rollback,
70 GError **error);
71
Alex Vakulenko2bddadd2014-03-27 13:23:46 -070072// Returns the name of kernel partition that can be rolled back into.
73gboolean update_engine_service_get_rollback_partition(
74 UpdateEngineService* self,
75 gchar** out_rollback_partition_name,
76 GError **error);
77
78// Returns a list of available kernel partitions and whether each of them
79// can be booted from or not.
80gboolean update_engine_service_get_kernel_devices(UpdateEngineService* self,
81 gchar** out_kernel_devices,
82 GError **error);
83
Jay Srinivasanc1ba09a2012-08-14 14:15:57 -070084gboolean update_engine_service_reset_status(UpdateEngineService* self,
85 GError **error);
86
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -070087gboolean update_engine_service_get_status(UpdateEngineService* self,
Andrew de los Reyes63b96d72010-05-10 13:08:54 -070088 int64_t* last_checked_time,
89 double* progress,
90 gchar** current_operation,
91 gchar** new_version,
92 int64_t* new_size,
93 GError **error);
94
Jay Srinivasanae4697c2013-03-18 17:08:08 -070095gboolean update_engine_service_reboot_if_needed(UpdateEngineService* self,
96 GError **error);
97
Jay Srinivasanae4697c2013-03-18 17:08:08 -070098// Changes the current channel of the device to the target channel. If the
99// target channel is a less stable channel than the current channel, then the
100// channel change happens immediately (at the next update check). If the
101// target channel is a more stable channel, then if is_powerwash_allowed is set
102// to true, then also the change happens immediately but with a powerwash if
103// required. Otherwise, the change takes effect eventually (when the version on
104// the target channel goes above the version number of what the device
105// currently has).
106gboolean update_engine_service_set_channel(UpdateEngineService* self,
107 gchar* target_channel,
Alex Deymoad923732013-08-29 16:13:49 -0700108 gboolean is_powerwash_allowed,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700109 GError **error);
Andrew de los Reyes63b96d72010-05-10 13:08:54 -0700110
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700111// If get_current_channel is set to true, populates |channel| with the name of
112// the channel that the device is currently on. Otherwise, it populates it with
113// the name of the channel the device is supposed to be (in case of a pending
114// channel change).
115gboolean update_engine_service_get_channel(UpdateEngineService* self,
Alex Deymoad923732013-08-29 16:13:49 -0700116 gboolean get_current_channel,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700117 gchar** channel,
118 GError **error);
Darin Petkov8daa3242010-10-25 13:28:47 -0700119
Alex Deymo5fdf7762013-07-17 20:01:40 -0700120// Enables or disables the sharing and consuming updates over P2P feature
121// according to the |enabled| argument passed.
122gboolean update_engine_service_set_p2p_update_permission(
123 UpdateEngineService* self,
124 gboolean enabled,
125 GError **error);
126
127// Returns in |enabled| the current value for the P2P enabled setting. This
128// involves both sharing and consuming updates over P2P.
129gboolean update_engine_service_get_p2p_update_permission(
130 UpdateEngineService* self,
131 gboolean* enabled,
132 GError **error);
133
Alex Deymof4867c42013-06-28 14:41:39 -0700134// If there's no device policy installed, sets the update over cellular networks
135// permission to the |allowed| value. Otherwise, this method returns with an
136// error since this setting is overridden by the applied policy.
137gboolean update_engine_service_set_update_over_cellular_permission(
138 UpdateEngineService* self,
Alex Deymoad923732013-08-29 16:13:49 -0700139 gboolean allowed,
Alex Deymof4867c42013-06-28 14:41:39 -0700140 GError **error);
141
142// Returns the current value of the update over cellular network setting, either
143// forced by the device policy if the device is enrolled or the current user
144// preference otherwise.
145gboolean update_engine_service_get_update_over_cellular_permission(
146 UpdateEngineService* self,
Alex Deymoad923732013-08-29 16:13:49 -0700147 gboolean* allowed,
Alex Deymof4867c42013-06-28 14:41:39 -0700148 GError **error);
149
David Zeuthen3c55abd2013-10-14 12:48:03 -0700150// Returns the duration since the last successful update, as the
151// duration on the wallclock. Returns an error if the device has not
152// updated.
153gboolean update_engine_service_get_duration_since_update(
154 UpdateEngineService* self,
155 gint64* out_usec_wallclock,
156 GError **error);
157
Andrew de los Reyes63b96d72010-05-10 13:08:54 -0700158gboolean update_engine_service_emit_status_update(
159 UpdateEngineService* self,
160 gint64 last_checked_time,
161 gdouble progress,
162 const gchar* current_operation,
163 const gchar* new_version,
164 gint64 new_size);
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -0700165
Alex Vakulenkodea2eac2014-03-14 15:56:59 -0700166// Returns the version string of OS that was used before the last reboot
Alex Vakulenko072359c2014-07-18 11:41:07 -0700167// into an updated version. This is available only when rebooting into an
Alex Vakulenkodea2eac2014-03-14 15:56:59 -0700168// update from previous version, otherwise an empty string is returned.
169gboolean update_engine_service_get_prev_version(
170 UpdateEngineService* self,
171 gchar** prev_version,
172 GError **error);
173
Andrew de los Reyes4e9b9f42010-04-26 15:06:43 -0700174G_END_DECLS
175
Gilad Arnoldcf175a02014-07-10 16:48:47 -0700176#endif // UPDATE_ENGINE_DBUS_SERVICE_H_