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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
/* $Id: USBProxyBackendWindows.cpp $ */
/** @file
* VirtualBox USB Proxy Service, Windows Specialization.
*/
/*
* 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
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_MAIN_USBPROXYBACKEND
#include "USBProxyBackend.h"
#include "LoggingNew.h"
#include <VBox/usb.h>
#include <iprt/errcore.h>
#include <iprt/string.h>
#include <iprt/alloc.h>
#include <iprt/assert.h>
#include <iprt/file.h>
#include <iprt/errcore.h>
#include <VBox/usblib.h>
/**
* Initialize data members.
*/
USBProxyBackendWindows::USBProxyBackendWindows()
: USBProxyBackend(), mhEventInterrupt(INVALID_HANDLE_VALUE)
{
LogFlowThisFunc(("\n"));
}
USBProxyBackendWindows::~USBProxyBackendWindows()
{
}
/**
* Initializes the object (called right after construction).
*
* @returns S_OK on success and non-fatal failures, some COM error otherwise.
*/
int USBProxyBackendWindows::init(USBProxyService *aUsbProxyService, const com::Utf8Str &strId,
const com::Utf8Str &strAddress, bool fLoadingSettings)
{
USBProxyBackend::init(aUsbProxyService, strId, strAddress, fLoadingSettings);
unconst(m_strBackend) = Utf8Str("host");
/*
* Create the semaphore (considered fatal).
*/
mhEventInterrupt = CreateEvent(NULL, FALSE, FALSE, NULL);
AssertReturn(mhEventInterrupt != INVALID_HANDLE_VALUE, VERR_OUT_OF_RESOURCES);
/*
* Initialize the USB lib and stuff.
*/
int vrc = USBLibInit();
if (RT_SUCCESS(vrc))
{
/*
* Start the poller thread.
*/
vrc = start();
if (RT_SUCCESS(vrc))
{
LogFlowThisFunc(("returns successfully\n"));
return VINF_SUCCESS;
}
USBLibTerm();
}
CloseHandle(mhEventInterrupt);
mhEventInterrupt = INVALID_HANDLE_VALUE;
LogFlowThisFunc(("returns failure!!! (vrc=%Rrc)\n", vrc));
return vrc;
}
/**
* Stop all service threads and free the device chain.
*/
void USBProxyBackendWindows::uninit()
{
LogFlowThisFunc(("\n"));
/*
* Stop the service.
*/
if (isActive())
stop();
if (mhEventInterrupt != INVALID_HANDLE_VALUE)
CloseHandle(mhEventInterrupt);
mhEventInterrupt = INVALID_HANDLE_VALUE;
/*
* Terminate the library...
*/
int vrc = USBLibTerm();
AssertRC(vrc);
USBProxyBackend::uninit();
}
void *USBProxyBackendWindows::insertFilter(PCUSBFILTER aFilter)
{
AssertReturn(aFilter, NULL);
LogFlow(("USBProxyBackendWindows::insertFilter()\n"));
void *pvId = USBLibAddFilter(aFilter);
LogFlow(("USBProxyBackendWindows::insertFilter(): returning pvId=%p\n", pvId));
return pvId;
}
void USBProxyBackendWindows::removeFilter(void *aID)
{
LogFlow(("USBProxyBackendWindows::removeFilter(): id=%p\n", aID));
AssertReturnVoid(aID);
USBLibRemoveFilter(aID);
}
int USBProxyBackendWindows::captureDevice(HostUSBDevice *aDevice)
{
/*
* Check preconditions.
*/
AssertReturn(aDevice, VERR_GENERAL_FAILURE);
AssertReturn(!aDevice->isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
LogFlowThisFunc(("aDevice=%s\n", aDevice->i_getName().c_str()));
Assert(aDevice->i_getUnistate() == kHostUSBDeviceState_Capturing);
/*
* Create a one-shot ignore filter for the device
* and trigger a re-enumeration of it.
*/
USBFILTER Filter;
USBFilterInit(&Filter, USBFILTERTYPE_ONESHOT_CAPTURE);
initFilterFromDevice(&Filter, aDevice);
Log(("USBFILTERIDX_PORT=%#x\n", USBFilterGetNum(&Filter, USBFILTERIDX_PORT)));
Log(("USBFILTERIDX_BUS=%#x\n", USBFilterGetNum(&Filter, USBFILTERIDX_BUS)));
void *pvId = USBLibAddFilter(&Filter);
if (!pvId)
{
AssertMsgFailed(("Add one-shot Filter failed\n"));
return VERR_GENERAL_FAILURE;
}
int vrc = USBLibRunFilters();
if (!RT_SUCCESS(vrc))
{
AssertMsgFailed(("Run Filters failed\n"));
USBLibRemoveFilter(pvId);
return vrc;
}
return VINF_SUCCESS;
}
int USBProxyBackendWindows::releaseDevice(HostUSBDevice *aDevice)
{
/*
* Check preconditions.
*/
AssertReturn(aDevice, VERR_GENERAL_FAILURE);
AssertReturn(!aDevice->isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
LogFlowThisFunc(("aDevice=%s\n", aDevice->i_getName().c_str()));
Assert(aDevice->i_getUnistate() == kHostUSBDeviceState_ReleasingToHost);
/*
* Create a one-shot ignore filter for the device
* and trigger a re-enumeration of it.
*/
USBFILTER Filter;
USBFilterInit(&Filter, USBFILTERTYPE_ONESHOT_IGNORE);
initFilterFromDevice(&Filter, aDevice);
Log(("USBFILTERIDX_PORT=%#x\n", USBFilterGetNum(&Filter, USBFILTERIDX_PORT)));
Log(("USBFILTERIDX_BUS=%#x\n", USBFilterGetNum(&Filter, USBFILTERIDX_BUS)));
void *pvId = USBLibAddFilter(&Filter);
if (!pvId)
{
AssertMsgFailed(("Add one-shot Filter failed\n"));
return VERR_GENERAL_FAILURE;
}
int vrc = USBLibRunFilters();
if (!RT_SUCCESS(vrc))
{
AssertMsgFailed(("Run Filters failed\n"));
USBLibRemoveFilter(pvId);
return vrc;
}
return VINF_SUCCESS;
}
/**
* Returns whether devices reported by this backend go through a de/re-attach
* and device re-enumeration cycle when they are captured or released.
*/
bool USBProxyBackendWindows::i_isDevReEnumerationRequired()
{
return true;
}
int USBProxyBackendWindows::wait(unsigned aMillies)
{
return USBLibWaitChange(aMillies);
}
int USBProxyBackendWindows::interruptWait(void)
{
return USBLibInterruptWaitChange();
}
/**
* Gets a list of all devices the VM can grab
*/
PUSBDEVICE USBProxyBackendWindows::getDevices(void)
{
PUSBDEVICE pDevices = NULL;
uint32_t cDevices = 0;
Log(("USBProxyBackendWindows::getDevices\n"));
USBLibGetDevices(&pDevices, &cDevices);
return pDevices;
}
|
