Changeset 79949 in vbox

Timestamp:

Jul 24, 2019 11:05:45 AM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

132374

Message:

Runtime: bugref:8231 Starting on defining and implementing a new RTIoQueue API to replace RTFileAio mid term.

The RTIoQueue API is meant to be more efficient as it doesn't require allocation
of request structures and is only meant as a thin layer around host dependent APIs.
It will support mutiple providers for different handle types and the best suited provider
supported on a particular host can be selected. This allows multiple implementations
to coexist for the same host in an easy manner.
The providers currently being implemented are (in various stages of the implementation):

• ioqueue-stdfile-provider.cpp:

A fallback provider if nothing else is available using the synchronous RTFile* APIs
emulating asynchronous behavior by using a dedicated worker thread.

• ioqueue-aiofile-provider.cpp:

Uses the current RTFileAio* API, will get replaced by dedicated provider implementations for
each host later on.

• ioqueue-iouringfile-provider.cpp:

Uses the recently added io_uring interface for Linux kernels 5.1 and newer. The new interface
is a great improvement over the old aio interface which is cumbersome to use and has various
restrictions. If not available on a host the code can fall back to one of the other providers.

The I/O queue interface is also meant to be suitable for sockets which can be implemented later.

Location:

trunk

Files:

• include/iprt/err.h (modified) (1 diff)
• include/iprt/ioqueue.h (added)
• include/iprt/log.h (modified) (3 diffs)
• include/iprt/mangling.h (modified) (2 diffs)
• src/VBox/Runtime/Makefile.kmk (modified) (2 diffs)
• src/VBox/Runtime/common/ioqueue (added)
• src/VBox/Runtime/common/ioqueue/ioqueue-aiofile-provider.cpp (added)
• src/VBox/Runtime/common/ioqueue/ioqueue-stdfile-provider.cpp (added)
• src/VBox/Runtime/common/ioqueue/ioqueuebase.cpp (added)
• src/VBox/Runtime/include/internal/ioqueue.h (added)
• src/VBox/Runtime/r3/linux/ioqueue-iouringfile-provider.cpp (added)

trunk/include/iprt/err.h

@@ -2687 +2687 @@
 /** @} */
 
+
+/** @name RTIoQueue status codes
+ * @{ */
+/** The handle was not registered for use with the I/O queue. */
+#define VERR_IOQUEUE_HANDLE_NOT_REGISTERED                      (-26200)
+/** The I/O queue is full and can't accept more requests. */
+#define VERR_IOQUEUE_FULL                                       (-26201)
+/** The I/O queue doesn't contain any prepared requests to commit or wait for completion. */
+#define VERR_IOQUEUE_EMPTY                                      (-26202)
+/** The I/O queue has requests pending which need complete first. */
+#define VERR_IOQUEUE_BUSY                                       (-26203)
+/** @} */
+
 /* SED-END */
 

trunk/include/iprt/log.h

@@ -63 +63 @@
     RTLOGGROUP_FS,
     RTLOGGROUP_HTTP,
+    RTLOGGROUP_IOQUEUE,
     RTLOGGROUP_LDR,
     RTLOGGROUP_LOCALIPC,
@@ -99 +100 @@
     "RT_FS", \
     "RT_HTTP", \
+    "RT_IOQUEUE", \
     "RT_LDR", \
     "RT_LOCALIPC", \
@@ -109 +111 @@
     "RT_TIMER", \
     "RT_VFS", \
-    "RT_18", \
     "RT_19", \
     "RT_20", \

trunk/include/iprt/mangling.h

@@ -1143 +1143 @@
 # define RTIniFileQueryPair                             RT_MANGLER(RTIniFileQueryPair)
 # define RTIniFileQueryValue                            RT_MANGLER(RTIniFileQueryValue)
+# define RTIoQueueCommit                                RT_MANGLER(RTIoQueueCommit)
+# define RTIoQueueCreate                                RT_MANGLER(RTIoQueueCreate)
+# define RTIoQueueDestroy                               RT_MANGLER(RTIoQueueDestroy)
+# define RTIoQueueEvtWait                               RT_MANGLER(RTIoQueueEvtWait)
+# define RTIoQueueEvtWaitWakeup                         RT_MANGLER(RTIoQueueEvtWaitWakeup)
+# define RTIoQueueHandleDeregister                      RT_MANGLER(RTIoQueueHandleDeregister)
+# define RTIoQueueHandleRegister                        RT_MANGLER(RTIoQueueHandleRegister)
+# define RTIoQueueProviderGetBestForHndType             RT_MANGLER(RTIoQueueProviderGetBestForHndType)
+# define RTIoQueueProviderGetById                       RT_MANGLER(RTIoQueueProviderGetById)
+# define RTIoQueueRequestPrepare                        RT_MANGLER(RTIoQueueRequestPrepare)
+# define RTIoQueueRequestPrepareSg                      RT_MANGLER(RTIoQueueRequestPrepareSg)
 # define RTJsonIteratorBegin                            RT_MANGLER(RTJsonIteratorBegin)
 # define RTJsonIteratorBeginArray                       RT_MANGLER(RTJsonIteratorBeginArray)
@@ -3947 +3958 @@
 # define g_cRTCrKeyAllMarkers                           RT_MANGLER(g_cRTCrKeyAllMarkers)
 # define g_acRTThreadTypeStats                          RT_MANGLER(g_acRTThreadTypeStats) /* internal */
+# define g_RTIoQueueStdFileProv                         RT_MANGLER(g_RTIoQueueStdFileProv) /* internal */
+# define g_RTIoQueueAioFileProv                         RT_MANGLER(g_RTIoQueueAioFileProv) /* internal */
+# define g_RTIoQueueLnxIoURingProv                      RT_MANGLER(g_RTIoQueueLnxIoURingProv) /* internal */
 
 #if 0 /* Disabled for now as I'm not sure the assmbler supports mangling yet. */

trunk/src/VBox/Runtime/Makefile.kmk

@@ -447 +447 @@
         common/fs/ntfsvfs.cpp \
         common/fs/RTFsCmdLs.cpp \
+        common/ioqueue/ioqueuebase.cpp \
+        common/ioqueue/ioqueue-aiofile-provider.cpp \
+        common/ioqueue/ioqueue-stdfile-provider.cpp \
         common/ldr/ldr.cpp \
         common/ldr/ldrELF.cpp \
@@ -2171 +2174 @@
         $(VBoxRT_0_OUTDIR)/VBoxRT.def
 VBoxRT_SOURCES.linux          += \
-        r3/linux/fileaio-linux.cpp
+        r3/linux/fileaio-linux.cpp \
+        r3/linux/ioqueue-iouringfile-provider.cpp
 VBoxRT_SOURCES.solaris        += \
         r3/solaris/fileaio-solaris.cpp