Changeset 11046

Timestamp:

07/31/08 22:09:59 (5 months ago)

Author:

vboxsync

Message:

Storage: Theoretically functional iSCSI backend.

Files:

• trunk/include/VBox/VBoxHDD-new.h (modified) (53 diffs)
• trunk/include/VBox/err.h (modified) (1 diff)

trunk/include/VBox/VBoxHDD-new.h

@@ -32 +32 @@
-#define ___VBox_VD_h
-
+#include <iprt/assert.h>
+#include <iprt/string.h>
+#include <iprt/mem.h>
-#include <VBox/cdefs.h>
-#include <VBox/types.h>
+#include <VBox/err.h>
+/** @todo eliminate this dependency by moving data type definitions to the
+ * right place. PFNVMPROGRESS and P*PDMMEDIAGEOMETRY are affected. */
-#include <VBox/pdm.h>
-
@@ -233 +239 @@
-    /** Interface for progress notification. */
-    VDINTERFACETYPE_PROGRESS,
+    /** Interface for configuration information. */
+    VDINTERFACETYPE_CONFIG,
-    /** invalid interface. */
-    VDINTERFACETYPE_INVALID
@@ -267 +275 @@
- * Get a specific interface from a list of interfaces specified by the type.
- *
-s
+ 
- * @param   pInterfaces     Pointer to the first interface in the list.
- * @param   enmInterface    Interface to search for.
@@ -376 +384 @@
- * to inform the backend that a task finished.
- * 
-s
+ 
- * @param   pvUser          Opaque user data which is passed on request submission.
- */
@@ -402 +410 @@
-     * Open callback
-     *
-s
+ 
-     * @param   pvUser          The opaque data passed on container creation.
-     * @param   pszLocation     Name of the location to open.
@@ -413 +421 @@
-     * Close callback.
-     *
-s
+ 
-     * @param   pvUser          The opaque data passed on container creation.
-     * @param   pStorage        The opaque storage handle to close.
@@ -422 +430 @@
-     * Synchronous write callback.
-     *
-s
+ 
-     * @param   pvUser          The opaque data passed on container creation.
-     * @param   pStorage        The storage handle to use.
@@ -436 +444 @@
-     * Synchronous read callback.
-     *
-s
+ 
-     * @param   pvUser          The opaque data passed on container creation.
-     * @param   pStorage        The storage handle to use.
@@ -450 +458 @@
-     * Flush data to the storage backend.
-     *
-s
+ 
-     * @param   pvUser          The opaque data passed on container creation.
-     * @param   pStorage        The storage handle to flush.
@@ -459 +467 @@
-     * Prepare an asynchronous read task.
-     *
-s
+ 
-     * @param   pvUser         The opqaue user data passed on container creation.
-     * @param   pStorage       The storage handle.
@@ -473 +481 @@
-     * Prepare an asynchronous write task.
-     *
-s
+ 
-     * @param   pvUser         The opaque user data passed on conatiner creation.
-     * @param   pStorage       The storage handle.
@@ -487 +495 @@
-     * Submit an array of tasks for processing
-     *
-s
+ 
-     * @param   pvUser        The opaque user data passed on container creation.
-     * @param   apTasks       Array of task handles to submit.
@@ -552 +560 @@
-    AssertMsgReturn(   (pInterfaceProgress->cbSize == sizeof(VDINTERFACEPROGRESS))
-                    && (pInterfaceProgress->enmInterface == VDINTERFACETYPE_PROGRESS),
-n
+
-
-    return pInterfaceProgress;
+}
+
+/** Configuration node for configuration information interface. */
+typedef struct VDCFGNODE *PVDCFGNODE;
+
+/**
+ * Configuration value type for configuration information interface.
+ */
+typedef enum VDCFGVALUETYPE
+{
+    /** Integer value. */
+    VDCFGVALUETYPE_INTEGER = 1,
+    /** String value. */
+    VDCDFVALUETYPE_STRING,
+    /** Bytestring value. */
+    VDCFGVALUETYPE_BYTES
+} VDCFGVALUETYPE;
+/** Pointer to configuration value type for configuration information interface. */
+typedef VDCFGVALUETYPE *PVDCFGVALUETYPE;
+
+/**
+ * Configuration information interface
+ */
+typedef struct VDINTERFACECONFIG
+{
+    /**
+     * Size of the configuration interface.
+     */
+    uint32_t    cbSize;
+
+    /**
+     * Interface type.
+     */
+    VDINTERFACETYPE enmInterface;
+
+    /**
+     * Validates that the values are within a set of valid names.
+     *
+     * @return  true if all names are found in pszzAllowed.
+     * @return  false if not.
+     * @param   pNode           The node which values should be examined.
+     * @param   pszzValid       List of valid names separated by '\\0' and ending with
+     *                          a double '\\0'.
+     */
+    DECLR3CALLBACKMEMBER(bool, pfnAreValuesValid, (PVDCFGNODE pNode, const char *pszzValid));
+    DECLR3CALLBACKMEMBER(int, pfnQueryType, (PVDCFGNODE pNode, const char *pszName, PVDCFGVALUETYPE penmType));
+    DECLR3CALLBACKMEMBER(int, pfnQuerySize, (PVDCFGNODE pNode, const char *pszName, size_t *pcb));
+    DECLR3CALLBACKMEMBER(int, pfnQueryInteger, (PVDCFGNODE pNode, const char *pszName, uint64_t *pu64));
+    DECLR3CALLBACKMEMBER(int, pfnQueryIntegerDef, (PVDCFGNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def));
+    DECLR3CALLBACKMEMBER(int, pfnQueryString, (PVDCFGNODE pNode, const char *pszName, char *pszString, size_t cchString));
+    DECLR3CALLBACKMEMBER(int, pfnQueryStringDef, (PVDCFGNODE pNode, const char *pszName, char *pszString, size_t cchString, const char *pszDef));
+    DECLR3CALLBACKMEMBER(int, pfnQueryBytes, (PVDCFGNODE pNode, const char *pszName, void *pvData, size_t cbData));
+} VDINTERFACECONFIG, *PVDINTERFACECONFIG;
+
+/**
+ * Get configuration information interface from opaque callback table.
+ *
+ * @return Pointer to the callback table.
+ * @param  pCallbacks Opaque interface pointer.
+ */
+DECLINLINE(PVDINTERFACECONFIG) VDGetInterfaceConfig(void *pCallbacks)
+{
+    PVDINTERFACECONFIG pInterfaceConfig = (PVDINTERFACECONFIG)pCallbacks;
+
+    /* Do basic checks. */
+    AssertMsgReturn(   (pInterfaceConfig->cbSize == sizeof(VDINTERFACECONFIG))
+                    && (pInterfaceConfig->enmInterface == VDINTERFACETYPE_CONFIG),
+                    ("Not a configuration informaion interface\n"), NULL);
+
+    return pInterfaceConfig;
+}
+
+/**
+ * Query configuration, validates that the values are within a set of valid names.
+ *
+ * @returns true if all names are found in pszzAllowed.
+ * @returns false if not.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       The node which values should be examined.
+ * @param   pszzValid   List of valid names separated by '\\0' and ending with
+ *                      a double '\\0'.
+ */
+DECLINLINE(bool) VDCFGAreValuesValid(PVDINTERFACECONFIG pCfgIf,
+                                     PVDCFGNODE pNode,
+                                     const char *pszzValid)
+{
+    return pCfgIf->pfnAreValuesValid(pNode, pszzValid);
+}
+
+/**
+ * Query configuration, unsigned 64-bit integer value with default.
+ * 
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       Which node to search for pszName in.
+ * @param   pszName     Name of an integer value
+ * @param   pu64        Where to store the value. Set to default on failure.
+ * @param   u64Def      The default value.
+ */
+DECLINLINE(int) VDCFGQueryU64Def(PVDINTERFACECONFIG pCfgIf, PVDCFGNODE pNode,
+                                 const char *pszName, uint64_t *pu64,
+                                 uint64_t u64Def)
+{
+    return pCfgIf->pfnQueryIntegerDef(pNode, pszName, pu64, u64Def);
+}
+
+/**
+ * Query configuration, unsigned 32-bit integer value with default.
+ * 
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       Which node to search for pszName in.
+ * @param   pszName     Name of an integer value
+ * @param   pu32        Where to store the value. Set to default on failure.
+ * @param   u32Def      The default value.
+ */
+DECLINLINE(int) VDCFGQueryU32Def(PVDINTERFACECONFIG pCfgIf, PVDCFGNODE pNode,
+                                 const char *pszName, uint32_t *pu32,
+                                 uint32_t u32Def)
+{
+    uint64_t u64;
+    int rc = pCfgIf->pfnQueryIntegerDef(pNode, pszName, &u64, u32Def);
+    if (VBOX_SUCCESS(rc))
+    {
+        if (!(u64 & UINT64_C(0xffffffff00000000)))
+            *pu32 = (uint32_t)u64;
+        else
+            rc = VERR_CFGM_INTEGER_TOO_BIG;
+    }
+    return rc;
+}
+
+/**
+ * Query configuration, bool value with default.
+ * 
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       Which node to search for pszName in.
+ * @param   pszName     Name of an integer value
+ * @param   pf          Where to store the value. Set to default on failure.
+ * @param   fDef        The default value.
+ */
+DECLINLINE(int) VDCFGQueryBoolDef(PVDINTERFACECONFIG pCfgIf, PVDCFGNODE pNode,
+                                  const char *pszName, bool *pf,
+                                  bool fDef)
+{
+    uint64_t u64;
+    int rc = pCfgIf->pfnQueryIntegerDef(pNode, pszName, &u64, fDef);
+    if (VBOX_SUCCESS(rc))
+        *pf = u64 ? true : false;
+    return rc;
+}
+
+/**
+ * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
+ * character value.
+ * 
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       Which node to search for pszName in.
+ * @param   pszName     Name of an zero terminated character value
+ * @param   ppszString  Where to store the string pointer. Not set on failure.
+ *                      Free this using RTMemFree().
+ */
+DECLINLINE(int) VDCFGQueryStringAlloc(PVDINTERFACECONFIG pCfgIf,
+                                      PVDCFGNODE pNode,
+                                      const char *pszName,
+                                      char **ppszString)
+{
+    size_t cch;
+    int rc = pCfgIf->pfnQuerySize(pNode, pszName, &cch);
+    if (VBOX_SUCCESS(rc))
+    {
+        char *pszString = (char *)RTMemAlloc(cch);
+        if (pszString)
+        {
+            rc = pCfgIf->pfnQueryString(pNode, pszName, pszString, cch);
+            if (VBOX_SUCCESS(rc))
+                *ppszString = pszString;
+            else
+                RTMemFree(pszString);
+        }
+        else
+            rc = VERR_NO_MEMORY;
+    }
+    return rc;
+}
+
+/**
+ * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
+ * character value with default.
+ * 
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       Which node to search for pszName in.
+ * @param   pszName     Name of an zero terminated character value
+ * @param   ppszString  Where to store the string pointer. Not set on failure.
+ *                      Free this using RTMemFree().
+ * @param   pszDef      The default value.
+ */
+DECLINLINE(int) VDCFGQueryStringAllocDef(PVDINTERFACECONFIG pCfgIf,
+                                         PVDCFGNODE pNode,
+                                         const char *pszName,
+                                         char **ppszString,
+                                         const char *pszDef)
+{
+    size_t cch;
+    int rc = pCfgIf->pfnQuerySize(pNode, pszName, &cch);
+    if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
+    {
+        cch = strlen(pszDef) + 1;
+        rc = VINF_SUCCESS;
+    }
+    if (VBOX_SUCCESS(rc))
+    {
+        char *pszString = (char *)RTMemAlloc(cch);
+        if (pszString)
+        {
+            rc = pCfgIf->pfnQueryStringDef(pNode, pszName, pszString, cch, pszDef);
+            if (VBOX_SUCCESS(rc))
+                *ppszString = pszString;
+            else
+                RTMemFree(pszString);
+        }
+        else
+            rc = VERR_NO_MEMORY;
+    }
+    return rc;
+}
+
+/**
+ * Query configuration, dynamically allocated (RTMemAlloc) byte string value.
+ * 
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @param   pNode       Which node to search for pszName in.
+ * @param   pszName     Name of an zero terminated character value
+ * @param   ppvData     Where to store the byte string pointer. Not set on failure.
+ *                      Free this using RTMemFree().
+ * @param   pcbData     Where to store the byte string length.
+ */
+DECLINLINE(int) VDCFGQueryBytesAlloc(PVDINTERFACECONFIG pCfgIf,
+                                     PVDCFGNODE pNode, const char *pszName,
+                                     void **ppvData, size_t *pcbData)
+{
+    size_t cb;
+    int rc = pCfgIf->pfnQuerySize(pNode, pszName, &cb);
+    if (VBOX_SUCCESS(rc))
+    {
+        char *pvData = (char *)RTMemAlloc(cb);
+        if (pvData)
+        {
+            rc = pCfgIf->pfnQueryBytes(pNode, pszName, pvData, cb);
+            if (VBOX_SUCCESS(rc))
+            {
+                *ppvData = pvData;
+                *pcbData = cb;
+            }
+            else
+                RTMemFree(pvData);
+        }
+        else
+            rc = VERR_NO_MEMORY;
+    }
+    return rc;
-}
-
@@ -571 +844 @@
- * Free all returned names with RTStrFree() when you no longer need them.
- *
-s
+ 
- *          VERR_BUFFER_OVERFLOW if not enough space is passed.
- * @param   cEntriesAlloc   Number of list entries available.
@@ -584 +857 @@
- * Free all returned names with RTStrFree() when you no longer need them.
- *
-s
+ 
- * @param   pszBackend      The backend name.
- * @param   pEntries        Pointer to an entry.
@@ -594 +867 @@
- * No image files are opened.
- *
-s
+ 
- * @param   pInterfaces     Pointer to the first supported interface.
- * @param   ppDisk          Where to store the reference to HDD container.
@@ -611 +884 @@
- * Try to get the backend name which can use this image.
- *
-s
+ 
- * @param   pszFilename     Name of the image file for which the backend is queried.
- * @param   ppszFormat      Receives pointer of the UTF-8 string which contains the format name.
@@ -631 +904 @@
- * Use VDIsReadOnly to check open mode.
- *
-s
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   pszBackend      Name of the image file backend to use.
@@ -643 +916 @@
- * Creates and opens a new base image file.
- *
-s
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   pszBackend      Name of the image file backend to use.
@@ -670 +943 @@
- * See comments for VDOpen function about differencing images.
- *
-s
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   pszBackend      Name of the image file backend to use.
@@ -691 +964 @@
- * images in the HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImageFrom      Name of the image file to merge from.
@@ -713 +986 @@
- * the image at the new location is opened in the same way as the old one was.
- *
-s
-s
+ 
+ 
- * @param   pDiskFrom       Pointer to source HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -736 +1009 @@
- * will be reopened in read/write mode.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   fDelete         If true, delete the image from the host disk.
@@ -746 +1019 @@
- * Closes all opened image files in HDD container.
- *
-s
+ 
- * @param   pDisk           Pointer to HDD container.
- */
@@ -754 +1027 @@
- * Read data from virtual HDD.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   uOffset         Offset of first reading byte from start of disk.
@@ -766 +1039 @@
- * Write data to virtual HDD.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   uOffset         Offset of first writing byte from start of disk.
@@ -778 +1051 @@
- * Make sure the on disk representation of a virtual HDD is up to date.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- */
@@ -787 +1060 @@
- * Get number of opened images in HDD container.
- *
-s
+ 
- * @param   pDisk           Pointer to HDD container.
- */
@@ -795 +1068 @@
- * Get read/write mode of HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- */
@@ -804 +1077 @@
- * Get total capacity of an image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -814 +1087 @@
- * Get total file size of an image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -824 +1097 @@
- * Get virtual disk PCHS geometry of an image in HDD container.
- *
-s
-s
-s
+ 
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -837 +1110 @@
- * Store virtual disk PCHS geometry of an image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -849 +1122 @@
- * Get virtual disk LCHS geometry of an image in HDD container.
- *
-s
-s
-s
+ 
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -862 +1135 @@
- * Store virtual disk LCHS geometry of an image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -874 +1147 @@
- * Get version of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -886 +1159 @@
- * Get type of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -898 +1171 @@
- * List the capabilities of image backend in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to the HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -910 +1183 @@
- * Get flags of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -921 +1194 @@
- * Get open flags of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -935 +1208 @@
- * Note that in case of unrecoverable error all images in HDD container will be closed.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -949 +1222 @@
- * purposes.
- *
-s
-s
-s
+ 
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -963 +1236 @@
- * Get the comment line of image in HDD container.
- *
-s
-s
-s
+ 
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -977 +1250 @@
- * Changes the comment line of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -989 +1262 @@
- * Get UUID of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -1000 +1273 @@
- * Set the image's UUID. Should not be used by normal applications.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -1011 +1284 @@
- * Get last modification UUID of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -1023 +1296 @@
- * Set the image's last modification UUID. Should not be used by normal applications.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -1035 +1308 @@
- * Get parent UUID of image in HDD container.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of the container.
@@ -1047 +1320 @@
- * Set the image's parent UUID. Should not be used by normal applications.
- *
-s
+ 
- * @param   pDisk           Pointer to HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -1067 +1340 @@
- * Query if asynchronous operations are supported for this disk.
- *
-s
-s
+ 
+ 
- * @param   pDisk           Pointer to the HDD container.
- * @param   nImage          Image number, counts from 0. 0 is always base image of container.
@@ -1079 +1352 @@
- * Start a asynchronous read request.
- *
-s
+ 
- * @param   pDisk           Pointer to the HDD container.
- * @param   uOffset         The offset of the virtual disk to read from.
@@ -1095 +1368 @@
- * Start a asynchronous write request.
- *
-s
+ 
- * @param   pDisk           Pointer to the HDD container.
- * @param   uOffset         The offset of the virtual disk to write to.

trunk/include/VBox/err.h

@@ -1049 +1049 @@
-/** Configuration value not found. */
-#define VERR_VDI_VALUE_NOT_FOUND                    (-3216)
+/** Configuration value is unknown. This indicates misconfiguration. */
+#define VERR_VDI_UNKNOWN_CFG_VALUES                 (-3217)
-/** Asynchronous I/O request finished. */
-#define VINF_VDI_ASYNC_IO_FINISHED                  3218