blob: 7923217358d2988c1cc0b102dc5e5b10dc1e02c0 [file] [log] [blame]
Alex Deymoaea4c1c2015-08-19 20:24:43 -07001//
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//
Jay Srinivasan43488792012-06-19 00:25:31 -070016
Gilad Arnoldcf175a02014-07-10 16:48:47 -070017#ifndef UPDATE_ENGINE_SYSTEM_STATE_H_
18#define UPDATE_ENGINE_SYSTEM_STATE_H_
Jay Srinivasan43488792012-06-19 00:25:31 -070019
Alex Deymob09305e2015-12-02 16:09:13 -030020namespace org {
21namespace chromium {
22class PowerManagerProxyInterface;
23} // namespace chromium
24} // namespace org
Alex Deymo30534502015-07-20 15:06:33 -070025
Gilad Arnold1f847232014-04-07 12:07:49 -070026class MetricsLibraryInterface;
Gilad Arnoldf3815bb2013-01-14 11:58:24 -080027
Alex Deymo63784a52014-05-28 10:46:14 -070028namespace chromeos_update_manager {
Alex Deymo94c06162014-03-21 20:34:46 -070029
Alex Deymo63784a52014-05-28 10:46:14 -070030class UpdateManager;
Alex Deymo94c06162014-03-21 20:34:46 -070031
Alex Deymo63784a52014-05-28 10:46:14 -070032} // namespace chromeos_update_manager
Alex Deymo94c06162014-03-21 20:34:46 -070033
Gilad Arnold1f847232014-04-07 12:07:49 -070034namespace policy {
35
36class DevicePolicy;
37
38} // namespace policy
39
Jay Srinivasan43488792012-06-19 00:25:31 -070040namespace chromeos_update_engine {
41
Jay Srinivasan55f50c22013-01-10 19:24:35 -080042// 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.
Alex Deymo763e7db2015-08-27 21:08:08 -070045class BootControlInterface;
David Zeuthenf413fe52013-04-22 14:04:39 -070046class ClockInterface;
Alex Deymof6ee0162015-07-31 12:35:22 -070047class ConnectionManagerInterface;
Alex Deymo94c06162014-03-21 20:34:46 -070048class HardwareInterface;
Gilad Arnold1f847232014-04-07 12:07:49 -070049class OmahaRequestParams;
David Zeuthen526cb582013-08-06 12:26:18 -070050class P2PManager;
Alex Deymo94c06162014-03-21 20:34:46 -070051class PayloadStateInterface;
52class PrefsInterface;
53class UpdateAttempter;
Alex Deymof7ead812015-10-23 17:37:27 -070054class WeaveServiceInterface;
Jay Srinivasan55f50c22013-01-10 19:24:35 -080055
Jay Srinivasan43488792012-06-19 00:25:31 -070056// An interface to global system context, including platform resources,
Jay Srinivasan6f6ea002012-12-14 11:26:28 -080057// the current state of the system, high-level objects whose lifetime is same
58// as main, system interfaces, etc.
Jay Srinivasan43488792012-06-19 00:25:31 -070059// 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.
Alex Deymo94c06162014-03-21 20:34:46 -070062// TODO(jaysri): Consider renaming this to something like GlobalContext.
Jay Srinivasan43488792012-06-19 00:25:31 -070063class SystemState {
64 public:
65 // Destructs this object.
66 virtual ~SystemState() {}
67
Jay Srinivasan43488792012-06-19 00:25:31 -070068 // Sets or gets the latest device policy.
Jay Srinivasan6f6ea002012-12-14 11:26:28 -080069 virtual void set_device_policy(const policy::DevicePolicy* device_policy) = 0;
Gilad Arnold1f847232014-04-07 12:07:49 -070070 virtual const policy::DevicePolicy* device_policy() = 0;
Jay Srinivasan43488792012-06-19 00:25:31 -070071
Alex Deymo763e7db2015-08-27 21:08:08 -070072 // Gets the interface object for the bootloader control interface.
73 virtual BootControlInterface* boot_control() = 0;
74
David Zeuthenf413fe52013-04-22 14:04:39 -070075 // Gets the interface object for the clock.
76 virtual ClockInterface* clock() = 0;
77
Jay Srinivasan43488792012-06-19 00:25:31 -070078 // Gets the connection manager object.
Alex Deymof6ee0162015-07-31 12:35:22 -070079 virtual ConnectionManagerInterface* connection_manager() = 0;
Jay Srinivasanf0572052012-10-23 18:12:56 -070080
Alex Deymo42432912013-07-12 20:21:15 -070081 // Gets the hardware interface object.
82 virtual HardwareInterface* hardware() = 0;
83
Jay Srinivasan6f6ea002012-12-14 11:26:28 -080084 // Gets the Metrics Library interface for reporting UMA stats.
Jay Srinivasanf0572052012-10-23 18:12:56 -070085 virtual MetricsLibraryInterface* metrics_lib() = 0;
Jay Srinivasan6f6ea002012-12-14 11:26:28 -080086
87 // Gets the interface object for persisted store.
88 virtual PrefsInterface* prefs() = 0;
89
Chris Sosaaa18e162013-06-20 13:20:30 -070090 // 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
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080096 // Gets the interface for the payload state object.
97 virtual PayloadStateInterface* payload_state() = 0;
Gilad Arnoldbf7919b2013-01-08 13:07:37 -080098
Jay Srinivasan55f50c22013-01-10 19:24:35 -080099 // Returns a pointer to the update attempter object.
Gilad Arnold1f847232014-04-07 12:07:49 -0700100 virtual UpdateAttempter* update_attempter() = 0;
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700101
Alex Deymof7ead812015-10-23 17:37:27 -0700102 // Returns a pointer to the WeaveServiceInterface class or nullptr if none.
103 virtual WeaveServiceInterface* weave_service() = 0;
104
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700105 // Returns a pointer to the object that stores the parameters that are
106 // common to all Omaha requests.
107 virtual OmahaRequestParams* request_params() = 0;
Chris Sosabe45bef2013-04-09 18:25:12 -0700108
David Zeuthen526cb582013-08-06 12:26:18 -0700109 // Returns a pointer to the P2PManager singleton.
110 virtual P2PManager* p2p_manager() = 0;
111
Alex Deymo63784a52014-05-28 10:46:14 -0700112 // Returns a pointer to the UpdateManager singleton.
113 virtual chromeos_update_manager::UpdateManager* update_manager() = 0;
Alex Deymo94c06162014-03-21 20:34:46 -0700114
Alex Deymo30534502015-07-20 15:06:33 -0700115 // DBus proxies. Mocked during test.
116 virtual org::chromium::PowerManagerProxyInterface* power_manager_proxy() = 0;
117
Chris Sosabe45bef2013-04-09 18:25:12 -0700118 // 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;
Jay Srinivasan43488792012-06-19 00:25:31 -0700122};
123
124} // namespace chromeos_update_engine
125
Gilad Arnoldcf175a02014-07-10 16:48:47 -0700126#endif // UPDATE_ENGINE_SYSTEM_STATE_H_