USBControllerImpl.cpp@ 38636

Last change on this file since 38636 was 38441, checked in by vboxsync, 13 years ago
Main/USB: do not propagate remote filter to USBProxyService for all platforms
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.2 KB

Line
1	/* $Id: USBControllerImpl.cpp 38441 2011-08-12 16:25:06Z vboxsync $ */
2	/** @file
3	* Implementation of IUSBController.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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 "USBControllerImpl.h"
19
20	#include "Global.h"
21	#include "MachineImpl.h"
22	#include "VirtualBoxImpl.h"
23	#include "HostImpl.h"
24	#ifdef VBOX_WITH_USB
25	# include "USBDeviceImpl.h"
26	# include "HostUSBDeviceImpl.h"
27	# include "USBProxyService.h"
28	# include "USBDeviceFilterImpl.h"
29	#endif
30
31	#include <iprt/string.h>
32	#include <iprt/cpp/utils.h>
33
34	#include <VBox/err.h>
35	#include <VBox/settings.h>
36
37	#include <algorithm>
38
39	#include "AutoStateDep.h"
40	#include "AutoCaller.h"
41	#include "Logging.h"
42
43	// defines
44	/////////////////////////////////////////////////////////////////////////////
45
46	typedef std::list< ComObjPtr<USBDeviceFilter> > DeviceFilterList;
47
48	struct BackupableUSBData
49	{
50	BackupableUSBData()
51	: fEnabled(false),
52	fEnabledEHCI(false)
53	{ }
54
55	BOOL fEnabled;
56	BOOL fEnabledEHCI;
57	};
58
59	struct USBController::Data
60	{
61	Data(Machine *pMachine)
62	: pParent(pMachine),
63	pHost(pMachine->getVirtualBox()->host())
64	{ }
65
66	~Data()
67	{};
68
69	Machine * const pParent;
70	Host * const pHost;
71
72	// peer machine's USB controller
73	const ComObjPtr<USBController> pPeer;
74
75	Backupable<BackupableUSBData> bd;
76	#ifdef VBOX_WITH_USB
77	// the following fields need special backup/rollback/commit handling,
78	// so they cannot be a part of BackupableData
79	Backupable<DeviceFilterList> llDeviceFilters;
80	#endif
81	};
82
83
84
85	// constructor / destructor
86	/////////////////////////////////////////////////////////////////////////////
87
88	DEFINE_EMPTY_CTOR_DTOR (USBController)
89
90	HRESULT USBController::FinalConstruct()
91	{
92	return BaseFinalConstruct();
93	}
94
95	void USBController::FinalRelease()
96	{
97	uninit();
98	BaseFinalRelease();
99	}
100
101	// public initializer/uninitializer for internal purposes only
102	/////////////////////////////////////////////////////////////////////////////
103
104	/**
105	* Initializes the USB controller object.
106	*
107	* @returns COM result indicator.
108	* @param aParent Pointer to our parent object.
109	*/
110	HRESULT USBController::init(Machine *aParent)
111	{
112	LogFlowThisFunc(("aParent=%p\n", aParent));
113
114	ComAssertRet(aParent, E_INVALIDARG);
115
116	/* Enclose the state transition NotReady->InInit->Ready */
117	AutoInitSpan autoInitSpan(this);
118	AssertReturn(autoInitSpan.isOk(), E_FAIL);
119
120	m = new Data(aParent);
121
122	/* mPeer is left null */
123
124	m->bd.allocate();
125	#ifdef VBOX_WITH_USB
126	m->llDeviceFilters.allocate();
127	#endif
128
129	/* Confirm a successful initialization */
130	autoInitSpan.setSucceeded();
131
132	return S_OK;
133	}
134
135	/**
136	* Initializes the USB controller object given another USB controller object
137	* (a kind of copy constructor). This object shares data with
138	* the object passed as an argument.
139	*
140	* @returns COM result indicator.
141	* @param aParent Pointer to our parent object.
142	* @param aPeer The object to share.
143	*
144	* @note This object must be destroyed before the original object
145	* it shares data with is destroyed.
146	*/
147	HRESULT USBController::init(Machine aParent, USBController aPeer)
148	{
149	LogFlowThisFunc(("aParent=%p, aPeer=%p\n", aParent, aPeer));
150
151	ComAssertRet(aParent && aPeer, E_INVALIDARG);
152
153	/* Enclose the state transition NotReady->InInit->Ready */
154	AutoInitSpan autoInitSpan(this);
155	AssertReturn(autoInitSpan.isOk(), E_FAIL);
156
157	m = new Data(aParent);
158
159	unconst(m->pPeer) = aPeer;
160
161	AutoWriteLock thatlock(aPeer COMMA_LOCKVAL_SRC_POS);
162	m->bd.share(aPeer->m->bd);
163
164	#ifdef VBOX_WITH_USB
165	/* create copies of all filters */
166	m->llDeviceFilters.allocate();
167	DeviceFilterList::const_iterator it = aPeer->m->llDeviceFilters->begin();
168	while (it != aPeer->m->llDeviceFilters->end())
169	{
170	ComObjPtr<USBDeviceFilter> filter;
171	filter.createObject();
172	filter->init(this, *it);
173	m->llDeviceFilters->push_back(filter);
174	++ it;
175	}
176	#endif /* VBOX_WITH_USB */
177
178	/* Confirm a successful initialization */
179	autoInitSpan.setSucceeded();
180
181	return S_OK;
182	}
183
184
185	/**
186	* Initializes the USB controller object given another guest object
187	* (a kind of copy constructor). This object makes a private copy of data
188	* of the original object passed as an argument.
189	*/
190	HRESULT USBController::initCopy(Machine aParent, USBController aPeer)
191	{
192	LogFlowThisFunc(("aParent=%p, aPeer=%p\n", aParent, aPeer));
193
194	ComAssertRet(aParent && aPeer, E_INVALIDARG);
195
196	/* Enclose the state transition NotReady->InInit->Ready */
197	AutoInitSpan autoInitSpan(this);
198	AssertReturn(autoInitSpan.isOk(), E_FAIL);
199
200	m = new Data(aParent);
201
202	/* mPeer is left null */
203
204	AutoWriteLock thatlock(aPeer COMMA_LOCKVAL_SRC_POS);
205	m->bd.attachCopy(aPeer->m->bd);
206
207	#ifdef VBOX_WITH_USB
208	/* create private copies of all filters */
209	m->llDeviceFilters.allocate();
210	DeviceFilterList::const_iterator it = aPeer->m->llDeviceFilters->begin();
211	while (it != aPeer->m->llDeviceFilters->end())
212	{
213	ComObjPtr<USBDeviceFilter> filter;
214	filter.createObject();
215	filter->initCopy(this, *it);
216	m->llDeviceFilters->push_back(filter);
217	++ it;
218	}
219	#endif /* VBOX_WITH_USB */
220
221	/* Confirm a successful initialization */
222	autoInitSpan.setSucceeded();
223
224	return S_OK;
225	}
226
227
228	/**
229	* Uninitializes the instance and sets the ready flag to FALSE.
230	* Called either from FinalRelease() or by the parent when it gets destroyed.
231	*/
232	void USBController::uninit()
233	{
234	LogFlowThisFunc(("\n"));
235
236	/* Enclose the state transition Ready->InUninit->NotReady */
237	AutoUninitSpan autoUninitSpan(this);
238	if (autoUninitSpan.uninitDone())
239	return;
240
241	#ifdef VBOX_WITH_USB
242	// uninit all device filters on the list (it's a standard std::list not an ObjectsList
243	// so we must uninit() manually)
244	for (DeviceFilterList::iterator it = m->llDeviceFilters->begin();
245	it != m->llDeviceFilters->end();
246	++it)
247	(*it)->uninit();
248
249	m->llDeviceFilters.free();
250	#endif
251	m->bd.free();
252
253	unconst(m->pPeer) = NULL;
254	unconst(m->pParent) = NULL;
255
256	delete m;
257	m = NULL;
258	}
259
260
261	// IUSBController properties
262	/////////////////////////////////////////////////////////////////////////////
263
264	STDMETHODIMP USBController::COMGETTER(Enabled) (BOOL *aEnabled)
265	{
266	CheckComArgOutPointerValid(aEnabled);
267
268	AutoCaller autoCaller(this);
269	if (FAILED(autoCaller.rc())) return autoCaller.rc();
270
271	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
272
273	*aEnabled = m->bd->fEnabled;
274
275	return S_OK;
276	}
277
278
279	STDMETHODIMP USBController::COMSETTER(Enabled) (BOOL aEnabled)
280	{
281	LogFlowThisFunc(("aEnabled=%RTbool\n", aEnabled));
282
283	AutoCaller autoCaller(this);
284	if (FAILED(autoCaller.rc())) return autoCaller.rc();
285
286	/* the machine needs to be mutable */
287	AutoMutableStateDependency adep(m->pParent);
288	if (FAILED(adep.rc())) return adep.rc();
289
290	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
291
292	if (m->bd->fEnabled != aEnabled)
293	{
294	m->bd.backup();
295	m->bd->fEnabled = aEnabled;
296
297	// leave the lock for safety
298	alock.release();
299
300	AutoWriteLock mlock(m->pParent COMMA_LOCKVAL_SRC_POS);
301	m->pParent->setModified(Machine::IsModified_USB);
302	mlock.release();
303
304	m->pParent->onUSBControllerChange();
305	}
306
307	return S_OK;
308	}
309
310	STDMETHODIMP USBController::COMGETTER(EnabledEhci) (BOOL *aEnabled)
311	{
312	CheckComArgOutPointerValid(aEnabled);
313
314	AutoCaller autoCaller(this);
315	if (FAILED(autoCaller.rc())) return autoCaller.rc();
316
317	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
318
319	*aEnabled = m->bd->fEnabledEHCI;
320
321	return S_OK;
322	}
323
324	STDMETHODIMP USBController::COMSETTER(EnabledEhci) (BOOL aEnabled)
325	{
326	LogFlowThisFunc(("aEnabled=%RTbool\n", aEnabled));
327
328	AutoCaller autoCaller(this);
329	if (FAILED(autoCaller.rc())) return autoCaller.rc();
330
331	/* the machine needs to be mutable */
332	AutoMutableStateDependency adep(m->pParent);
333	if (FAILED(adep.rc())) return adep.rc();
334
335	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
336
337	if (m->bd->fEnabledEHCI != aEnabled)
338	{
339	m->bd.backup();
340	m->bd->fEnabledEHCI = aEnabled;
341
342	// leave the lock for safety
343	alock.release();
344
345	AutoWriteLock mlock(m->pParent COMMA_LOCKVAL_SRC_POS);
346	m->pParent->setModified(Machine::IsModified_USB);
347	mlock.release();
348
349	m->pParent->onUSBControllerChange();
350	}
351
352	return S_OK;
353	}
354
355	STDMETHODIMP USBController::COMGETTER(ProxyAvailable) (BOOL *aEnabled)
356	{
357	CheckComArgOutPointerValid(aEnabled);
358
359	AutoCaller autoCaller(this);
360	if (FAILED(autoCaller.rc())) return autoCaller.rc();
361
362	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
363
364	#ifdef VBOX_WITH_USB
365	*aEnabled = true;
366	#else
367	*aEnabled = false;
368	#endif
369
370	return S_OK;
371	}
372
373	STDMETHODIMP USBController::COMGETTER(USBStandard) (USHORT *aUSBStandard)
374	{
375	CheckComArgOutPointerValid(aUSBStandard);
376
377	AutoCaller autoCaller(this);
378	if (FAILED(autoCaller.rc())) return autoCaller.rc();
379
380	/* not accessing data -- no need to lock */
381
382	/** @todo This is no longer correct */
383	*aUSBStandard = 0x0101;
384
385	return S_OK;
386	}
387
388	#ifndef VBOX_WITH_USB
389	/**
390	* Fake class for build without USB.
391	* We need an empty collection & enum for deviceFilters, that's all.
392	*/
393	class ATL_NO_VTABLE USBDeviceFilter :
394	public VirtualBoxBase,
395	VBOX_SCRIPTABLE_IMPL(IUSBDeviceFilter)
396	{
397	public:
398	DECLARE_NOT_AGGREGATABLE(USBDeviceFilter)
399	DECLARE_PROTECT_FINAL_CONSTRUCT()
400	BEGIN_COM_MAP(USBDeviceFilter)
401	COM_INTERFACE_ENTRY(ISupportErrorInfo)
402	COM_INTERFACE_ENTRY(IUSBDeviceFilter)
403	END_COM_MAP()
404
405	DECLARE_EMPTY_CTOR_DTOR (USBDeviceFilter)
406
407	// IUSBDeviceFilter properties
408	STDMETHOD(COMGETTER(Name)) (BSTR *aName);
409	STDMETHOD(COMSETTER(Name)) (IN_BSTR aName);
410	STDMETHOD(COMGETTER(Active)) (BOOL *aActive);
411	STDMETHOD(COMSETTER(Active)) (BOOL aActive);
412	STDMETHOD(COMGETTER(VendorId)) (BSTR *aVendorId);
413	STDMETHOD(COMSETTER(VendorId)) (IN_BSTR aVendorId);
414	STDMETHOD(COMGETTER(ProductId)) (BSTR *aProductId);
415	STDMETHOD(COMSETTER(ProductId)) (IN_BSTR aProductId);
416	STDMETHOD(COMGETTER(Revision)) (BSTR *aRevision);
417	STDMETHOD(COMSETTER(Revision)) (IN_BSTR aRevision);
418	STDMETHOD(COMGETTER(Manufacturer)) (BSTR *aManufacturer);
419	STDMETHOD(COMSETTER(Manufacturer)) (IN_BSTR aManufacturer);
420	STDMETHOD(COMGETTER(Product)) (BSTR *aProduct);
421	STDMETHOD(COMSETTER(Product)) (IN_BSTR aProduct);
422	STDMETHOD(COMGETTER(SerialNumber)) (BSTR *aSerialNumber);
423	STDMETHOD(COMSETTER(SerialNumber)) (IN_BSTR aSerialNumber);
424	STDMETHOD(COMGETTER(Port)) (BSTR *aPort);
425	STDMETHOD(COMSETTER(Port)) (IN_BSTR aPort);
426	STDMETHOD(COMGETTER(Remote)) (BSTR *aRemote);
427	STDMETHOD(COMSETTER(Remote)) (IN_BSTR aRemote);
428	STDMETHOD(COMGETTER(MaskedInterfaces)) (ULONG *aMaskedIfs);
429	STDMETHOD(COMSETTER(MaskedInterfaces)) (ULONG aMaskedIfs);
430	};
431	#endif /* !VBOX_WITH_USB */
432
433
434	STDMETHODIMP USBController::COMGETTER(DeviceFilters) (ComSafeArrayOut(IUSBDeviceFilter *, aDevicesFilters))
435	{
436	#ifdef VBOX_WITH_USB
437	CheckComArgOutSafeArrayPointerValid(aDevicesFilters);
438
439	AutoCaller autoCaller(this);
440	if (FAILED(autoCaller.rc())) return autoCaller.rc();
441
442	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
443
444	SafeIfaceArray<IUSBDeviceFilter> collection (*m->llDeviceFilters.data());
445	collection.detachTo(ComSafeArrayOutArg(aDevicesFilters));
446
447	return S_OK;
448	#else
449	NOREF(aDevicesFilters);
450	# ifndef RT_OS_WINDOWS
451	NOREF(aDevicesFiltersSize);
452	# endif
453	ReturnComNotImplemented();
454	#endif
455	}
456
457	// IUSBController methods
458	/////////////////////////////////////////////////////////////////////////////
459
460	STDMETHODIMP USBController::CreateDeviceFilter (IN_BSTR aName,
461	IUSBDeviceFilter **aFilter)
462	{
463	#ifdef VBOX_WITH_USB
464	CheckComArgOutPointerValid(aFilter);
465
466	CheckComArgStrNotEmptyOrNull(aName);
467
468	AutoCaller autoCaller(this);
469	if (FAILED(autoCaller.rc())) return autoCaller.rc();
470
471	/* the machine needs to be mutable */
472	AutoMutableStateDependency adep(m->pParent);
473	if (FAILED(adep.rc())) return adep.rc();
474
475	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
476
477	ComObjPtr<USBDeviceFilter> filter;
478	filter.createObject();
479	HRESULT rc = filter->init (this, aName);
480	ComAssertComRCRetRC (rc);
481	rc = filter.queryInterfaceTo(aFilter);
482	AssertComRCReturnRC(rc);
483
484	return S_OK;
485	#else
486	NOREF(aName);
487	NOREF(aFilter);
488	ReturnComNotImplemented();
489	#endif
490	}
491
492	STDMETHODIMP USBController::InsertDeviceFilter(ULONG aPosition,
493	IUSBDeviceFilter *aFilter)
494	{
495	#ifdef VBOX_WITH_USB
496
497	CheckComArgNotNull(aFilter);
498
499	AutoCaller autoCaller(this);
500	if (FAILED(autoCaller.rc())) return autoCaller.rc();
501
502	/* the machine needs to be mutable */
503	AutoMutableStateDependency adep(m->pParent);
504	if (FAILED(adep.rc())) return adep.rc();
505
506	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
507
508	ComObjPtr<USBDeviceFilter> filter = static_cast<USBDeviceFilter*>(aFilter);
509	// @todo r=dj make sure the input object is actually from us
510	// if (!filter)
511	// return setError (E_INVALIDARG,
512	// tr ("The given USB device filter is not created within "
513	// "this VirtualBox instance"));
514
515	if (filter->mInList)
516	return setError(VBOX_E_INVALID_OBJECT_STATE,
517	tr("The given USB device filter is already in the list"));
518
519	/* backup the list before modification */
520	m->llDeviceFilters.backup();
521
522	/* iterate to the position... */
523	DeviceFilterList::iterator it;
524	if (aPosition < m->llDeviceFilters->size())
525	{
526	it = m->llDeviceFilters->begin();
527	std::advance (it, aPosition);
528	}
529	else
530	it = m->llDeviceFilters->end();
531	/* ...and insert */
532	m->llDeviceFilters->insert (it, filter);
533	filter->mInList = true;
534
535	/* notify the proxy (only when it makes sense) */
536	if (filter->getData().mActive && Global::IsOnline(adep.machineState())
537	&& filter->getData().mRemote.isMatch (false))
538	{
539	USBProxyService *service = m->pHost->usbProxyService();
540	ComAssertRet(service, E_FAIL);
541
542	ComAssertRet(filter->getId() == NULL, E_FAIL);
543	filter->getId() = service->insertFilter (&filter->getData().mUSBFilter);
544	}
545
546	alock.release();
547	AutoWriteLock mlock(m->pParent COMMA_LOCKVAL_SRC_POS);
548	m->pParent->setModified(Machine::IsModified_USB);
549	mlock.release();
550
551	return S_OK;
552
553	#else /* VBOX_WITH_USB */
554
555	NOREF(aPosition);
556	NOREF(aFilter);
557	ReturnComNotImplemented();
558
559	#endif /* VBOX_WITH_USB */
560	}
561
562	STDMETHODIMP USBController::RemoveDeviceFilter(ULONG aPosition,
563	IUSBDeviceFilter **aFilter)
564	{
565	#ifdef VBOX_WITH_USB
566
567	CheckComArgOutPointerValid(aFilter);
568
569	AutoCaller autoCaller(this);
570	if (FAILED(autoCaller.rc())) return autoCaller.rc();
571
572	/* the machine needs to be mutable */
573	AutoMutableStateDependency adep(m->pParent);
574	if (FAILED(adep.rc())) return adep.rc();
575
576	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
577
578	if (!m->llDeviceFilters->size())
579	return setError(E_INVALIDARG,
580	tr("The USB device filter list is empty"));
581
582	if (aPosition >= m->llDeviceFilters->size())
583	return setError(E_INVALIDARG,
584	tr("Invalid position: %lu (must be in range [0, %lu])"),
585	aPosition, m->llDeviceFilters->size() - 1);
586
587	/* backup the list before modification */
588	m->llDeviceFilters.backup();
589
590	ComObjPtr<USBDeviceFilter> filter;
591	{
592	/* iterate to the position... */
593	DeviceFilterList::iterator it = m->llDeviceFilters->begin();
594	std::advance (it, aPosition);
595	/* ...get an element from there... */
596	filter = *it;
597	/* ...and remove */
598	filter->mInList = false;
599	m->llDeviceFilters->erase (it);
600	}
601
602	/* cancel sharing (make an independent copy of data) */
603	filter->unshare();
604
605	filter.queryInterfaceTo(aFilter);
606
607	/* notify the proxy (only when it makes sense) */
608	if (filter->getData().mActive && Global::IsOnline(adep.machineState())
609	&& filter->getData().mRemote.isMatch (false))
610	{
611	USBProxyService *service = m->pHost->usbProxyService();
612	ComAssertRet(service, E_FAIL);
613
614	ComAssertRet(filter->getId() != NULL, E_FAIL);
615	service->removeFilter(filter->getId());
616	filter->getId() = NULL;
617	}
618
619	alock.release();
620	AutoWriteLock mlock(m->pParent COMMA_LOCKVAL_SRC_POS);
621	m->pParent->setModified(Machine::IsModified_USB);
622	mlock.release();
623
624	return S_OK;
625
626	#else /* VBOX_WITH_USB */
627
628	NOREF(aPosition);
629	NOREF(aFilter);
630	ReturnComNotImplemented();
631
632	#endif /* VBOX_WITH_USB */
633	}
634
635	// public methods only for internal purposes
636	/////////////////////////////////////////////////////////////////////////////
637
638	/**
639	* Loads settings from the given machine node.
640	* May be called once right after this object creation.
641	*
642	* @param aMachineNode <Machine> node.
643	*
644	* @note Does not lock "this" as Machine::loadHardware, which calls this, does not lock either.
645	*/
646	HRESULT USBController::loadSettings(const settings::USBController &data)
647	{
648	AutoCaller autoCaller(this);
649	AssertComRCReturnRC(autoCaller.rc());
650
651	/* Note: we assume that the default values for attributes of optional
652	* nodes are assigned in the Data::Data() constructor and don't do it
653	* here. It implies that this method may only be called after constructing
654	* a new BIOSSettings object while all its data fields are in the default
655	* values. Exceptions are fields whose creation time defaults don't match
656	* values that should be applied when these fields are not explicitly set
657	* in the settings file (for backwards compatibility reasons). This takes
658	* place when a setting of a newly created object must default to A while
659	* the same setting of an object loaded from the old settings file must
660	* default to B. */
661
662	m->bd->fEnabled = data.fEnabled;
663	m->bd->fEnabledEHCI = data.fEnabledEHCI;
664
665	#ifdef VBOX_WITH_USB
666	for (settings::USBDeviceFiltersList::const_iterator it = data.llDeviceFilters.begin();
667	it != data.llDeviceFilters.end();
668	++it)
669	{
670	const settings::USBDeviceFilter &f = *it;
671	ComObjPtr<USBDeviceFilter> pFilter;
672	pFilter.createObject();
673	HRESULT rc = pFilter->init(this, // parent
674	f);
675	if (FAILED(rc)) return rc;
676
677	m->llDeviceFilters->push_back(pFilter);
678	pFilter->mInList = true;
679	}
680	#endif /* VBOX_WITH_USB */
681
682	return S_OK;
683	}
684
685	/**
686	* Saves settings to the given machine node.
687	*
688	* @param aMachineNode <Machine> node.
689	*
690	* @note Locks this object for reading.
691	*/
692	HRESULT USBController::saveSettings(settings::USBController &data)
693	{
694	AutoCaller autoCaller(this);
695	if (FAILED(autoCaller.rc())) return autoCaller.rc();
696
697	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
698
699	data.fEnabled = !!m->bd->fEnabled;
700	data.fEnabledEHCI = !!m->bd->fEnabledEHCI;
701
702	#ifdef VBOX_WITH_USB
703	data.llDeviceFilters.clear();
704
705	for (DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
706	it != m->llDeviceFilters->end();
707	++it)
708	{
709	AutoWriteLock filterLock(*it COMMA_LOCKVAL_SRC_POS);
710	const USBDeviceFilter::Data &filterData = (*it)->getData();
711
712	Bstr str;
713
714	settings::USBDeviceFilter f;
715	f.strName = filterData.mName;
716	f.fActive = !!filterData.mActive;
717	(*it)->COMGETTER(VendorId)(str.asOutParam());
718	f.strVendorId = str;
719	(*it)->COMGETTER(ProductId)(str.asOutParam());
720	f.strProductId = str;
721	(*it)->COMGETTER (Revision) (str.asOutParam());
722	f.strRevision = str;
723	(*it)->COMGETTER (Manufacturer) (str.asOutParam());
724	f.strManufacturer = str;
725	(*it)->COMGETTER (Product) (str.asOutParam());
726	f.strProduct = str;
727	(*it)->COMGETTER (SerialNumber) (str.asOutParam());
728	f.strSerialNumber = str;
729	(*it)->COMGETTER (Port) (str.asOutParam());
730	f.strPort = str;
731	f.strRemote = filterData.mRemote.string();
732	f.ulMaskedInterfaces = filterData.mMaskedIfs;
733
734	data.llDeviceFilters.push_back(f);
735	}
736	#endif /* VBOX_WITH_USB */
737
738	return S_OK;
739	}
740
741	/** @note Locks objects for writing! */
742	void USBController::rollback()
743	{
744	AutoCaller autoCaller(this);
745	AssertComRCReturnVoid(autoCaller.rc());
746
747	/* we need the machine state */
748	AutoAnyStateDependency adep(m->pParent);
749	AssertComRCReturnVoid(adep.rc());
750
751	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
752
753	m->bd.rollback();
754
755	#ifdef VBOX_WITH_USB
756
757	if (m->llDeviceFilters.isBackedUp())
758	{
759	USBProxyService *service = m->pHost->usbProxyService();
760	Assert(service);
761
762	/* uninitialize all new filters (absent in the backed up list) */
763	DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
764	DeviceFilterList *backedList = m->llDeviceFilters.backedUpData();
765	while (it != m->llDeviceFilters->end())
766	{
767	if (std::find (backedList->begin(), backedList->end(), *it) ==
768	backedList->end())
769	{
770	/* notify the proxy (only when it makes sense) */
771	if ((*it)->getData().mActive &&
772	Global::IsOnline (adep.machineState())
773	&& (*it)->getData().mRemote.isMatch (false))
774	{
775	USBDeviceFilter filter = it;
776	Assert(filter->getId() != NULL);
777	service->removeFilter(filter->getId());
778	filter->getId() = NULL;
779	}
780
781	(*it)->uninit();
782	}
783	++ it;
784	}
785
786	if (Global::IsOnline (adep.machineState()))
787	{
788	/* find all removed old filters (absent in the new list)
789	* and insert them back to the USB proxy */
790	it = backedList->begin();
791	while (it != backedList->end())
792	{
793	if (std::find (m->llDeviceFilters->begin(), m->llDeviceFilters->end(), *it) ==
794	m->llDeviceFilters->end())
795	{
796	/* notify the proxy (only when necessary) */
797	if ((*it)->getData().mActive
798	&& (*it)->getData().mRemote.isMatch (false))
799	{
800	USBDeviceFilter flt = it; /* resolve ambiguity */
801	Assert(flt->getId() == NULL);
802	flt->getId() = service->insertFilter(&flt->getData().mUSBFilter);
803	}
804	}
805	++ it;
806	}
807	}
808
809	/* restore the list */
810	m->llDeviceFilters.rollback();
811	}
812
813	/* here we don't depend on the machine state any more */
814	adep.release();
815
816	/* rollback any changes to filters after restoring the list */
817	DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
818	while (it != m->llDeviceFilters->end())
819	{
820	if ((*it)->isModified())
821	{
822	(*it)->rollback();
823	/* call this to notify the USB proxy about changes */
824	onDeviceFilterChange(*it);
825	}
826	++it;
827	}
828
829	#endif /* VBOX_WITH_USB */
830	}
831
832	/**
833	* @note Locks this object for writing, together with the peer object (also
834	* for writing) if there is one.
835	*/
836	void USBController::commit()
837	{
838	/* sanity */
839	AutoCaller autoCaller(this);
840	AssertComRCReturnVoid (autoCaller.rc());
841
842	/* sanity too */
843	AutoCaller peerCaller(m->pPeer);
844	AssertComRCReturnVoid (peerCaller.rc());
845
846	/* lock both for writing since we modify both (mPeer is "master" so locked
847	* first) */
848	AutoMultiWriteLock2 alock(m->pPeer, this COMMA_LOCKVAL_SRC_POS);
849
850	if (m->bd.isBackedUp())
851	{
852	m->bd.commit();
853	if (m->pPeer)
854	{
855	/* attach new data to the peer and reshare it */
856	AutoWriteLock peerlock(m->pPeer COMMA_LOCKVAL_SRC_POS);
857	m->pPeer->m->bd.attach(m->bd);
858	}
859	}
860
861	#ifdef VBOX_WITH_USB
862	bool commitFilters = false;
863
864	if (m->llDeviceFilters.isBackedUp())
865	{
866	m->llDeviceFilters.commit();
867
868	/* apply changes to peer */
869	if (m->pPeer)
870	{
871	AutoWriteLock peerlock(m->pPeer COMMA_LOCKVAL_SRC_POS);
872
873	/* commit all changes to new filters (this will reshare data with
874	* peers for those who have peers) */
875	DeviceFilterList *newList = new DeviceFilterList();
876	DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
877	while (it != m->llDeviceFilters->end())
878	{
879	(*it)->commit();
880
881	/* look if this filter has a peer filter */
882	ComObjPtr<USBDeviceFilter> peer = (*it)->peer();
883	if (!peer)
884	{
885	/* no peer means the filter is a newly created one;
886	* create a peer owning data this filter share it with */
887	peer.createObject();
888	peer->init(m->pPeer, it, true / aReshare */);
889	}
890	else
891	{
892	/* remove peer from the old list */
893	m->pPeer->m->llDeviceFilters->remove(peer);
894	}
895	/* and add it to the new list */
896	newList->push_back (peer);
897
898	++ it;
899	}
900
901	/* uninit old peer's filters that are left */
902	it = m->pPeer->m->llDeviceFilters->begin();
903	while (it != m->pPeer->m->llDeviceFilters->end())
904	{
905	(*it)->uninit();
906	++ it;
907	}
908
909	/* attach new list of filters to our peer */
910	m->pPeer->m->llDeviceFilters.attach(newList);
911	}
912	else
913	{
914	/* we have no peer (our parent is the newly created machine);
915	* just commit changes to filters */
916	commitFilters = true;
917	}
918	}
919	else
920	{
921	/* the list of filters itself is not changed,
922	* just commit changes to filters themselves */
923	commitFilters = true;
924	}
925
926	if (commitFilters)
927	{
928	DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
929	while (it != m->llDeviceFilters->end())
930	{
931	(*it)->commit();
932	++ it;
933	}
934	}
935	#endif /* VBOX_WITH_USB */
936	}
937
938	/**
939	* @note Locks this object for writing, together with the peer object
940	* represented by @a aThat (locked for reading).
941	*/
942	void USBController::copyFrom (USBController *aThat)
943	{
944	AssertReturnVoid (aThat != NULL);
945
946	/* sanity */
947	AutoCaller autoCaller(this);
948	AssertComRCReturnVoid (autoCaller.rc());
949
950	/* sanity too */
951	AutoCaller thatCaller (aThat);
952	AssertComRCReturnVoid (thatCaller.rc());
953
954	/* even more sanity */
955	AutoAnyStateDependency adep(m->pParent);
956	AssertComRCReturnVoid (adep.rc());
957	/* Machine::copyFrom() may not be called when the VM is running */
958	AssertReturnVoid (!Global::IsOnline (adep.machineState()));
959
960	/* peer is not modified, lock it for reading (aThat is "master" so locked
961	* first) */
962	AutoReadLock rl(aThat COMMA_LOCKVAL_SRC_POS);
963	AutoWriteLock wl(this COMMA_LOCKVAL_SRC_POS);
964
965	/* this will back up current data */
966	m->bd.assignCopy(aThat->m->bd);
967
968	#ifdef VBOX_WITH_USB
969
970	/* Note that we won't inform the USB proxy about new filters since the VM is
971	* not running when we are here and therefore no need to do so */
972
973	/* create private copies of all filters */
974	m->llDeviceFilters.backup();
975	m->llDeviceFilters->clear();
976	for (DeviceFilterList::const_iterator it = aThat->m->llDeviceFilters->begin();
977	it != aThat->m->llDeviceFilters->end();
978	++ it)
979	{
980	ComObjPtr<USBDeviceFilter> filter;
981	filter.createObject();
982	filter->initCopy (this, *it);
983	m->llDeviceFilters->push_back (filter);
984	}
985
986	#endif /* VBOX_WITH_USB */
987	}
988
989	#ifdef VBOX_WITH_USB
990
991	/**
992	* Called by setter methods of all USB device filters.
993	*
994	* @note Locks nothing.
995	*/
996	HRESULT USBController::onDeviceFilterChange (USBDeviceFilter *aFilter,
997	BOOL aActiveChanged /* = FALSE */)
998	{
999	AutoCaller autoCaller(this);
1000	AssertComRCReturnRC(autoCaller.rc());
1001
1002	/* we need the machine state */
1003	AutoAnyStateDependency adep(m->pParent);
1004	AssertComRCReturnRC(adep.rc());
1005
1006	/* nothing to do if the machine isn't running */
1007	if (!Global::IsOnline (adep.machineState()))
1008	return S_OK;
1009
1010	/* we don't modify our data fields -- no need to lock */
1011
1012	if ( aFilter->mInList
1013	&& m->pParent->isRegistered())
1014	{
1015	USBProxyService *service = m->pHost->usbProxyService();
1016	ComAssertRet(service, E_FAIL);
1017
1018	if (aActiveChanged)
1019	{
1020	if (aFilter->getData().mRemote.isMatch (false))
1021	{
1022	/* insert/remove the filter from the proxy */
1023	if (aFilter->getData().mActive)
1024	{
1025	ComAssertRet(aFilter->getId() == NULL, E_FAIL);
1026	aFilter->getId() = service->insertFilter(&aFilter->getData().mUSBFilter);
1027	}
1028	else
1029	{
1030	ComAssertRet(aFilter->getId() != NULL, E_FAIL);
1031	service->removeFilter(aFilter->getId());
1032	aFilter->getId() = NULL;
1033	}
1034	}
1035	}
1036	else
1037	{
1038	if (aFilter->getData().mActive)
1039	{
1040	/* update the filter in the proxy */
1041	ComAssertRet(aFilter->getId() != NULL, E_FAIL);
1042	service->removeFilter(aFilter->getId());
1043	if (aFilter->getData().mRemote.isMatch (false))
1044	{
1045	aFilter->getId() = service->insertFilter(&aFilter->getData().mUSBFilter);
1046	}
1047	}
1048	}
1049	}
1050
1051	return S_OK;
1052	}
1053
1054	/**
1055	* Returns true if the given USB device matches to at least one of
1056	* this controller's USB device filters.
1057	*
1058	* A HostUSBDevice specific version.
1059	*
1060	* @note Locks this object for reading.
1061	*/
1062	bool USBController::hasMatchingFilter (const ComObjPtr<HostUSBDevice> &aDevice, ULONG *aMaskedIfs)
1063	{
1064	AutoCaller autoCaller(this);
1065	AssertComRCReturn (autoCaller.rc(), false);
1066
1067	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1068
1069	/* Disabled USB controllers cannot actually work with USB devices */
1070	if (!m->bd->fEnabled)
1071	return false;
1072
1073	/* apply self filters */
1074	for (DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
1075	it != m->llDeviceFilters->end();
1076	++ it)
1077	{
1078	AutoWriteLock filterLock(*it COMMA_LOCKVAL_SRC_POS);
1079	if (aDevice->isMatch((*it)->getData()))
1080	{
1081	aMaskedIfs = (it)->getData().mMaskedIfs;
1082	return true;
1083	}
1084	}
1085
1086	return false;
1087	}
1088
1089	/**
1090	* Returns true if the given USB device matches to at least one of
1091	* this controller's USB device filters.
1092	*
1093	* A generic version that accepts any IUSBDevice on input.
1094	*
1095	* @note
1096	* This method MUST correlate with HostUSBDevice::isMatch()
1097	* in the sense of the device matching logic.
1098	*
1099	* @note Locks this object for reading.
1100	*/
1101	bool USBController::hasMatchingFilter (IUSBDevice aUSBDevice, ULONG aMaskedIfs)
1102	{
1103	LogFlowThisFuncEnter();
1104
1105	AutoCaller autoCaller(this);
1106	AssertComRCReturn (autoCaller.rc(), false);
1107
1108	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1109
1110	/* Disabled USB controllers cannot actually work with USB devices */
1111	if (!m->bd->fEnabled)
1112	return false;
1113
1114	HRESULT rc = S_OK;
1115
1116	/* query fields */
1117	USBFILTER dev;
1118	USBFilterInit (&dev, USBFILTERTYPE_CAPTURE);
1119
1120	USHORT vendorId = 0;
1121	rc = aUSBDevice->COMGETTER(VendorId) (&vendorId);
1122	ComAssertComRCRet(rc, false);
1123	ComAssertRet(vendorId, false);
1124	int vrc = USBFilterSetNumExact (&dev, USBFILTERIDX_VENDOR_ID, vendorId, true); AssertRC(vrc);
1125
1126	USHORT productId = 0;
1127	rc = aUSBDevice->COMGETTER(ProductId) (&productId);
1128	ComAssertComRCRet(rc, false);
1129	vrc = USBFilterSetNumExact (&dev, USBFILTERIDX_PRODUCT_ID, productId, true); AssertRC(vrc);
1130
1131	USHORT revision;
1132	rc = aUSBDevice->COMGETTER(Revision) (&revision);
1133	ComAssertComRCRet(rc, false);
1134	vrc = USBFilterSetNumExact (&dev, USBFILTERIDX_DEVICE, revision, true); AssertRC(vrc);
1135
1136	Bstr manufacturer;
1137	rc = aUSBDevice->COMGETTER(Manufacturer) (manufacturer.asOutParam());
1138	ComAssertComRCRet(rc, false);
1139	if (!manufacturer.isEmpty())
1140	USBFilterSetStringExact (&dev, USBFILTERIDX_MANUFACTURER_STR, Utf8Str(manufacturer).c_str(), true);
1141
1142	Bstr product;
1143	rc = aUSBDevice->COMGETTER(Product) (product.asOutParam());
1144	ComAssertComRCRet(rc, false);
1145	if (!product.isEmpty())
1146	USBFilterSetStringExact (&dev, USBFILTERIDX_PRODUCT_STR, Utf8Str(product).c_str(), true);
1147
1148	Bstr serialNumber;
1149	rc = aUSBDevice->COMGETTER(SerialNumber) (serialNumber.asOutParam());
1150	ComAssertComRCRet(rc, false);
1151	if (!serialNumber.isEmpty())
1152	USBFilterSetStringExact (&dev, USBFILTERIDX_SERIAL_NUMBER_STR, Utf8Str(serialNumber).c_str(), true);
1153
1154	Bstr address;
1155	rc = aUSBDevice->COMGETTER(Address) (address.asOutParam());
1156	ComAssertComRCRet(rc, false);
1157
1158	USHORT port = 0;
1159	rc = aUSBDevice->COMGETTER(Port)(&port);
1160	ComAssertComRCRet(rc, false);
1161	USBFilterSetNumExact (&dev, USBFILTERIDX_PORT, port, true);
1162
1163	BOOL remote = FALSE;
1164	rc = aUSBDevice->COMGETTER(Remote)(&remote);
1165	ComAssertComRCRet(rc, false);
1166	ComAssertRet(remote == TRUE, false);
1167
1168	bool match = false;
1169
1170	/* apply self filters */
1171	for (DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
1172	it != m->llDeviceFilters->end();
1173	++ it)
1174	{
1175	AutoWriteLock filterLock(*it COMMA_LOCKVAL_SRC_POS);
1176	const USBDeviceFilter::Data &aData = (*it)->getData();
1177
1178	if (!aData.mActive)
1179	continue;
1180	if (!aData.mRemote.isMatch (remote))
1181	continue;
1182	if (!USBFilterMatch (&aData.mUSBFilter, &dev))
1183	continue;
1184
1185	match = true;
1186	*aMaskedIfs = aData.mMaskedIfs;
1187	break;
1188	}
1189
1190	LogFlowThisFunc(("returns: %d\n", match));
1191	LogFlowThisFuncLeave();
1192
1193	return match;
1194	}
1195
1196	/**
1197	* Notifies the proxy service about all filters as requested by the
1198	* @a aInsertFilters argument.
1199	*
1200	* @param aInsertFilters @c true to insert filters, @c false to remove.
1201	*
1202	* @note Locks this object for reading.
1203	*/
1204	HRESULT USBController::notifyProxy (bool aInsertFilters)
1205	{
1206	LogFlowThisFunc(("aInsertFilters=%RTbool\n", aInsertFilters));
1207
1208	AutoCaller autoCaller(this);
1209	AssertComRCReturn (autoCaller.rc(), false);
1210
1211	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
1212
1213	USBProxyService *service = m->pHost->usbProxyService();
1214	AssertReturn(service, E_FAIL);
1215
1216	DeviceFilterList::const_iterator it = m->llDeviceFilters->begin();
1217	while (it != m->llDeviceFilters->end())
1218	{
1219	USBDeviceFilter flt = it; /* resolve ambiguity (for ComPtr below) */
1220
1221	/* notify the proxy (only if the filter is active) */
1222	if (flt->getData().mActive
1223	&& flt->getData().mRemote.isMatch (false) /* and if the filter is NOT remote */
1224	)
1225	{
1226	if (aInsertFilters)
1227	{
1228	AssertReturn(flt->getId() == NULL, E_FAIL);
1229	flt->getId() = service->insertFilter(&flt->getData().mUSBFilter);
1230	}
1231	else
1232	{
1233	/* It's possible that the given filter was not inserted the proxy
1234	* when this method gets called (as a result of an early VM
1235	* process crash for example. So, don't assert that ID != NULL. */
1236	if (flt->getId() != NULL)
1237	{
1238	service->removeFilter(flt->getId());
1239	flt->getId() = NULL;
1240	}
1241	}
1242	}
1243	++ it;
1244	}
1245
1246	return S_OK;
1247	}
1248
1249	Machine* USBController::getMachine()
1250	{
1251	return m->pParent;
1252	}
1253
1254	#endif /* VBOX_WITH_USB */
1255
1256	// private methods
1257	/////////////////////////////////////////////////////////////////////////////
1258	/* 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/USBControllerImpl.cpp@ 38636

Download in other formats: