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
|
/* $Id: USBProxyService.h $ */
/** @file
* VirtualBox USB Proxy Service (base) class.
*/
/*
* Copyright (C) 2005-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_USBProxyService_h
#define MAIN_INCLUDED_USBProxyService_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/usb.h>
#include <VBox/usbfilter.h>
#include "VirtualBoxBase.h"
#include "VirtualBoxImpl.h"
#include "HostUSBDeviceImpl.h"
#include "USBProxyBackend.h"
class Host;
namespace settings
{
struct USBDeviceSource;
typedef std::list<USBDeviceSource> USBDeviceSourcesList;
}
/**
* Base class for the USB Proxy service.
*/
class USBProxyService
: public Lockable
{
public:
DECLARE_TRANSLATE_METHODS(USBProxyService)
USBProxyService(Host *aHost);
virtual HRESULT init(void);
virtual ~USBProxyService();
/**
* Override of the default locking class to be used for validating lock
* order with the standard member lock handle.
*/
virtual VBoxLockingClass getLockingClass() const
{
// the USB proxy service uses the Host object lock, so return the
// same locking class as the host
return LOCKCLASS_HOSTOBJECT;
}
void uninit(void);
bool isActive(void);
int getLastError(void);
RWLockHandle *lockHandle() const;
/** @name Interface for the USBController and the Host object.
* @{ */
void *insertFilter(PCUSBFILTER aFilter);
void removeFilter(void *aId);
/** @} */
/** @name Host Interfaces
* @{ */
HRESULT getDeviceCollection(std::vector<ComPtr<IHostUSBDevice> > &aUSBDevices);
HRESULT addUSBDeviceSource(const com::Utf8Str &aBackend, const com::Utf8Str &aId, const com::Utf8Str &aAddress,
const std::vector<com::Utf8Str> &aPropertyNames, const std::vector<com::Utf8Str> &aPropertyValues);
HRESULT removeUSBDeviceSource(const com::Utf8Str &aId);
/** @} */
/** @name SessionMachine Interfaces
* @{ */
HRESULT captureDeviceForVM(SessionMachine *aMachine, IN_GUID aId, const com::Utf8Str &aCaptureFilename);
HRESULT detachDeviceFromVM(SessionMachine *aMachine, IN_GUID aId, bool aDone);
HRESULT autoCaptureDevicesForVM(SessionMachine *aMachine);
HRESULT detachAllDevicesFromVM(SessionMachine *aMachine, bool aDone, bool aAbnormal);
/** @} */
typedef std::list< ComObjPtr<HostUSBDeviceFilter> > USBDeviceFilterList;
HRESULT i_loadSettings(const settings::USBDeviceSourcesList &llUSBDeviceSources);
HRESULT i_saveSettings(settings::USBDeviceSourcesList &llUSBDeviceSources);
void i_deviceAdded(ComObjPtr<HostUSBDevice> &aDevice, PUSBDEVICE aUSBDevice);
void i_deviceRemoved(ComObjPtr<HostUSBDevice> &aDevice);
void i_updateDeviceState(ComObjPtr<HostUSBDevice> &aDevice, PUSBDEVICE aUSBDevice, bool fFakeUpdate);
protected:
ComObjPtr<HostUSBDevice> findDeviceById(IN_GUID aId);
static HRESULT setError(HRESULT aResultCode, const char *aText, ...);
USBProxyBackend *findUsbProxyBackendById(const com::Utf8Str &strId);
HRESULT createUSBDeviceSource(const com::Utf8Str &aBackend, const com::Utf8Str &aId,
const com::Utf8Str &aAddress, const std::vector<com::Utf8Str> &aPropertyNames,
const std::vector<com::Utf8Str> &aPropertyValues, bool fLoadingSettings);
private:
HRESULT runAllFiltersOnDevice(ComObjPtr<HostUSBDevice> &aDevice,
SessionMachinesList &llOpenedMachines,
SessionMachine *aIgnoreMachine);
bool runMachineFilters(SessionMachine *aMachine, ComObjPtr<HostUSBDevice> &aDevice);
void deviceChanged(ComObjPtr<HostUSBDevice> &aDevice, bool fRunFilters, SessionMachine *aIgnoreMachine);
/** Pointer to the Host object. */
Host *mHost;
/** List of smart HostUSBDevice pointers. */
typedef std::list<ComObjPtr<HostUSBDevice> > HostUSBDeviceList;
/** List of the known USB devices. */
HostUSBDeviceList mDevices;
/** List of USBProxyBackend pointers. */
typedef std::list<ComObjPtr<USBProxyBackend> > USBProxyBackendList;
/** List of active USB backends. */
USBProxyBackendList mBackends;
int mLastError;
};
#endif /* !MAIN_INCLUDED_USBProxyService_h */
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
