VirtualBox

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

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

OSE header fixes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.9 KB
Line 
1/* $Id: USBProxyService.h 31892 2010-08-24 08:00:51Z 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 const char *aUsbfsRoot = "/proc/bus/usb");
208 HRESULT init(void);
209 ~USBProxyServiceLinux();
210
211 virtual int captureDevice(HostUSBDevice *aDevice);
212 virtual int releaseDevice(HostUSBDevice *aDevice);
213
214protected:
215 int initUsbfs(void);
216 int initSysfs(void);
217 void doUsbfsCleanupAsNeeded(void);
218 virtual int wait(RTMSINTERVAL aMillies);
219 virtual int interruptWait(void);
220 virtual PUSBDEVICE getDevices(void);
221 PUSBDEVICE getDevicesFromUsbfs(void);
222 PUSBDEVICE getDevicesFromSysfs(void);
223 int addDeviceToChain(PUSBDEVICE pDev, PUSBDEVICE *ppFirst, PUSBDEVICE **pppNext, int rc);
224 virtual void deviceAdded(ComObjPtr<HostUSBDevice> &aDevice, SessionMachinesList &llOpenedMachines, PUSBDEVICE aUSBDevice);
225 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
226
227private:
228 int waitUsbfs(RTMSINTERVAL aMillies);
229 int waitSysfs(RTMSINTERVAL aMillies);
230
231private:
232 /** File handle to the '/proc/bus/usb/devices' file. */
233 RTFILE mFile;
234 /** Stream for mFile. */
235 FILE *mStream;
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 mUsbfsRoot;
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 querying device information from hal. */
248 VBoxMainUSBDeviceInfo mDeviceList;
249 /** Object used for polling for hotplug events from hal. */
250 VBoxMainHotplugWaiter mWaiter;
251# endif
252};
253# endif /* RT_OS_LINUX */
254
255
256# ifdef RT_OS_OS2
257# include <usbcalls.h>
258
259/**
260 * The Linux hosted USB Proxy Service.
261 */
262class USBProxyServiceOs2 : public USBProxyService
263{
264public:
265 USBProxyServiceOs2 (Host *aHost);
266 /// @todo virtual HRESULT init(void);
267 ~USBProxyServiceOs2();
268
269 virtual int captureDevice (HostUSBDevice *aDevice);
270 virtual int releaseDevice (HostUSBDevice *aDevice);
271
272protected:
273 virtual int wait(RTMSINTERVAL aMillies);
274 virtual int interruptWait(void);
275 virtual PUSBDEVICE getDevices(void);
276 int addDeviceToChain(PUSBDEVICE pDev, PUSBDEVICE *ppFirst, PUSBDEVICE **pppNext, int rc);
277 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
278
279private:
280 /** The notification event semaphore */
281 HEV mhev;
282 /** The notification id. */
283 USBNOTIFY mNotifyId;
284 /** The usbcalls.dll handle. */
285 HMODULE mhmod;
286 /** UsbRegisterChangeNotification */
287 APIRET (APIENTRY *mpfnUsbRegisterChangeNotification)(PUSBNOTIFY, HEV, HEV);
288 /** UsbDeregisterNotification */
289 APIRET (APIENTRY *mpfnUsbDeregisterNotification)(USBNOTIFY);
290 /** UsbQueryNumberDevices */
291 APIRET (APIENTRY *mpfnUsbQueryNumberDevices)(PULONG);
292 /** UsbQueryDeviceReport */
293 APIRET (APIENTRY *mpfnUsbQueryDeviceReport)(ULONG, PULONG, PVOID);
294};
295# endif /* RT_OS_LINUX */
296
297
298# ifdef RT_OS_SOLARIS
299# include <libdevinfo.h>
300
301/**
302 * The Solaris hosted USB Proxy Service.
303 */
304class USBProxyServiceSolaris : public USBProxyService
305{
306public:
307 USBProxyServiceSolaris(Host *aHost);
308 HRESULT init(void);
309 ~USBProxyServiceSolaris();
310
311 virtual void *insertFilter (PCUSBFILTER aFilter);
312 virtual void removeFilter (void *aID);
313
314 virtual int captureDevice (HostUSBDevice *aDevice);
315 virtual int releaseDevice (HostUSBDevice *aDevice);
316 virtual void captureDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
317 virtual void releaseDeviceCompleted(HostUSBDevice *aDevice, bool aSuccess);
318
319protected:
320 virtual int wait(RTMSINTERVAL aMillies);
321 virtual int interruptWait(void);
322 virtual PUSBDEVICE getDevices(void);
323 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
324
325private:
326 RTSEMEVENT mNotifyEventSem;
327 /** Whether we've successfully initialized the USBLib and should call USBLibTerm in the destructor. */
328 bool mUSBLibInitialized;
329};
330#endif /* RT_OS_SOLARIS */
331
332
333# ifdef RT_OS_WINDOWS
334/**
335 * The Windows hosted USB Proxy Service.
336 */
337class USBProxyServiceWindows : public USBProxyService
338{
339public:
340 USBProxyServiceWindows(Host *aHost);
341 HRESULT init(void);
342 ~USBProxyServiceWindows();
343
344 virtual void *insertFilter (PCUSBFILTER aFilter);
345 virtual void removeFilter (void *aID);
346
347 virtual int captureDevice (HostUSBDevice *aDevice);
348 virtual int releaseDevice (HostUSBDevice *aDevice);
349
350protected:
351 virtual int wait(RTMSINTERVAL aMillies);
352 virtual int interruptWait(void);
353 virtual PUSBDEVICE getDevices(void);
354 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
355
356private:
357
358 HANDLE mhEventInterrupt;
359};
360# endif /* RT_OS_WINDOWS */
361
362# ifdef RT_OS_FREEBSD
363/**
364 * The FreeBSD hosted USB Proxy Service.
365 */
366class USBProxyServiceFreeBSD : public USBProxyService
367{
368public:
369 USBProxyServiceFreeBSD(Host *aHost);
370 HRESULT init(void);
371 ~USBProxyServiceFreeBSD();
372
373 virtual int captureDevice(HostUSBDevice *aDevice);
374 virtual int releaseDevice(HostUSBDevice *aDevice);
375
376protected:
377 int initUsbfs(void);
378 int initSysfs(void);
379 virtual int wait(RTMSINTERVAL aMillies);
380 virtual int interruptWait(void);
381 virtual PUSBDEVICE getDevices(void);
382 int addDeviceToChain(PUSBDEVICE pDev, PUSBDEVICE *ppFirst, PUSBDEVICE **pppNext, int rc);
383 virtual void deviceAdded(ComObjPtr<HostUSBDevice> &aDevice, SessionMachinesList &llOpenedMachines, PUSBDEVICE aUSBDevice);
384 virtual bool updateDeviceState(HostUSBDevice *aDevice, PUSBDEVICE aUSBDevice, bool *aRunFilters, SessionMachine **aIgnoreMachine);
385
386private:
387 RTSEMEVENT mNotifyEventSem;
388};
389# endif /* RT_OS_FREEBSD */
390
391#endif /* !____H_USBPROXYSERVICE */
392/* 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