Changeset 63905 in vbox for trunk/src

Timestamp:

Sep 20, 2016 8:31:05 AM (8 years ago)

Author:

vboxsync

Message:

Storage/VD: Add proper versioning of the backend structures instead of just relying on the structure size to make changing callback signatures possible in the future and still being able to reject incompatible plugins

Location:

trunk/src/VBox/Storage

Files:

• DMG.cpp (modified) (2 diffs)
• ISCSI.cpp (modified) (2 diffs)
• Parallels.cpp (modified) (2 diffs)
• QCOW.cpp (modified) (2 diffs)
• QED.cpp (modified) (2 diffs)
• RAW.cpp (modified) (2 diffs)
• VCICache.cpp (modified) (2 diffs)
• VD.cpp (modified) (4 diffs)
• VDI.cpp (modified) (2 diffs)
• VHD.cpp (modified) (2 diffs)
• VHDX.cpp (modified) (2 diffs)
• VMDK.cpp (modified) (2 diffs)

trunk/src/VBox/Storage/DMG.cpp

@@ -2406 +2406 @@
 const VDIMAGEBACKEND g_DmgBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "DMG",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_FILE | VD_CAP_VFS,
@@ -2499 +2499 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };
 

trunk/src/VBox/Storage/ISCSI.cpp

@@ -5497 +5497 @@
 const VDIMAGEBACKEND g_ISCSIBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "iSCSI",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_CONFIG | VD_CAP_TCPNET | VD_CAP_ASYNC,
@@ -5590 +5590 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/Parallels.cpp

@@ -1069 +1069 @@
 const VDIMAGEBACKEND g_ParallelsBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "Parallels",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF,
@@ -1162 +1162 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/QCOW.cpp

@@ -2317 +2317 @@
 const VDIMAGEBACKEND g_QCowBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "QCOW",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_FILE | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF | VD_CAP_ASYNC,
@@ -2410 +2410 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/QED.cpp

@@ -2373 +2373 @@
 const VDIMAGEBACKEND g_QedBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "QED",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_FILE | VD_CAP_VFS | VD_CAP_CREATE_DYNAMIC | VD_CAP_DIFF | VD_CAP_ASYNC,
@@ -2466 +2466 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32Version */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/RAW.cpp

@@ -957 +957 @@
 const VDIMAGEBACKEND g_RawBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "RAW",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_CREATE_FIXED | VD_CAP_FILE | VD_CAP_ASYNC | VD_CAP_VFS,
@@ -1050 +1050 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/VCICache.cpp

@@ -1983 +1983 @@
 const VDCACHEBACKEND g_VciCacheBackend =
 {
+    /* u32Version */
+    VD_CACHEBACKEND_VERSION,
     /* pszBackendName */
     "vci",
-    /* cbSize */
-    sizeof(VDCACHEBACKEND),
     /* uBackendCaps */
     VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC | VD_CAP_FILE | VD_CAP_VFS,
@@ -2038 +2038 @@
     NULL,
     /* pfnComposeName */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_CACHEBACKEND_VERSION
 };
 

trunk/src/VBox/Storage/VD.cpp

@@ -3547 +3547 @@
     int rc = VINF_SUCCESS;
 
-    if (pBackend->cbSize == sizeof(VDIMAGEBACKEND))
+    if (VD_VERSION_ARE_COMPATIBLE(VD_IMGBACKEND_VERSION, pBackend->u32Version))
         vdAddBackend((RTLDRMOD)pvUser, pBackend);
     else
     {
-        LogFunc(("ignored plugin: pBackend->cbSize=%d rc=%Rrc\n", pBackend->cbSize, rc));
+        LogFunc(("ignored plugin: pBackend->u32Version=%u rc=%Rrc\n", pBackend->u32Version, rc));
         rc = VERR_IGNORED;
     }
@@ -3565 +3565 @@
     int rc = VINF_SUCCESS;
 
-    if (pBackend->cbSize == sizeof(VDCACHEBACKEND))
+    if (VD_VERSION_ARE_COMPATIBLE(VD_CACHEBACKEND_VERSION, pBackend->u32Version))
         vdAddCacheBackend((RTLDRMOD)pvUser, pBackend);
     else
     {
-        LogFunc(("ignored plugin: pBackend->cbSize=%d rc=%Rrc\n", pBackend->cbSize, rc));
+        LogFunc(("ignored plugin: pBackend->u32Version=%u rc=%Rrc\n", pBackend->u32Version, rc));
         rc = VERR_IGNORED;
     }
@@ -3583 +3583 @@
     int rc = VINF_SUCCESS;
 
-    if (pBackend->cbSize == sizeof(VDFILTERBACKEND))
+    if (VD_VERSION_ARE_COMPATIBLE(VD_FLTBACKEND_VERSION, pBackend->u32Version))
         vdAddFilterBackend((RTLDRMOD)pvUser, pBackend);
     else
     {
-        LogFunc(("ignored plugin: pBackend->cbSize=%d rc=%Rrc\n", pBackend->cbSize, rc));
+        LogFunc(("ignored plugin: pBackend->u32Version=%u rc=%Rrc\n", pBackend->u32Version, rc));
         rc = VERR_IGNORED;
     }
@@ -3720 +3720 @@
         PFNVDPLUGINLOAD pfnVDPluginLoad = NULL;
 
+        BackendRegister.u32Version        = VD_BACKENDREG_CB_VERSION;
         BackendRegister.pfnRegisterImage  = vdPluginRegisterImage;
         BackendRegister.pfnRegisterCache  = vdPluginRegisterCache;

trunk/src/VBox/Storage/VDI.cpp

@@ -3000 +3000 @@
 const VDIMAGEBACKEND g_VDIBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "VDI",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
       VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
@@ -3095 +3095 @@
     vdiRepair,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/VHD.cpp

@@ -3011 +3011 @@
 const VDIMAGEBACKEND g_VhdBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "VHD",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_UUID | VD_CAP_DIFF | VD_CAP_FILE |
@@ -3106 +3106 @@
     vhdRepair,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/VHDX.cpp

@@ -2489 +2489 @@
 const VDIMAGEBACKEND g_VhdxBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "VHDX",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
     VD_CAP_FILE | VD_CAP_VFS,
@@ -2582 +2582 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };

trunk/src/VBox/Storage/VMDK.cpp

@@ -6347 +6347 @@
 const VDIMAGEBACKEND g_VmdkBackend =
 {
+    /* u32Version */
+    VD_IMGBACKEND_VERSION,
     /* pszBackendName */
     "VMDK",
-    /* cbSize */
-    sizeof(VDIMAGEBACKEND),
     /* uBackendCaps */
       VD_CAP_UUID | VD_CAP_CREATE_FIXED | VD_CAP_CREATE_DYNAMIC
@@ -6442 +6442 @@
     NULL,
     /* pfnTraverseMetadata */
-    NULL
+    NULL,
+    /* u32VersionEnd */
+    VD_IMGBACKEND_VERSION
 };