USBProxyBackendUsbIp.cpp@ 60551

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

Line
1	/* $Id: USBProxyBackendUsbIp.cpp 60551 2016-04-18 17:37:22Z vboxsync $ */
2	/** @file
3	* VirtualBox USB Proxy Backend, USB/IP.
4	*/
5
6	/*
7	* Copyright (C) 2015 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.215389.xyz. 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	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#include "USBProxyService.h"
23	#include "USBGetDevices.h"
24	#include "Logging.h"
25
26	#include <VBox/usb.h>
27	#include <VBox/usblib.h>
28	#include <VBox/err.h>
29
30	#include <iprt/string.h>
31	#include <iprt/alloc.h>
32	#include <iprt/assert.h>
33	#include <iprt/ctype.h>
34	#include <iprt/tcp.h>
35	#include <iprt/env.h>
36	#include <iprt/err.h>
37	#include <iprt/mem.h>
38	#include <iprt/pipe.h>
39	#include <iprt/asm.h>
40	#include <iprt/cdefs.h>
41
42	/** The USB/IP default port to connect to. */
43	#define USBIP_PORT_DEFAULT 3240
44	/** The USB version number used for the protocol. */
45	#define USBIP_VERSION UINT16_C(0x0111)
46	/** Request indicator in the command code. */
47	#define USBIP_INDICATOR_REQ RT_BIT(15)
48
49	/** Command/Reply code for OP_REQ/RET_DEVLIST. */
50	#define USBIP_REQ_RET_DEVLIST UINT16_C(5)
51
52	/** @todo: Duplicate code in USBProxyDevice-usbip.cpp */
53	/**
54	* Exported device entry in the OP_RET_DEVLIST reply.
55	*/
56	#pragma pack(1)
57	typedef struct UsbIpExportedDevice
58	{
59	/** Path of the device, zero terminated string. */
60	char szPath[256];
61	/** Bus ID of the exported device, zero terminated string. */
62	char szBusId[32];
63	/** Bus number. */
64	uint32_t u32BusNum;
65	/** Device number. */
66	uint32_t u32DevNum;
67	/** Speed indicator of the device. */
68	uint32_t u32Speed;
69	/** Vendor ID of the device. */
70	uint16_t u16VendorId;
71	/** Product ID of the device. */
72	uint16_t u16ProductId;
73	/** Device release number. */
74	uint16_t u16BcdDevice;
75	/** Device class. */
76	uint8_t bDeviceClass;
77	/** Device Subclass. */
78	uint8_t bDeviceSubClass;
79	/** Device protocol. */
80	uint8_t bDeviceProtocol;
81	/** Configuration value. */
82	uint8_t bConfigurationValue;
83	/** Current configuration value of the device. */
84	uint8_t bNumConfigurations;
85	/** Number of interfaces for the device. */
86	uint8_t bNumInterfaces;
87	} UsbIpExportedDevice;
88	/** Pointer to a exported device entry. */
89	typedef UsbIpExportedDevice *PUsbIpExportedDevice;
90	#pragma pack()
91	AssertCompileSize(UsbIpExportedDevice, 312);
92
93	/**
94	* Interface descriptor entry for an exported device.
95	*/
96	#pragma pack(1)
97	typedef struct UsbIpDeviceInterface
98	{
99	/** Intefrace class. */
100	uint8_t bInterfaceClass;
101	/** Interface sub class. */
102	uint8_t bInterfaceSubClass;
103	/** Interface protocol identifier. */
104	uint8_t bInterfaceProtocol;
105	/** Padding byte for alignment. */
106	uint8_t bPadding;
107	} UsbIpDeviceInterface;
108	/** Pointer to an interface descriptor entry. */
109	typedef UsbIpDeviceInterface *PUsbIpDeviceInterface;
110	#pragma pack()
111
112	/**
113	* USB/IP device list request.
114	*/
115	#pragma pack(1)
116	typedef struct UsbIpReqDevList
117	{
118	/** Protocol version number. */
119	uint16_t u16Version;
120	/** Command code. */
121	uint16_t u16Cmd;
122	/** Status field, unused. */
123	int32_t u32Status;
124	} UsbIpReqDevList;
125	/** Pointer to a device list request. */
126	typedef UsbIpReqDevList *PUsbIpReqDevList;
127	#pragma pack()
128
129	/**
130	* USB/IP Import reply.
131	*
132	* This is only the header, for successful
133	* requests the device details are sent to as
134	* defined in UsbIpExportedDevice.
135	*/
136	#pragma pack(1)
137	typedef struct UsbIpRetDevList
138	{
139	/** Protocol version number. */
140	uint16_t u16Version;
141	/** Command code. */
142	uint16_t u16Cmd;
143	/** Status field, unused. */
144	int32_t u32Status;
145	/** Number of exported devices. */
146	uint32_t u32DevicesExported;
147	} UsbIpRetDevList;
148	/** Pointer to a import reply. */
149	typedef UsbIpRetDevList *PUsbIpRetDevList;
150	#pragma pack()
151
152	/** Pollset id of the socket. */
153	#define USBIP_POLL_ID_SOCKET 0
154	/** Pollset id of the pipe. */
155	#define USBIP_POLL_ID_PIPE 1
156
157	/** @name USB/IP error codes.
158	* @{ */
159	/** Success indicator. */
160	#define USBIP_STATUS_SUCCESS INT32_C(0)
161	/** @} */
162
163	/** @name USB/IP device speeds.
164	* @{ */
165	/** Unknown speed. */
166	#define USBIP_SPEED_UNKNOWN 0
167	/** Low (1.0) speed. */
168	#define USBIP_SPEED_LOW 1
169	/** Full (1.1) speed. */
170	#define USBIP_SPEED_FULL 2
171	/** High (2.0) speed. */
172	#define USBIP_SPEED_HIGH 3
173	/** Variable (CWUSB) speed. */
174	#define USBIP_SPEED_WIRELESS 4
175	/** Super (3.0) speed. */
176	#define USBIP_SPEED_SUPER 5
177	/** @} */
178
179	/**
180	* Private USB/IP proxy backend data.
181	*/
182	struct USBProxyBackendUsbIp::Data
183	{
184	Data()
185	: hSocket(NIL_RTSOCKET),
186	hWakeupPipeR(NIL_RTPIPE),
187	hWakeupPipeW(NIL_RTPIPE),
188	hPollSet(NIL_RTPOLLSET),
189	uPort(USBIP_PORT_DEFAULT),
190	pszHost(NULL),
191	hMtxDevices(NIL_RTSEMFASTMUTEX),
192	cUsbDevicesCur(0),
193	pUsbDevicesCur(NULL),
194	enmRecvState(kUsbIpRecvState_Invalid),
195	cbResidualRecv(0),
196	pbRecvBuf(NULL),
197	cDevicesLeft(0),
198	pHead(NULL),
199	ppNext(&pHead)
200	{ }
201
202	/** Socket handle to the server. */
203	RTSOCKET hSocket;
204	/** Pipe used to interrupt wait(), the read end. */
205	RTPIPE hWakeupPipeR;
206	/** Pipe used to interrupt wait(), the write end. */
207	RTPIPE hWakeupPipeW;
208	/** Pollset for the socket and wakeup pipe. */
209	RTPOLLSET hPollSet;
210	/** Port of the USB/IP host to connect to. */
211	uint32_t uPort;
212	/** USB/IP host address. */
213	char *pszHost;
214	/** Mutex protecting the device list against concurrent access. */
215	RTSEMFASTMUTEX hMtxDevices;
216	/** Number of devices in the list. */
217	uint32_t cUsbDevicesCur;
218	/** The current list of devices to compare with. */
219	PUSBDEVICE pUsbDevicesCur;
220	/** Current receive state. */
221	USBIPRECVSTATE enmRecvState;
222	/** Scratch space for holding the data until it was completely received.
223	* Which one to access is based on the current receive state. */
224	union
225	{
226	UsbIpRetDevList RetDevList;
227	UsbIpExportedDevice ExportedDevice;
228	UsbIpDeviceInterface DeviceInterface;
229	/** Byte view. */
230	uint8_t abRecv[1];
231	} Scratch;
232	/** Residual number of bytes to receive before we can work with the data. */
233	size_t cbResidualRecv;
234	/** Current pointer into the scratch buffer. */
235	uint8_t *pbRecvBuf;
236	/** Number of devices left to receive for the current request. */
237	uint32_t cDevicesLeft;
238	/** Number of interfaces to skip during receive. */
239	uint32_t cInterfacesLeft;
240	/** The current head pointer for the new device list. */
241	PUSBDEVICE pHead;
242	/** The next pointer to add a device to. */
243	PUSBDEVICE *ppNext;
244	/** Current amount of devices in the list. */
245	uint32_t cDevicesCur;
246	};
247
248	/**
249	* Convert the given exported device structure from host to network byte order.
250	*
251	* @returns nothing.
252	* @param pDevice The device structure to convert.
253	*/
254	DECLINLINE(void) usbProxyBackendUsbIpExportedDeviceN2H(PUsbIpExportedDevice pDevice)
255	{
256	pDevice->u32BusNum = RT_N2H_U32(pDevice->u32BusNum);
257	pDevice->u32DevNum = RT_N2H_U32(pDevice->u32DevNum);
258	pDevice->u32Speed = RT_N2H_U16(pDevice->u32Speed);
259	pDevice->u16VendorId = RT_N2H_U16(pDevice->u16VendorId);
260	pDevice->u16ProductId = RT_N2H_U16(pDevice->u16ProductId);
261	pDevice->u16BcdDevice = RT_N2H_U16(pDevice->u16BcdDevice);
262	}
263
264	/**
265	* Initialize data members.
266	*/
267	USBProxyBackendUsbIp::USBProxyBackendUsbIp()
268	: USBProxyBackend()
269	{
270	}
271
272	USBProxyBackendUsbIp::~USBProxyBackendUsbIp()
273	{
274
275	}
276
277	/**
278	* Initializes the object (called right after construction).
279	*
280	* @returns S_OK on success and non-fatal failures, some COM error otherwise.
281	*/
282	int USBProxyBackendUsbIp::init(USBProxyService *aUsbProxyService, const com::Utf8Str &strId, const com::Utf8Str &strAddress)
283	{
284	int rc = VINF_SUCCESS;
285
286	USBProxyBackend::init(aUsbProxyService, strId, strAddress);
287
288	unconst(m_strBackend) = Utf8Str("USBIP");
289
290	m = new Data;
291
292	/* Split address into hostname and port. */
293	RTCList<RTCString> lstAddress = strAddress.split(":");
294	if (lstAddress.size() < 1)
295	return VERR_INVALID_PARAMETER;
296	m->pszHost = RTStrDup(lstAddress[0].c_str());
297	if (!m->pszHost)
298	return VERR_NO_STR_MEMORY;
299	if (lstAddress.size() == 2)
300	{
301	m->uPort = lstAddress[1].toUInt32();
302	if (!m->uPort)
303	return VERR_INVALID_PARAMETER;
304	}
305
306	/* Setup wakeup pipe and poll set first. */
307	rc = RTSemFastMutexCreate(&m->hMtxDevices);
308	if (RT_SUCCESS(rc))
309	{
310	rc = RTPipeCreate(&m->hWakeupPipeR, &m->hWakeupPipeW, 0);
311	if (RT_SUCCESS(rc))
312	{
313	rc = RTPollSetCreate(&m->hPollSet);
314	if (RT_SUCCESS(rc))
315	{
316	rc = RTPollSetAddPipe(m->hPollSet, m->hWakeupPipeR,
317	RTPOLL_EVT_READ, USBIP_POLL_ID_PIPE);
318	if (RT_SUCCESS(rc))
319	{
320	/* Connect to the USB/IP host. */
321	rc = reconnect();
322	if (RT_SUCCESS(rc))
323	rc = start(); /* Start service thread. */
324	}
325
326	if (RT_FAILURE(rc))
327	{
328	RTPollSetRemove(m->hPollSet, USBIP_POLL_ID_PIPE);
329	int rc2 = RTPollSetDestroy(m->hPollSet);
330	AssertRC(rc2);
331	m->hPollSet = NIL_RTPOLLSET;
332	}
333	}
334
335	if (RT_FAILURE(rc))
336	{
337	int rc2 = RTPipeClose(m->hWakeupPipeR);
338	AssertRC(rc2);
339	rc2 = RTPipeClose(m->hWakeupPipeW);
340	AssertRC(rc2);
341	m->hWakeupPipeR = m->hWakeupPipeW = NIL_RTPIPE;
342	}
343	}
344	if (RT_FAILURE(rc))
345	{
346	RTSemFastMutexDestroy(m->hMtxDevices);
347	m->hMtxDevices = NIL_RTSEMFASTMUTEX;
348	}
349	}
350
351	return rc;
352	}
353
354	/**
355	* Stop all service threads and free the device chain.
356	*/
357	void USBProxyBackendUsbIp::uninit()
358	{
359	LogFlowThisFunc(("\n"));
360
361	/*
362	* Stop the service.
363	*/
364	if (isActive())
365	stop();
366
367	/*
368	* Free resources.
369	*/
370	if (m->hPollSet != NIL_RTPOLLSET)
371	{
372	disconnect();
373
374	int rc = RTPollSetRemove(m->hPollSet, USBIP_POLL_ID_PIPE);
375	AssertRC(rc);
376	rc = RTPollSetDestroy(m->hPollSet);
377	AssertRC(rc);
378	rc = RTPipeClose(m->hWakeupPipeR);
379	AssertRC(rc);
380	rc = RTPipeClose(m->hWakeupPipeW);
381	AssertRC(rc);
382
383	m->hPollSet = NIL_RTPOLLSET;
384	m->hWakeupPipeR = NIL_RTPIPE;
385	m->hWakeupPipeW = NIL_RTPIPE;
386	}
387
388	if (m->pszHost)
389	RTStrFree(m->pszHost);
390	if (m->hMtxDevices != NIL_RTSEMFASTMUTEX)
391	{
392	RTSemFastMutexDestroy(m->hMtxDevices);
393	m->hMtxDevices = NIL_RTSEMFASTMUTEX;
394	}
395
396	delete m;
397	USBProxyBackend::uninit();
398	}
399
400
401	int USBProxyBackendUsbIp::captureDevice(HostUSBDevice *aDevice)
402	{
403	AssertReturn(aDevice, VERR_GENERAL_FAILURE);
404	AssertReturn(!aDevice->isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
405
406	AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
407	LogFlowThisFunc(("aDevice=%s\n", aDevice->i_getName().c_str()));
408
409	/*
410	* We don't need to do anything when the device is held... fake it.
411	*/
412	Assert(aDevice->i_getUnistate() == kHostUSBDeviceState_Capturing);
413	devLock.release();
414	interruptWait();
415
416	return VINF_SUCCESS;
417	}
418
419
420	int USBProxyBackendUsbIp::releaseDevice(HostUSBDevice *aDevice)
421	{
422	AssertReturn(aDevice, VERR_GENERAL_FAILURE);
423	AssertReturn(!aDevice->isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
424
425	AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
426	LogFlowThisFunc(("aDevice=%s\n", aDevice->i_getName().c_str()));
427
428	/*
429	* We're not really holding it atm., just fake it.
430	*/
431	Assert(aDevice->i_getUnistate() == kHostUSBDeviceState_ReleasingToHost);
432	devLock.release();
433	interruptWait();
434
435	return VINF_SUCCESS;
436	}
437
438
439	bool USBProxyBackendUsbIp::updateDeviceState(HostUSBDevice aDevice, PUSBDEVICE aUSBDevice, bool aRunFilters,
440	SessionMachine **aIgnoreMachine)
441	{
442	AssertReturn(aDevice, false);
443	AssertReturn(!aDevice->isWriteLockOnCurrentThread(), false);
444	AutoReadLock devLock(aDevice COMMA_LOCKVAL_SRC_POS);
445	if ( aUSBDevice->enmState == USBDEVICESTATE_USED_BY_HOST_CAPTURABLE
446	&& aDevice->i_getUsbData()->enmState == USBDEVICESTATE_USED_BY_HOST)
447	LogRel(("USBProxy: Device %04x:%04x (%s) has become accessible.\n",
448	aUSBDevice->idVendor, aUSBDevice->idProduct, aUSBDevice->pszAddress));
449	devLock.release();
450	return updateDeviceStateFake(aDevice, aUSBDevice, aRunFilters, aIgnoreMachine);
451	}
452
453
454	int USBProxyBackendUsbIp::wait(RTMSINTERVAL aMillies)
455	{
456	int rc = VINF_SUCCESS;
457	bool fDeviceListChangedOrWokenUp = false;
458
459	/* Try to reconnect once when we enter if we lost the connection earlier. */
460	if (m->hSocket == NIL_RTSOCKET)
461	rc = reconnect();
462
463	/* Query a new device list upon entering. */
464	if ( RT_SUCCESS(rc)
465	&& m->enmRecvState == kUsbIpRecvState_None)
466	{
467	rc = startListExportedDevicesReq();
468	if (RT_FAILURE(rc))
469	disconnect();
470	}
471
472	/*
473	* Because the USB/IP protocol doesn't specify a way to get notified about
474	* new or removed exported devices we have to poll the host periodically for
475	* a new device list and compare it with the previous one notifying the proxy
476	* service about changes.
477	*/
478	while ( !fDeviceListChangedOrWokenUp
479	&& (aMillies == RT_INDEFINITE_WAIT \|\| aMillies > 0)
480	&& RT_SUCCESS(rc))
481	{
482	RTMSINTERVAL msWait = aMillies;
483	uint64_t msPollStart = RTTimeMilliTS();
484	uint32_t uIdReady = 0;
485	uint32_t fEventsRecv = 0;
486
487	/* Limit the waiting time to 1sec so we can either reconnect or get a new device list. */
488	if (m->hSocket == NIL_RTSOCKET \|\| m->enmRecvState == kUsbIpRecvState_None)
489	msWait = RT_MIN(1000, aMillies);
490
491	rc = RTPoll(m->hPollSet, msWait, &fEventsRecv, &uIdReady);
492	if (RT_SUCCESS(rc))
493	{
494	if (uIdReady == USBIP_POLL_ID_PIPE)
495	{
496	/* Drain the wakeup pipe. */
497	char bRead = 0;
498	size_t cbRead = 0;
499
500	rc = RTPipeRead(m->hWakeupPipeR, &bRead, 1, &cbRead);
501	Assert(RT_SUCCESS(rc) && cbRead == 1);
502	fDeviceListChangedOrWokenUp = true;
503	}
504	else if (uIdReady == USBIP_POLL_ID_SOCKET)
505	{
506	if (fEventsRecv & RTPOLL_EVT_ERROR)
507	rc = VERR_NET_SHUTDOWN;
508	else
509	rc = receiveData();
510	if (RT_SUCCESS(rc))
511	{
512	/*
513	* If we are in the none state again we received the previous request
514	* and have a new device list to compare the old against.
515	*/
516	if (m->enmRecvState == kUsbIpRecvState_None)
517	{
518	if (hasDevListChanged(m->pHead))
519	fDeviceListChangedOrWokenUp = true;
520
521	/* Update to the new list in any case now that we have it anyway. */
522	RTSemFastMutexRequest(m->hMtxDevices);
523	freeDeviceList(m->pUsbDevicesCur);
524	m->cUsbDevicesCur = m->cDevicesCur;
525	m->pUsbDevicesCur = m->pHead;
526	RTSemFastMutexRelease(m->hMtxDevices);
527
528	m->pHead = NULL;
529	resetRecvState();
530	}
531	}
532	else if (rc == VERR_NET_SHUTDOWN \|\| rc == VERR_BROKEN_PIPE)
533	{
534	LogRelMax(10, ("USB/IP: Lost connection to host \"%s\", trying to reconnect...\n", m->pszHost));
535	disconnect();
536	rc = VINF_SUCCESS;
537	}
538	}
539	else
540	{
541	AssertMsgFailed(("Invalid poll ID returned\n"));
542	rc = VERR_INVALID_STATE;
543	}
544	aMillies -= (RTTimeMilliTS() - msPollStart);
545	}
546	else if (rc == VERR_TIMEOUT)
547	{
548	aMillies -= msWait;
549	if (aMillies)
550	{
551	/* Try to reconnect and start a new request if we lost the connection before. */
552	if (m->hSocket == NIL_RTSOCKET)
553	rc = reconnect();
554
555	if (RT_SUCCESS(rc))
556	rc = startListExportedDevicesReq();
557	}
558	}
559	}
560
561	return rc;
562	}
563
564
565	int USBProxyBackendUsbIp::interruptWait(void)
566	{
567	AssertReturn(!isWriteLockOnCurrentThread(), VERR_GENERAL_FAILURE);
568
569	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
570
571	int rc = RTPipeWriteBlocking(m->hWakeupPipeW, "", 1, NULL);
572	if (RT_SUCCESS(rc))
573	RTPipeFlush(m->hWakeupPipeW);
574	LogFlowFunc(("returning %Rrc\n", rc));
575	return rc;
576	}
577
578
579	PUSBDEVICE USBProxyBackendUsbIp::getDevices(void)
580	{
581	PUSBDEVICE pFirst = NULL;
582	PUSBDEVICE *ppNext = &pFirst;
583
584	/* Create a deep copy of the device list. */
585	RTSemFastMutexRequest(m->hMtxDevices);
586	PUSBDEVICE pCur = m->pUsbDevicesCur;
587	while (pCur)
588	{
589	PUSBDEVICE pNew = (PUSBDEVICE)RTMemAllocZ(sizeof(USBDEVICE));
590	if (pNew)
591	{
592	pNew->pszManufacturer = RTStrDup(pCur->pszManufacturer);
593	pNew->pszProduct = RTStrDup(pCur->pszProduct);
594	if (pCur->pszSerialNumber)
595	pNew->pszSerialNumber = RTStrDup(pCur->pszSerialNumber);
596	pNew->pszBackend = RTStrDup(pCur->pszBackend);
597	pNew->pszAddress = RTStrDup(pCur->pszAddress);
598
599	pNew->idVendor = pCur->idVendor;
600	pNew->idProduct = pCur->idProduct;
601	pNew->bcdDevice = pCur->bcdDevice;
602	pNew->bcdUSB = pCur->bcdUSB;
603	pNew->bDeviceClass = pCur->bDeviceClass;
604	pNew->bDeviceSubClass = pCur->bDeviceSubClass;
605	pNew->bDeviceProtocol = pCur->bDeviceProtocol;
606	pNew->bNumConfigurations = pCur->bNumConfigurations;
607	pNew->enmState = pCur->enmState;
608	pNew->u64SerialHash = pCur->u64SerialHash;
609	pNew->bBus = pCur->bBus;
610	pNew->bPort = pCur->bPort;
611	pNew->enmSpeed = pCur->enmSpeed;
612
613	/* link it */
614	pNew->pNext = NULL;
615	pNew->pPrev = *ppNext;
616	*ppNext = pNew;
617	ppNext = &pNew->pNext;
618	}
619
620	pCur = pCur->pNext;
621	}
622	RTSemFastMutexRelease(m->hMtxDevices);
623
624	return pFirst;
625	}
626
627	/**
628	* Frees a given device list.
629	*
630	* @returns nothing.
631	* @param pHead The head of the device list to free.
632	*/
633	void USBProxyBackendUsbIp::freeDeviceList(PUSBDEVICE pHead)
634	{
635	PUSBDEVICE pNext = pHead;
636	while (pNext)
637	{
638	PUSBDEVICE pFree = pNext;
639	pNext = pNext->pNext;
640	freeDevice(pFree);
641	}
642	}
643
644	/**
645	* Resets the receive state to the idle state.
646	*
647	* @returns nothing.
648	*/
649	void USBProxyBackendUsbIp::resetRecvState()
650	{
651	freeDeviceList(m->pHead);
652	m->pHead = NULL;
653	m->ppNext = &m->pHead;
654	m->cDevicesCur = 0;
655	m->enmRecvState = kUsbIpRecvState_None;
656	m->cbResidualRecv = 0;
657	m->pbRecvBuf = &m->Scratch.abRecv[0];
658	m->cDevicesLeft = 0;
659	}
660
661	/**
662	* Disconnects from the host and resets the receive state.
663	*
664	* @returns nothing.
665	*/
666	void USBProxyBackendUsbIp::disconnect()
667	{
668	if (m->hSocket != NIL_RTSOCKET)
669	{
670	int rc = RTPollSetRemove(m->hPollSet, USBIP_POLL_ID_SOCKET);
671	Assert(RT_SUCCESS(rc) \|\| rc == VERR_POLL_HANDLE_ID_NOT_FOUND);
672
673	RTTcpClientCloseEx(m->hSocket, false /fGracefulShutdown/);
674	m->hSocket = NIL_RTSOCKET;
675	}
676
677	resetRecvState();
678	}
679
680	/**
681	* Tries to reconnect to the USB/IP host.
682	*
683	* @returns VBox status code.
684	*/
685	int USBProxyBackendUsbIp::reconnect()
686	{
687	/* Make sure we are disconnected. */
688	disconnect();
689
690	/* Connect to the USB/IP host. */
691	int rc = RTTcpClientConnect(m->pszHost, m->uPort, &m->hSocket);
692	if (RT_SUCCESS(rc))
693	{
694	rc = RTTcpSetSendCoalescing(m->hSocket, false);
695	if (RT_FAILURE(rc))
696	LogRel(("USB/IP: Disabling send coalescing failed (rc=%Rrc), continuing nevertheless but expect increased latency\n", rc));
697
698	rc = RTPollSetAddSocket(m->hPollSet, m->hSocket, RTPOLL_EVT_READ \| RTPOLL_EVT_ERROR,
699	USBIP_POLL_ID_SOCKET);
700	if (RT_FAILURE(rc))
701	{
702	RTTcpClientCloseEx(m->hSocket, false /fGracefulShutdown/);
703	m->hSocket = NIL_RTSOCKET;
704	}
705	else
706	LogRel(("USB/IP: Connected to host \"%s\"\n", m->pszHost));
707	}
708
709	return rc;
710	}
711
712	/**
713	* Initiates a new List Exported Devices request.
714	*
715	* @returns VBox status code.
716	*/
717	int USBProxyBackendUsbIp::startListExportedDevicesReq()
718	{
719	int rc = VINF_SUCCESS;
720
721	/*
722	* Reset the current state and reconnect in case we were called in the middle
723	* of another transfer (which should not happen).
724	*/
725	Assert(m->enmRecvState == kUsbIpRecvState_None);
726	if (m->enmRecvState != kUsbIpRecvState_None)
727	rc = reconnect();
728
729	if (RT_SUCCESS(rc))
730	{
731	/* Send of the request. */
732	UsbIpReqDevList ReqDevList;
733	ReqDevList.u16Version = RT_H2N_U16(USBIP_VERSION);
734	ReqDevList.u16Cmd = RT_H2N_U16(USBIP_INDICATOR_REQ \| USBIP_REQ_RET_DEVLIST);
735	ReqDevList.u32Status = RT_H2N_U32(0);
736	rc = RTTcpWrite(m->hSocket, &ReqDevList, sizeof(ReqDevList));
737	if (RT_SUCCESS(rc))
738	advanceState(kUsbIpRecvState_Hdr);
739	}
740
741	return rc;
742	}
743
744	/**
745	* Advances the state machine to the given state.
746	*
747	* @returns nothing.
748	* @param enmRecvState The new receive state.
749	*/
750	void USBProxyBackendUsbIp::advanceState(USBIPRECVSTATE enmRecvState)
751	{
752	switch (enmRecvState)
753	{
754	case kUsbIpRecvState_None:
755	break;
756	case kUsbIpRecvState_Hdr:
757	{
758	m->cbResidualRecv = sizeof(UsbIpRetDevList);
759	m->pbRecvBuf = (uint8_t *)&m->Scratch.RetDevList;
760	break;
761	}
762	case kUsbIpRecvState_ExportedDevice:
763	{
764	m->cbResidualRecv = sizeof(UsbIpExportedDevice);
765	m->pbRecvBuf = (uint8_t *)&m->Scratch.ExportedDevice;
766	break;
767	}
768	case kUsbIpRecvState_DeviceInterface:
769	{
770	m->cbResidualRecv = sizeof(UsbIpDeviceInterface);
771	m->pbRecvBuf = (uint8_t *)&m->Scratch.DeviceInterface;
772	break;
773	}
774	default:
775	AssertMsgFailed(("Invalid USB/IP receive state %d\n", enmRecvState));
776	return;
777	}
778
779	m->enmRecvState = enmRecvState;
780	}
781
782	/**
783	* Receives data from the USB/IP host and processes it when everything for the current
784	* state was received.
785	*
786	* @returns VBox status code.
787	*/
788	int USBProxyBackendUsbIp::receiveData()
789	{
790	size_t cbRecvd = 0;
791	int rc = RTTcpReadNB(m->hSocket, m->pbRecvBuf, m->cbResidualRecv, &cbRecvd);
792	if (RT_SUCCESS(rc))
793	{
794	m->cbResidualRecv -= cbRecvd;
795	m->pbRecvBuf += cbRecvd;
796	/* In case we received everything for the current state process the data. */
797	if (!m->cbResidualRecv)
798	rc = processData();
799	}
800
801	return rc;
802	}
803
804	/**
805	* Processes the data in the scratch buffer based on the current state.
806	*
807	* @returns VBox status code.
808	*/
809	int USBProxyBackendUsbIp::processData()
810	{
811	int rc = VINF_SUCCESS;
812
813	switch (m->enmRecvState)
814	{
815	case kUsbIpRecvState_Hdr:
816	{
817	/* Check that the reply matches our expectations. */
818	if ( RT_N2H_U16(m->Scratch.RetDevList.u16Version) == USBIP_VERSION
819	&& RT_N2H_U16(m->Scratch.RetDevList.u16Cmd) == USBIP_REQ_RET_DEVLIST
820	&& RT_N2H_U32(m->Scratch.RetDevList.u32Status) == USBIP_STATUS_SUCCESS)
821	{
822	/* Populate the number of exported devices in the list and go to the next state. */
823	m->cDevicesLeft = RT_N2H_U32(m->Scratch.RetDevList.u32DevicesExported);
824	if (m->cDevicesLeft)
825	advanceState(kUsbIpRecvState_ExportedDevice);
826	else
827	advanceState(kUsbIpRecvState_None);
828	}
829	else
830	{
831	LogRelMax(10, ("USB/IP: Host sent an invalid reply to the list exported device request (Version: %#x Cmd: %#x Status: %#x)\n",
832	RT_N2H_U16(m->Scratch.RetDevList.u16Version), RT_N2H_U16(m->Scratch.RetDevList.u16Cmd),
833	RT_N2H_U32(m->Scratch.RetDevList.u32Status)));
834	rc = VERR_INVALID_STATE;
835	}
836	break;
837	}
838	case kUsbIpRecvState_ExportedDevice:
839	{
840	/* Create a new device and add it to the list. */
841	usbProxyBackendUsbIpExportedDeviceN2H(&m->Scratch.ExportedDevice);
842	rc = addDeviceToList(&m->Scratch.ExportedDevice);
843	if (RT_SUCCESS(rc))
844	{
845	m->cInterfacesLeft = m->Scratch.ExportedDevice.bNumInterfaces;
846	if (m->cInterfacesLeft)
847	advanceState(kUsbIpRecvState_DeviceInterface);
848	else
849	{
850	m->cDevicesLeft--;
851	if (m->cDevicesLeft)
852	advanceState(kUsbIpRecvState_ExportedDevice);
853	else
854	advanceState(kUsbIpRecvState_None);
855	}
856	}
857	break;
858	}
859	case kUsbIpRecvState_DeviceInterface:
860	{
861	/*
862	* If all interfaces for the current device were received receive the next device
863	* if there is another one left, if not we are done with the current request.
864	*/
865	m->cInterfacesLeft--;
866	if (m->cInterfacesLeft)
867	advanceState(kUsbIpRecvState_DeviceInterface);
868	else
869	{
870	m->cDevicesLeft--;
871	if (m->cDevicesLeft)
872	advanceState(kUsbIpRecvState_ExportedDevice);
873	else
874	advanceState(kUsbIpRecvState_None);
875	}
876	break;
877	}
878	case kUsbIpRecvState_None:
879	default:
880	AssertMsgFailed(("Invalid USB/IP receive state %d\n", m->enmRecvState));
881	return VERR_INVALID_STATE;
882	}
883
884	return rc;
885	}
886
887	/**
888	* Creates a new USB device and adds it to the list.
889	*
890	* @returns VBox status code.
891	* @param pDev Pointer to the USB/IP exported device structure to take
892	* the information for the new device from.
893	*/
894	int USBProxyBackendUsbIp::addDeviceToList(PUsbIpExportedDevice pDev)
895	{
896	PUSBDEVICE pNew = (PUSBDEVICE)RTMemAllocZ(sizeof(USBDEVICE));
897	if (!pNew)
898	return VERR_NO_MEMORY;
899
900	pNew->pszManufacturer = RTStrDup("");
901	pNew->pszProduct = RTStrDup("");
902	pNew->pszSerialNumber = NULL;
903	pNew->pszBackend = RTStrDup("usbip");
904
905	/* Make sure the Bus id is 0 terminated. */
906	pDev->szBusId[31] = '\0';
907	int rc = RTStrAPrintf((char **)&pNew->pszAddress, "usbip://%s:%u:%s", m->pszHost, m->uPort, &pDev->szBusId[0]);
908	if (RT_SUCCESS(rc))
909	{
910	pNew->idVendor = pDev->u16VendorId;
911	pNew->idProduct = pDev->u16ProductId;
912	pNew->bcdDevice = pDev->u16BcdDevice;
913	pNew->bDeviceClass = pDev->bDeviceClass;
914	pNew->bDeviceSubClass = pDev->bDeviceSubClass;
915	pNew->bDeviceProtocol = pDev->bDeviceProtocol;
916	pNew->bNumConfigurations = pDev->bNumConfigurations;
917	pNew->enmState = USBDEVICESTATE_USED_BY_HOST_CAPTURABLE;
918	pNew->u64SerialHash = 0;
919	/** @todo: The following is not correct but is required to to get USB testing working
920	* because only the port can be part of a filter (adding the required attributes for the bus
921	* breaks API and ABI compatibility).
922	* Filtering by port number is required for USB testing to connect to the correct device
923	* in case there are multiple ones.
924	*/
925	pNew->bBus = (uint8_t)pDev->u32DevNum;
926	pNew->bPort = (uint8_t)pDev->u32BusNum;
927
928	switch (pDev->u32Speed)
929	{
930	case USBIP_SPEED_LOW:
931	pNew->enmSpeed = USBDEVICESPEED_LOW;
932	pNew->bcdUSB = 1 << 8;
933	break;
934	case USBIP_SPEED_FULL:
935	pNew->enmSpeed = USBDEVICESPEED_FULL;
936	pNew->bcdUSB = 1 << 8;
937	break;
938	case USBIP_SPEED_HIGH:
939	pNew->enmSpeed = USBDEVICESPEED_HIGH;
940	pNew->bcdUSB = 2 << 8;
941	break;
942	case USBIP_SPEED_WIRELESS:
943	pNew->enmSpeed = USBDEVICESPEED_VARIABLE;
944	pNew->bcdUSB = 1 << 8;
945	break;
946	case USBIP_SPEED_SUPER:
947	pNew->enmSpeed = USBDEVICESPEED_SUPER;
948	pNew->bcdUSB = 3 << 8;
949	break;
950	case USBIP_SPEED_UNKNOWN:
951	default:
952	pNew->bcdUSB = 1 << 8;
953	pNew->enmSpeed = USBDEVICESPEED_UNKNOWN;
954	}
955
956	/* link it */
957	pNew->pNext = NULL;
958	pNew->pPrev = *m->ppNext;
959	*m->ppNext = pNew;
960	m->ppNext = &pNew->pNext;
961	m->cDevicesCur++;
962	}
963
964	if (RT_FAILURE(rc))
965	{
966	if (pNew->pszManufacturer)
967	RTStrFree((char *)pNew->pszManufacturer);
968	if (pNew->pszProduct)
969	RTStrFree((char *)pNew->pszProduct);
970	if (pNew->pszBackend)
971	RTStrFree((char *)pNew->pszBackend);
972	if (pNew->pszAddress)
973	RTStrFree((char *)pNew->pszAddress);
974	RTMemFree(pNew);
975	}
976
977	return rc;
978	}
979
980	/**
981	* Compares the given device list with the current one and returns whether it has
982	* changed.
983	*
984	* @returns flag whether the device list has changed compared to the current one.
985	* @param pDevices The device list to compare the current one against.
986	*/
987	bool USBProxyBackendUsbIp::hasDevListChanged(PUSBDEVICE pDevices)
988	{
989	/** @todo */
990	return true;
991	}
992

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

source: vbox/trunk/src/VBox/Main/src-server/generic/USBProxyBackendUsbIp.cpp@ 60551

Download in other formats: