Changeset 51102 in vbox for trunk

Timestamp:

Apr 18, 2014 9:57:44 AM (11 years ago)

Author:

vboxsync

Message:

Storage/FilterCrypt: Remove hardcoded data unit size of 512 bytes and introduce interface to query the size from the generic layer

Location:

trunk

Files:

• include/VBox/vd-ifs-internal.h (modified) (2 diffs)
• include/VBox/vd-ifs.h (modified) (3 diffs)
• src/VBox/Storage/VD.cpp (modified) (2 diffs)

trunk/include/VBox/vd-ifs-internal.h

@@ -407 +407 @@
                                                 size_t cbCheck, bool fAdvance));
 
+    /**
+     * Returns the data unit size, i.e. the smallest size for a transfer.
+     * (similar to the sector size of disks).
+     *
+     * @returns The data unit size.
+     * @param   pvUser         The opaque user data passed on container creation.
+     * @param   pIoCtx         The I/O context.
+     */
+    DECLR3CALLBACKMEMBER(size_t, pfnIoCtxGetDataUnitSize, (void *pvUser, PVDIOCTX pIoCtx));
+
 } VDINTERFACEIOINT, *PVDINTERFACEIOINT;
 
@@ -585 +595 @@
 }
 
+DECLINLINE(size_t) vdIfIoIntIoCtxGetDataUnitSize(PVDINTERFACEIOINT pIfIoInt, PVDIOCTX pIoCtx)
+{
+    return pIfIoInt->pfnIoCtxGetDataUnitSize(pIfIoInt->Core.pvUser, pIoCtx);
+}
 
 /**

trunk/include/VBox/vd-ifs.h

@@ -743 +743 @@
      */
     DECLR3CALLBACKMEMBER(int, pfnQuery, (void *pvUser, const char *pszName, char *pszValue, size_t cchValue));
+
+    /**
+     * Query the bytes value associated with a key.
+     *
+     * @return  VBox status code.
+     *          VERR_CFGM_VALUE_NOT_FOUND means that the key is not known.
+     *          VERR_CFGM_NOT_ENOUGH_SPACE means that the buffer is not big enough.
+     * @param   pvUser          The opaque user data associated with this interface.
+     * @param   pszName         Name of the key to query.
+     * @param   ppvData         Pointer to buffer where to store the data.
+     * @param   cbData          Length of data buffer.
+     */
+    DECLR3CALLBACKMEMBER(int, pfnQueryBytes, (void *pvUser, const char *pszName, void *ppvData, size_t cbData));
 
 } VDINTERFACECONFIG, *PVDINTERFACECONFIG;
@@ -951 +964 @@
         if (pbData)
         {
-            rc = pCfgIf->pfnQuery(pCfgIf->Core.pvUser, pszName, pbData, cb);
+            if(pCfgIf->pfnQueryBytes)
+                rc = pCfgIf->pfnQueryBytes(pCfgIf->Core.pvUser, pszName, pbData, cb);
+            else
+                rc = pCfgIf->pfnQuery(pCfgIf->Core.pvUser, pszName, pbData, cb);
+
             if (RT_SUCCESS(rc))
             {
                 *ppvData = pbData;
-                *pcbData = cb - 1; /* Exclude terminator of the queried string. */
+                *pcbData = cb;
             }
             else
@@ -964 +981 @@
     }
     return rc;
+}
+
+/**
+ * Query configuration, dynamically allocated (RTMemAlloc) zero terminated
+ * character value - the memory is locked to prevent paging to disk,
+ * useful for memory which holds keys, passwords, etc.
+ *
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @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) VDCFGQueryStringAllocLocked(PVDINTERFACECONFIG pCfgIf,
+                                            const char *pszName, char **ppszString)
+{
+    size_t cb;
+    int rc = pCfgIf->pfnQuerySize(pCfgIf->Core.pvUser, pszName, &cb);
+    if (RT_SUCCESS(rc))
+    {
+        char *pszString = (char *)RTMemLockedAlloc(cb);
+        if (pszString)
+        {
+            rc = pCfgIf->pfnQuery(pCfgIf->Core.pvUser, pszName, pszString, cb);
+            if (RT_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 - the memory is locked to prevent paging to disk,
+ * useful for memory which holds keys, passwords, etc.
+ *
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @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) VDCFGQueryStringAllocLockedDef(PVDINTERFACECONFIG pCfgIf,
+                                               const char *pszName,
+                                               char **ppszString,
+                                               const char *pszDef)
+{
+    size_t cb;
+    int rc = pCfgIf->pfnQuerySize(pCfgIf->Core.pvUser, pszName, &cb);
+    if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
+    {
+        cb = strlen(pszDef) + 1;
+        rc = VINF_SUCCESS;
+    }
+    if (RT_SUCCESS(rc))
+    {
+        char *pszString = (char *)RTMemLockedAlloc(cb);
+        if (pszString)
+        {
+            rc = pCfgIf->pfnQuery(pCfgIf->Core.pvUser, pszName, pszString, cb);
+            if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
+            {
+                memcpy(pszString, pszDef, cb);
+                rc = VINF_SUCCESS;
+            }
+            if (RT_SUCCESS(rc))
+                *ppszString = pszString;
+            else
+                RTMemFree(pszString);
+        }
+        else
+            rc = VERR_NO_MEMORY;
+    }
+    return rc;
+}
+
+/**
+ * Query configuration, dynamically allocated (RTMemAlloc) byte string value -
+ * the memory is locked to prevent paging to disk, useful for memory which holds
+ * keys, passwords, etc..
+ *
+ * @return  VBox status code.
+ * @param   pCfgIf      Pointer to configuration callback table.
+ * @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) VDCFGQueryBytesAllocLocked(PVDINTERFACECONFIG pCfgIf,
+                                           const char *pszName, void **ppvData, size_t *pcbData)
+{
+    size_t cb;
+    int rc = pCfgIf->pfnQuerySize(pCfgIf->Core.pvUser, pszName, &cb);
+    if (RT_SUCCESS(rc))
+    {
+        char *pbData;
+        Assert(cb);
+
+        pbData = (char *)RTMemLockedAlloc(cb);
+        if (pbData)
+        {
+            if(pCfgIf->pfnQueryBytes)
+                rc = pCfgIf->pfnQueryBytes(pCfgIf->Core.pvUser, pszName, pbData, cb);
+            else
+                rc = pCfgIf->pfnQuery(pCfgIf->Core.pvUser, pszName, pbData, cb);
+
+            if (RT_SUCCESS(rc))
+            {
+                *ppvData = pbData;
+                *pcbData = cb;
+            }
+            else
+                RTMemFree(pbData);
+        }
+        else
+            rc = VERR_NO_MEMORY;
+    }
+    return rc;
+}
+
+/**
+ * Frees memory allocated using one of the VDCFGQuery*AllocLocked methods.
+ */
+DECLINLINE(void) VDCFGMemLockedFree(void *pvData)
+{
+    RTMemLockedFree(pvData);
 }
 

trunk/src/VBox/Storage/VD.cpp

@@ -4919 +4919 @@
 }
 
+static DECLCALLBACK(size_t) vdIOIntIoCtxGetDataUnitSize(void *pvUser, PVDIOCTX pIoCtx)
+{
+    PVDIO    pVDIo = (PVDIO)pvUser;
+    PVBOXHDD pDisk = pVDIo->pDisk;
+
+    PVDIMAGE pImage = vdGetImageByNumber(pDisk, VD_LAST_IMAGE);
+    AssertPtrReturn(pImage, 0);
+    return pImage->Backend->pfnGetSectorSize(pImage->pBackendData);  
+}
+
 /**
  * VD I/O interface callback for opening a file (limited version for VDGetFormat).
@@ -5181 +5191 @@
 static void vdIfIoIntCallbacksSetup(PVDINTERFACEIOINT pIfIoInt)
 {
-    pIfIoInt->pfnOpen                = vdIOIntOpen;
-    pIfIoInt->pfnClose               = vdIOIntClose;
-    pIfIoInt->pfnDelete              = vdIOIntDelete;
-    pIfIoInt->pfnMove                = vdIOIntMove;
-    pIfIoInt->pfnGetFreeSpace        = vdIOIntGetFreeSpace;
-    pIfIoInt->pfnGetModificationTime = vdIOIntGetModificationTime;
-    pIfIoInt->pfnGetSize             = vdIOIntGetSize;
-    pIfIoInt->pfnSetSize             = vdIOIntSetSize;
-    pIfIoInt->pfnReadUser            = vdIOIntReadUser;
-    pIfIoInt->pfnWriteUser           = vdIOIntWriteUser;
-    pIfIoInt->pfnReadMeta            = vdIOIntReadMeta;
-    pIfIoInt->pfnWriteMeta           = vdIOIntWriteMeta;
-    pIfIoInt->pfnMetaXferRelease     = vdIOIntMetaXferRelease;
-    pIfIoInt->pfnFlush               = vdIOIntFlush;
-    pIfIoInt->pfnIoCtxCopyFrom       = vdIOIntIoCtxCopyFrom;
-    pIfIoInt->pfnIoCtxCopyTo         = vdIOIntIoCtxCopyTo;
-    pIfIoInt->pfnIoCtxSet            = vdIOIntIoCtxSet;
-    pIfIoInt->pfnIoCtxSegArrayCreate = vdIOIntIoCtxSegArrayCreate;
-    pIfIoInt->pfnIoCtxCompleted      = vdIOIntIoCtxCompleted;
-    pIfIoInt->pfnIoCtxIsSynchronous  = vdIOIntIoCtxIsSynchronous;
-    pIfIoInt->pfnIoCtxIsZero         = vdIOIntIoCtxIsZero;
+    pIfIoInt->pfnOpen                 = vdIOIntOpen;
+    pIfIoInt->pfnClose                = vdIOIntClose;
+    pIfIoInt->pfnDelete               = vdIOIntDelete;
+    pIfIoInt->pfnMove                 = vdIOIntMove;
+    pIfIoInt->pfnGetFreeSpace         = vdIOIntGetFreeSpace;
+    pIfIoInt->pfnGetModificationTime  = vdIOIntGetModificationTime;
+    pIfIoInt->pfnGetSize              = vdIOIntGetSize;
+    pIfIoInt->pfnSetSize              = vdIOIntSetSize;
+    pIfIoInt->pfnReadUser             = vdIOIntReadUser;
+    pIfIoInt->pfnWriteUser            = vdIOIntWriteUser;
+    pIfIoInt->pfnReadMeta             = vdIOIntReadMeta;
+    pIfIoInt->pfnWriteMeta            = vdIOIntWriteMeta;
+    pIfIoInt->pfnMetaXferRelease      = vdIOIntMetaXferRelease;
+    pIfIoInt->pfnFlush                = vdIOIntFlush;
+    pIfIoInt->pfnIoCtxCopyFrom        = vdIOIntIoCtxCopyFrom;
+    pIfIoInt->pfnIoCtxCopyTo          = vdIOIntIoCtxCopyTo;
+    pIfIoInt->pfnIoCtxSet             = vdIOIntIoCtxSet;
+    pIfIoInt->pfnIoCtxSegArrayCreate  = vdIOIntIoCtxSegArrayCreate;
+    pIfIoInt->pfnIoCtxCompleted       = vdIOIntIoCtxCompleted;
+    pIfIoInt->pfnIoCtxIsSynchronous   = vdIOIntIoCtxIsSynchronous;
+    pIfIoInt->pfnIoCtxIsZero          = vdIOIntIoCtxIsZero;
+    pIfIoInt->pfnIoCtxGetDataUnitSize = vdIOIntIoCtxGetDataUnitSize;
 }