1//
2// Copyright (C) 2012 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_SYSTEM_STATE_H_
18#define UPDATE_ENGINE_SYSTEM_STATE_H_
19
20namespace org {
21namespace chromium {
22class PowerManagerProxyInterface;
23}  // namespace chromium
24}  // namespace org
25
26class MetricsLibraryInterface;
27
28namespace chromeos_update_manager {
29
30class UpdateManager;
31
32}  // namespace chromeos_update_manager
33
34namespace policy {
35
36class DevicePolicy;
37
38}  // namespace policy
39
40namespace chromeos_update_engine {
41
42// SystemState is the root class within the update engine. So we should avoid
43// any circular references in header file inclusion. Hence forward-declaring
44// the required classes.
45class BootControlInterface;
46class ClockInterface;
47class ConnectionManagerInterface;
48class HardwareInterface;
49class OmahaRequestParams;
50class P2PManager;
51class PayloadStateInterface;
52class PrefsInterface;
53class UpdateAttempter;
54class WeaveServiceInterface;
55
56// An interface to global system context, including platform resources,
57// the current state of the system, high-level objects whose lifetime is same
58// as main, system interfaces, etc.
59// Carved out separately so it can be mocked for unit tests.
60// Currently it has only one method, but we should start migrating other
61// methods to use this as and when needed to unit test them.
62// TODO(jaysri): Consider renaming this to something like GlobalContext.
63class SystemState {
64 public:
65  // Destructs this object.
66  virtual ~SystemState() {}
67
68  // Sets or gets the latest device policy.
69  virtual void set_device_policy(const policy::DevicePolicy* device_policy) = 0;
70  virtual const policy::DevicePolicy* device_policy() = 0;
71
72  // Gets the interface object for the bootloader control interface.
73  virtual BootControlInterface* boot_control() = 0;
74
75  // Gets the interface object for the clock.
76  virtual ClockInterface* clock() = 0;
77
78  // Gets the connection manager object.
79  virtual ConnectionManagerInterface* connection_manager() = 0;
80
81  // Gets the hardware interface object.
82  virtual HardwareInterface* hardware() = 0;
83
84  // Gets the Metrics Library interface for reporting UMA stats.
85  virtual MetricsLibraryInterface* metrics_lib() = 0;
86
87  // Gets the interface object for persisted store.
88  virtual PrefsInterface* prefs() = 0;
89
90  // Gets the interface object for the persisted store that persists across
91  // powerwashes. Please note that this should be used very seldomly and must
92  // be forwards and backwards compatible as powerwash is used to go back and
93  // forth in system versions.
94  virtual PrefsInterface* powerwash_safe_prefs() = 0;
95
96  // Gets the interface for the payload state object.
97  virtual PayloadStateInterface* payload_state() = 0;
98
99  // Returns a pointer to the update attempter object.
100  virtual UpdateAttempter* update_attempter() = 0;
101
102  // Returns a pointer to the WeaveServiceInterface class or nullptr if none.
103  virtual WeaveServiceInterface* weave_service() = 0;
104
105  // Returns a pointer to the object that stores the parameters that are
106  // common to all Omaha requests.
107  virtual OmahaRequestParams* request_params() = 0;
108
109  // Returns a pointer to the P2PManager singleton.
110  virtual P2PManager* p2p_manager() = 0;
111
112  // Returns a pointer to the UpdateManager singleton.
113  virtual chromeos_update_manager::UpdateManager* update_manager() = 0;
114
115  // DBus proxies. Mocked during test.
116  virtual org::chromium::PowerManagerProxyInterface* power_manager_proxy() = 0;
117
118  // If true, this is the first instance of the update engine since the system
119  // restarted. Important for tracking whether you are running instance of the
120  // update engine on first boot or due to a crash/restart.
121  virtual bool system_rebooted() = 0;
122};
123
124}  // namespace chromeos_update_engine
125
126#endif  // UPDATE_ENGINE_SYSTEM_STATE_H_
127