forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
concierge_client.h
177 lines (146 loc) · 6.9 KB
/
concierge_client.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_DBUS_CONCIERGE_CLIENT_H_
#define CHROMEOS_DBUS_CONCIERGE_CLIENT_H_
#include <memory>
#include "base/component_export.h"
#include "base/files/scoped_file.h"
#include "chromeos/dbus/concierge/service.pb.h"
#include "chromeos/dbus/dbus_client.h"
#include "chromeos/dbus/dbus_method_call_status.h"
#include "dbus/object_proxy.h"
namespace chromeos {
// ConciergeClient is used to communicate with Concierge, which is used to
// start and stop VMs, as well as for disk image management.
class COMPONENT_EXPORT(CHROMEOS_DBUS) ConciergeClient : public DBusClient {
public:
// Used for observing all concierge signals related to running
// containers (e.g. startup).
class ContainerObserver {
public:
// OnContainerStartupFailed is signaled by Concierge after the long-running
// container startup process's failure is detected. Note the signal protocol
// buffer type is the same as in OnContainerStarted.
virtual void OnContainerStartupFailed(
const vm_tools::concierge::ContainerStartedSignal& signal) = 0;
protected:
virtual ~ContainerObserver() = default;
};
// Used for observing all concierge signals related to VM disk image
// operations, e.g. importing.
class DiskImageObserver {
public:
// OnDiskImageProgress is signaled by Concierge after an ImportDiskImage
// call has been made and an update about the status of the import
// is available.
virtual void OnDiskImageProgress(
const vm_tools::concierge::DiskImageStatusResponse& signal) = 0;
protected:
virtual ~DiskImageObserver() = default;
};
// Adds an observer for container startup.
virtual void AddContainerObserver(ContainerObserver* observer) = 0;
// Removes an observer if added.
virtual void RemoveContainerObserver(ContainerObserver* observer) = 0;
// Adds an observer for disk image operations.
virtual void AddDiskImageObserver(DiskImageObserver* observer) = 0;
// Adds an observer for disk image operations.
virtual void RemoveDiskImageObserver(DiskImageObserver* observer) = 0;
// IsContainerStartupFailedSignalConnected must return true before
// StartContainer is called.
virtual bool IsContainerStartupFailedSignalConnected() = 0;
// IsDiskImageProgressSignalConnected must return true before
// ImportDiskImage is called.
virtual bool IsDiskImageProgressSignalConnected() = 0;
// Creates a disk image for the Termina VM.
// |callback| is called after the method call finishes.
virtual void CreateDiskImage(
const vm_tools::concierge::CreateDiskImageRequest& request,
DBusMethodCallback<vm_tools::concierge::CreateDiskImageResponse>
callback) = 0;
// Destroys a Termina VM and removes its disk image.
// |callback| is called after the method call finishes.
virtual void DestroyDiskImage(
const vm_tools::concierge::DestroyDiskImageRequest& request,
DBusMethodCallback<vm_tools::concierge::DestroyDiskImageResponse>
callback) = 0;
// Imports a VM disk image.
// |callback| is called after the method call finishes.
virtual void ImportDiskImage(
base::ScopedFD fd,
const vm_tools::concierge::ImportDiskImageRequest& request,
DBusMethodCallback<vm_tools::concierge::ImportDiskImageResponse>
callback) = 0;
// Cancels a VM disk image operation (import or export) that is being
// executed.
// |callback| is called after the method call finishes.
virtual void CancelDiskImageOperation(
const vm_tools::concierge::CancelDiskImageRequest& request,
DBusMethodCallback<vm_tools::concierge::CancelDiskImageResponse>
callback) = 0;
// Retrieves the status of a disk image operation
// |callback| is called after the method call finishes.
virtual void DiskImageStatus(
const vm_tools::concierge::DiskImageStatusRequest& request,
DBusMethodCallback<vm_tools::concierge::DiskImageStatusResponse>
callback) = 0;
// Lists the Termina VMs.
// |callback| is called after the method call finishes.
virtual void ListVmDisks(
const vm_tools::concierge::ListVmDisksRequest& request,
DBusMethodCallback<vm_tools::concierge::ListVmDisksResponse>
callback) = 0;
// Starts a Termina VM if there is not alread one running.
// |callback| is called after the method call finishes.
virtual void StartTerminaVm(
const vm_tools::concierge::StartVmRequest& request,
DBusMethodCallback<vm_tools::concierge::StartVmResponse> callback) = 0;
// Stops the named Termina VM if it is running.
// |callback| is called after the method call finishes.
virtual void StopVm(
const vm_tools::concierge::StopVmRequest& request,
DBusMethodCallback<vm_tools::concierge::StopVmResponse> callback) = 0;
// Registers |callback| to run when the Concierge service becomes available.
// If the service is already available, or if connecting to the name-owner-
// changed signal fails, |callback| will be run once asynchronously.
// Otherwise, |callback| will be run once in the future after the service
// becomes available.
virtual void WaitForServiceToBeAvailable(
dbus::ObjectProxy::WaitForServiceToBeAvailableCallback callback) = 0;
// Gets SSH server public key of container and trusted SSH client private key
// which can be used to connect to the container.
// |callback| is called after the method call finishes.
virtual void GetContainerSshKeys(
const vm_tools::concierge::ContainerSshKeysRequest& request,
DBusMethodCallback<vm_tools::concierge::ContainerSshKeysResponse>
callback) = 0;
// Attaches a USB device to a VM.
// |callback| is called once the method call has finished.
virtual void AttachUsbDevice(base::ScopedFD fd,
const vm_tools::concierge::AttachUsbDeviceRequest& request,
DBusMethodCallback<vm_tools::concierge::AttachUsbDeviceResponse>
callback) = 0;
// Removes a USB device from a VM it's been attached to.
// |callback| is called once the method call has finished.
virtual void DetachUsbDevice(
const vm_tools::concierge::DetachUsbDeviceRequest& request,
DBusMethodCallback<vm_tools::concierge::DetachUsbDeviceResponse>
callback) = 0;
// Lists all the USB devices currently attached to a given VM.
// |callback| is called once the method call has finished.
virtual void ListUsbDevices(
const vm_tools::concierge::ListUsbDeviceRequest& request,
DBusMethodCallback<vm_tools::concierge::ListUsbDeviceResponse>
callback) = 0;
// Creates an instance of ConciergeClient.
static std::unique_ptr<ConciergeClient> Create();
~ConciergeClient() override;
protected:
// Create() should be used instead.
ConciergeClient();
private:
DISALLOW_COPY_AND_ASSIGN(ConciergeClient);
};
} // namespace chromeos
#endif // CHROMEOS_DBUS_CONCIERGE_CLIENT_H_