1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
/* $Id: VUSBUrbPool.cpp $ */
/** @file
* Virtual USB - URB pool.
*/
/*
* Copyright (C) 2016-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_DRV_VUSB
#include <VBox/log.h>
#include <iprt/errcore.h>
#include <iprt/mem.h>
#include <iprt/critsect.h>
#include "VUSBInternal.h"
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
/** Maximum age for one URB. */
#define VUSBURB_AGE_MAX 10
/** Convert from an URB to the URB header. */
#define VUSBURBPOOL_URB_2_URBHDR(a_pUrb) RT_FROM_MEMBER(a_pUrb, VUSBURBHDR, Urb);
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* URB header not visible to the caller allocating an URB
* and only for internal tracking.
*/
typedef struct VUSBURBHDR
{
/** List node for keeping the URB in the free list. */
RTLISTNODE NdFree;
/** Size of the data allocated for the URB (Only the variable part including the
* HCI and TDs). */
size_t cbAllocated;
/** Age of the URB waiting on the list, if it is waiting for too long without being used
* again it will be freed. */
uint32_t cAge;
#if HC_ARCH_BITS == 64
uint32_t u32Alignment0;
#endif
/** The embedded URB. */
VUSBURB Urb;
} VUSBURBHDR;
/** Pointer to a URB header. */
typedef VUSBURBHDR *PVUSBURBHDR;
AssertCompileSizeAlignment(VUSBURBHDR, 8);
DECLHIDDEN(int) vusbUrbPoolInit(PVUSBURBPOOL pUrbPool)
{
int rc = RTCritSectInit(&pUrbPool->CritSectPool);
if (RT_SUCCESS(rc))
{
pUrbPool->cUrbsInPool = 0;
for (unsigned i = 0; i < RT_ELEMENTS(pUrbPool->aLstFreeUrbs); i++)
RTListInit(&pUrbPool->aLstFreeUrbs[i]);
}
return rc;
}
DECLHIDDEN(void) vusbUrbPoolDestroy(PVUSBURBPOOL pUrbPool)
{
RTCritSectEnter(&pUrbPool->CritSectPool);
for (unsigned i = 0; i < RT_ELEMENTS(pUrbPool->aLstFreeUrbs); i++)
{
PVUSBURBHDR pHdr, pHdrNext;
RTListForEachSafe(&pUrbPool->aLstFreeUrbs[i], pHdr, pHdrNext, VUSBURBHDR, NdFree)
{
RTListNodeRemove(&pHdr->NdFree);
pHdr->cbAllocated = 0;
pHdr->Urb.u32Magic = 0;
pHdr->Urb.enmState = VUSBURBSTATE_INVALID;
RTMemFree(pHdr);
}
}
RTCritSectLeave(&pUrbPool->CritSectPool);
RTCritSectDelete(&pUrbPool->CritSectPool);
}
DECLHIDDEN(PVUSBURB) vusbUrbPoolAlloc(PVUSBURBPOOL pUrbPool, VUSBXFERTYPE enmType,
VUSBDIRECTION enmDir, size_t cbData, size_t cbHci,
size_t cbHciTd, unsigned cTds)
{
Assert((uint32_t)cbData == cbData);
Assert((uint32_t)cbHci == cbHci);
/*
* Reuse or allocate a new URB.
*/
/** @todo The allocations should be done by the device, at least as an option, since the devices
* frequently wish to associate their own stuff with the in-flight URB or need special buffering
* (isochronous on Darwin for instance). */
/* Get the required amount of additional memory to allocate the whole state. */
size_t cbMem = cbData + sizeof(VUSBURBVUSBINT) + cbHci + cTds * cbHciTd;
AssertReturn((size_t)enmType < RT_ELEMENTS(pUrbPool->aLstFreeUrbs), NULL);
RTCritSectEnter(&pUrbPool->CritSectPool);
PVUSBURBHDR pHdr = NULL;
PVUSBURBHDR pIt, pItNext;
RTListForEachSafe(&pUrbPool->aLstFreeUrbs[enmType], pIt, pItNext, VUSBURBHDR, NdFree)
{
if (pIt->cbAllocated >= cbMem)
{
RTListNodeRemove(&pIt->NdFree);
Assert(pIt->Urb.u32Magic == VUSBURB_MAGIC);
Assert(pIt->Urb.enmState == VUSBURBSTATE_FREE);
/*
* If the allocation is far too big we increase the age counter too
* so we don't waste memory for a lot of small transfers
*/
if (pIt->cbAllocated >= 2 * cbMem)
pIt->cAge++;
else
pIt->cAge = 0;
pHdr = pIt;
break;
}
else
{
/* Increase age and free if it reached a threshold. */
pIt->cAge++;
if (pIt->cAge == VUSBURB_AGE_MAX)
{
RTListNodeRemove(&pIt->NdFree);
ASMAtomicDecU32(&pUrbPool->cUrbsInPool);
pIt->cbAllocated = 0;
pIt->Urb.u32Magic = 0;
pIt->Urb.enmState = VUSBURBSTATE_INVALID;
RTMemFree(pIt);
}
}
}
if (!pHdr)
{
/* allocate a new one. */
size_t cbDataAllocated = cbMem <= _4K ? RT_ALIGN_32(cbMem, _1K)
: cbMem <= _32K ? RT_ALIGN_32(cbMem, _4K)
: RT_ALIGN_32(cbMem, 16*_1K);
pHdr = (PVUSBURBHDR)RTMemAllocZ(RT_UOFFSETOF_DYN(VUSBURBHDR, Urb.abData[cbDataAllocated]));
if (RT_UNLIKELY(!pHdr))
{
RTCritSectLeave(&pUrbPool->CritSectPool);
AssertLogRelFailedReturn(NULL);
}
pHdr->cbAllocated = cbDataAllocated;
pHdr->cAge = 0;
ASMAtomicIncU32(&pUrbPool->cUrbsInPool);
}
else
{
/* Paranoia: Clear memory that's part of the guest data buffer now
* but wasn't before. See @bugref{10410}.
*/
if (cbData > pHdr->Urb.cbData)
{
memset(&pHdr->Urb.abData[pHdr->Urb.cbData], 0, cbData - pHdr->Urb.cbData);
}
}
RTCritSectLeave(&pUrbPool->CritSectPool);
Assert(pHdr->cbAllocated >= cbMem);
/*
* (Re)init the URB
*/
uint32_t offAlloc = (uint32_t)cbData;
PVUSBURB pUrb = &pHdr->Urb;
pUrb->u32Magic = VUSBURB_MAGIC;
pUrb->enmState = VUSBURBSTATE_ALLOCATED;
pUrb->fCompleting = false;
pUrb->pszDesc = NULL;
pUrb->pVUsb = (PVUSBURBVUSB)&pUrb->abData[offAlloc];
offAlloc += sizeof(VUSBURBVUSBINT);
pUrb->pVUsb->pUrb = pUrb;
pUrb->pVUsb->pvFreeCtx = NULL;
pUrb->pVUsb->pfnFree = NULL;
pUrb->pVUsb->pCtrlUrb = NULL;
pUrb->pVUsb->u64SubmitTS = 0;
pUrb->Dev.pvPrivate = NULL;
pUrb->Dev.pNext = NULL;
pUrb->EndPt = UINT8_MAX;
pUrb->enmType = enmType;
pUrb->enmDir = enmDir;
pUrb->fShortNotOk = false;
pUrb->enmStatus = VUSBSTATUS_INVALID;
pUrb->cbData = (uint32_t)cbData;
pUrb->pHci = cbHci ? (PVUSBURBHCI)&pUrb->abData[offAlloc] : NULL;
offAlloc += (uint32_t)cbHci;
pUrb->paTds = (cbHciTd && cTds) ? (PVUSBURBHCITD)&pUrb->abData[offAlloc] : NULL;
return pUrb;
}
DECLHIDDEN(void) vusbUrbPoolFree(PVUSBURBPOOL pUrbPool, PVUSBURB pUrb)
{
PVUSBURBHDR pHdr = VUSBURBPOOL_URB_2_URBHDR(pUrb);
/* URBs which aged too much because they are too big are freed. */
if (pHdr->cAge == VUSBURB_AGE_MAX)
{
ASMAtomicDecU32(&pUrbPool->cUrbsInPool);
pHdr->cbAllocated = 0;
pHdr->Urb.u32Magic = 0;
pHdr->Urb.enmState = VUSBURBSTATE_INVALID;
RTMemFree(pHdr);
}
else
{
/* Put it into the list of free URBs. */
VUSBXFERTYPE enmType = pUrb->enmType;
AssertReturnVoid((size_t)enmType < RT_ELEMENTS(pUrbPool->aLstFreeUrbs));
RTCritSectEnter(&pUrbPool->CritSectPool);
pUrb->enmState = VUSBURBSTATE_FREE;
RTListAppend(&pUrbPool->aLstFreeUrbs[enmType], &pHdr->NdFree);
RTCritSectLeave(&pUrbPool->CritSectPool);
}
}
|
