VirtualBox

source: vbox/trunk/src/VBox/Main/include/USBProxyService.h@ 36877

Last change on this file since 36877 was 36418, checked in by vboxsync, 14 years ago

Main/USB/Linux: extend environment variables for selecting USB probing method and add skeleton testcase
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.6 KB
Line 
1/* $Id: USBProxyService.h 36418 2011-03-24 22:53:13Z vboxsync $ */
2/** @file
3 * VirtualBox USB Proxy Service (base) class.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19#ifndef ____H_USBPROXYSERVICE
20#define ____H_USBPROXYSERVICE
21
22#include <VBox/usb.h>
23#include <VBox/usbfilter.h>
24
25#include "VirtualBoxBase.h"
26#include "VirtualBoxImpl.h"
27#include "HostUSBDeviceImpl.h"
28class Host;
29
30/**
31 * Base class for the USB Proxy service.
32 */
33class USBProxyService
34 : public VirtualBoxTranslatable
35{
36public:
37 USBProxyService(Host *aHost);
38 virtual HRESULT init(void);
39 virtual ~USBProxyService();
40
41 /**
42 * Override of the default locking class to be used for validating lock
43 * order with the standard member lock handle.
44 */
45 virtual VBoxLockingClass getLockingClass() const
46 {
47 // the USB proxy service uses the Host object lock, so return the
48 // same locking class as the host
49 return LOCKCLASS_HOSTOBJECT;
50 }
51
52 bool isActive(void);
53 int getLastError(void);
54 HRESULT getLastErrorMessage(BSTR *aError);
55
56 RWLockHandle *lockHandle() const;
57
58 /** @name Host Interfaces
59 * @{ */
60 HRESULT getDeviceCollection(ComSafeArrayOut(IHostUSBDevice *, aUSBDevices));
61 /** @} */
62
63 /** @name SessionMachine Interfaces
64 * @{ */
65 HRESULT captureDeviceForVM(SessionMachine *aMachine, IN_GUID aId);
66 HRESULT detachDeviceFromVM(SessionMachine *aMachine, IN_GUID aId, bool aDone);
67 HRESULT autoCaptureDevicesForVM(SessionMachine *aMachine);
68 HRESULT detachAllDevicesFromVM(SessionMachine *aMachine, bool aDone, bool aAbnormal);
69 /** @} */
70
71 /** @name Interface for the USBController and the Host object.
72 * @{ */
73 virtual void *insertFilter(PCUSBFILTER aFilter);
74 virtual void removeFilter(void *aId);
75 /** @} */
76
77 /** @name Interfaces for the HostUSBDevice
78 * @{ */
79 virtual int captureDevice(HostUSBDevice *aDevice);
80 virtual void captureDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
81 virtual void detachingDevice(HostUSBDevice *aDevice);
82 virtual int releaseDevice(HostUSBDevice *aDevice);
83 virtual void releaseDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
84 /** @} */
85
86protected:
87 int start(void);
88 int stop(void);
89 virtual void serviceThreadInit(void);
90 virtual void serviceThreadTerm(void);
91
92 virtual int wait(RTMSINTERVAL aMillies);
93 virtual int interruptWait(void);
94 virtual PUSBDEVICE getDevices(void);
95 virtual void deviceAdded(ComObjPtr<HostUSBDevice> &aDevice, SessionMachinesList &llOpenedMachines, PUSBDEVICE aUSBDevice);
96 virtual void deviceRemoved(ComObjPtr<HostUSBDevice> &aDevice);
97 virtual void deviceChanged(ComObjPtr<HostUSBDevice> &aDevice, SessionMachinesList *pllOpenedMachines, SessionMachine *aIgnoreMachine);
98 bool updateDeviceStateFake(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
99 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
100
101 ComObjPtr<HostUSBDevice> findDeviceById(IN_GUID aId);
102
103 static HRESULT setError(HRESULT aResultCode, const char *aText, ...);
104
105 static void initFilterFromDevice(PUSBFILTER aFilter, HostUSBDevice *aDevice);
106 static void freeDeviceMembers(PUSBDEVICE pDevice);
107public:
108 static void freeDevice(PUSBDEVICE pDevice);
109
110private:
111 HRESULT runAllFiltersOnDevice(ComObjPtr<HostUSBDevice> &aDevice,
112 SessionMachinesList &llOpenedMachines,
113 SessionMachine *aIgnoreMachine);
114 bool runMachineFilters(SessionMachine *aMachine, ComObjPtr<HostUSBDevice> &aDevice);
115 void processChanges(void);
116 static DECLCALLBACK(int) serviceThread(RTTHREAD Thread, void *pvUser);
117
118protected:
119 /** Pointer to the Host object. */
120 Host *mHost;
121 /** Thread handle of the service thread. */
122 RTTHREAD mThread;
123 /** Flag which stop() sets to cause serviceThread to return. */
124 bool volatile mTerminate;
125 /** VBox status code of the last failure.
126 * (Only used by start(), stop() and the child constructors.) */
127 int mLastError;
128 /** Optional error message to complement mLastError. */
129 Bstr mLastErrorMessage;
130 /** List of smart HostUSBDevice pointers. */
131 typedef std::list<ComObjPtr<HostUSBDevice> > HostUSBDeviceList;
132 /** List of the known USB devices. */
133 HostUSBDeviceList mDevices;
134};
135
136
137# ifdef RT_OS_DARWIN
138# include <VBox/param.h>
139# undef PAGE_SHIFT
140# undef PAGE_SIZE
141# define OSType Carbon_OSType
142# include <Carbon/Carbon.h>
143# undef OSType
144
145/**
146 * The Darwin hosted USB Proxy Service.
147 */
148class USBProxyServiceDarwin : public USBProxyService
149{
150public:
151 USBProxyServiceDarwin(Host *aHost);
152 HRESULT init(void);
153 ~USBProxyServiceDarwin();
154
155#ifdef VBOX_WITH_NEW_USB_CODE_ON_DARWIN
156 virtual void *insertFilter(PCUSBFILTER aFilter);
157 virtual void removeFilter(void *aId);
158#endif
159
160 virtual int captureDevice(HostUSBDevice *aDevice);
161 virtual void captureDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
162 virtual void detachingDevice(HostUSBDevice *aDevice);
163 virtual int releaseDevice(HostUSBDevice *aDevice);
164 virtual void releaseDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
165
166protected:
167 virtual int wait(RTMSINTERVAL aMillies);
168 virtual int interruptWait (void);
169 virtual PUSBDEVICE getDevices (void);
170 virtual void serviceThreadInit (void);
171 virtual void serviceThreadTerm (void);
172 virtual bool updateDeviceState (HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
173
174private:
175 /** Reference to the runloop of the service thread.
176 * This is NULL if the service thread isn't running. */
177 CFRunLoopRef mServiceRunLoopRef;
178 /** The opaque value returned by DarwinSubscribeUSBNotifications. */
179 void *mNotifyOpaque;
180 /** A hack to work around the problem with the usb device enumeration
181 * not including newly attached devices. */
182 bool mWaitABitNextTime;
183#ifndef VBOX_WITH_NEW_USB_CODE_ON_DARWIN
184 /** Whether we've got a fake async event and should return without entering the runloop. */
185 bool volatile mFakeAsync;
186#endif
187 /** Whether we've successfully initialized the USBLib and should call USBLibTerm in the destructor. */
188 bool mUSBLibInitialized;
189};
190# endif /* RT_OS_DARWIN */
191
192
193# ifdef RT_OS_LINUX
194# include <stdio.h>
195# ifdef VBOX_USB_WITH_SYSFS
196# include <HostHardwareLinux.h>
197# endif
198
199/**
200 * The Linux hosted USB Proxy Service.
201 */
202class USBProxyServiceLinux
203 : public USBProxyService
204{
205public:
206 USBProxyServiceLinux(Host *aHost);
207 HRESULT init(void);
208 ~USBProxyServiceLinux();
209
210 virtual int captureDevice(HostUSBDevice *aDevice);
211 virtual int releaseDevice(HostUSBDevice *aDevice);
212
213protected:
214#ifdef TESTCASE
215 virtual
216#endif
217 int initUsbfs(void);
218#ifdef TESTCASE
219 virtual
220#endif
221 int initSysfs(void);
222 void doUsbfsCleanupAsNeeded(void);
223 virtual int wait(RTMSINTERVAL aMillies);
224 virtual int interruptWait(void);
225 virtual PUSBDEVICE getDevices(void);
226 virtual void deviceAdded(ComObjPtr<HostUSBDevice> &aDevice, SessionMachinesList &llOpenedMachines, PUSBDEVICE aUSBDevice);
227 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
228
229private:
230 int waitUsbfs(RTMSINTERVAL aMillies);
231 int waitSysfs(RTMSINTERVAL aMillies);
232
233private:
234 /** File handle to the '/proc/bus/usb/devices' file. */
235 RTFILE mFile;
236 /** Pipe used to interrupt wait(), the read end. */
237 RTFILE mWakeupPipeR;
238 /** Pipe used to interrupt wait(), the write end. */
239 RTFILE mWakeupPipeW;
240 /** The root of usbfs. */
241 Utf8Str mDevicesRoot;
242 /** Whether we're using <mUsbfsRoot>/devices or /sys/whatever. */
243 bool mUsingUsbfsDevices;
244 /** Number of 500ms polls left to do. See usbDeterminState for details. */
245 unsigned mUdevPolls;
246# ifdef VBOX_USB_WITH_SYSFS
247 /** Object used for polling for hotplug events from hal. */
248 VBoxMainHotplugWaiter *mpWaiter;
249# endif
250};
251# endif /* RT_OS_LINUX */
252
253
254# ifdef RT_OS_OS2
255# include <usbcalls.h>
256
257/**
258 * The Linux hosted USB Proxy Service.
259 */
260class USBProxyServiceOs2 : public USBProxyService
261{
262public:
263 USBProxyServiceOs2 (Host *aHost);
264 /// @todo virtual HRESULT init(void);
265 ~USBProxyServiceOs2();
266
267 virtual int captureDevice (HostUSBDevice *aDevice);
268 virtual int releaseDevice (HostUSBDevice *aDevice);
269
270protected:
271 virtual int wait(RTMSINTERVAL aMillies);
272 virtual int interruptWait(void);
273 virtual PUSBDEVICE getDevices(void);
274 int addDeviceToChain(PUSBDEVICE pDev, PUSBDEVICE *ppFirst, PUSBDEVICE **pppNext, int rc);
275 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
276
277private:
278 /** The notification event semaphore */
279 HEV mhev;
280 /** The notification id. */
281 USBNOTIFY mNotifyId;
282 /** The usbcalls.dll handle. */
283 HMODULE mhmod;
284 /** UsbRegisterChangeNotification */
285 APIRET (APIENTRY *mpfnUsbRegisterChangeNotification)(PUSBNOTIFY, HEV, HEV);
286 /** UsbDeregisterNotification */
287 APIRET (APIENTRY *mpfnUsbDeregisterNotification)(USBNOTIFY);
288 /** UsbQueryNumberDevices */
289 APIRET (APIENTRY *mpfnUsbQueryNumberDevices)(PULONG);
290 /** UsbQueryDeviceReport */
291 APIRET (APIENTRY *mpfnUsbQueryDeviceReport)(ULONG, PULONG, PVOID);
292};
293# endif /* RT_OS_LINUX */
294
295
296# ifdef RT_OS_SOLARIS
297# include <libdevinfo.h>
298
299/**
300 * The Solaris hosted USB Proxy Service.
301 */
302class USBProxyServiceSolaris : public USBProxyService
303{
304public:
305 USBProxyServiceSolaris(Host *aHost);
306 HRESULT init(void);
307 ~USBProxyServiceSolaris();
308
309 virtual void *insertFilter (PCUSBFILTER aFilter);
310 virtual void removeFilter (void *aID);
311
312 virtual int captureDevice (HostUSBDevice *aDevice);
313 virtual int releaseDevice (HostUSBDevice *aDevice);
314 virtual void captureDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
315 virtual void releaseDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
316
317protected:
318 virtual int wait(RTMSINTERVAL aMillies);
319 virtual int interruptWait(void);
320 virtual PUSBDEVICE getDevices(void);
321 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
322
323private:
324 RTSEMEVENT mNotifyEventSem;
325 /** Whether we've successfully initialized the USBLib and should call USBLibTerm in the destructor. */
326 bool mUSBLibInitialized;
327};
328#endif /* RT_OS_SOLARIS */
329
330
331# ifdef RT_OS_WINDOWS
332/**
333 * The Windows hosted USB Proxy Service.
334 */
335class USBProxyServiceWindows : public USBProxyService
336{
337public:
338 USBProxyServiceWindows(Host *aHost);
339 HRESULT init(void);
340 ~USBProxyServiceWindows();
341
342 virtual void *insertFilter (PCUSBFILTER aFilter);
343 virtual void removeFilter (void *aID);
344
345 virtual int captureDevice (HostUSBDevice *aDevice);
346 virtual int releaseDevice (HostUSBDevice *aDevice);
347
348protected:
349 virtual int wait(RTMSINTERVAL aMillies);
350 virtual int interruptWait(void);
351 virtual PUSBDEVICE getDevices(void);
352 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
353
354private:
355
356 HANDLE mhEventInterrupt;
357};
358# endif /* RT_OS_WINDOWS */
359
360# ifdef RT_OS_FREEBSD
361/**
362 * The FreeBSD hosted USB Proxy Service.
363 */
364class USBProxyServiceFreeBSD : public USBProxyService
365{
366public:
367 USBProxyServiceFreeBSD(Host *aHost);
368 HRESULT init(void);
369 ~USBProxyServiceFreeBSD();
370
371 virtual int captureDevice(HostUSBDevice *aDevice);
372 virtual int releaseDevice(HostUSBDevice *aDevice);
373
374protected:
375 int initUsbfs(void);
376 int initSysfs(void);
377 virtual int wait(RTMSINTERVAL aMillies);
378 virtual int interruptWait(void);
379 virtual PUSBDEVICE getDevices(void);
380 int addDeviceToChain(PUSBDEVICE pDev, PUSBDEVICE *ppFirst, PUSBDEVICE **pppNext, int rc);
381 virtual void deviceAdded(ComObjPtr<HostUSBDevice> &aDevice, SessionMachinesList &llOpenedMachines, PUSBDEVICE aUSBDevice);
382 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
383
384private:
385 RTSEMEVENT mNotifyEventSem;
386};
387# endif /* RT_OS_FREEBSD */
388
389#endif /* !____H_USBPROXYSERVICE */
390/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette