Changeset 32553 in vbox for trunk/include/VBox

Timestamp:

Sep 16, 2010 12:07:01 PM (14 years ago)

Author:

vboxsync

Message:

VBoxHDD: More cleanup

• The I/O interface between the generic layer and the backend is private because it includes operations for various async I/O tasks the user of VBoxHDD doesn't know about. Renamed it to make clear that it is internal and make the old async I/O interface the one which can be used for the VFS layer from the outside.

File:

• trunk/include/VBox/VBoxHDD.h (modified) (8 diffs)

trunk/include/VBox/VBoxHDD.h

@@ -253 +253 @@
     /** Interface to pass error message to upper layers. Per-disk. */
     VDINTERFACETYPE_ERROR = VDINTERFACETYPE_FIRST,
-    /** Interface for asynchronous I/O operations. Per-disk. */
-    VDINTERFACETYPE_ASYNCIO,
+    /** Interface for I/O operations. Per-disk. */
+    VDINTERFACETYPE_IO,
     /** Interface for progress notification. Per-operation. */
     VDINTERFACETYPE_PROGRESS,
@@ -265 +265 @@
     /** Interface for synchronizing accesses from several threads. Per-disk. */
     VDINTERFACETYPE_THREADSYNC,
-    /** Interface for I/O between the generic VBoxHDD code and the backend. Per-image. */
-    VDINTERFACETYPE_IO,
+    /** Interface for I/O between the generic VBoxHDD code and the backend. Per-image (internal).
+     * This interface is completely internal and must not be used elsewhere. */
+    VDINTERFACETYPE_IOINT,
     /** invalid interface. */
     VDINTERFACETYPE_INVALID
@@ -506 +507 @@
 
 /**
- * Support interface for asynchronous I/O
- *
- * Per-disk. Optional.
- */
-typedef struct VDINTERFACEASYNCIO
+ * Support interface for I/O
+ *
+ * Per-disk. Optional as input.
+ */
+typedef struct VDINTERFACEIO
 {
     /**
@@ -555 +556 @@
 
     /**
+     * Delete callback.
+     *
+     * @return  VBox status code.
+     * @param   pvUser          The opaque data passed on container creation.
+     * @param   pcszFilename    Name of the file to delete.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnDelete, (void *pvUser, const char *pcszFilename));
+
+    /**
+     * Move callback.
+     *
+     * @return  VBox status code.
+     * @param   pvUser          The opaque data passed on container creation.
+     * @param   pcszSrc         The path to the source file.
+     * @param   pcszDst         The path to the destination file.
+     *                          This file will be created.
+     * @param   fMove           A combination of the RTFILEMOVE_* flags.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnMove, (void *pvUser, const char *pcszSrc, const char *pcszDst, unsigned fMove));
+
+    /**
+     * Returns the free space on a disk.
+     *
+     * @return  VBox status code.
+     * @param   pvUser          The opaque data passed on container creation.
+     * @param   pcszFilename    Name of a file to identify the disk.
+     * @param   pcbFreeSpace    Where to store the free space of the disk.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnGetFreeSpace, (void *pvUser, const char *pcszFilename, int64_t *pcbFreeSpace));
+
+    /**
+     * Returns the last modification timestamp of a file.
+     *
+     * @return  VBox status code.
+     * @param   pvUser          The opaque data passed on container creation.
+     * @param   pcszFilename    Name of a file to identify the disk.
+     * @param   pModificationTime   Where to store the timestamp of the file.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnGetModificationTime, (void *pvUser, const char *pcszFilename, PRTTIMESPEC pModificationTime));
+
+    /**
      * Returns the size of the opened storage backend.
      *
@@ -660 +702 @@
                                               void *pvCompletion, void **ppTask));
 
-} VDINTERFACEASYNCIO, *PVDINTERFACEASYNCIO;
+} VDINTERFACEIO, *PVDINTERFACEIO;
 
 /**
@@ -668 +710 @@
  * @param  pInterface Pointer to the interface descriptor.
  */
-DECLINLINE(PVDINTERFACEASYNCIO) VDGetInterfaceAsyncIO(PVDINTERFACE pInterface)
-{
-    PVDINTERFACEASYNCIO pInterfaceAsyncIO;
+DECLINLINE(PVDINTERFACEIO) VDGetInterfaceIO(PVDINTERFACE pInterface)
+{
+    PVDINTERFACEIO pInterfaceIO;
 
     /* Check that the interface descriptor is a async I/O interface. */
-    AssertMsgReturn(   (pInterface->enmInterface == VDINTERFACETYPE_ASYNCIO)
+    AssertMsgReturn(   (pInterface->enmInterface == VDINTERFACETYPE_IO)
                     && (pInterface->cbSize == sizeof(VDINTERFACE)),
                     ("Not an async I/O interface"), NULL);
 
-    pInterfaceAsyncIO = (PVDINTERFACEASYNCIO)pInterface->pCallbacks;
+    pInterfaceIO = (PVDINTERFACEIO)pInterface->pCallbacks;
 
     /* Do basic checks. */
-    AssertMsgReturn(   (pInterfaceAsyncIO->cbSize == sizeof(VDINTERFACEASYNCIO))
-                    && (pInterfaceAsyncIO->enmInterface == VDINTERFACETYPE_ASYNCIO),
-                    ("A non async I/O callback table attached to a async I/O interface descriptor\n"), NULL);
-
-    return pInterfaceAsyncIO;
+    AssertMsgReturn(   (pInterfaceIO->cbSize == sizeof(VDINTERFACEIO))
+                    && (pInterfaceIO->enmInterface == VDINTERFACETYPE_IO),
+                    ("A non async I/O callback table attached to a I/O interface descriptor\n"), NULL);
+
+    return pInterfaceIO;
 }
 
@@ -1547 +1589 @@
 
 /**
- * Support interface for file I/O
- *
- * Per-image. Optional as input, always passed to backends.
- */
-typedef struct VDINTERFACEIO
-{
-    /**
-     * Size of the I/O interface.
+ * Internal I/O interface between the generic VD layer and the backends.
+ *
+ * Per-image. Always passed to backends.
+ */
+typedef struct VDINTERFACEIOINT
+{
+    /**
+     * Size of the internal I/O interface.
      */
     uint32_t    cbSize;
@@ -1856 +1898 @@
     DECLR3CALLBACKMEMBER(void, pfnIoCtxCompleted, (void *pvUser, PVDIOCTX pIoCtx,
                                                    int rcReq, size_t cbCompleted));
-} VDINTERFACEIO, *PVDINTERFACEIO;
-
-/**
- * Get async I/O interface from opaque callback table.
+} VDINTERFACEIOINT, *PVDINTERFACEIOINT;
+
+/**
+ * Get internal I/O interface from opaque callback table.
  *
  * @return Pointer to the callback table.
  * @param  pInterface Pointer to the interface descriptor.
  */
-DECLINLINE(PVDINTERFACEIO) VDGetInterfaceIO(PVDINTERFACE pInterface)
-{
-    PVDINTERFACEIO pInterfaceIO;
+DECLINLINE(PVDINTERFACEIOINT) VDGetInterfaceIOInt(PVDINTERFACE pInterface)
+{
+    PVDINTERFACEIOINT pInterfaceIO;
 
     /* Check that the interface descriptor is a async I/O interface. */
-    AssertMsgReturn(   (pInterface->enmInterface == VDINTERFACETYPE_IO)
+    AssertMsgReturn(   (pInterface->enmInterface == VDINTERFACETYPE_IOINT)
                     && (pInterface->cbSize == sizeof(VDINTERFACE)),
                     ("Not an I/O interface"), NULL);
 
-    pInterfaceIO = (PVDINTERFACEIO)pInterface->pCallbacks;
+    pInterfaceIO = (PVDINTERFACEIOINT)pInterface->pCallbacks;
 
     /* Do basic checks. */
-    AssertMsgReturn(   (pInterfaceIO->cbSize == sizeof(VDINTERFACEIO))
-                    && (pInterfaceIO->enmInterface == VDINTERFACETYPE_IO),
+    AssertMsgReturn(   (pInterfaceIO->cbSize == sizeof(VDINTERFACEIOINT))
+                    && (pInterfaceIO->enmInterface == VDINTERFACETYPE_IOINT),
                     ("A non I/O callback table attached to a I/O interface descriptor\n"), NULL);