USBProxyService.cpp@ 60755

Last change on this file since 60755 was 60755, checked in by vboxsync, 9 years ago
Main/USBProxyBackend: Fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 30.4 KB

Line
1	/* $Id: USBProxyService.cpp 60755 2016-04-29 10:00:11Z vboxsync $ */
2	/** @file
3	* VirtualBox USB Proxy Service (base) class.
4	*/
5
6	/*
7	* Copyright (C) 2006-2014 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	#include "USBProxyService.h"
19	#include "HostUSBDeviceImpl.h"
20	#include "HostImpl.h"
21	#include "MachineImpl.h"
22	#include "VirtualBoxImpl.h"
23
24	#include "AutoCaller.h"
25	#include "Logging.h"
26
27	#include <VBox/com/array.h>
28	#include <VBox/err.h>
29	#include <iprt/asm.h>
30	#include <iprt/semaphore.h>
31	#include <iprt/thread.h>
32	#include <iprt/mem.h>
33	#include <iprt/string.h>
34
35	/** Pair of a USB proxy backend and the opaque filter data assigned by the backend. */
36	typedef std::pair<ComObjPtr<USBProxyBackend> , void *> USBFilterPair;
37	/** List of USB filter pairs. */
38	typedef std::list<USBFilterPair> USBFilterList;
39
40	/**
41	* Data for a USB device filter.
42	*/
43	struct USBFilterData
44	{
45	USBFilterData()
46	: llUsbFilters()
47	{ }
48
49	USBFilterList llUsbFilters;
50	};
51
52	/**
53	* Initialize data members.
54	*/
55	USBProxyService::USBProxyService(Host *aHost)
56	: mHost(aHost), mDevices(), mBackends()
57	{
58	LogFlowThisFunc(("aHost=%p\n", aHost));
59	}
60
61
62	/**
63	* Stub needed as long as the class isn't virtual
64	*/
65	HRESULT USBProxyService::init(void)
66	{
67	# if defined(RT_OS_DARWIN)
68	ComObjPtr<USBProxyBackendDarwin> UsbProxyBackendHost;
69	# elif defined(RT_OS_LINUX)
70	ComObjPtr<USBProxyBackendLinux> UsbProxyBackendHost;
71	# elif defined(RT_OS_OS2)
72	ComObjPtr<USBProxyBackendOs2> UsbProxyBackendHost;
73	# elif defined(RT_OS_SOLARIS)
74	ComObjPtr<USBProxyBackendSolaris> UsbProxyBackendHost;
75	# elif defined(RT_OS_WINDOWS)
76	ComObjPtr<USBProxyBackendWindows> UsbProxyBackendHost;
77	# elif defined(RT_OS_FREEBSD)
78	ComObjPtr<USBProxyBackendFreeBSD> UsbProxyBackendHost;
79	# else
80	ComObjPtr<USBProxyBackend> UsbProxyBackendHost;
81	# endif
82	UsbProxyBackendHost.createObject();
83	int vrc = UsbProxyBackendHost->init(this, Utf8Str("host"), Utf8Str(""));
84	if (RT_FAILURE(vrc))
85	{
86	mLastError = vrc;
87	}
88	else
89	mBackends.push_back(static_cast<ComObjPtr<USBProxyBackend> >(UsbProxyBackendHost));
90
91	return S_OK;
92	}
93
94
95	/**
96	* Empty destructor.
97	*/
98	USBProxyService::~USBProxyService()
99	{
100	LogFlowThisFunc(("\n"));
101	while (!mBackends.empty())
102	mBackends.pop_front();
103
104	mDevices.clear();
105	mBackends.clear();
106	mHost = NULL;
107	}
108
109
110	/**
111	* Query if the service is active and working.
112	*
113	* @returns true if the service is up running.
114	* @returns false if the service isn't running.
115	*/
116	bool USBProxyService::isActive(void)
117	{
118	return mBackends.size() > 0;
119	}
120
121
122	/**
123	* Get last error.
124	* Can be used to check why the proxy !isActive() upon construction.
125	*
126	* @returns VBox status code.
127	*/
128	int USBProxyService::getLastError(void)
129	{
130	return mLastError;
131	}
132
133
134	/**
135	* We're using the Host object lock.
136	*
137	* This is just a temporary measure until all the USB refactoring is
138	* done, probably... For now it help avoiding deadlocks we don't have
139	* time to fix.
140	*
141	* @returns Lock handle.
142	*/
143	RWLockHandle *USBProxyService::lockHandle() const
144	{
145	return mHost->lockHandle();
146	}
147
148
149	void *USBProxyService::insertFilter(PCUSBFILTER aFilter)
150	{
151	USBFilterData *pFilterData = new USBFilterData();
152
153	for (USBProxyBackendList::iterator it = mBackends.begin();
154	it != mBackends.end();
155	++it)
156	{
157	ComObjPtr<USBProxyBackend> pUsbProxyBackend = *it;
158	void *pvId = pUsbProxyBackend->insertFilter(aFilter);
159
160	pFilterData->llUsbFilters.push_back(USBFilterPair(pUsbProxyBackend, pvId));
161	}
162
163	return pFilterData;
164	}
165
166	void USBProxyService::removeFilter(void *aId)
167	{
168	USBFilterData pFilterData = (USBFilterData )aId;
169
170	for (USBFilterList::iterator it = pFilterData->llUsbFilters.begin();
171	it != pFilterData->llUsbFilters.end();
172	++it)
173	{
174	ComObjPtr<USBProxyBackend> pUsbProxyBackend = it->first;
175	pUsbProxyBackend->removeFilter(it->second);
176	}
177
178	pFilterData->llUsbFilters.clear();
179	delete pFilterData;
180	}
181
182	/**
183	* Gets the collection of USB devices, slave of Host::USBDevices.
184	*
185	* This is an interface for the HostImpl::USBDevices property getter.
186	*
187	*
188	* @param aUSBDevices Where to store the pointer to the collection.
189	*
190	* @returns COM status code.
191	*
192	* @remarks The caller must own the write lock of the host object.
193	*/
194	HRESULT USBProxyService::getDeviceCollection(std::vector<ComPtr<IHostUSBDevice> > &aUSBDevices)
195	{
196	AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
197
198	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
199
200	aUSBDevices.resize(mDevices.size());
201	size_t i = 0;
202	for (HostUSBDeviceList::const_iterator it = mDevices.begin(); it != mDevices.end(); ++it, ++i)
203	aUSBDevices[i] = *it;
204
205	return S_OK;
206	}
207
208
209	HRESULT USBProxyService::addUSBDeviceSource(const com::Utf8Str &aBackend, const com::Utf8Str &aId, const com::Utf8Str &aAddress,
210	const std::vector<com::Utf8Str> &aPropertyNames, const std::vector<com::Utf8Str> &aPropertyValues)
211	{
212	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
213
214	HRESULT hrc = createUSBDeviceSource(aBackend, aId, aAddress, aPropertyNames, aPropertyValues);
215	if (SUCCEEDED(hrc))
216	{
217	alock.release();
218	AutoWriteLock vboxLock(mHost->i_parent() COMMA_LOCKVAL_SRC_POS);
219	return mHost->i_parent()->i_saveSettings();
220	}
221
222	return hrc;
223	}
224
225	HRESULT USBProxyService::removeUSBDeviceSource(const com::Utf8Str &aId)
226	{
227	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
228
229	for (USBProxyBackendList::iterator it = mBackends.begin();
230	it != mBackends.end();
231	++it)
232	{
233	ComObjPtr<USBProxyBackend> UsbProxyBackend = *it;
234
235	if (aId.equals(UsbProxyBackend->i_getId()))
236	{
237	mBackends.erase(it);
238
239	/*
240	* The proxy backend uninit method will be called when the pointer goes
241	* out of scope.
242	*/
243
244	alock.release();
245	AutoWriteLock vboxLock(mHost->i_parent() COMMA_LOCKVAL_SRC_POS);
246	return mHost->i_parent()->i_saveSettings();
247	}
248	}
249
250	return setError(VBOX_E_OBJECT_NOT_FOUND,
251	tr("The USB device source \"%s\" could not be found"), aId.c_str());
252	}
253
254	/**
255	* Request capture of a specific device.
256	*
257	* This is in an interface for SessionMachine::CaptureUSBDevice(), which is
258	* an internal worker used by Console::AttachUSBDevice() from the VM process.
259	*
260	* When the request is completed, SessionMachine::onUSBDeviceAttach() will
261	* be called for the given machine object.
262	*
263	*
264	* @param aMachine The machine to attach the device to.
265	* @param aId The UUID of the USB device to capture and attach.
266	*
267	* @returns COM status code and error info.
268	*
269	* @remarks This method may operate synchronously as well as asynchronously. In the
270	* former case it will temporarily abandon locks because of IPC.
271	*/
272	HRESULT USBProxyService::captureDeviceForVM(SessionMachine *aMachine, IN_GUID aId, const com::Utf8Str &aCaptureFilename)
273	{
274	ComAssertRet(aMachine, E_INVALIDARG);
275	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
276
277	/*
278	* Translate the device id into a device object.
279	*/
280	ComObjPtr<HostUSBDevice> pHostDevice = findDeviceById(aId);
281	if (pHostDevice.isNull())
282	return setError(E_INVALIDARG,
283	tr("The USB device with UUID {%RTuuid} is not currently attached to the host"), Guid(aId).raw());
284
285	/*
286	* Try to capture the device
287	*/
288	alock.release();
289	return pHostDevice->i_requestCaptureForVM(aMachine, true /* aSetError */, aCaptureFilename);
290	}
291
292
293	/**
294	* Notification from VM process about USB device detaching progress.
295	*
296	* This is in an interface for SessionMachine::DetachUSBDevice(), which is
297	* an internal worker used by Console::DetachUSBDevice() from the VM process.
298	*
299	* @param aMachine The machine which is sending the notification.
300	* @param aId The UUID of the USB device is concerns.
301	* @param aDone \a false for the pre-action notification (necessary
302	* for advancing the device state to avoid confusing
303	* the guest).
304	* \a true for the post-action notification. The device
305	* will be subjected to all filters except those of
306	* of \a Machine.
307	*
308	* @returns COM status code.
309	*
310	* @remarks When \a aDone is \a true this method may end up doing IPC to other
311	* VMs when running filters. In these cases it will temporarily
312	* abandon its locks.
313	*/
314	HRESULT USBProxyService::detachDeviceFromVM(SessionMachine *aMachine, IN_GUID aId, bool aDone)
315	{
316	LogFlowThisFunc(("aMachine=%p{%s} aId={%RTuuid} aDone=%RTbool\n",
317	aMachine,
318	aMachine->i_getName().c_str(),
319	Guid(aId).raw(),
320	aDone));
321
322	// get a list of all running machines while we're outside the lock
323	// (getOpenedMachines requests locks which are incompatible with the lock of the machines list)
324	SessionMachinesList llOpenedMachines;
325	mHost->i_parent()->i_getOpenedMachines(llOpenedMachines);
326
327	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
328
329	ComObjPtr<HostUSBDevice> pHostDevice = findDeviceById(aId);
330	ComAssertRet(!pHostDevice.isNull(), E_FAIL);
331	AutoWriteLock devLock(pHostDevice COMMA_LOCKVAL_SRC_POS);
332
333	/*
334	* Work the state machine.
335	*/
336	LogFlowThisFunc(("id={%RTuuid} state=%s aDone=%RTbool name={%s}\n",
337	pHostDevice->i_getId().raw(), pHostDevice->i_getStateName(), aDone, pHostDevice->i_getName().c_str()));
338	bool fRunFilters = false;
339	HRESULT hrc = pHostDevice->i_onDetachFromVM(aMachine, aDone, &fRunFilters);
340
341	/*
342	* Run filters if necessary.
343	*/
344	if ( SUCCEEDED(hrc)
345	&& fRunFilters)
346	{
347	Assert(aDone && pHostDevice->i_getUnistate() == kHostUSBDeviceState_HeldByProxy && pHostDevice->i_getMachine().isNull());
348	devLock.release();
349	alock.release();
350	HRESULT hrc2 = runAllFiltersOnDevice(pHostDevice, llOpenedMachines, aMachine);
351	ComAssertComRC(hrc2);
352	}
353	return hrc;
354	}
355
356
357	/**
358	* Apply filters for the machine to all eligible USB devices.
359	*
360	* This is in an interface for SessionMachine::CaptureUSBDevice(), which
361	* is an internal worker used by Console::AutoCaptureUSBDevices() from the
362	* VM process at VM startup.
363	*
364	* Matching devices will be attached to the VM and may result IPC back
365	* to the VM process via SessionMachine::onUSBDeviceAttach() depending
366	* on whether the device needs to be captured or not. If capture is
367	* required, SessionMachine::onUSBDeviceAttach() will be called
368	* asynchronously by the USB proxy service thread.
369	*
370	* @param aMachine The machine to capture devices for.
371	*
372	* @returns COM status code, perhaps with error info.
373	*
374	* @remarks Temporarily locks this object, the machine object and some USB
375	* device, and the called methods will lock similar objects.
376	*/
377	HRESULT USBProxyService::autoCaptureDevicesForVM(SessionMachine *aMachine)
378	{
379	LogFlowThisFunc(("aMachine=%p{%s}\n",
380	aMachine,
381	aMachine->i_getName().c_str()));
382
383	/*
384	* Make a copy of the list because we cannot hold the lock protecting it.
385	* (This will not make copies of any HostUSBDevice objects, only reference them.)
386	*/
387	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
388	HostUSBDeviceList ListCopy = mDevices;
389	alock.release();
390
391	for (HostUSBDeviceList::iterator it = ListCopy.begin();
392	it != ListCopy.end();
393	++it)
394	{
395	ComObjPtr<HostUSBDevice> pHostDevice = *it;
396	AutoReadLock devLock(pHostDevice COMMA_LOCKVAL_SRC_POS);
397	if ( pHostDevice->i_getUnistate() == kHostUSBDeviceState_HeldByProxy
398	\|\| pHostDevice->i_getUnistate() == kHostUSBDeviceState_Unused
399	\|\| pHostDevice->i_getUnistate() == kHostUSBDeviceState_Capturable)
400	{
401	devLock.release();
402	runMachineFilters(aMachine, pHostDevice);
403	}
404	}
405
406	return S_OK;
407	}
408
409
410	/**
411	* Detach all USB devices currently attached to a VM.
412	*
413	* This is in an interface for SessionMachine::DetachAllUSBDevices(), which
414	* is an internal worker used by Console::powerDown() from the VM process
415	* at VM startup, and SessionMachine::uninit() at VM abend.
416	*
417	* This is, like #detachDeviceFromVM(), normally a two stage journey
418	* where \a aDone indicates where we are. In addition we may be called
419	* to clean up VMs that have abended, in which case there will be no
420	* preparatory call. Filters will be applied to the devices in the final
421	* call with the risk that we have to do some IPC when attaching them
422	* to other VMs.
423	*
424	* @param aMachine The machine to detach devices from.
425	*
426	* @returns COM status code, perhaps with error info.
427	*
428	* @remarks Write locks the host object and may temporarily abandon
429	* its locks to perform IPC.
430	*/
431	HRESULT USBProxyService::detachAllDevicesFromVM(SessionMachine *aMachine, bool aDone, bool aAbnormal)
432	{
433	// get a list of all running machines while we're outside the lock
434	// (getOpenedMachines requests locks which are incompatible with the host object lock)
435	SessionMachinesList llOpenedMachines;
436	mHost->i_parent()->i_getOpenedMachines(llOpenedMachines);
437
438	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
439
440	/*
441	* Make a copy of the device list (not the HostUSBDevice objects, just
442	* the list) since we may end up performing IPC and temporarily have
443	* to abandon locks when applying filters.
444	*/
445	HostUSBDeviceList ListCopy = mDevices;
446
447	for (HostUSBDeviceList::iterator it = ListCopy.begin();
448	it != ListCopy.end();
449	++it)
450	{
451	ComObjPtr<HostUSBDevice> pHostDevice = *it;
452	AutoWriteLock devLock(pHostDevice COMMA_LOCKVAL_SRC_POS);
453	if (pHostDevice->i_getMachine() == aMachine)
454	{
455	/*
456	* Same procedure as in detachUSBDevice().
457	*/
458	bool fRunFilters = false;
459	HRESULT hrc = pHostDevice->i_onDetachFromVM(aMachine, aDone, &fRunFilters, aAbnormal);
460	if ( SUCCEEDED(hrc)
461	&& fRunFilters)
462	{
463	Assert( aDone
464	&& pHostDevice->i_getUnistate() == kHostUSBDeviceState_HeldByProxy
465	&& pHostDevice->i_getMachine().isNull());
466	devLock.release();
467	alock.release();
468	HRESULT hrc2 = runAllFiltersOnDevice(pHostDevice, llOpenedMachines, aMachine);
469	ComAssertComRC(hrc2);
470	alock.acquire();
471	}
472	}
473	}
474
475	return S_OK;
476	}
477
478
479	// Internals
480	/////////////////////////////////////////////////////////////////////////////
481
482
483	/**
484	* Loads the given settings and constructs the additional USB device sources.
485	*
486	* @returns COM status code.
487	* @param llUSBDeviceSources The list of additional device sources.
488	*/
489	HRESULT USBProxyService::i_loadSettings(const settings::USBDeviceSourcesList &llUSBDeviceSources)
490	{
491	HRESULT hrc = S_OK;
492
493	for (settings::USBDeviceSourcesList::const_iterator it = llUSBDeviceSources.begin();
494	it != llUSBDeviceSources.end() && SUCCEEDED(hrc);
495	++it)
496	{
497	std::vector<com::Utf8Str> vecPropNames, vecPropValues;
498	const settings::USBDeviceSource &src = *it;
499	hrc = createUSBDeviceSource(src.strBackend, src.strName, src.strAddress, vecPropNames, vecPropValues);
500	}
501
502	return hrc;
503	}
504
505	/**
506	* Saves the additional device sources in the given settings.
507	*
508	* @returns COM status code.
509	* @param llUSBDeviceSources The list of additional device sources.
510	*/
511	HRESULT USBProxyService::i_saveSettings(settings::USBDeviceSourcesList &llUSBDeviceSources)
512	{
513	for (USBProxyBackendList::iterator it = mBackends.begin();
514	it != mBackends.end();
515	++it)
516	{
517	USBProxyBackend pUsbProxyBackend = it;
518
519	/* Host backends are not saved as they are always created during startup. */
520	if (!pUsbProxyBackend->i_getBackend().equals("host"))
521	{
522	settings::USBDeviceSource src;
523
524	src.strBackend = pUsbProxyBackend->i_getBackend();
525	src.strName = pUsbProxyBackend->i_getId();
526	src.strAddress = pUsbProxyBackend->i_getAddress();
527
528	llUSBDeviceSources.push_back(src);
529	}
530	}
531
532	return S_OK;
533	}
534
535	/**
536	* Performs the required actions when a device has been added.
537	*
538	* This means things like running filters and subsequent capturing and
539	* VM attaching. This may result in IPC and temporary lock abandonment.
540	*
541	* @param aDevice The device in question.
542	* @param aUSBDevice The USB device structure.
543	*/
544	void USBProxyService::i_deviceAdded(ComObjPtr<HostUSBDevice> &aDevice,
545	PUSBDEVICE pDev)
546	{
547	/*
548	* Validate preconditions.
549	*/
550	AssertReturnVoid(!isWriteLockOnCurrentThread());
551	AssertReturnVoid(!aDevice->isWriteLockOnCurrentThread());
552	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
553	AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
554	LogFlowThisFunc(("aDevice=%p name={%s} state=%s id={%RTuuid}\n",
555	(HostUSBDevice *)aDevice,
556	aDevice->i_getName().c_str(),
557	aDevice->i_getStateName(),
558	aDevice->i_getId().raw()));
559
560	/* Add to our list. */
561	HostUSBDeviceList::iterator it = mDevices.begin();
562	while (it != mDevices.end())
563	{
564	ComObjPtr<HostUSBDevice> pHostDevice = *it;
565
566	/* Assert that the object is still alive. */
567	AutoCaller devCaller(pHostDevice);
568	AssertComRC(devCaller.rc());
569
570	AutoWriteLock curLock(pHostDevice COMMA_LOCKVAL_SRC_POS);
571	if ( pHostDevice->i_getUsbProxyBackend() == aDevice->i_getUsbProxyBackend()
572	&& pHostDevice->i_compare(pDev) < 0)
573	break;
574
575	it++;
576	}
577
578	mDevices.insert(it, aDevice);
579
580	/*
581	* Run filters on the device.
582	*/
583	if (aDevice->i_isCapturableOrHeld())
584	{
585	devLock.release();
586	alock.release();
587	SessionMachinesList llOpenedMachines;
588	mHost->i_parent()->i_getOpenedMachines(llOpenedMachines);
589	HRESULT rc = runAllFiltersOnDevice(aDevice, llOpenedMachines, NULL /* aIgnoreMachine */);
590	AssertComRC(rc);
591	}
592	}
593
594	/**
595	* Remove device notification hook for the USB proxy service.
596	*
597	* @param aDevice The device in question.
598	*/
599	void USBProxyService::i_deviceRemoved(ComObjPtr<HostUSBDevice> &aDevice)
600	{
601	/*
602	* Validate preconditions.
603	*/
604	AssertReturnVoid(!isWriteLockOnCurrentThread());
605	AssertReturnVoid(!aDevice->isWriteLockOnCurrentThread());
606	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
607	AutoWriteLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
608	LogFlowThisFunc(("aDevice=%p name={%s} state=%s id={%RTuuid}\n",
609	(HostUSBDevice *)aDevice,
610	aDevice->i_getName().c_str(),
611	aDevice->i_getStateName(),
612	aDevice->i_getId().raw()));
613
614	mDevices.remove(aDevice);
615
616	/*
617	* Detach the device from any machine currently using it,
618	* reset all data and uninitialize the device object.
619	*/
620	devLock.release();
621	alock.release();
622	aDevice->i_onPhysicalDetached();
623	}
624
625	/**
626	* Updates the device state.
627	*
628	* This is responsible for calling HostUSBDevice::updateState().
629	*
630	* @returns true if there is a state change.
631	* @param aDevice The device in question.
632	* @param aUSBDevice The USB device structure for the last enumeration.
633	* @param fFakeUpdate Flag whether to fake updating state.
634	*/
635	void USBProxyService::i_updateDeviceState(ComObjPtr<HostUSBDevice> &aDevice, PUSBDEVICE aUSBDevice, bool fFakeUpdate)
636	{
637	AssertReturnVoid(aDevice);
638	AssertReturnVoid(!aDevice->isWriteLockOnCurrentThread());
639
640	bool fRunFilters = false;
641	SessionMachine *pIgnoreMachine = NULL;
642	bool fDevChanged = false;
643	if (fFakeUpdate)
644	fDevChanged = aDevice->i_updateStateFake(aUSBDevice, &fRunFilters, &pIgnoreMachine);
645	else
646	fDevChanged = aDevice->i_updateState(aUSBDevice, &fRunFilters, &pIgnoreMachine);
647
648	if (fDevChanged)
649	deviceChanged(aDevice, fRunFilters, pIgnoreMachine);
650	}
651
652
653	/**
654	* Handle a device which state changed in some significant way.
655	*
656	* This means things like running filters and subsequent capturing and
657	* VM attaching. This may result in IPC and temporary lock abandonment.
658	*
659	* @param aDevice The device.
660	* @param fRunFilters Flag whether to run filters.
661	* @param aIgnoreMachine Machine to ignore when running filters.
662	*/
663	void USBProxyService::deviceChanged(ComObjPtr<HostUSBDevice> &aDevice, bool fRunFilters,
664	SessionMachine *aIgnoreMachine)
665	{
666	/*
667	* Validate preconditions.
668	*/
669	AssertReturnVoid(!isWriteLockOnCurrentThread());
670	AssertReturnVoid(!aDevice->isWriteLockOnCurrentThread());
671	AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
672	LogFlowThisFunc(("aDevice=%p name={%s} state=%s id={%RTuuid} aRunFilters=%RTbool aIgnoreMachine=%p\n",
673	(HostUSBDevice *)aDevice,
674	aDevice->i_getName().c_str(),
675	aDevice->i_getStateName(),
676	aDevice->i_getId().raw(),
677	fRunFilters,
678	aIgnoreMachine));
679	devLock.release();
680
681	/*
682	* Run filters if requested to do so.
683	*/
684	if (fRunFilters)
685	{
686	SessionMachinesList llOpenedMachines;
687	mHost->i_parent()->i_getOpenedMachines(llOpenedMachines);
688	HRESULT rc = runAllFiltersOnDevice(aDevice, llOpenedMachines, aIgnoreMachine);
689	AssertComRC(rc);
690	}
691	}
692
693
694	/**
695	* Runs all the filters on the specified device.
696	*
697	* All filters mean global and active VM, with the exception of those
698	* belonging to \a aMachine. If a global ignore filter matched or if
699	* none of the filters matched, the device will be released back to
700	* the host.
701	*
702	* The device calling us here will be in the HeldByProxy, Unused, or
703	* Capturable state. The caller is aware that locks held might have
704	* to be abandond because of IPC and that the device might be in
705	* almost any state upon return.
706	*
707	*
708	* @returns COM status code (only parameter & state checks will fail).
709	* @param aDevice The USB device to apply filters to.
710	* @param aIgnoreMachine The machine to ignore filters from (we've just
711	* detached the device from this machine).
712	*
713	* @note The caller is expected to own no locks.
714	*/
715	HRESULT USBProxyService::runAllFiltersOnDevice(ComObjPtr<HostUSBDevice> &aDevice,
716	SessionMachinesList &llOpenedMachines,
717	SessionMachine *aIgnoreMachine)
718	{
719	LogFlowThisFunc(("{%s} ignoring=%p\n", aDevice->i_getName().c_str(), aIgnoreMachine));
720
721	/*
722	* Verify preconditions.
723	*/
724	AssertReturn(!isWriteLockOnCurrentThread(), E_FAIL);
725	AssertReturn(!aDevice->isWriteLockOnCurrentThread(), E_FAIL);
726
727	/*
728	* Get the lists we'll iterate.
729	*/
730	Host::USBDeviceFilterList globalFilters;
731	mHost->i_getUSBFilters(&globalFilters);
732
733	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
734	AutoWriteLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
735	AssertMsgReturn(aDevice->i_isCapturableOrHeld(), ("{%s} %s\n", aDevice->i_getName().c_str(),
736	aDevice->i_getStateName()), E_FAIL);
737
738	/*
739	* Run global filters filters first.
740	*/
741	bool fHoldIt = false;
742	for (Host::USBDeviceFilterList::const_iterator it = globalFilters.begin();
743	it != globalFilters.end();
744	++it)
745	{
746	AutoWriteLock filterLock(*it COMMA_LOCKVAL_SRC_POS);
747	const HostUSBDeviceFilter::Data &data = (*it)->i_getData();
748	if (aDevice->i_isMatch(data))
749	{
750	USBDeviceFilterAction_T action = USBDeviceFilterAction_Null;
751	(*it)->COMGETTER(Action)(&action);
752	if (action == USBDeviceFilterAction_Ignore)
753	{
754	/*
755	* Release the device to the host and we're done.
756	*/
757	filterLock.release();
758	devLock.release();
759	alock.release();
760	aDevice->i_requestReleaseToHost();
761	return S_OK;
762	}
763	if (action == USBDeviceFilterAction_Hold)
764	{
765	/*
766	* A device held by the proxy needs to be subjected
767	* to the machine filters.
768	*/
769	fHoldIt = true;
770	break;
771	}
772	AssertMsgFailed(("action=%d\n", action));
773	}
774	}
775	globalFilters.clear();
776
777	/*
778	* Run the per-machine filters.
779	*/
780	for (SessionMachinesList::const_iterator it = llOpenedMachines.begin();
781	it != llOpenedMachines.end();
782	++it)
783	{
784	ComObjPtr<SessionMachine> pMachine = *it;
785
786	/* Skip the machine the device was just detached from. */
787	if ( aIgnoreMachine
788	&& pMachine == aIgnoreMachine)
789	continue;
790
791	/* runMachineFilters takes care of checking the machine state. */
792	devLock.release();
793	alock.release();
794	if (runMachineFilters(pMachine, aDevice))
795	{
796	LogFlowThisFunc(("{%s} attached to %p\n", aDevice->i_getName().c_str(), (void *)pMachine));
797	return S_OK;
798	}
799	alock.acquire();
800	devLock.acquire();
801	}
802
803	/*
804	* No matching machine, so request hold or release depending
805	* on global filter match.
806	*/
807	devLock.release();
808	alock.release();
809	if (fHoldIt)
810	aDevice->i_requestHold();
811	else
812	aDevice->i_requestReleaseToHost();
813	return S_OK;
814	}
815
816
817	/**
818	* Runs the USB filters of the machine on the device.
819	*
820	* If a match is found we will request capture for VM. This may cause
821	* us to temporary abandon locks while doing IPC.
822	*
823	* @param aMachine Machine whose filters are to be run.
824	* @param aDevice The USB device in question.
825	* @returns @c true if the device has been or is being attached to the VM, @c false otherwise.
826	*
827	* @note Locks several objects temporarily for reading or writing.
828	*/
829	bool USBProxyService::runMachineFilters(SessionMachine *aMachine, ComObjPtr<HostUSBDevice> &aDevice)
830	{
831	LogFlowThisFunc(("{%s} aMachine=%p \n", aDevice->i_getName().c_str(), aMachine));
832
833	/*
834	* Validate preconditions.
835	*/
836	AssertReturn(aMachine, false);
837	AssertReturn(!isWriteLockOnCurrentThread(), false);
838	AssertReturn(!aMachine->isWriteLockOnCurrentThread(), false);
839	AssertReturn(!aDevice->isWriteLockOnCurrentThread(), false);
840	/* Let HostUSBDevice::requestCaptureToVM() validate the state. */
841
842	/*
843	* Do the job.
844	*/
845	ULONG ulMaskedIfs;
846	if (aMachine->i_hasMatchingUSBFilter(aDevice, &ulMaskedIfs))
847	{
848	/* try to capture the device */
849	HRESULT hrc = aDevice->i_requestCaptureForVM(aMachine, false /* aSetError */, Utf8Str(), ulMaskedIfs);
850	return SUCCEEDED(hrc)
851	\|\| hrc == E_UNEXPECTED /* bad device state, give up */;
852	}
853
854	return false;
855	}
856
857
858	/**
859	* Searches the list of devices (mDevices) for the given device.
860	*
861	*
862	* @returns Smart pointer to the device on success, NULL otherwise.
863	* @param aId The UUID of the device we're looking for.
864	*/
865	ComObjPtr<HostUSBDevice> USBProxyService::findDeviceById(IN_GUID aId)
866	{
867	Guid Id(aId);
868	ComObjPtr<HostUSBDevice> Dev;
869	for (HostUSBDeviceList::iterator it = mDevices.begin();
870	it != mDevices.end();
871	++it)
872	if ((*it)->i_getId() == Id)
873	{
874	Dev = (*it);
875	break;
876	}
877
878	return Dev;
879	}
880
881	/**
882	* Creates a new USB device source.
883	*
884	* @returns COM status code.
885	* @param aBackend The backend to use.
886	* @param aId The ID of the source.
887	* @param aAddress The backend specific address.
888	* @param aPropertyNames Vector of optional property keys the backend supports.
889	* @param aPropertyValues Vector of optional property values the backend supports.
890	*/
891	HRESULT USBProxyService::createUSBDeviceSource(const com::Utf8Str &aBackend, const com::Utf8Str &aId,
892	const com::Utf8Str &aAddress, const std::vector<com::Utf8Str> &aPropertyNames,
893	const std::vector<com::Utf8Str> &aPropertyValues)
894	{
895	HRESULT hrc = S_OK;
896
897	AssertReturn(isWriteLockOnCurrentThread(), E_FAIL);
898
899	/** @todo */
900	NOREF(aPropertyNames);
901	NOREF(aPropertyValues);
902
903	/* Check whether the ID is used first. */
904	for (USBProxyBackendList::iterator it = mBackends.begin();
905	it != mBackends.end();
906	++it)
907	{
908	USBProxyBackend pUsbProxyBackend = it;
909
910	if (aId.equals(pUsbProxyBackend->i_getId()))
911	return setError(VBOX_E_OBJECT_IN_USE,
912	tr("The USB device source \"%s\" exists already"), aId.c_str());
913	}
914
915	/* Create appropriate proxy backend. */
916	if (aBackend.equalsIgnoreCase("USBIP"))
917	{
918	ComObjPtr<USBProxyBackendUsbIp> UsbProxyBackend;
919
920	UsbProxyBackend.createObject();
921	int vrc = UsbProxyBackend->init(this, aId, aAddress);
922	if (RT_FAILURE(vrc))
923	hrc = setError(E_FAIL,
924	tr("Creating the USB device source \"%s\" using backend \"%s\" failed with %Rrc"),
925	aId.c_str(), aBackend.c_str(), vrc);
926	else
927	mBackends.push_back(static_cast<ComObjPtr<USBProxyBackend> >(UsbProxyBackend));
928	}
929	else
930	hrc = setError(VBOX_E_OBJECT_NOT_FOUND,
931	tr("The USB backend \"%s\" is not supported"), aBackend.c_str());
932
933	return hrc;
934	}
935
936	/static/
937	HRESULT USBProxyService::setError(HRESULT aResultCode, const char *aText, ...)
938	{
939	va_list va;
940	va_start(va, aText);
941	HRESULT rc = VirtualBoxBase::setErrorInternal(aResultCode,
942	COM_IIDOF(IHost),
943	"USBProxyService",
944	Utf8StrFmt(aText, va),
945	false /* aWarning*/,
946	true /* aLogIt*/);
947	va_end(va);
948	return rc;
949	}
950
951	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-server/USBProxyService.cpp@ 60755

Download in other formats: