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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/* $Id: ioqueuebase.cpp $ */
/** @file
* IPRT - I/O queue, Base/Public API.
*/
/*
* Copyright (C) 2019-2020 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP RTLOGGROUP_IOQUEUE
#include <iprt/ioqueue.h>
#include <iprt/asm.h>
#include <iprt/err.h>
#include <iprt/log.h>
#include <iprt/mem.h>
#include <iprt/semaphore.h>
#include <iprt/string.h>
#include "internal/ioqueue.h"
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* Internal I/O queue instance data.
*/
typedef struct RTIOQUEUEINT
{
/** Magic identifying the I/O queue structure. */
uint32_t u32Magic;
/** Pointer to the provider vtable. */
PCRTIOQUEUEPROVVTABLE pVTbl;
/** I/O queue provider instance handle. */
RTIOQUEUEPROV hIoQueueProv;
/** Maximum number of submission queue entries - constant. */
uint32_t cSqEntries;
/** Maximum number of completion queue entries - constant. */
uint32_t cCqEntries;
/** Number of currently committed and not completed requests. */
volatile uint32_t cReqsCommitted;
/** Number of prepared requests. */
volatile uint32_t cReqsPrepared;
/** Start of the provider specific instance data - vvariable in size. */
uint8_t abInst[1];
} RTIOQUEUEINT;
/** Pointer to the internal I/O queue instance data. */
typedef RTIOQUEUEINT *PRTIOQUEUEINT;
/*********************************************************************************************************************************
* Global Variables *
*********************************************************************************************************************************/
/** Array of I/O queue providers we know about, order is important for each type.
* The best suited ones for each platform should come first.
*/
static PCRTIOQUEUEPROVVTABLE g_apIoQueueProviders[] =
{
#if defined(RT_OS_LINUX)
&g_RTIoQueueLnxIoURingProv,
#endif
#ifndef RT_OS_OS2
&g_RTIoQueueAioFileProv,
#endif
&g_RTIoQueueStdFileProv
};
/*********************************************************************************************************************************
* Internal Functions *
*********************************************************************************************************************************/
RTDECL(PCRTIOQUEUEPROVVTABLE) RTIoQueueProviderGetBestForHndType(RTHANDLETYPE enmHnd)
{
/* Go through the array and pick the first supported provider for the given handle type. */
for (unsigned i = 0; i < RT_ELEMENTS(g_apIoQueueProviders); i++)
{
PCRTIOQUEUEPROVVTABLE pIoQueueProv = g_apIoQueueProviders[i];
if ( pIoQueueProv->enmHnd == enmHnd
&& pIoQueueProv->pfnIsSupported())
return pIoQueueProv;
}
return NULL;
}
RTDECL(PCRTIOQUEUEPROVVTABLE) RTIoQueueProviderGetById(const char *pszId)
{
for (unsigned i = 0; i < RT_ELEMENTS(g_apIoQueueProviders); i++)
{
PCRTIOQUEUEPROVVTABLE pIoQueueProv = g_apIoQueueProviders[i];
if (!strcmp(pIoQueueProv->pszId, pszId))
return pIoQueueProv;
}
return NULL;
}
RTDECL(int) RTIoQueueCreate(PRTIOQUEUE phIoQueue, PCRTIOQUEUEPROVVTABLE pProvVTable,
uint32_t fFlags, uint32_t cSqEntries, uint32_t cCqEntries)
{
AssertPtrReturn(phIoQueue, VERR_INVALID_POINTER);
AssertPtrReturn(pProvVTable, VERR_INVALID_POINTER);
AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
AssertReturn(cSqEntries > 0, VERR_INVALID_PARAMETER);
AssertReturn(cCqEntries > 0, VERR_INVALID_PARAMETER);
int rc = VINF_SUCCESS;
PRTIOQUEUEINT pThis = (PRTIOQUEUEINT)RTMemAllocZ(RT_UOFFSETOF_DYN(RTIOQUEUEINT, abInst[pProvVTable->cbIoQueueProv]));
if (RT_LIKELY(pThis))
{
pThis->pVTbl = pProvVTable;
pThis->hIoQueueProv = (RTIOQUEUEPROV)&pThis->abInst[0];
pThis->cSqEntries = cSqEntries;
pThis->cCqEntries = cCqEntries;
pThis->cReqsCommitted = 0;
pThis->cReqsPrepared = 0;
rc = pThis->pVTbl->pfnQueueInit(pThis->hIoQueueProv, fFlags, cSqEntries, cCqEntries);
if (RT_SUCCESS(rc))
{
*phIoQueue = pThis;
return VINF_SUCCESS;
}
RTMemFree(pThis);
}
else
rc = VERR_NO_MEMORY;
return rc;
}
RTDECL(int) RTIoQueueDestroy(RTIOQUEUE hIoQueue)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
AssertReturn(ASMAtomicReadU32(&pThis->cReqsCommitted) == 0, VERR_IOQUEUE_BUSY);
pThis->pVTbl->pfnQueueDestroy(pThis->hIoQueueProv);
RTMemFree(pThis);
return VINF_SUCCESS;
}
RTDECL(int) RTIoQueueHandleRegister(RTIOQUEUE hIoQueue, PCRTHANDLE pHandle)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
/** @todo Efficiently check that handle wasn't registered previously. */
return pThis->pVTbl->pfnHandleRegister(pThis->hIoQueueProv, pHandle);
}
RTDECL(int) RTIoQueueHandleDeregister(RTIOQUEUE hIoQueue, PCRTHANDLE pHandle)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
/** @todo Efficiently check that handle was registered previously. */
return pThis->pVTbl->pfnHandleDeregister(pThis->hIoQueueProv, pHandle);
}
RTDECL(int) RTIoQueueRequestPrepare(RTIOQUEUE hIoQueue, PCRTHANDLE pHandle, RTIOQUEUEOP enmOp,
uint64_t off, void *pvBuf, size_t cbBuf, uint32_t fReqFlags,
void *pvUser)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
AssertReturn(pHandle->enmType == pThis->pVTbl->enmHnd, VERR_INVALID_HANDLE);
/** @todo Efficiently check that handle was registered previously. */
int rc = pThis->pVTbl->pfnReqPrepare(pThis->hIoQueueProv, pHandle, enmOp, off, pvBuf, cbBuf,
fReqFlags, pvUser);
if (RT_SUCCESS(rc))
ASMAtomicIncU32(&pThis->cReqsPrepared);
return rc;
}
RTDECL(int) RTIoQueueRequestPrepareSg(RTIOQUEUE hIoQueue, PCRTHANDLE pHandle, RTIOQUEUEOP enmOp,
uint64_t off, PCRTSGBUF pSgBuf, size_t cbSg, uint32_t fReqFlags,
void *pvUser)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
AssertReturn(pHandle->enmType == pThis->pVTbl->enmHnd, VERR_INVALID_HANDLE);
/** @todo Efficiently check that handle was registered previously. */
int rc = pThis->pVTbl->pfnReqPrepareSg(pThis->hIoQueueProv, pHandle, enmOp, off, pSgBuf, cbSg,
fReqFlags, pvUser);
if (RT_SUCCESS(rc))
ASMAtomicIncU32(&pThis->cReqsPrepared);
return rc;
}
RTDECL(int) RTIoQueueCommit(RTIOQUEUE hIoQueue)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
AssertReturn(ASMAtomicReadU32(&pThis->cReqsPrepared) > 0, VERR_IOQUEUE_EMPTY);
uint32_t cReqsPreparedOld = 0;
uint32_t cReqsCommitted = 0;
int rc = VINF_SUCCESS;
do
{
rc = pThis->pVTbl->pfnCommit(pThis->hIoQueueProv, &cReqsCommitted);
if (RT_SUCCESS(rc))
{
ASMAtomicAddU32(&pThis->cReqsCommitted, cReqsCommitted);
cReqsPreparedOld = ASMAtomicSubU32(&pThis->cReqsPrepared, cReqsCommitted);
}
} while (RT_SUCCESS(rc) && cReqsPreparedOld - cReqsCommitted > 0);
return rc;
}
RTDECL(int) RTIoQueueEvtWait(RTIOQUEUE hIoQueue, PRTIOQUEUECEVT paCEvt, uint32_t cCEvt, uint32_t cMinWait,
uint32_t *pcCEvt, uint32_t fFlags)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
AssertPtrReturn(paCEvt, VERR_INVALID_POINTER);
AssertReturn(cCEvt > 0, VERR_INVALID_PARAMETER);
AssertReturn(cMinWait > 0, VERR_INVALID_PARAMETER);
AssertPtrReturn(pcCEvt, VERR_INVALID_POINTER);
AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
AssertReturn(ASMAtomicReadU32(&pThis->cReqsCommitted) > 0, VERR_IOQUEUE_EMPTY);
*pcCEvt = 0;
int rc = pThis->pVTbl->pfnEvtWait(pThis->hIoQueueProv, paCEvt, cCEvt, cMinWait, pcCEvt, fFlags);
if ( (RT_SUCCESS(rc) || rc == VERR_INTERRUPTED)
&& *pcCEvt > 0)
ASMAtomicSubU32(&pThis->cReqsCommitted, *pcCEvt);
return rc;
}
RTDECL(int) RTIoQueueEvtWaitWakeup(RTIOQUEUE hIoQueue)
{
PRTIOQUEUEINT pThis = hIoQueue;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
return pThis->pVTbl->pfnEvtWaitWakeup(pThis->hIoQueueProv);
}
|
